Skip to main content

SchemaModelMetadata

@webda/sql-schema

Interface: SchemaModelMetadata

Defined in: packages/sql-schema/src/metadata.ts:73

The model metadata the builder reads: structurally compatible with ModelMetadata from @webda/compiler, both as compiled in webda.module.json and as resolved at runtime

Properties​

Ancestors?​

optional Ancestors?: ModelReference[]

Defined in: packages/sql-schema/src/metadata.ts:93

Ordered from the closest

Identifier​

Identifier: string

Defined in: packages/sql-schema/src/metadata.ts:77

Identifier

PrimaryKey​

PrimaryKey: string[]

Defined in: packages/sql-schema/src/metadata.ts:85

Primary key

PrimaryKeySeparator?​

optional PrimaryKeySeparator?: string

Defined in: packages/sql-schema/src/metadata.ts:89

Primary key separator

Reflection?​

optional Reflection?: object

Defined in: packages/sql-schema/src/metadata.ts:127

Reflection

Index Signature​

[field: string]: object

Relations?​

optional Relations?: object

Defined in: packages/sql-schema/src/metadata.ts:101

Relations

Index Signature​

[key: string]: unknown

indexes?​

optional indexes?: IndexDeclaration[]

Attributes tagged @Index / @Unique; those sharing a name form one composite index, in declaration order

optional links?: object[]

onDelete defaults to NONE

maps?​

optional maps?: object[]

Index Signature​

[key: string]: unknown

parent?​

optional parent?: object

onDelete defaults to CASCADE

parent.attribute​

attribute: string

parent.model?​

optional model?: string

parent.onDelete?​

optional onDelete?: DeletePolicy

queries?​

optional queries?: object[]

Schemas?​

optional Schemas?: object

Defined in: packages/sql-schema/src/metadata.ts:131

Schemas

Index Signature​

[key: string]: unknown

Stored?​

optional Stored?: JSONSchemaLike

ShortName?​

optional ShortName?: string

Defined in: packages/sql-schema/src/metadata.ts:81

Short name

Subclasses?​

optional Subclasses?: ModelReference[]

Defined in: packages/sql-schema/src/metadata.ts:97

Subclasses