Class Postgres

Hierarchy (View Summary)

Database
- Postgres

Constructors

constructor

new Postgres(config?: Postgres.Config): Postgres
Creates a new instance of the class
Parameters
- config: Postgres.Config = {}
Returns Postgres
Overrides Database.constructor

Properties

`Readonly`config

config: Postgres.Config = {}

`Readonly`pool

pool: Pool

tableOptions

tableOptions: string = ''

`Readonly`type

type: Type

Accessors

idleConnections

get idleConnections(): number
Gets the total number of idle connections in the pool

Returns number
Overrides Database.idleConnections

totalConnections

get totalConnections(): number
Gets the total number of connections in the pool

Returns number
Overrides Database.totalConnections

typeName

get typeName(): string
Returns string
Inherited from Database.typeName

`Static`type

get type(): Type
Returns Type

Methods

`Protected`_executeMulti

_executeMulti(
queries: Database.Query[],
useTransaction: boolean,
): Promise<Database.Query.Result<any>>
Protected
Executes multiple statements and returns their results in a single Database.Query.Result
Parameters
- queries: Database.Query[]
- useTransaction: boolean
Returns Promise<Database.Query.Result<any>>
Inherited from Database._executeMulti

`Protected`_prepareColumns

_prepareColumns(fields: Column[]): [string[], any[]]
Protected
Prepares the columns for a CREATE statement
Parameters
- fields: Column[]
Returns [string[], any[]]
Inherited from Database._prepareColumns

`Protected`_prepareConstraints

_prepareConstraints(table: string, fields: Column[]): string[]
Protected
Prepares any foreign key constraints based upon the field supplied
Parameters
- table: string
- fields: Column[]
Returns string[]
Inherited from Database._prepareConstraints

`Protected`_prepareCreateIndex

_prepareCreateIndex(
    databaseType: Type,
    table: string,
    fields: string[],
    type?: IndexType,
): Database.Query
Protected
Prepares the creation of an index on a table
Parameters
- databaseType: Type
- table: string
- fields: string[]
- type: IndexType = Database.Table.IndexType.NONE
Returns Database.Query
Inherited from Database._prepareCreateIndex

`Protected`_prepareCreateIndexes

_prepareCreateIndexes(
    databaseType: Type,
    table: string,
    fields: Column[],
    type?: IndexType,
): Database.Query[]
Protected
Prepares statements to create indexes during a CREATE table statement
Parameters
- databaseType: Type
- table: string
- fields: Column[]
- type: IndexType = Database.Table.IndexType.NONE
Returns Database.Query[]
Inherited from Database._prepareCreateIndexes

`Protected`_prepareCreateTable

_prepareCreateTable(
    databaseType: Type,
    table: string,
    columns: Column[],
    primaryKey?: string[],
    tableOptions?: string,
): Database.Query[]
Prepares the creation of a table including the relevant indexes and constraints
Parameters
- databaseType: Type
- table: string
- columns: Column[]
- primaryKey: string[] = []
- tableOptions: string = ''
Returns Database.Query[]
Inherited from Database._prepareCreateTable

`Protected`_prepareMultiInsert

_prepareMultiInsert(
    databaseType: Type,
    table: string,
    columns?: string[],
    values: any[][],
): Database.Query[]
Prepares a query to perform a multi-insert statement which is far faster than a bunch of individual insert statements
Parameters
- databaseType: Type
- table: string
- columns: string[] = []
- values: any[][]
Returns Database.Query[]
Inherited from Database._prepareMultiInsert

`Protected`_prepareMultiUpdate

_prepareMultiUpdate(
    databaseType: Type,
    table: string,
    primaryKey: string[],
    columns: string[],
    values: any[][],
): Database.Query[]
Prepares a query to perform a multi-update statement which is based upon a multi-insert statement that performs an UPSERT and this is a lot faster than a bunch of individual update statements
Parameters
- databaseType: Type
- table: string
- primaryKey: string[]
- columns: string[]
- values: any[][]
Returns Database.Query[]
Inherited from Database._prepareMultiUpdate

`Protected`beginTransaction

beginTransaction(connection: PoolClient): Promise<void>
Protected
Starts a transaction on the specified connection
Parameters
- connection: PoolClient
Returns Promise<void>
Overrides Database.beginTransaction

close

close(): Promise<void>
Closes all pooled connections

Returns Promise<void>
Overrides Database.close

`Protected`commitTransaction

