incrementalIngestionProvidersExtensionPoint

Home > @backstage/plugin-catalog-backend-module-incremental-ingestion > incrementalIngestionProvidersExtensionPoint

Extension point for registering incremental ingestion providers. The catalogModuleIncrementalIngestionEntityProvider must be installed for these providers to work.

Signature:

incrementalIngestionProvidersExtensionPoint: import("@backstage/backend-plugin-api").ExtensionPoint<IncrementalIngestionProviderExtensionPoint>

Example

backend.add(createBackendModule({
  pluginId: 'catalog',
  moduleId: 'my-incremental-provider',
  register(env) {
    env.registerInit({
      deps: {
        extension: incrementalIngestionProvidersExtensionPoint,
      },
      async init({ extension }) {
        extension.addProvider({
          burstInterval: ...,
          burstLength: ...,
          restLength: ...,
        }, {
          next(context, cursor) {
            ...
          },
          ...
        })
      })
    })
  }
}))