Overview of sdk-backend-spi

Home > @gooddata/sdk-backend-spi

sdk-backend-spi package

This package provides definitions of the Service Provider Interface (SPI) for the Analytical Backend.

Remarks

The interface defines functionality to be implemented for a particular backend to be used in GoodData.UI. The Analytical Backend SPI for the GoodData platform (codename bear in @gooddata/sdk-backend-bear) is fully implemented. The Analytical Backend SPI for GoodData Cloud and GoodData.CN (joint codename tiger in @gooddata/sdk-backend-tiger) is almost fully implemented.

Classes

Class	Description
AnalyticalBackendError	Superclass for all exceptions that can occur in Analytical Backend.
ContractExpired	This exception is thrown when a contract has expired, for example if a plan's trial period has ended
DataTooLargeError	This exception MUST be thrown when backend execution identifies that there is too much data to process for the execution and refuses to proceed.
LimitReached	This exception is thrown when the limit of objects that can be created on backend is reached, for example if no more workspaces can be created because of the plan limits.
NoDataError	This exception MUST be thrown when the backend execution identifies that there is no data to calculate.
NotAuthenticated	This exception is thrown when client code triggers an operation which requires authentication but the client code did not provide credentials or the credentials are invalid.
NotImplemented	This exception is thrown when client code asks Analytical Backend to exercise a feature that is not implemented yet.
NotSupported	This exception is thrown when client code asks Analytical Backend to exercise an unsupported feature.
ProtectedDataError	This exception MUST be thrown when backend execution identifies that the data to calculate results for is protected and the caller lacks the sufficient authorization.
UnexpectedError	This exception MUST be thrown when the unexpected happens. This is a last-resort error type that SHOULD be used if the erroneous state cannot be categorized in a better way.
UnexpectedResponseError	This exception MUST be thrown when communication with the backend encounters an unexpected response status code and it cannot handle or categorize it to a known, domain-specific error.

Functions

Function	Description
isAnalyticalBackendError(obj)	Type guard checking whether input is an instance of AnalyticalBackendError
isContractExpired(obj)	Type guard checking whether input is an instance of ContractExpired
isDataTooLargeError(obj)	Type guard checking whether input is an instance of DataTooLargeError
isElementsQueryOptionsElementsByPrimaryDisplayFormValue(obj)	Type guard checking whether the object is an instance of IElementsQueryOptionsElementsByPrimaryDisplayFormValue.
isElementsQueryOptionsElementsByValue(obj)	Type guard checking whether the object is an instance of IElementsQueryOptionsElementsByValue.
isLimitReached(obj)	Type guard checking whether input is an instance of LimitReached
isNoDataError(obj)	Type guard checking whether input is an instance of NoDataError
isNotAuthenticated(obj)	Type guard checking whether input is an instance of NotAuthenticated
isNotImplemented(obj)	Type guard checking whether input is an instance of NotImplemented
isNotSupported(obj)	Type guard checking whether input is an instance of NotSupported
isProtectedDataError(obj)	Type guard checking whether input is an instance of ProtectedDataError
isUnexpectedError(obj)	Type guard checking whether input is an instance of UnexpectedResponseError
isUnexpectedResponseError(obj)	Type guard checking whether input is an instance of UnexpectedResponseError
isValueBasedElementsQueryOptionsElements(obj)	Type guard checking whether the object is an instance of IElementsQueryOptionsElementsByValue or IElementsQueryOptionsElementsByPrimaryDisplayFormValue.
prepareExecution(backend, definition)	Prepares execution of the provided definition against a backend.

Interfaces

