Interface ModelSchemaOperations

Schema operations available on every model.

Each mirrors the QueryInterface method of the same name with the table argument removed.

interface ModelSchemaOperations {
    addColumn(
        columnName: string,
        definition: TableColumnDefinition,
        options?: QueryInterfaceOptions,
    ): Promise<void>;
    removeColumn(
        columnName: string,
        options?: QueryInterfaceOptions,
    ): Promise<void>;
    changeColumn(
        columnName: string,
        definition: TableColumnDefinition,
        options?: QueryInterfaceOptions,
    ): Promise<void>;
    renameColumn(
        oldColumnName: string,
        newColumnName: string,
        options?: QueryInterfaceOptions,
    ): Promise<void>;
    addIndex(
        fieldsOrName: string | string[] | IndexFieldDefinition[],
        fieldsOrOptions?:
            | string[]
            | IndexFieldDefinition[]
            | IndexOptions & QueryInterfaceOptions,
        options?: IndexOptions & QueryInterfaceOptions,
    ): Promise<void>;
    removeIndex(
        indexName: string,
        options?: QueryInterfaceOptions,
    ): Promise<void>;
    showIndexes(): Promise<
        { name: string; fields: string[]; unique: boolean }[],
    >;
    indexExists(indexName: string): Promise<boolean>;
    createFullTextIndex(
        options: Omit<FullTextIndexOptions, "table"> & { table?: string },
    ): Promise<void>;
    addConstraint(
        constraintNameOrOptions:
            | string
            | ConstraintDefinition & { name?: string },
        constraintOrOptions?: ConstraintDefinition,
        options?: QueryInterfaceOptions,
    ): Promise<void>;
    removeConstraint(
        constraintName: string,
        typeOrOptions?: string | QueryInterfaceOptions,
    ): Promise<void>;
    getConstraints(): Promise<any[]>;
    getForeignKeys(): Promise<any[]>;
    tableExists(): Promise<boolean>;
    renameTable(
        newName: string,
        options?: QueryInterfaceOptions,
    ): Promise<void>;
    enableRowLevelSecurity(): Promise<void>;
    disableRowLevelSecurity(): Promise<void>;
    createPolicy(
        options: Omit<CreatePolicyOptions, "table"> & { table?: string },
    ): Promise<void>;
    dropPolicy(name: string, options?: { ifExists?: boolean }): Promise<void>;
    createTrigger(
        trigger: Omit<TriggerDefinition<Record<string, unknown>>, "table"> & {
            table?: string;
        },
    ): Promise<void>;
    dropTrigger(name: string, options?: { ifExists?: boolean }): Promise<void>;
    createPartition(
        options: Omit<CreatePartitionOptions, "parentTable"> & {
            parentTable?: string;
        },
    ): Promise<void>;
    attachPartition(
        options: Omit<AttachPartitionOptions, "parentTable"> & {
            parentTable?: string;
        },
    ): Promise<void>;
    detachPartition(options: DetachPartitionOptions): Promise<void>;
    dropPartition(
        partitionName: string,
        options?: { ifExists?: boolean; cascade?: boolean } & QueryInterfaceOptions,
    ): Promise<void>;
    describeTable(): Promise<TableDescription>;
}

Hierarchy (View Summary)

ModelSchemaOperations
- ModelStatic

Methods

addColumn

addColumn(
    columnName: string,
    definition: TableColumnDefinition,
    options?: QueryInterfaceOptions,
): Promise<void>
Add a column to this model's table.
Parameters
- columnName: string
- definition: TableColumnDefinition
- Optionaloptions: QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:65

removeColumn

removeColumn(columnName: string, options?: QueryInterfaceOptions): Promise<void>
Remove a column from this model's table.
Parameters
- columnName: string
- Optionaloptions: QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:71

changeColumn

changeColumn(
    columnName: string,
    definition: TableColumnDefinition,
    options?: QueryInterfaceOptions,
): Promise<void>
Change a column's definition.
Parameters
- columnName: string
- definition: TableColumnDefinition
- Optionaloptions: QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:73

