IGenerateLogicalModelRequest
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Options of the logical data model generation from a data source.
export interface IGenerateLogicalModelRequest
Remarks
The prefixes and the separator tell the backend how to detect LDM objects from table and column names.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
boolean | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
(ALPHA) (Optional) Physical data model to generate the logical data model from. When not set, the backend scans the data source. | |||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) Workspace whose logical data model the backend uses to keep the existing identifiers. |
Property details
IGenerateLogicalModelRequest.aggregatedFactPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
aggregatedFactPrefix?: string;
IGenerateLogicalModelRequest.dateGranularitiespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
dateGranularities?: string;
IGenerateLogicalModelRequest.dateReferencePrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
dateReferencePrefix?: string;
IGenerateLogicalModelRequest.denormPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
denormPrefix?: string;
IGenerateLogicalModelRequest.factPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
factPrefix?: string;
IGenerateLogicalModelRequest.generateLongIdspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
generateLongIds?: boolean;
IGenerateLogicalModelRequest.grainMultivalueReferencePrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
grainMultivalueReferencePrefix?: string;
IGenerateLogicalModelRequest.grainPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
grainPrefix?: string;
IGenerateLogicalModelRequest.grainReferencePrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
grainReferencePrefix?: string;
IGenerateLogicalModelRequest.multivalueReferencePrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
multivalueReferencePrefix?: string;
IGenerateLogicalModelRequest.pdmpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Physical data model to generate the logical data model from. When not set, the backend scans the data source.
pdm?: IGenerateLogicalModelPdm;
IGenerateLogicalModelRequest.primaryLabelPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
primaryLabelPrefix?: string;
IGenerateLogicalModelRequest.referencePrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
referencePrefix?: string;
IGenerateLogicalModelRequest.secondaryLabelPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
secondaryLabelPrefix?: string;
IGenerateLogicalModelRequest.separatorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
separator?: string;
IGenerateLogicalModelRequest.tablePrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
tablePrefix?: string;
IGenerateLogicalModelRequest.translationPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
translationPrefix?: string;
IGenerateLogicalModelRequest.viewPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
viewPrefix?: string;
IGenerateLogicalModelRequest.wdfPrefixpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
wdfPrefix?: string;
IGenerateLogicalModelRequest.workspaceIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Workspace whose logical data model the backend uses to keep the existing identifiers.
workspaceId?: string;