IWorkspaceFactsService
Service for querying additional facts data. If you want to query facts themselves, use catalog IWorkspaceCatalogFactory
export interface IWorkspaceFactsService
Methods
Method | Description |
|---|---|
Get information about the given fact | |
Get information about the given fact’s dataset | |
Facts query factory. | |
Updates metadata of the fact. |
Method details
IWorkspaceFactsService.getFact()method
Get information about the given fact
getFact(ref: ObjRef, opts?: {
include?: ["dataset"];
}): Promise<IFactMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the fact | |
opts | { include?: [“dataset”]; } | (Optional) options to include additional data |
Returns
Promise<IFactMetadataObject>
promise of metadata object
IWorkspaceFactsService.getFactDatasetMeta()method
Get information about the given fact’s dataset
getFactDatasetMeta(ref: ObjRef): Promise<IMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the fact |
Returns
Promise<IMetadataObject>
promise of metadata object
IWorkspaceFactsService.getFactsQuery()method
Facts query factory.
getFactsQuery(): IFactsQuery;
Returns
facts query
IWorkspaceFactsService.updateFactMeta()method
Updates metadata of the fact.
updateFactMeta(updatedFact: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IFactMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
updatedFact | Partial<IMetadataObjectBase> & IMetadataObjectIdentity | update to apply |
Returns
Promise<IFactMetadataObject>