@backstage/plugin-catalog-node

Home > @backstage/plugin-catalog-node

The catalog-backend-node module for @backstage/plugin-catalog-backend.

Functions

Function	Description
locationSpecToLocationEntity(opts)	A standard way of producing a machine generated Location kind entity for a location.
locationSpecToMetadataName(location)	A standard way of producing a machine generated name for a location.

Interfaces

Interface	Description
CatalogProcessorCache	A cache for storing data during processing. The values stored in the cache are always local to each processor, meaning no processor can see cache values from other processors. The cache instance provided to the CatalogProcessor is also scoped to the entity being processed, meaning that each processor run can't see cache values from processing runs for other entities. Values that are set during a processing run will only be visible in the directly following run. The cache will be overwritten every run unless no new cache items are written, in which case the existing values remain in the cache.
CatalogService	A version of the CatalogApi that requires backend credentials to be passed instead of a token.
CatalogServiceRequestOptions
EntityProvider	An entity provider is able to provide entities to the catalog. See https://backstage.io/docs/features/software-catalog/life-of-an-entity for more details.
EntityProviderConnection	The connection between the catalog and the entity provider. Entity providers use this connection to add and remove entities from the catalog.

Variables

Variable	Description
catalogServiceRef	The catalogService provides the catalog API.
processingResult	Factory functions for the standard processing result types.

Type Aliases

Type Alias	Description
AnalyzeOptions
CatalogProcessor
CatalogProcessorEmit
CatalogProcessorEntityResult
CatalogProcessorErrorResult
CatalogProcessorLocationResult
CatalogProcessorParser	A parser, that is able to take the raw catalog descriptor data and turn it into the actual result pieces. The default implementation performs a YAML document parsing.
CatalogProcessorRefreshKeysResult
CatalogProcessorRelationResult
CatalogProcessorResult
DeferredEntity	Entities that are not yet processed.
EntitiesSearchFilter	Matches rows in the search table.
EntityFilter	A filter expression for entities.
EntityProviderMutation	A 'full' mutation replaces all existing entities created by this entity provider with new ones. A 'delta' mutation can both add and remove entities provided by this provider. Previously provided entities from a 'full' mutation are not removed.
EntityProviderRefreshOptions	The options given to an entity refresh operation.
EntityRelationSpec	Holds the relation data for entities.
LocationAnalyzer
LocationSpec	Holds the entity location information.
PlaceholderResolver
PlaceholderResolverParams
PlaceholderResolverRead
PlaceholderResolverResolveUrl
ScmLocationAnalyzer