Class Schema`Abstract`

Represents a SQL-schema implementation.

Hierarchy

Schema
- PostgresSchema
- SQLiteSchema

Index

Constructors

Properties

Methods

commit hasColumn hasColumns hasTable table

Constructors

constructor

new Schema(connection: Connection): Schema
Parameters
- connection: Connection
  
  The SQL connection to execute against.
Returns Schema
- Defined in src/orm/schema/Schema.ts:9

Properties

`Protected` `Readonly` connection

connection: Connection

The SQL connection to execute against.

Methods

commit

commit(schema: TableBuilder): Promise<void>
Apply the table to the schema.
Parameters
- schema: TableBuilder
Returns Promise<void>
- Defined in src/orm/schema/Schema.ts:44

`Abstract` hasColumn

hasColumn(table: string, name: string): Awaitable<boolean>
Resolve true if the schema table with the given name has a column with the given name.
Parameters
- table: string
- name: string
Returns Awaitable<boolean>
- Defined in src/orm/schema/Schema.ts:25

`Abstract` hasColumns

hasColumns(table: string, name: string[]): Awaitable<boolean>
Resolve true if the schema table with the given name has all the specified columns.
Parameters
- table: string
- name: string[]
Returns Awaitable<boolean>
- Defined in src/orm/schema/Schema.ts:32

`Abstract` hasTable

hasTable(name: string): Awaitable<boolean>
Resolve true if the schema has a table with the given name.
Parameters
- name: string
Returns Awaitable<boolean>
- Defined in src/orm/schema/Schema.ts:18

`Abstract` table

table(table: string): Awaitable<TableBuilder>
Get a TableBuilder instance for a table on the schema.
Parameters
- table: string
Returns Awaitable<TableBuilder>
- Defined in src/orm/schema/Schema.ts:38