Class SchemaUtils

Index

Constructors

Methods

getColumn getColumnNames getField getPrimaryKeys getRelation getToManyRelation isForeignKey isPrimaryKey throwIfAlreadyDefinedField throwIfMissingField

Constructors

constructor

new SchemaUtils(): SchemaUtils
Returns SchemaUtils

Methods

`Static`getColumn

getColumn(
    schema: CollectionSchema,
    fieldName: string,
    collectionName?: string,
): ColumnSchema
Parameters
- schema: CollectionSchema
- fieldName: string
- OptionalcollectionName: string
Returns ColumnSchema
- Defined in packages/datasource-toolkit/src/utils/schema.ts:57

`Static`getColumnNames

getColumnNames(schema: CollectionSchema): string[]
Parameters
- schema: CollectionSchema
Returns string[]
- Defined in packages/datasource-toolkit/src/utils/schema.ts:132

`Static`getField

getField(
    schema: CollectionSchema,
    fieldName: string,
    collectionName?: string,
): FieldSchema
Parameters
- schema: CollectionSchema
- fieldName: string
- OptionalcollectionName: string
Returns FieldSchema
- Defined in packages/datasource-toolkit/src/utils/schema.ts:47

`Static`getPrimaryKeys

getPrimaryKeys(schema: CollectionSchema): string[]
Parameters
- schema: CollectionSchema
Returns string[]
- Defined in packages/datasource-toolkit/src/utils/schema.ts:95

`Static`getRelation

getRelation(
    schema: CollectionSchema,
    relationName: string,
    collectionName?: string,
): RelationSchema
Parameters
- schema: CollectionSchema
- relationName: string
- OptionalcollectionName: string
Returns RelationSchema
- Defined in packages/datasource-toolkit/src/utils/schema.ts:73

`Static`getToManyRelation

getToManyRelation(
schema: CollectionSchema,
relationName: string,
): OneToManySchema | ManyToManySchema
Parameters
- schema: CollectionSchema
- relationName: string
Returns OneToManySchema | ManyToManySchema
- Defined in packages/datasource-toolkit/src/utils/schema.ts:116

`Static`isForeignKey

isForeignKey(schema: CollectionSchema, name: string): boolean
Parameters
- schema: CollectionSchema
- name: string
Returns boolean
- Defined in packages/datasource-toolkit/src/utils/schema.ts:105

`Static`isPrimaryKey

isPrimaryKey(schema: CollectionSchema, fieldName: string): boolean
Parameters
- schema: CollectionSchema
- fieldName: string
Returns boolean
- Defined in packages/datasource-toolkit/src/utils/schema.ts:99

`Static`throwIfAlreadyDefinedField

throwIfAlreadyDefinedField(
    schema: CollectionSchema,
    fieldName: string,
    collectionName?: string,
): void
Parameters
- schema: CollectionSchema
- fieldName: string
- OptionalcollectionName: string
Returns void
- Defined in packages/datasource-toolkit/src/utils/schema.ts:19

`Static`throwIfMissingField

throwIfMissingField(
    schema: CollectionSchema,
    fieldName: string,
    collectionName?: string,
): void
Parameters
- schema: CollectionSchema
- fieldName: string
- OptionalcollectionName: string
Returns void
- Defined in packages/datasource-toolkit/src/utils/schema.ts:31