Class: MigrationBuilder

Defined in: src/migrations/MigrationBuilder.ts:105

Constructors

Constructor

new MigrationBuilder(): MigrationBuilder

Returns

MigrationBuilder

Methods

createTable()

createTable(tableName, fn): this

Defined in: src/migrations/MigrationBuilder.ts:108

Parameters

Parameter	Type
tableName	string
fn	(table) => void

Returns

this

---

dropTable()

dropTable(tableName): this

Defined in: src/migrations/MigrationBuilder.ts:150

Parameters

Parameter	Type
tableName	string

Returns

this

---

dropTableIfExists()

dropTableIfExists(tableName): this

Defined in: src/migrations/MigrationBuilder.ts:155

Parameters

Parameter	Type
tableName	string

Returns

this

---

addColumn()

addColumn(tableName, columnName, type, fn?): this

Defined in: src/migrations/MigrationBuilder.ts:160

Parameters

Parameter	Type
tableName	string
columnName	string
type	string
fn?	(col) => void

Returns

this

---

dropColumn()

dropColumn(tableName, columnName): this

Defined in: src/migrations/MigrationBuilder.ts:180

Parameters

Parameter	Type
tableName	string
columnName	string

Returns

this

---

createIndex()

createIndex(tableName, columns, options?): this

Defined in: src/migrations/MigrationBuilder.ts:190

Parameters

Parameter	Type
tableName	string
columns	string[]
options?	{ unique?: boolean; name?: string; }
options.unique?	boolean
options.name?	string

Returns

this

---

dropIndex()

dropIndex(tableName, indexName): this

Defined in: src/migrations/MigrationBuilder.ts:206

Parameters

Parameter	Type
tableName	string
indexName	string

Returns

this

---

executeSql()

executeSql(sql): this

Defined in: src/migrations/MigrationBuilder.ts:211

Parameters

Parameter	Type
sql	string

Returns

this

---

renameColumn()

renameColumn(tableName, oldName, newName, columnType?): this

Defined in: src/migrations/MigrationBuilder.ts:216

Parameters

Parameter	Type
tableName	string
oldName	string
newName	string
columnType?	string

Returns

this

---

alterColumn()

alterColumn(tableName, columnName, type, fn?): this

Defined in: src/migrations/MigrationBuilder.ts:234

Parameters

Parameter	Type
tableName	string
columnName	string
type	string
fn?	(col) => void

Returns

this

---

addForeignKey()

addForeignKey(tableName, columnName, referencedTable, referencedColumn, options?): this

Defined in: src/migrations/MigrationBuilder.ts:256

Parameters

Parameter	Type
tableName	string
columnName	string
referencedTable	string
referencedColumn	string
options?	{ constraintName?: string; onDelete?: "CASCADE" | "SET NULL" | "RESTRICT" | "NO ACTION"; }
options.constraintName?	string
options.onDelete?	"CASCADE" | "SET NULL" | "RESTRICT" | "NO ACTION"

Returns

this

---

getSqlStatements()

getSqlStatements(adapter): string[]

Defined in: src/migrations/MigrationBuilder.ts:283

Parameters

Parameter	Type
adapter	IDbAdapter

Returns

string[]