renameColumn

renameColumn(
    oldColumnName: string,
    newColumnName: string,
    options?: QueryInterfaceOptions,
): Promise<void>
Rename a column.
Parameters
- oldColumnName: string
- newColumnName: string
- Optionaloptions: QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:79

addIndex

addIndex(
    fieldsOrName: string | string[] | IndexFieldDefinition[],
    fieldsOrOptions?:
        | string[]
        | IndexFieldDefinition[]
        | IndexOptions & QueryInterfaceOptions,
    options?: IndexOptions & QueryInterfaceOptions,
): Promise<void>
Add an index to this model's table.
Parameters
- fieldsOrName: string | string[] | IndexFieldDefinition[]
- OptionalfieldsOrOptions: string[] | IndexFieldDefinition[] | IndexOptions & QueryInterfaceOptions
- Optionaloptions: IndexOptions & QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:87

removeIndex

removeIndex(indexName: string, options?: QueryInterfaceOptions): Promise<void>
Remove an index by name.
Parameters
- indexName: string
- Optionaloptions: QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:93

showIndexes

showIndexes(): Promise<{ name: string; fields: string[]; unique: boolean }[]>
List this model's indexes.

Returns Promise<{ name: string; fields: string[]; unique: boolean }[]>
- Defined in model-schema-ops.ts:95

indexExists

indexExists(indexName: string): Promise<boolean>
Whether an index exists on this model's table.
Parameters
- indexName: string
Returns Promise<boolean>
- Defined in model-schema-ops.ts:97

createFullTextIndex

createFullTextIndex(
options: Omit<FullTextIndexOptions, "table"> & { table?: string },
): Promise<void>
Create a full-text index; table defaults to this model.
Parameters
- options: Omit<FullTextIndexOptions, "table"> & { table?: string }
Returns Promise<void>
- Defined in model-schema-ops.ts:99

addConstraint

addConstraint(
    constraintNameOrOptions:
        | string
        | ConstraintDefinition & { name?: string },
    constraintOrOptions?: ConstraintDefinition,
    options?: QueryInterfaceOptions,
): Promise<void>
Add a constraint to this model's table.
Parameters
- constraintNameOrOptions: string | ConstraintDefinition & { name?: string }
- OptionalconstraintOrOptions: ConstraintDefinition
- Optionaloptions: QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:105

removeConstraint

removeConstraint(
constraintName: string,
typeOrOptions?: string | QueryInterfaceOptions,
): Promise<void>
Remove a constraint by name.
Parameters
- constraintName: string
- OptionaltypeOrOptions: string | QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:111

getConstraints

getConstraints(): Promise<any[]>
List this model's constraints.

Returns Promise<any[]>
- Defined in model-schema-ops.ts:116

getForeignKeys

getForeignKeys(): Promise<any[]>
List the foreign keys on this model's table.

Returns Promise<any[]>
- Defined in model-schema-ops.ts:118

tableExists

tableExists(): Promise<boolean>
Whether this model's table exists in the database.

Returns Promise<boolean>
- Defined in model-schema-ops.ts:122

renameTable

renameTable(newName: string, options?: QueryInterfaceOptions): Promise<void>
Rename this model's table. Does not update the model's own tableName.
Parameters
- newName: string
- Optionaloptions: QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:124

enableRowLevelSecurity

enableRowLevelSecurity(): Promise<void>
Turn row-level security on for this model's table.

Returns Promise<void>
- Defined in model-schema-ops.ts:128

disableRowLevelSecurity

disableRowLevelSecurity(): Promise<void>
Turn row-level security off.

Returns Promise<void>
- Defined in model-schema-ops.ts:130

createPolicy

createPolicy(
options: Omit<CreatePolicyOptions, "table"> & { table?: string },
): Promise<void>
Create a policy on this model's table; table defaults to this model.
Parameters
- options: Omit<CreatePolicyOptions, "table"> & { table?: string }
Returns Promise<void>
- Defined in model-schema-ops.ts:132

