Class PostgresSchema

A PostgreSQL-compatible schema implementation.

Hierarchy

Schema
- PostgresSchema

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PostgresSchema(connection: PostgresConnection, schema?: string): PostgresSchema

Overrides Schema.constructor
- Defined in src/orm/schema/PostgresSchema.ts:12
Parameters
- connection: PostgresConnection
- schema: string = 'public'
Returns PostgresSchema

Properties

Protected Readonly connection

connection: Connection

Readonly schema

schema: string = 'public'

Methods

commit

commit(schema: TableBuilder): Promise<void>

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

Parameters
- schema: TableBuilder
Returns Promise<void>

Protected getCheckConstraints

getCheckConstraints(table: string): Promise<Collection<QueryRow>>

- Defined in src/orm/schema/PostgresSchema.ts:285
see

https://dataedo.com/kb/query/postgresql/list-table-check-constraints

Parameters
- table: string
Returns Promise<Collection<QueryRow>>

Protected getColumns

getColumns(table: string): Promise<Collection<QueryRow>>

- Defined in src/orm/schema/PostgresSchema.ts:332
Query the database to look up all columns on a table.

Parameters
- table: string
Returns Promise<Collection<QueryRow>>

Protected getConstraints

getConstraints(table: string): Promise<Collection<QueryRow>>

- Defined in src/orm/schema/PostgresSchema.ts:223
Query the database to look up all constraints on a table, by column.

see

https://dba.stackexchange.com/a/290854

Parameters
- table: string
Returns Promise<Collection<QueryRow>>

Protected getIndexes

getIndexes(table: string): Promise<Collection<QueryRow>>

- Defined in src/orm/schema/PostgresSchema.ts:185
Query the database to look up all indexes on a table, by column.

see

https://stackoverflow.com/a/2213199/4971138

Parameters
- table: string
Returns Promise<Collection<QueryRow>>

hasColumn

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

Overrides Schema.hasColumn
- Defined in src/orm/schema/PostgresSchema.ts:20
Parameters
- table: string
- name: string
Returns Awaitable<boolean>

hasColumns

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

Overrides Schema.hasColumns
- Defined in src/orm/schema/PostgresSchema.ts:30
Parameters
- table: string
- name: string[]
Returns Promise<boolean>

hasTable

hasTable(name: string): Awaitable<boolean>

Overrides Schema.hasTable
- Defined in src/orm/schema/PostgresSchema.ts:43
Parameters
- name: string
Returns Awaitable<boolean>

Protected populateTable

populateTable(table: TableBuilder): Promise<TableBuilder>

- Defined in src/orm/schema/PostgresSchema.ts:62
If the table for the given TableBuilder already exists in the database, fill in the columns, constraints, and indexes.

Parameters
- table: TableBuilder
Returns Promise<TableBuilder>

table

table(table: string): Promise<TableBuilder>

Overrides Schema.table
- Defined in src/orm/schema/PostgresSchema.ts:52
Parameters
- table: string
Returns Promise<TableBuilder>

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

Extollo is a free & libre application framework in TypeScript.