commitTransaction(connection: PoolClient): Promise<void>
Protected
Commits a transaction on the specified connection
Parameters
- connection: PoolClient
Returns Promise<void>
Overrides Database.commitTransaction

`Protected`connection

connection(): Promise<PoolClient>
Protected
Returns a database connection from the pool

Returns Promise<PoolClient>
Overrides Database.connection

createIndex

createIndex(
    table: string,
    fields: string[],
    type?: IndexType,
    useTransaction?: boolean,
): Promise<void>
Prepares and executes the creation of an index on the table specified
Parameters
- table: string
- fields: string[]
- type: IndexType = Database.Table.IndexType.NONE
- useTransaction: boolean = true
Returns Promise<void>
Inherited from Database.createIndex

createTable

createTable(
    name: string,
    fields: Column[],
    primaryKey?: string[],
    tableOptions?: string,
    useTransaction?: boolean,
): Promise<void>
Prepares and executes the creation of a table including the relevant indexes and constraints
Parameters
- name: string
- fields: Column[]
- primaryKey: string[] = []
- tableOptions: string = ...
- useTransaction: boolean = true
Returns Promise<void>
Inherited from Database.createTable

dropTable

dropTable(tables: string | string[]): Promise<Database.Query.Result<any>[]>
Drop the tables from the database
Parameters
- tables: string | string[]
Returns Promise<Database.Query.Result<any>[]>
Inherited from Database.dropTable

escape

escape(value: string): string
Escapes the value for SQL
Parameters
- value: string
Returns string
Inherited from Database.escape

escapeId

escapeId(id: string): string
Escapes the ID for sql
Parameters
- id: string
Returns string
Inherited from Database.escapeId

listTables

listTables(database?: undefined | string): Promise<string[]>
Lists the tables in the current schema
Parameters
- database: undefined | string = ...
Returns Promise<string[]>
Overrides Database.listTables

multiInsert

multiInsert(
    table: string,
    columns?: string[],
    values: any[][],
    useTransaction?: boolean,
): Promise<Database.Query.Result<any>>
Prepares and performs a query that performs a multi-insert statement which is far faster than a bunch of individual insert statements
Parameters
- table: string
- columns: string[] = []
- values: any[][]
- useTransaction: boolean = true
Returns Promise<Database.Query.Result<any>>
Inherited from Database.multiInsert

multiUpdate

multiUpdate(
    table: string,
    primaryKey: string[],
    columns: string[],
    values: any[][],
    useTransaction?: boolean,
): Promise<Database.Query.Result<any>>
Prepares and executes a query to that performs a multi-update statement which is based upon a multi-insert statement that performs an UPSERT which is a lot faster than a bunch of update statements
Parameters
- table: string
- primaryKey: string[]
- columns: string[]
- values: any[][]
- useTransaction: boolean = true
Returns Promise<Database.Query.Result<any>>
Inherited from Database.multiUpdate

on

on(event: "connect", listener: (client: PoolClient) => void): this
Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
```
server.on('connection', (stream) => {
  console.log('someone connected!');
});
```
Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
```
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a
```
Parameters
- event: "connect"
- listener: (client: PoolClient) => void
  The callback function
Returns this
Since
v0.1.101

Overrides Database.on
on(event: "acquire", listener: (client: PoolClient) => void): this
Parameters
- event: "acquire"
- listener: (client: PoolClient) => void
Returns this
Overrides Database.on
on(event: "remove", listener: (client: PoolClient) => void): this
Parameters
- event: "remove"
- listener: (client: PoolClient) => void
Returns this
Overrides Database.on
on(event: "error", listener: (error: Error, client: PoolClient) => void): this
Parameters
- event: "error"
- listener: (error: Error, client: PoolClient) => void
Returns this
Overrides Database.on

prepareCreateIndex

prepareCreateIndex(
    table: string,
    fields: string[],
    type?: IndexType,
): Database.Query[]
Prepares the creation of an index on the specified table
Parameters
- table: string
- fields: string[]
- type: IndexType = Database.Table.IndexType.NONE
Returns Database.Query[]
Inherited from Database.prepareCreateIndex

prepareCreateTable

prepareCreateTable(
    name: string,
    fields: Column[],
    primaryKey?: string[],
    tableOptions?: string,
): Database.Query[]
Prepares the creation of a table including the relevant indexes and constraints
Parameters
- name: string
- fields: Column[]
- primaryKey: string[] = []
- tableOptions: string = ...
Returns Database.Query[]
Inherited from Database.prepareCreateTable

prepareMultiInsert