dropPolicy

dropPolicy(name: string, options?: { ifExists?: boolean }): Promise<void>
Drop a policy from this model's table.
Parameters
- name: string
- Optionaloptions: { ifExists?: boolean }
Returns Promise<void>
- Defined in model-schema-ops.ts:134

createTrigger

createTrigger(
    trigger: Omit<TriggerDefinition<Record<string, unknown>>, "table"> & {
        table?: string;
    },
): Promise<void>
Create a trigger on this model's table; table defaults to this model.
Parameters
- trigger: Omit<TriggerDefinition<Record<string, unknown>>, "table"> & { table?: string }
Returns Promise<void>
- Defined in model-schema-ops.ts:138

dropTrigger

dropTrigger(name: string, options?: { ifExists?: boolean }): Promise<void>
Drop a trigger from this model's table.
Parameters
- name: string
- Optionaloptions: { ifExists?: boolean }
Returns Promise<void>
- Defined in model-schema-ops.ts:140

createPartition

createPartition(
    options: Omit<CreatePartitionOptions, "parentTable"> & {
        parentTable?: string;
    },
): Promise<void>
Create a partition of this model's table; parentTable defaults to it.
Parameters
- options: Omit<CreatePartitionOptions, "parentTable"> & { parentTable?: string }
Returns Promise<void>
- Defined in model-schema-ops.ts:144

attachPartition

attachPartition(
    options: Omit<AttachPartitionOptions, "parentTable"> & {
        parentTable?: string;
    },
): Promise<void>
Attach an existing table as a partition of this model's table.
Parameters
- options: Omit<AttachPartitionOptions, "parentTable"> & { parentTable?: string }
Returns Promise<void>
- Defined in model-schema-ops.ts:148

detachPartition

detachPartition(options: DetachPartitionOptions): Promise<void>
Detach a partition from this model's table.
Parameters
- options: DetachPartitionOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:152

dropPartition

dropPartition(
partitionName: string,
options?: { ifExists?: boolean; cascade?: boolean } & QueryInterfaceOptions,
): Promise<void>
Drop a partition of this model's table.
Parameters
- partitionName: string
- Optionaloptions: { ifExists?: boolean; cascade?: boolean } & QueryInterfaceOptions
Returns Promise<void>
- Defined in model-schema-ops.ts:154

describeTable

describeTable(): Promise<TableDescription>
Describe this model's table as the database reports it.

Returns Promise<TableDescription>
- Defined in model-schema-ops.ts:161

Interface ModelSchemaOperations

Hierarchy (View Summary)

Index

Methods

Methods

addColumn

Parameters

Returns Promise<void>

removeColumn

Parameters

Returns Promise<void>

changeColumn

Parameters

Returns Promise<void>

renameColumn

Parameters

Returns Promise<void>

addIndex

Parameters

Returns Promise<void>

removeIndex

Parameters

Returns Promise<void>

showIndexes

Returns Promise<{ name: string; fields: string[]; unique: boolean }[]>

indexExists

Parameters

Returns Promise<boolean>

createFullTextIndex

Parameters

Returns Promise<void>

addConstraint

Parameters

Returns Promise<void>

removeConstraint

Parameters

Returns Promise<void>

getConstraints

Returns Promise<any[]>

getForeignKeys

Returns Promise<any[]>

tableExists

Returns Promise<boolean>

renameTable

Parameters

Returns Promise<void>

enableRowLevelSecurity

Returns Promise<void>

disableRowLevelSecurity

Returns Promise<void>

createPolicy

Parameters

Returns Promise<void>

dropPolicy

Parameters

Returns Promise<void>

createTrigger

Parameters

Returns Promise<void>

dropTrigger

Parameters

Returns Promise<void>

createPartition

Parameters

Returns Promise<void>

attachPartition

Parameters

Returns Promise<void>

detachPartition

Parameters

Returns Promise<void>

dropPartition

Parameters

Returns Promise<void>

describeTable

Returns Promise<TableDescription>

Settings

On This Page