Class PostgresSchema

A PostgreSQL-compatible schema implementation.

Hierarchy

Schema
- PostgresSchema

Index

Constructors

Properties

connection schema

Methods

commit getCheckConstraints getColumns getConstraints getIndexes hasColumn hasColumns hasTable populateTable table

Constructors

constructor

new PostgresSchema(connection: PostgresConnection, schema?: string): PostgresSchema
Parameters
- connection: PostgresConnection
- schema: string = 'public'
Returns PostgresSchema
Overrides Schema.constructor
- Defined in src/orm/schema/PostgresSchema.ts:13

Properties

`Protected` `Readonly` connection

connection: Connection

The SQL connection to execute against.

`Readonly` schema

schema: string = 'public'

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

`Protected` getCheckConstraints

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

See
https://dataedo.com/kb/query/postgresql/list-table-check-constraints
Parameters
- table: string
Returns Promise<Collection<QueryRow>>
- Defined in src/orm/schema/PostgresSchema.ts:285

`Protected` getColumns

getColumns(table: string): Promise<Collection<QueryRow>>
Protected
Query the database to look up all columns on a table.
Parameters
- table: string
Returns Promise<Collection<QueryRow>>
- Defined in src/orm/schema/PostgresSchema.ts:332

`Protected` getConstraints

getConstraints(table: string): Promise<Collection<QueryRow>>
Protected
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>>
- Defined in src/orm/schema/PostgresSchema.ts:223

`Protected` getIndexes

getIndexes(table: string): Promise<Collection<QueryRow>>
Protected
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>>
- Defined in src/orm/schema/PostgresSchema.ts:185

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/PostgresSchema.ts:20

hasColumns

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

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/PostgresSchema.ts:43

`Protected` populateTable

populateTable(table: TableBuilder): Promise<TableBuilder>
Protected
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>
- Defined in src/orm/schema/PostgresSchema.ts:62

table

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