@backstage/plugin-catalog-backend-module-incremental-ingestion

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

Provides efficient incremental ingestion of entities into the catalog.

Classes

Class	Description
IncrementalCatalogBuilder

Interfaces

Interface	Description
IncrementalEntityProvider	Ingest entities into the catalog in bite-sized chunks. A Normal EntityProvider allows you to introduce entities into the processing pipeline by calling an applyMutation() on the full set of entities. However, this is not great when the number of entities that you have to keep track of is extremely large because it entails having all of them in memory at once. An IncrementalEntityProvider by contrast allows you to provide batches of entities in sequence so that you never need to have more than a few hundred in memory at a time.
IncrementalEntityProviderOptions
IncrementalIngestionProviderExtensionPoint	Interface for incrementalIngestionProvidersExtensionPoint.

Variables

Variable	Description
catalogModuleIncrementalIngestionEntityProvider	Registers the incremental entity provider with the catalog processing extension point.
incrementalIngestionProvidersExtensionPoint	Extension point for registering incremental ingestion providers. The catalogModuleIncrementalIngestionEntityProvider must be installed for these providers to work.

Type Aliases

Type Alias	Description
EntityIteratorResult	Value returned by an IncrementalEntityProvider to provide a single page of entities to ingest.
IncrementalEntityEventResult	An object returned by event handler to indicate whether to ignore the event or to apply a delta in response to the event.
PluginEnvironment