Class: DatabaseSchema

knex.DatabaseSchema

Hierarchy

• DatabaseSchema

Constructors

constructor

+ new DatabaseSchema(): DatabaseSchema

Returns: DatabaseSchema

Properties

tables

• Private Readonly tables: DatabaseTable[]

Defined in: packages/knex/src/schema/DatabaseSchema.ts:9

Methods

addTable

▸ addTable(name: string, schema: undefined | null | string): DatabaseTable

Parameters:

Name	Type
name	string
schema	undefined | null | string

Returns: DatabaseTable

Defined in: packages/knex/src/schema/DatabaseSchema.ts:11

---

getTable

▸ getTable(name: string): undefined | DatabaseTable

Parameters:

Name	Type
name	string

Returns: undefined | DatabaseTable

Defined in: packages/knex/src/schema/DatabaseSchema.ts:22

---

getTables

▸ getTables(): DatabaseTable[]

Returns: DatabaseTable[]

Defined in: packages/knex/src/schema/DatabaseSchema.ts:18

---

create

▸ Staticcreate(connection: AbstractSqlConnection, helper: SchemaHelper, config: Configuration<IDatabaseDriver<Connection>>): Promise<DatabaseSchema>

Parameters:

Name	Type
connection	AbstractSqlConnection
helper	SchemaHelper
config	Configuration<IDatabaseDriver<Connection>>

Returns: Promise<DatabaseSchema>

Defined in: packages/knex/src/schema/DatabaseSchema.ts:26