Class SQLiteSchema

Represents a SQL-schema implementation.

Hierarchy

Schema
- SQLiteSchema

Index

Constructors

Properties

Methods

commit hasColumn hasColumns hasTable populateTable table

Constructors

constructor

new SQLiteSchema(connection: SQLiteConnection): SQLiteSchema
Parameters
- connection: SQLiteConnection
Returns SQLiteSchema
Overrides Schema.constructor
- Defined in src/orm/schema/SQLiteSchema.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>
Inherited from Schema.commit
- Defined in src/orm/schema/Schema.ts:44

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>
Overrides Schema.hasColumn
- Defined in src/orm/schema/SQLiteSchema.ts:15

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>
Overrides Schema.hasColumns
- Defined in src/orm/schema/SQLiteSchema.ts:23

hasTable

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

`Protected` populateTable

populateTable(table: TableBuilder): Promise<TableBuilder>
Parameters
- table: TableBuilder
Returns Promise<TableBuilder>
- Defined in src/orm/schema/SQLiteSchema.ts:46

table

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