Interface	Description
IAnalyticalBackend	The root of the Analytical Backend SPI.
IAnalyticalBackendConfig	Specifies platform agnostic configuration of an analytical backend.
IAnalyticalWorkspace	Represents an analytical workspace hosted on a backend.
IAttributeDescriptor	Describes attribute slicing of a dimension.
IAttributeDescriptorBody	Attribute descriptior header.
IAttributeDisplayFormMetadataObject	Attribute display form metadata object
IAttributeElement	Attribute element represented by concrete display form
IAttributeElementExpressionToken	Parsed MAQL token referencing an attribute element.
IAttributeHeaderFormOf	Describes attributes to which the display form belongs.
IAttributeMetadataObject	Attribute metadata object
IAuthenticatedPrincipal	Describes user, which is currently authenticated to the backend.
IAuthenticationContext	Describes context in which the authentication is done.
IAuthenticationProvider	Defines authentication provider to use when instance of IAnalyticalBackend discovers that the current session is not authentication.
IBackendCapabilities	Analytical Backend communicates its capabilities via objects of this type. In return, the capabilities can then be used by applications to enable / disable particular features.
IBracketExpressionToken	Parsed MAQL bracket.
ICatalogAttribute	Type representing catalog attribute
ICatalogDateAttribute	Type representing catalog dateDataset date attribute
ICatalogDateDataset	Type representing catalog date dataset
ICatalogFact	Type representing catalog fact
ICatalogGroup	Catalog group can be used to group catalog items
ICatalogItemBase	Properties contained in each catalog item
ICatalogMeasure	Type representing catalog measure
ICommentExpressionToken	Parsed MAQL comment text.
IDashboardMetadataObject	Dashboard metadata object
IDataColumn	Dataset column with name, type and boolean flag whether the column needs to be skipped while data loading or not.
IDataColumnBody	Data column object interface.
IDataHeader	Structural information about CSV header and columns.
IDataset	Dataset describes a particular structure of dataset (CSV file).
IDatasetBody	Dataset object interface.
IDatasetLoadInfo	Object wrapping basic information (owner, date created, status) about a CSV Load.
IDataSetMetadataObject	DataSet metadata object
IDatasetUser	Object wrapping info about the user that created CSV load. Contains their login and full name.
IDataView	A view on the calculated data.
IDimensionDescriptor	Dimension descriptor is the output counter-part of the dimension specification that was included in the execution definition.
IElementsQuery	Service to query valid attribute elements for particular display form.
IElementsQueryAttributeFilter	Attribute filter limiting the elements.
IElementsQueryFactory	The attribute itself contains no view data, it's just a sequence of id's.
IElementsQueryOptions	Configuration options for querying attribute elements
IElementsQueryOptionsElementsByPrimaryDisplayFormValue	Specification of particular elements to load in IElementsQueryOptions using the values of the primary display form related to the attribute the requested display form is from.
IElementsQueryOptionsElementsByUri	Specification of particular elements to load in IElementsQueryOptions using their URIs.
IElementsQueryOptionsElementsByValue	Specification of particular elements to load in IElementsQueryOptions using their values.
IExecutionFactory	Execution factory provides several methods to create a prepared execution from different types of inputs.
IExecutionResult	Represents results of execution done with particular definition.
IExportConfig	Configuration for exports of results into XLSX or CSV.
IExportResult	Result of export is a link to prepared file that can be downloaded.
IFactMetadataObject	Fact metadata object
IFilterElementsQuery	Service to query valid filter elements for particular filter.
IGetInsightOptions	Configuration options for getting a single insight.
IGetVisualizationClassesOptions	Additional options for the IWorkspaceInsightsService.getVisualizationClasses() function.
IGroupableCatalogItemBase	Properties contained in each groupable catalog item
IInsightReferences	Contains information about objects that may be referenced by an insight.
IInsightReferencing	Contains information about objects that may be referencing an insight.
IInsightsQueryOptions	Configuration options for querying insights
IMeasureDescriptor	Describes measure included in a dimension.
IMeasureDescriptorItem	Measure descriptor object.
IMeasureDescriptorObject	Descriptor of the measure and its contents.
IMeasureGroupDescriptor	Describes measure group and its contents.
IMeasureReferencing	Contains information about objects that may be referencing an measure. IWorkspaceMeasuresService.getMeasureReferencingObjects() function.
IMetadataObject
IObjectExpressionToken	Parsed MAQL token referencing a metadata object.
IOrganization	Represents an organization that services analytical workspaces.
IOrganizationDescriptor	Organization descriptor contains details about the organization that services analytical workspaces.Use IOrganizationDescriptor
IOrganizations	Provides functions to obtain IOrganization instances
IOrganizationSettingsService	This service provides access to organization settings
IOrganizationStylingService	This service provides access to organization styling settings such as theme.
IPagedResource	Interface to interact with paged asynchronous resources
IPreparedExecution	Prepared execution already knows what data to calculate and allows to specify how the data should be sorted and shaped into dimensions.
IResultAttributeHeader	Attribute header specifies name and URI of the attribute element to which the calculated measure values in the particular data view slice belong.
IResultAttributeHeaderItem	Attribute header item specifies name and URI of the attribute element to which the calculated measure values in the particular data view slice belong.
IResultMeasureHeader	Measure header specifes name of the measure to which the calculated values in the particular data view slice belong.
IResultMeasureHeaderItem	Measure header specifes name of the measure to which the calculated values in the particular data view slice belong.
IResultTotalHeader	Total header specifies name and type of total to which the calculated values in particular data view slice belong.
IResultTotalHeaderItem	Total header specifies name and type of total to which the calculated values in particular data view slice belong.
IResultWarning	Represents an execution result warning. (e.g. when execution was executed successfully, but backend didn't take something into the account)
ISecuritySettingsService	This service provides access to security settings defined on backend.
ISeparators	Settings for regional number formatting
ISettings	Settings are obtained from backend and are effectively a collection of feature flags or settings with concrete string or numeric value.
ITextExpressionToken	Parsed MAQL text.
ITheme	(BETA) Theme used to customize selected parts of the UI
IThemeAnalyticalDesigner	(BETA) Analytical designer specific properties.
IThemeAnalyticalDesignerTitle	(BETA) Analytical designer title specific properties.
IThemeButton	(BETA) Button customizable UI properties
IThemeChart	(BETA) Charts customization
IThemeColorFamily	(BETA) Variants of the palette color
IThemeComplementaryPalette	(BETA) Used to color various elements across many components by replacing the default complementary palette of gray color shades
IThemeDashboard	(BETA) KPI dashboards specific properties
IThemeDashboardContent	(BETA) Dashboard content customizable properties.
IThemeDashboardContentKpi	(BETA) Dashboard content KPI customizable properties.
IThemeDashboardContentWidget	(BETA) Dashboard content widget customizable properties.
IThemeDashboardEditPanel	(BETA) Edit panel specific properties.
IThemeDashboardFilterBar	(BETA) Dashboard filterBar customizable properties.
IThemeDashboardFilterBarButton	(BETA) Filter bar button specific properties
IThemeDashboardNavigation	(BETA) Navigation customizable properties.
IThemeDashboardNavigationItem	(BETA) Navigation items (dashboards) specific properties.
IThemeDashboardNavigationTitle	(BETA) Dashboard navigation title specific properties.
IThemeDashboardSection	(BETA) Dashboard section customizable properties.
IThemeDashboardSectionDescription	(BETA) Dashboard section description properties.
IThemeDashboardSectionTitle	(BETA) Dashboard section title properties.
IThemeDashboardTitle	(BETA) Dashboard title specific properties.
IThemeKpi	(BETA) Kpi values customization
IThemeKpiValue	(BETA) Kpi value specific properties.
IThemeModal	(BETA) Modal customizable properties.
IThemeModalTitle	(BETA) Properties of the title of the modal.
IThemePalette	(BETA) Customizable palette of major colorsInspired by Material UI palette: https://material-ui.com/customization/palette/
IThemeTable	(BETA) Table customization
IThemeTooltip	(BETA) Tooltip customizable UI properties
IThemeTypography	(BETA) Definition of both normal and bold font URIs
IThemeWidgetTitle	(BETA) Title of the widget
ITotalDescriptor	Describes total included in a dimension.
ITotalDescriptorItem	Describes total included in a dimension.
IUserAccessGrantee	User access grantee specification.
IUserGroupAccessGrantee	User group access grantee specification.
IUserService	Represents a user. It is an entry point to various services that can be used to inspect and modify the user.
IUserSettings	Settings for particular user.
IUserSettingsService	This query service provides access to feature flags that are in effect for particular user.
IUserWorkspaceSettings	Settings for particular combination of user and workspace.
IVariableMetadataObject	Variable metadata object
IWorkspaceAttributesService	Service for querying additional attributes and attribute display forms data, and their elements.
IWorkspaceCatalog	Instance of workspace catalog with loaded items
IWorkspaceCatalogAvailableItemsFactory	Service to obtain only valid items for a particular execution or insight.
IWorkspaceCatalogFactory	Catalog is useful for: - Interactive insight/execution creation - Exporting execution model for a specific workspace
IWorkspaceCatalogFactoryMethods	Common methods for catalog configuration
IWorkspaceCatalogFactoryOptions	Configuration options for querying catalog items
IWorkspaceCatalogMethods	Common methods to obtain catalog items
IWorkspaceCatalogWithAvailableItems	Instance of workspace catalog with loaded available items.
IWorkspaceCatalogWithAvailableItemsFactoryOptions	Configuration options for querying catalog available items
IWorkspaceDatasetsService	Service for querying workspace datasets
IWorkspaceDescriptor	Workspace descriptor contains details about the analytical workspace.
IWorkspaceFactsService	Service for querying additional facts data. If you want to query facts themselves, use catalog IWorkspaceCatalogFactory
IWorkspaceInsightsService	Service to query, update or delete insights, and other methods related to insights. Check IInsight for more details.
IWorkspaceMeasuresService	Service for create, update or delete measures and querying additional measures data. If you want to query measures themselves, use catalog IWorkspaceCatalogFactory
IWorkspacePermissionsService	Service to query workspace permissions
IWorkspaceSettings	Settings for particular workspace.
IWorkspaceSettingsService	This query service provides access to feature flags that are in effect for particular workspace.
IWorkspacesQuery	Query to retrieve available workspaces.
IWorkspacesQueryFactory	Factory providing creating queries used to get available workspaces.
IWorkspaceStylingService	This service provides access to workspace styling settings such as color palette.
IWorkspaceUser	Represents platform user in context of the workspace.
IWorkspaceUsersQuery	Service to query users for current workspace
IWorkspaceUsersQueryOptions	Configuration options for querying users

Variables

Variable	Description
AnalyticalBackendErrorTypes	Types of errors that can be raised by Analytical Backends.
attributeDescriptorLocalId	Returns local identifier of attribute described in the provided attribute descriptor.
attributeDescriptorName	Returns name of attribute described in the provided attribute descriptor.
catalogItemMetadataObject	Get metadata object that catalog item represents
isAttributeDescriptor	Type-guard testing whether the provided object is an instance of IAttributeDescriptor.
isAttributeDisplayFormMetadataObject	Tests whether the provided object is of type IAttributeDisplayFormMetadataObject.
isAttributeMetadataObject	Tests whether the provided object is of type IAttributeMetadataObject.
isCatalogAttribute	Type guard checking whether the provided object is a ICatalogAttribute
isCatalogDateDataset	Type guard checking whether object is an instance of ICatalogDateDataset.
isCatalogFact	Type guard checking whether the provided object is a ICatalogFact
isCatalogMeasure	Type guard checking whether the provided object is a ICatalogMeasure
isDashboardMetadataObject	Tests whether the provided object is of type IDashboardMetadataObject.
isDataSetMetadataObject	Tests whether the provided object is of type IDataSetMetadataObject.
isFactMetadataObject	Tests whether the provided object is of type IFactMetadataObject.
isMeasureDescriptor	Type-guard testing whether the provided object is an instance of IMeasureDescriptor.
isMeasureGroupDescriptor	Type-guard testing whether the provided object is an instance of IMeasureGroupDescriptor.
isMeasureMetadataObject	Tests whether the provided object is of type IMeasureMetadataObject.
isMeasureMetadataObjectDefinition	Tests whether the provided object is of type IMeasureMetadataObjectDefinition.
isMetadataObject	Type guard checking whether input is an instance of IMetadataObject.
isResultAttributeHeader	Type-guard testing whether the provided object is an instance of IResultAttributeHeader.
isResultMeasureHeader	Type-guard testing whether the provided object is an instance of IResultMeasureHeader.
isResultTotalHeader	Type-guard testing whether the provided object is an instance of IResultTotalHeader.
isTotalDescriptor	Type-guard testing whether the provided object is an instance of ITotalDescriptor.
isUserAccessGrantee	Tests whether the provided object is an instance of IUserAccessGrantee.
isUserGroupAccessGrantee	Tests whether the provided object is an instance of IUserGroupAccessGrantee.
isVariableMetadataObject	Tests whether the provided object is of type IVariableMetadataObject.
metadataObjectId	Get metadata object identifier
resultHeaderName	Returns item name contained within a result header.

Type Aliases

Type Alias	Description
AnalyticalBackendFactory	Factory function to create new instances of Analytical Backend realization using both platform agnostic and platform specific configuration.
AuthenticationFlow	Implementation of different backends MAY indicate through this structure where to redirect the browser in order to start authentication flow.
CatalogItem	Type representing catalog item - attribute, measure, fact or dateDataset
CatalogItemType	Type representing catalog item type - attribute, measure, fact or dateDataset
DataColumnType	Represents type of LDM field created from the Dataset column.
DatasetLoadStatus	Represents the current status of CSV source.
DataValue	Single calculated data value.
ElementsQueryOptionsElementsSpecification	Specification of particular elements to load in IElementsQueryOptions.
ErrorConverter	Error converter
FilterWithResolvableElements	Only for these filter types makes sense to resolve their elements
GroupableCatalogItem	Type representing groupable catalog item - attribute, measure or fact
IAccessGrantee	Access grantee specification.
IDateFilterConfigsQueryResult	Paged result of valid element query. Last page of data returns empty items.
IDimensionItemDescriptor	Headers describing contents of a dimension.
IElementsQueryResult	Paged result of valid element query. Last page of data returns empty items.
IInsightsQueryResult	Queried insights are returned in a paged representation.
IMeasureExpressionToken	Token representing part of parsed MAQL measure expression.
IMeasureMetadataObject	Measure metadata object
IMeasureMetadataObjectDefinition	Measure metadata object definition
InsightOrdering	Ordering options for insight query.
InsightReferenceTypes
IResultHeader	Result headers provide metadata about data included in the data view.
IWorkspacePermissions	Dictionary of workspace permissions
IWorkspacesQueryResult	Paged resource with results of a workspace query.
IWorkspaceUsersQueryResult	Paged result of users query. Last page of data returns empty items.
MetadataObject	Type that represents any metadata object
NotAuthenticatedHandler	Type of the function to be called when the Analytical Backend raises a NotAuthenticated error. See IAuthenticationProvider.onNotAuthenticated for more details.
NotAuthenticatedReason	More detailed reason of the NotAuthenticated error.
PlatformEdition	Indicates current platform edition.
SupportedInsightReferenceTypes	List of currently supported types of references that can be retrieved using the IWorkspaceInsightsService.getInsightReferencedObjects() function.
ThemeColor	(BETA) Color string in hex format, e.g. #14b2e2
ThemeFontUri	(BETA) Custom font URI which is used to override the default font
ValidationContext	The type of context in which is tested URL valid.
WorkspacePermission	Workspace permission types