Class Schema

Represents a SQL-schema implementation.

Hierarchy

Schema
- PostgresSchema

Index

Constructors

constructor

Properties

connection

Methods

Constructors

constructor

new Schema(connection: Connection): Schema

- Defined in src/orm/schema/Schema.ts:8
Parameters
- connection: Connection
Returns Schema

Properties

Protected Readonly connection

connection: Connection

Methods

commit

commit(schema: TableBuilder): Promise<void>

- Defined in src/orm/schema/Schema.ts:44
Apply the table to the schema.

Parameters
- schema: TableBuilder
Returns Promise<void>

Abstract hasColumn

hasColumn(table: string, name: string): Awaitable<boolean>

- Defined in src/orm/schema/Schema.ts:25
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>

Abstract hasColumns

hasColumns(table: string, name: string[]): Awaitable<boolean>

- Defined in src/orm/schema/Schema.ts:32
Resolve true if the schema table with the given name has all the specified columns.

Parameters
- table: string
- name: string[]
Returns Awaitable<boolean>

Abstract hasTable

hasTable(name: string): Awaitable<boolean>

- Defined in src/orm/schema/Schema.ts:18
Resolve true if the schema has a table with the given name.

Parameters
- name: string
Returns Awaitable<boolean>

Abstract table

table(table: string): Awaitable<TableBuilder>

- Defined in src/orm/schema/Schema.ts:38
Get a TableBuilder instance for a table on the schema.

Parameters
- table: string
Returns Awaitable<TableBuilder>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.