Interface: TableBuilder#
Hierarchy#
TableBuilder
Methods#
bigIncrements#
â–¸ bigIncrements(columnName?: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName? | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1717
bigInteger#
â–¸ bigInteger(columnName: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1722
binary#
â–¸ binary(columnName: string, length?: number): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
length? | number |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1751
boolean#
â–¸ boolean(columnName: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1740
comment#
â–¸ comment(val: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
val | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1765
date#
â–¸ date(columnName: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1741
dateTime#
â–¸ dateTime(columnName: string, options?: Readonly<{ precision?: undefined | number ; useTz?: undefined | boolean }>): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
options? | Readonly<{ precision?: undefined | number ; useTz?: undefined | boolean }> |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1742
decimal#
â–¸ decimal(columnName: string, precision?: null | number, scale?: number): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
precision? | null | number |
scale? | number |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1735
double#
â–¸ double(columnName: string, precision?: number, scale?: number): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
precision? | number |
scale? | number |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1730
dropColumn#
â–¸ dropColumn(columnName: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1718
dropColumns#
â–¸ dropColumns(...columnNames: string[]): TableBuilder
Parameters:#
| Name | Type |
|---|---|
...columnNames | string[] |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1719
dropForeign#
â–¸ dropForeign(columnNames: readonly string[], foreignKeyName?: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
columnNames | readonly string[] |
foreignKeyName? | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1779
dropIndex#
â–¸ dropIndex(columnNames: string | readonly (string | Raw<any>)[], indexName?: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
columnNames | string | readonly (string | Raw<any>)[] |
indexName? | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1782
dropPrimary#
â–¸ dropPrimary(constraintName?: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
constraintName? | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1781
dropTimestamps#
â–¸ dropTimestamps(): ColumnBuilder
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1783
dropUnique#
â–¸ dropUnique(columnNames: readonly (string | Raw<any>)[], indexName?: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
columnNames | readonly (string | Raw<any>)[] |
indexName? | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1780
enu#
â–¸ enu(columnName: string, values: readonly Value[], options?: EnumOptions): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
values | readonly Value[] |
options? | EnumOptions |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1757
enum#
â–¸ enum(columnName: string, values: readonly Value[], options?: EnumOptions): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
values | readonly Value[] |
options? | EnumOptions |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1752
float#
â–¸ float(columnName: string, precision?: number, scale?: number): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
precision? | number |
scale? | number |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1725
foreign#
â–¸ foreign(column: string, foreignKeyName?: string): ForeignConstraintBuilder
Parameters:#
| Name | Type |
|---|---|
column | string |
foreignKeyName? | string |
Returns: ForeignConstraintBuilder
Defined in: node_modules/knex/types/index.d.ts:1774
â–¸ foreign(columns: readonly string[], foreignKeyName?: string): MultikeyForeignConstraintBuilder
Parameters:#
| Name | Type |
|---|---|
columns | readonly string[] |
foreignKeyName? | string |
Returns: MultikeyForeignConstraintBuilder
Defined in: node_modules/knex/types/index.d.ts:1775
increments#
â–¸ increments(columnName?: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName? | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1716
index#
â–¸ index(columnNames: string | readonly (string | Raw<any>)[], indexName?: string, indexType?: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
columnNames | string | readonly (string | Raw<any>)[] |
indexName? | string |
indexType? | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1768
integer#
â–¸ integer(columnName: string, length?: number): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
length? | number |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1721
json#
â–¸ json(columnName: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1762
jsonb#
â–¸ jsonb(columnName: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1763
primary#
â–¸ primary(columnNames: readonly string[], constraintName?: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
columnNames | readonly string[] |
constraintName? | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1767
queryContext#
â–¸ queryContext(context: any): TableBuilder
Parameters:#
| Name | Type |
|---|---|
context | any |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1784
renameColumn#
â–¸ renameColumn(from: string, to: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
from | string |
to | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1720
specificType#
â–¸ specificType(columnName: string, type: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
type | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1766
string#
â–¸ string(columnName: string, length?: number): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
length? | number |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1724
text#
â–¸ text(columnName: string, textType?: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
textType? | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1723
time#
â–¸ time(columnName: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1743
timestamp#
â–¸ timestamp(columnName: string, options?: Readonly<{ precision?: undefined | number ; useTz?: undefined | boolean }>): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
options? | Readonly<{ precision?: undefined | number ; useTz?: undefined | boolean }> |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1744
â–¸ timestamp(columnName: string, withoutTz?: boolean, precision?: number): ColumnBuilder
deprecated
Parameters:#
| Name | Type |
|---|---|
columnName | string |
withoutTz? | boolean |
precision? | number |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1746
timestamps#
â–¸ timestamps(useTimestampType?: boolean, makeDefaultNow?: boolean): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
useTimestampType? | boolean |
makeDefaultNow? | boolean |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1747
unique#
â–¸ unique(columnNames: readonly (string | Raw<any>)[], indexName?: string): TableBuilder
Parameters:#
| Name | Type |
|---|---|
columnNames | readonly (string | Raw<any>)[] |
indexName? | string |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:1773
uuid#
â–¸ uuid(columnName: string): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
columnName | string |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:1764