Interface: SchemaBuilder#
Hierarchy#
ChainableInterface<void>
↳ SchemaBuilder
Properties#
[Symbol.toStringTag]#
• Readonly [Symbol.toStringTag]: string
Inherited from: ChainableInterface.[Symbol.toStringTag]
Defined in: node_modules/knex/types/index.d.ts:1639
Methods#
alterTable#
â–¸ alterTable(tableName: string, callback: (tableBuilder: CreateTableBuilder) => any): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
tableName | string |
callback | (tableBuilder: CreateTableBuilder) => any |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1693
asCallback#
â–¸ asCallback(callback: Function): Promise<void>
Parameters:#
| Name | Type |
|---|---|
callback | Function |
Returns: Promise<void>
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1657
catch#
â–¸ catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<void | TResult>
Attaches a callback for only the rejection of the Promise.
Type parameters:#
| Name | Default |
|---|---|
TResult | never |
Parameters:#
| Name | Type | Description |
|---|---|---|
onrejected? | null | (reason: any) => TResult | PromiseLike<TResult> | The callback to execute when the Promise is rejected. |
Returns: Promise<void | TResult>
A Promise for the completion of the callback.
Inherited from: ChainableInterface
Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1448
connection#
â–¸ connection(connection: any): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
connection | any |
Returns: SchemaBuilder
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1644
createSchema#
â–¸ createSchema(schemaName: string): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
schemaName | string |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1691
createSchemaIfNotExists#
â–¸ createSchemaIfNotExists(schemaName: string): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
schemaName | string |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1692
createTable#
â–¸ createTable(tableName: string, callback: (tableBuilder: CreateTableBuilder) => any): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
tableName | string |
callback | (tableBuilder: CreateTableBuilder) => any |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1683
createTableIfNotExists#
â–¸ createTableIfNotExists(tableName: string, callback: (tableBuilder: CreateTableBuilder) => any): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
tableName | string |
callback | (tableBuilder: CreateTableBuilder) => any |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1687
debug#
â–¸ debug(enabled: boolean): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
enabled | boolean |
Returns: SchemaBuilder
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1645
dropSchema#
â–¸ dropSchema(schemaName: string): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
schemaName | string |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1706
dropSchemaIfExists#
â–¸ dropSchemaIfExists(schemaName: string): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
schemaName | string |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1707
dropTable#
â–¸ dropTable(tableName: string): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
tableName | string |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1698
dropTableIfExists#
â–¸ dropTableIfExists(tableName: string): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
tableName | string |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1705
finally#
â–¸ finally(onfinally?: null | () => void): Promise<void>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters:#
| Name | Type | Description |
|---|---|---|
onfinally? | null | () => void | The callback to execute when the Promise is settled (fulfilled or rejected). |
Returns: Promise<void>
A Promise for the completion of the callback.
Inherited from: ChainableInterface
Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31
hasColumn#
â–¸ hasColumn(tableName: string, columnName: string): Promise<boolean>
Parameters:#
| Name | Type |
|---|---|
tableName | string |
columnName | string |
Returns: Promise<boolean>
Defined in: node_modules/knex/types/index.d.ts:1700
hasTable#
â–¸ hasTable(tableName: string): Promise<boolean>
Parameters:#
| Name | Type |
|---|---|
tableName | string |
Returns: Promise<boolean>
Defined in: node_modules/knex/types/index.d.ts:1699
options#
â–¸ options(options: Readonly<{ [key: string]: any; }>): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
options | Readonly<{ [key: string]: any; }> |
Returns: SchemaBuilder
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1643
pipe#
â–¸ pipe<T>(writable: T, options?: Readonly<{ [key: string]: any; }>): PassThrough
Type parameters:#
| Name | Type |
|---|---|
T | WritableStream<T> |
Parameters:#
| Name | Type |
|---|---|
writable | T |
options? | Readonly<{ [key: string]: any; }> |
Returns: PassThrough
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1653
queryContext#
â–¸ queryContext(context: any): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
context | any |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1710
raw#
â–¸ raw(statement: string): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
statement | string |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1708
renameTable#
â–¸ renameTable(oldTableName: string, newTableName: string): Promise<void>
Parameters:#
| Name | Type |
|---|---|
oldTableName | string |
newTableName | string |
Returns: Promise<void>
Defined in: node_modules/knex/types/index.d.ts:1697
stream#
â–¸ stream(handler: (readable: PassThrough) => any): Promise<any>
Parameters:#
| Name | Type |
|---|---|
handler | (readable: PassThrough) => any |
Returns: Promise<any>
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1647
â–¸ stream(options: Readonly<{ [key: string]: any; }>, handler: (readable: PassThrough) => any): Promise<any>
Parameters:#
| Name | Type |
|---|---|
options | Readonly<{ [key: string]: any; }> |
handler | (readable: PassThrough) => any |
Returns: Promise<any>
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1648
â–¸ stream(options?: Readonly<{ [key: string]: any; }>): PassThrough
Parameters:#
| Name | Type |
|---|---|
options? | Readonly<{ [key: string]: any; }> |
Returns: PassThrough
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1652
table#
â–¸ table(tableName: string, callback: (tableBuilder: AlterTableBuilder) => any): Promise<void>
Parameters:#
| Name | Type |
|---|---|
tableName | string |
callback | (tableBuilder: AlterTableBuilder) => any |
Returns: Promise<void>
Defined in: node_modules/knex/types/index.d.ts:1701
then#
â–¸ then<TResult1, TResult2>(onfulfilled?: null | (value: void) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type parameters:#
| Name | Default |
|---|---|
TResult1 | void |
TResult2 | never |
Parameters:#
| Name | Type | Description |
|---|---|---|
onfulfilled? | null | (value: void) => TResult1 | PromiseLike<TResult1> | The callback to execute when the Promise is resolved. |
onrejected? | null | (reason: any) => TResult2 | PromiseLike<TResult2> | The callback to execute when the Promise is rejected. |
Returns: Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Inherited from: ChainableInterface
Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1441
toQuery#
â–¸ toQuery(): string
Returns: string
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1642
toSQL#
â–¸ toSQL(): Sql
Returns: Sql
Defined in: node_modules/knex/types/index.d.ts:1712
toString#
â–¸ toString(): string
Returns: string
Defined in: node_modules/knex/types/index.d.ts:1711
transacting#
â–¸ transacting(trx: Transaction<any, any>): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
trx | Transaction<any, any> |
Returns: SchemaBuilder
Inherited from: ChainableInterface
Defined in: node_modules/knex/types/index.d.ts:1646
withSchema#
â–¸ withSchema(schemaName: string): SchemaBuilder
Parameters:#
| Name | Type |
|---|---|
schemaName | string |
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:1709