IWorkspaceAnalyticsAsCodeService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Service that provisions a workspace from analytics-as-code documents.
export interface IWorkspaceAnalyticsAsCodeService
Methods
Method | Description |
|---|---|
(ALPHA) Replaces the logical data model and the analytical objects of the workspace with the documents. |
Method details
IWorkspaceAnalyticsAsCodeService.deploy()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Replaces the logical data model and the analytical objects of the workspace with the documents.
deploy(documents: AnalyticsAsCodeDocument[], options?: IAnalyticsAsCodeDeployOptions): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
documents | all documents of the workspace | |
options | (Optional) the deploy options |
Returns
Promise<void>
Remarks
The documents must be valid against the AaC schema. The ids must be unique in each kind of object. The objects that the documents do not contain are removed from the workspace.