prepareMultiInsert(
    table: string,
    columns?: string[],
    values: any[][],
): Database.Query[]
Prepares a query to perform a multi-insert statement which is far faster than a bunch of individual insert statements
Parameters
- table: string
- columns: string[] = []
- values: any[][]
Returns Database.Query[]
Inherited from Database.prepareMultiInsert

prepareMultiUpdate

prepareMultiUpdate(
    table: string,
    primaryKey: string[],
    columns: string[],
    values: any[][],
): Database.Query[]
Prepares a query to perform a multi-update statement which is based upon a multi-insert statement that performs an UPSERT and this is a lot faster than a bunch of individual update statements
Parameters
- table: string
- primaryKey: string[]
- columns: string[]
- values: any[][]
Returns Database.Query[]
Inherited from Database.prepareMultiUpdate

query

query<RecordType = any>(
query: string | Database.Query,
...values: any[],
): Promise<Postgres.Query.Result<RecordType>>
Performs an individual query and returns the results
Type Parameters
- RecordType = any
Parameters
- query: string | Database.Query
- ...values: any[]
Returns Promise<Postgres.Query.Result<RecordType>>
Overrides Database.query

`Protected`release

release(connection: PoolClient): Promise<void>
Protected
Assists with releasing connections once we are done with them
Parameters
- connection: PoolClient
Returns Promise<void>

`Protected`rollbackTransaction

rollbackTransaction(connection: PoolClient): Promise<void>
Protected
Rolls back a transaction on the specified connection
Parameters
- connection: PoolClient
Returns Promise<void>
Overrides Database.rollbackTransaction

transaction

transaction<RecordType = any>(
queries: Database.Query[],
): Promise<Postgres.Query.Result<RecordType>[]>
Performs the specified queries in a transaction
Type Parameters
- RecordType = any
Parameters
- queries: Database.Query[]
Returns Promise<Postgres.Query.Result<RecordType>[]>
Overrides Database.transaction

`Protected`transformQuery

transformQuery(query: string): string
Protected
Transforms a query from using ?-based placeholders to pgsql placeholders
Parameters
- query: string
Returns string

truncate

truncate(table: string | string[], useTransaction?: boolean): Promise<boolean>
Truncates the specified table(s)
Parameters
- table: string | string[]
- useTransaction: boolean = true
Returns Promise<boolean>
Inherited from Database.truncate

use

use(database: string, user?: string, password?: string): Promise<Postgres>
Creates a new instance connected to the specified database using the same configuration options
Parameters
- database: string
- Optionaluser: string
- Optionalpassword: string
Returns Promise<Postgres>
Overrides Database.use

Class Postgres

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Postgres

Properties

Readonlyconfig

Readonlypool

tableOptions

Readonlytype

Accessors

idleConnections

Returns number

totalConnections

Returns number

typeName

Returns string

Statictype

Returns Type

Methods

Protected_executeMulti

Parameters

Returns Promise<Database.Query.Result<any>>

Protected_prepareColumns

Parameters

Returns [string[], any[]]

Protected_prepareConstraints

Parameters

Returns string[]

Protected_prepareCreateIndex

Parameters

Returns Database.Query

Protected_prepareCreateIndexes

Parameters

Returns Database.Query[]

Protected_prepareCreateTable

Parameters

Returns Database.Query[]

Protected_prepareMultiInsert

Parameters

Returns Database.Query[]

Protected_prepareMultiUpdate

Parameters

Returns Database.Query[]

ProtectedbeginTransaction

Parameters

Returns Promise<void>

close

Returns Promise<void>

ProtectedcommitTransaction

Parameters

Returns Promise<void>

Protectedconnection

Returns Promise<PoolClient>

createIndex

Parameters

Returns Promise<void>

createTable

Parameters

Returns Promise<void>

dropTable

Parameters

Returns Promise<Database.Query.Result<any>[]>

escape

Parameters

Returns string

escapeId

Parameters

Returns string

listTables

Parameters

Returns Promise<string[]>

multiInsert

Parameters

`Readonly`config

`Readonly`pool

`Readonly`type

`Static`type

`Protected`_executeMulti

`Protected`_prepareColumns

`Protected`_prepareConstraints

`Protected`_prepareCreateIndex

`Protected`_prepareCreateIndexes

`Protected`_prepareCreateTable

`Protected`_prepareMultiInsert

`Protected`_prepareMultiUpdate

`Protected`beginTransaction

`Protected`commitTransaction

`Protected`connection

`Protected`release

`Protected`rollbackTransaction

`Protected`transformQuery