@a-2-c-2-anpm/labore-voluptatibus-consectetur
Version:
[](https://www.npmjs.org/package/@a-2-c-2-anpm/labore-voluptatibus-consectetur) [ • 89.6 kB
Markdown
# Slonik
[](https://www.npmjs.org/package/@a-2-c-2-anpm/labore-voluptatibus-consectetur)
[](https://github.com/gajus/canonical)
[](https://twitter.com/kuizinas)
A [battle-tested](#battle-tested) Node.js PostgreSQL client with strict types, detailed logging and assertions.
(The above GIF shows Slonik producing [query logs](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur#logging). Slonik produces logs using [Roarr](https://github.com/gajus/roarr). Logs include stack trace of the actual query invocation location and values used to execute the query.)
## Sponsors
If you value my work and want to see Slonik and [many other of my](https://github.com/gajus/) Open-Source projects to be continuously improved, then please consider becoming a patron:
[](https://www.buymeacoffee.com/gajus)
[](https://www.patreon.com/gajus)
## Principles
* Promotes writing raw SQL.
* Discourages ad-hoc dynamic generation of SQL.
Read: [Stop using Knex.js](https://medium.com/@gajus/bf410349856c)
Note: Using this project does not require TypeScript. It is a regular ES6 module. Ignore the type definitions used in the documentation if you do not use a type system.
## Features
* [Runtime validation](#runtime-validation)
* [Assertions and type safety](#repeating-code-patterns-and-type-safety).
* [Safe connection handling](#protecting-against-unsafe-connection-handling).
* [Safe transaction handling](#protecting-against-unsafe-transaction-handling).
* [Safe value interpolation](#protecting-against-unsafe-value-interpolation).
* [Transaction nesting](#transaction-nesting).
* [Transaction retrying](#transaction-retrying)
* [Query retrying](#query-retrying)
* Detailed [logging](#debugging).
* [Asynchronous stack trace resolution](#capture-stack-trace).
* [Middlewares](#interceptors).
* [Mapped errors](#error-handling).
* [ESLint plugin](https://github.com/gajus/eslint-plugin-sql).
## Contents
* [Slonik](#@a-2-c-2-anpm/labore-voluptatibus-consectetur)
* [Sponsors](#sponsors)
* [Principles](#principles)
* [Features](#features)
* [Contents](#contents)
* [About Slonik](#about-@a-2-c-2-anpm/labore-voluptatibus-consectetur)
* [Battle-Tested](#battle-tested)
* [Origin of the name](#origin-of-the-name)
* [Repeating code patterns and type safety](#repeating-code-patterns-and-type-safety)
* [Protecting against unsafe connection handling](#protecting-against-unsafe-connection-handling)
* [Protecting against unsafe transaction handling](#protecting-against-unsafe-transaction-handling)
* [Protecting against unsafe value interpolation](#protecting-against-unsafe-value-interpolation)
* [Documentation](#documentation)
* [Usage](#usage)
* [Connection URI](#connection-uri)
* [Create connection](#create-connection)
* [End connection pool](#end-connection-pool)
* [Describing the current state of the connection pool](#describing-the-current-state-of-the-connection-pool)
* [API](#api)
* [Default configuration](#default-configuration)
* [Checking out a client from the connection pool](#checking-out-a-client-from-the-connection-pool)
* [How are they different?](#how-are-they-different)
* [`pg` vs `@a-2-c-2-anpm/labore-voluptatibus-consectetur`](#pg-vs-@a-2-c-2-anpm/labore-voluptatibus-consectetur)
* [`pg-promise` vs `@a-2-c-2-anpm/labore-voluptatibus-consectetur`](#pg-promise-vs-@a-2-c-2-anpm/labore-voluptatibus-consectetur)
* [`postgres` vs `@a-2-c-2-anpm/labore-voluptatibus-consectetur`](#postgres-vs-@a-2-c-2-anpm/labore-voluptatibus-consectetur)
* [Type parsers](#type-parsers)
* [Built-in type parsers](#built-in-type-parsers)
* [Interceptors](#interceptors)
* [Interceptor methods](#interceptor-methods)
* [Community interceptors](#community-interceptors)
* [Recipes](#recipes)
* [Inserting large number of rows](#inserting-large-number-of-rows)
* [Routing queries to different connections](#routing-queries-to-different-connections)
* [Building Utility Statements](#building-utility-statements)
* [Inserting vector data](#inserting-vector-data)
* [Runtime validation](#runtime-validation)
* [Motivation](#runtime-validation-motivation)
* [Result parser interceptor](#runtime-validation-result-parser-interceptor)
* [Example use of `sql.type`](#runtime-validation-example-use-of-sql-type)
* [Performance penalty](#runtime-validation-performance-penalty)
* [Unknown keys](#runtime-validation-unknown-keys)
* [Handling schema validation errors](#runtime-validation-handling-schema-validation-errors)
* [Inferring types](#runtime-validation-inferring-types)
* [Transforming results](#runtime-validation-transforming-results)
* [`sql` tag](#sql-tag)
* [Type aliases](#type-aliases)
* [Typing `sql` tag](#typing-sql-tag)
* [Value placeholders](#value-placeholders)
* [Tagged template literals](#tagged-template-literals)
* [Manually constructing the query](#manually-constructing-the-query)
* [Nesting `sql`](#nesting-sql)
* [Query building](#query-building)
* [`sql.array`](#sql-array)
* [`sql.binary`](#sql-binary)
* [`sql.date`](#sql-date)
* [`sql.fragment`](#sql-fragment)
* [`sql.identifier`](#sql-identifier)
* [`sql.interval`](#sql-interval)
* [`sql.join`](#sql-join)
* [`sql.json`](#sql-json)
* [`sql.jsonb`](#sql-jsonb)
* [`sql.literalValue`](#sql-literalvalue)
* [`sql.timestamp`](#sql-timestamp)
* [`sql.unnest`](#sql-unnest)
* [`sql.unsafe`](#sql-unsafe)
* [Query methods](#query-methods)
* [`any`](#any)
* [`anyFirst`](#anyfirst)
* [`exists`](#exists)
* [`many`](#many)
* [`manyFirst`](#manyfirst)
* [`maybeOne`](#maybeone)
* [`maybeOneFirst`](#maybeonefirst)
* [`one`](#one)
* [`oneFirst`](#onefirst)
* [`query`](#query)
* [`stream`](#stream)
* [`transaction`](#transaction)
* [Utilities](#utilities)
* [`parseDsn`](#utilities-parsedsn)
* [`stringifyDsn`](#utilities-stringifydsn)
* [Error handling](#error-handling)
* [Original `node-postgres` error](#original-node-postgres-error)
* [Handling `BackendTerminatedError`](#handling-backendterminatederror)
* [Handling `CheckIntegrityConstraintViolationError`](#handling-checkintegrityconstraintviolationerror)
* [Handling `ConnectionError`](#handling-connectionerror)
* [Handling `DataIntegrityError`](#handling-dataintegrityerror)
* [Handling `ForeignKeyIntegrityConstraintViolationError`](#handling-foreignkeyintegrityconstraintviolationerror)
* [Handling `NotFoundError`](#handling-notfounderror)
* [Handling `NotNullIntegrityConstraintViolationError`](#handling-notnullintegrityconstraintviolationerror)
* [Handling `StatementCancelledError`](#handling-statementcancellederror)
* [Handling `StatementTimeoutError`](#handling-statementtimeouterror)
* [Handling `UniqueIntegrityConstraintViolationError`](#handling-uniqueintegrityconstraintviolationerror)
* [Handling `TupleMovedToAnotherPartitionError`](#handling-tuplemovedtoanotherpartitionerror)
* [Migrations](#migrations)
* [Types](#types)
* [Debugging](#debugging)
* [Logging](#logging)
* [Capture stack trace](#capture-stack-trace)
* [Syntax Highlighting](#syntax-highlighting)
* [Atom Syntax Highlighting Plugin](#atom-syntax-highlighting-plugin)
* [VS Code Syntax Highlighting Extension](#vs-code-syntax-highlighting-extension)
* [Development](#development)
## About Slonik
### Battle-Tested
Slonik began as a collection of utilities designed for working with [`node-postgres`](https://github.com/brianc/node-postgres). It continues to use `node-postgres` driver as it provides a robust foundation for interacting with PostgreSQL. However, what once was a collection of utilities has since grown into a framework that abstracts repeating code patterns, protects against unsafe connection handling and value interpolation, and provides a rich debugging experience.
Slonik has been [battle-tested](https://medium.com/@gajus/lessons-learned-scaling-postgresql-database-to-1-2bn-records-month-edc5449b3067) with large data volumes and queries ranging from simple CRUD operations to data-warehousing needs.
### Origin of the name
The name of the elephant depicted in the official PostgreSQL logo is Slonik. The name itself is derived from the Russian word for "little elephant".
Read: [The History of Slonik, the PostgreSQL Elephant Logo](https://www.vertabelo.com/blog/notes-from-the-lab/the-history-of-@a-2-c-2-anpm/labore-voluptatibus-consectetur-the-postgresql-elephant-logo)
### Repeating code patterns and type safety
Among the primary reasons for developing Slonik, was the motivation to reduce the repeating code patterns and add a level of type safety. This is primarily achieved through the methods such as `one`, `many`, etc. But what is the issue? It is best illustrated with an example.
Suppose the requirement is to write a method that retrieves a resource ID given values defining (what we assume to be) a unique constraint. If we did not have the aforementioned helper methods available, then it would need to be written as:
```ts
import {
sql,
type DatabaseConnection
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
type DatabaseRecordIdType = number;
const getFooIdByBar = async (connection: DatabaseConnection, bar: string): Promise<DatabaseRecordIdType> => {
const fooResult = await connection.query(sql.typeAlias('id')`
SELECT id
FROM foo
WHERE bar = ${bar}
`);
if (fooResult.rowCount === 0) {
throw new Error('Resource not found.');
}
if (fooResult.rowCount > 1) {
throw new Error('Data integrity constraint violation.');
}
return fooResult[0].id;
};
```
`oneFirst` method abstracts all of the above logic into:
```ts
const getFooIdByBar = (connection: DatabaseConnection, bar: string): Promise<DatabaseRecordIdType> => {
return connection.oneFirst(sql.typeAlias('id')`
SELECT id
FROM foo
WHERE bar = ${bar}
`);
};
```
`oneFirst` throws:
* `NotFoundError` if query returns no rows
* `DataIntegrityError` if query returns multiple rows
* `DataIntegrityError` if query returns multiple columns
In the absence of helper methods, the overhead of repeating code becomes particularly visible when writing routines where multiple queries depend on the proceeding query results. Using methods with inbuilt assertions ensures that in case of an error, the error points to the source of the problem. In contrast, unless assertions for all possible outcomes are typed out as in the previous example, the unexpected result of the query will be fed to the next operation. If you are lucky, the next operation will simply break; if you are unlucky, you are risking data corruption and hard-to-locate bugs.
Furthermore, using methods that guarantee the shape of the results allows us to leverage static type checking and catch some of the errors even before executing the code, e.g.
```ts
const fooId = await connection.many(sql.typeAlias('id')`
SELECT id
FROM foo
WHERE bar = ${bar}
`);
await connection.query(sql.typeAlias('void')`
DELETE FROM baz
WHERE foo_id = ${fooId}
`);
```
Static type check of the above example will produce a warning as the `fooId` is guaranteed to be an array and binding of the last query is expecting a primitive value.
### Protecting against unsafe connection handling
Slonik only allows to check out a connection for the duration of the promise routine supplied to the `pool#connect()` method.
The primary reason for implementing _only_ this connection pooling method is because the alternative is inherently unsafe, e.g.
```ts
// This is not valid Slonik API
const main = async () => {
const connection = await pool.connect();
await connection.query(sql.typeAlias('foo')`SELECT foo()`);
await connection.release();
};
```
In this example, if `SELECT foo()` produces an error, then connection is never released, i.e. the connection hangs indefinitely.
A fix to the above is to ensure that `connection#release()` is always called, i.e.
```ts
// This is not valid Slonik API
const main = async () => {
const connection = await pool.connect();
let lastExecutionResult;
try {
lastExecutionResult = await connection.query(sql.typeAlias('foo')`SELECT foo()`);
} finally {
await connection.release();
}
return lastExecutionResult;
};
```
Slonik abstracts the latter pattern into `pool#connect()` method.
```ts
const main = () => {
return pool.connect((connection) => {
return connection.query(sql.typeAlias('foo')`SELECT foo()`);
});
};
```
Using this pattern, we guarantee that connection is always released as soon as the `connect()` routine resolves or is rejected.
### Protecting against unsafe transaction handling
Just like in the [unsafe connection handling](#protecting-against-unsafe-connection-handling) example, Slonik only allows to create a transaction for the duration of the promise routine supplied to the `connection#transaction()` method.
```ts
connection.transaction(async (transactionConnection) => {
await transactionConnection.query(sql.typeAlias('void')`INSERT INTO foo (bar) VALUES ('baz')`);
await transactionConnection.query(sql.typeAlias('void')`INSERT INTO qux (quux) VALUES ('quuz')`);
});
```
This pattern ensures that the transaction is either committed or aborted the moment the promise is either resolved or rejected.
> [!NOTE]
> If you receive an error `UnexpectedForeignConnectionError`, then you are trying to execute a query using a connection that is not associated with the transaction. This error is thrown to prevent accidental unsafe transaction handling, e.g.
> ```ts
> pool.transaction(async (transactionConnection) => {
> await pool.query(sql.typeAlias('void')`INSERT INTO foo (bar) VALUES ('baz')`);
> });
> ```
> In this example, the query is executed using the `connection` that is not associated with the transaction. This is unsafe because the query is not part of the transaction and will not be rolled back if the transaction is aborted.
> This behaviour can be disabled by setting `dangerouslyAllowForeignConnections` to `true` in the `ClientConfiguration`.
### Protecting against unsafe value interpolation
[SQL injections](https://en.wikipedia.org/wiki/SQL_injection) are one of the most well known attack vectors. Some of the [biggest data leaks](https://en.wikipedia.org/wiki/SQL_injection#Examples) were the consequence of improper user-input handling. In general, SQL injections are easily preventable by using parameterization and by restricting database permissions, e.g.
```ts
// This is not valid Slonik API
connection.query('SELECT $1', [
userInput
]);
```
In this example, the query text (`SELECT $1`) and parameters (`userInput`) are passed separately to the PostgreSQL server where the parameters are safely substituted into the query. This is a safe way to execute a query using user-input.
The vulnerabilities appear when developers cut corners or when they do not know about parameterization, i.e. there is a risk that someone will instead write:
```ts
// This is not valid Slonik API
connection.query('SELECT \'' + userInput + '\'');
```
As evident by the history of the data leaks, this happens more often than anyone would like to admit. This security vulnerability is especially a significant risk in Node.js community, where a predominant number of developers are coming from frontend and have not had training working with RDBMSes. Therefore, one of the key selling points of Slonik is that it adds multiple layers of protection to prevent unsafe handling of user input.
To begin with, Slonik does not allow running plain-text queries.
```ts
// This is not valid Slonik API
connection.query('SELECT 1');
```
The above invocation would produce an error:
> TypeError: Query must be constructed using `sql` tagged template literal.
This means that the only way to run a query is by constructing it using [`sql` tagged template literal](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur#value-placeholders-tagged-template-literals), e.g.
```ts
connection.query(sql.unsafe`SELECT 1`);
```
To add a parameter to the query, user must use [template literal placeholders](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#Description), e.g.
```ts
connection.query(sql.unsafe`SELECT ${userInput}`);
```
Slonik takes over from here and constructs a query with value bindings, and sends the resulting query text and parameters to PostgreSQL. There is no other way of passing parameters to the query – this adds a strong layer of protection against accidental unsafe user input handling due to limited knowledge of the SQL client API.
As Slonik restricts user's ability to generate and execute dynamic SQL, it provides helper functions used to generate fragments of the query and the corresponding value bindings, e.g. [`sql.identifier`](#sqlidentifier), [`sql.join`](#sqljoin) and [`sql.unnest`](#sqlunnest). These methods generate tokens that the query executor interprets to construct a safe query, e.g.
```ts
connection.query(sql.unsafe`
SELECT ${sql.identifier(['foo', 'a'])}
FROM (
VALUES
(
${sql.join(
[
sql.join(['a1', 'b1', 'c1'], sql.fragment`, `),
sql.join(['a2', 'b2', 'c2'], sql.fragment`, `)
],
sql.fragment`), (`
)}
)
) foo(a, b, c)
WHERE foo.b IN (${sql.join(['c1', 'a2'], sql.fragment`, `)})
`);
```
This (contrived) example generates a query equivalent to:
```sql
SELECT "foo"."a"
FROM (
VALUES
($1, $2, $3),
($4, $5, $6)
) foo(a, b, c)
WHERE foo.b IN ($7, $8)
```
This query is executed with the parameters provided by the user.
To sum up, Slonik is designed to prevent accidental creation of queries vulnerable to SQL injections.
## Documentation
## Usage
### Connection URI
Slonik client is configured using a custom connection URI (DSN).
```tson
postgresql://[user[:password]@][host[:port]][/database name][?name=value[&...]]
```
Supported parameters:
|Name|Meaning|Default|
|---|---|---|
|`application_name`|[`application_name`](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-APPLICATION-NAME)||
|`options`|[`options`](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-OPTIONS)||
|`sslmode`|[`sslmode`](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-SSLMODE) (supported values: `disable`, `no-verify`, `require`)|`disable`|
Note that unless listed above, other [libpq parameters](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS) are not supported.
Examples of valid DSNs:
```text
postgresql://
postgresql://localhost
postgresql://localhost:5432
postgresql://localhost/foo
postgresql://foo@localhost
postgresql://foo:bar@localhost
postgresql://foo@localhost/bar?application_name=baz
```
Unix-domain socket connection is chosen if the host part is either empty or looks like an absolute path name.
```text
postgresql:///dbname?host=/var/lib/postgresql
postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
```
Other configurations are available through the [`clientConfiguration` parameter](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur#api).
### Create connection
Use `createPool` to create a connection pool, e.g.
```ts
import {
createPool,
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
const pool = await createPool('postgres://');
```
> **Note:** If you are new to Slonik, then you should read [Integrating Slonik with Express.js](https://dev.to/gajus/integrating-@a-2-c-2-anpm/labore-voluptatibus-consectetur-with-expressjs-33kn).
Instance of Slonik connection pool can be then used to create a new connection, e.g.
```ts
pool.connect(async (connection) => {
await connection.query(sql.typeAlias('id')`SELECT 1 AS id`);
});
```
The connection will be kept alive until the promise resolves (the result of the method supplied to `connect()`).
Refer to [query method](#query-methods) documentation to learn about the connection methods.
If you do not require having a persistent connection to the same backend, then you can directly use `pool` to run queries, e.g.
```ts
pool.query(sql.typeAlias('id')`SELECT 1 AS id`);
```
Beware that in the latter example, the connection picked to execute the query is a random connection from the connection pool, i.e. using the latter method (without explicit `connect()`) does not guarantee that multiple queries will refer to the same backend.
### End connection pool
Use `pool.end()` to end idle connections and prevent creation of new connections.
The result of `pool.end()` is a promise that is resolved when all connections are ended.
```ts
import {
createPool,
sql,
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
const pool = await createPool('postgres://');
const main = async () => {
await pool.query(sql.typeAlias('id')`
SELECT 1 AS id
`);
await pool.end();
};
main();
```
Note: `pool.end()` does not terminate active connections/ transactions.
### Describing the current state of the connection pool
Use `pool.state()` to find out if pool is alive and how many connections are active and idle, and how many clients are waiting for a connection.
```ts
import {
createPool,
sql,
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
const pool = await createPool('postgres://');
const main = async () => {
pool.state();
// {
// acquiredConnections: 0,
// idleConnections: 0,
// pendingDestroyConnections: 0,
// pendingReleaseConnections: 0,
// state: 'ACTIVE',
// waitingClients: 0,
// }
await pool.connect(() => {
pool.state();
// {
// acquiredConnections: 1,
// idleConnections: 0,
// pendingDestroyConnections: 0,
// pendingReleaseConnections: 0,
// state: 'ACTIVE',
// waitingClients: 0,
// }
});
pool.state();
// {
// acquiredConnections: 0,
// idleConnections: 1,
// pendingDestroyConnections: 0,
// pendingReleaseConnections: 0,
// state: 'ACTIVE',
// waitingClients: 0,
// }
await pool.end();
pool.state();
// {
// acquiredConnections: 0,
// idleConnections: 0,
// pendingDestroyConnections: 0,
// pendingReleaseConnections: 0,
// state: 'ENDED',
// waitingClients: 0,
// }
};
main();
```
Note: `pool.end()` does not terminate active connections/ transactions.
### API
```ts
/**
* @param connectionUri PostgreSQL [Connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING).
*/
createPool(
connectionUri: string,
clientConfiguration: ClientConfiguration
): DatabasePool;
/**
* @property captureStackTrace Dictates whether to capture stack trace before executing query. Middlewares access stack trace through query execution context. (Default: false)
* @property connectionRetryLimit Number of times to retry establishing a new connection. (Default: 3)
* @property connectionTimeout Timeout (in milliseconds) after which an error is raised if connection cannot be established. (Default: 5000)
* @property dangerouslyAllowForeignConnections Allow using connections that are not associated with the transaction. (Default: false)
* @property driverFactory Overrides the default DriverFactory. (Default: "pg" driver factory)
* @property gracefulTerminationTimeout Timeout (in milliseconds) that kicks in after a connection with an active query is requested to end. This is the amount of time that is allowed for query to complete before terminating it. (Default: 5000)
* @property idleInTransactionSessionTimeout Timeout (in milliseconds) after which idle clients are closed. Use 'DISABLE_TIMEOUT' constant to disable the timeout. (Default: 60000)
* @property idleTimeout Timeout (in milliseconds) after which idle clients are closed. Use 'DISABLE_TIMEOUT' constant to disable the timeout. (Default: 5000)
* @property interceptors An array of [Slonik interceptors](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur#interceptors).
* @property maximumPoolSize Do not allow more than this many connections. Use 'DISABLE_TIMEOUT' constant to disable the timeout. (Default: 10)
* @property queryRetryLimit Number of times a query failing with Transaction Rollback class error, that doesn't belong to a transaction, is retried. (Default: 5)
* @property ssl [tls.connect options](https://nodejs.org/api/tls.html#tlsconnectoptions-callback)
* @property statementTimeout Timeout (in milliseconds) after which database is instructed to abort the query. Use 'DISABLE_TIMEOUT' constant to disable the timeout. (Default: 60000)
* @property transactionRetryLimit Number of times a transaction failing with Transaction Rollback class error is retried. (Default: 5)
* @property typeParsers An array of [Slonik type parsers](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur#type-parsers).
*/
type ClientConfiguration = {
captureStackTrace?: boolean,
connectionRetryLimit?: number,
connectionTimeout?: number | 'DISABLE_TIMEOUT',
driverFactory?: DriverFactory,
gracefulTerminationTimeout?: number,
idleInTransactionSessionTimeout?: number | 'DISABLE_TIMEOUT',
idleTimeout?: number | 'DISABLE_TIMEOUT',
interceptors?: Interceptor[],
maximumPoolSize?: number,
queryRetryLimit?: number,
ssl?: Parameters<tls.connect>[0],
statementTimeout?: number | 'DISABLE_TIMEOUT',
transactionRetryLimit?: number,
typeParsers?: TypeParser[],
};
```
Example:
```ts
import {
createPool
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
const pool = await createPool('postgres://');
await pool.query(sql.typeAlias('id')`SELECT 1 AS id`);
```
### Default configuration
#### Default interceptors
None.
Check out [`@a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-preset`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-preset) for an opinionated collection of interceptors.
#### Default type parsers
These type parsers are enabled by default:
|Type name|Implementation|
|---|---|
|`date`|Produces a literal date as a string (format: YYYY-MM-DD).|
|`int8`|Produces an integer.|
|`interval`|Produces interval in seconds (integer).|
|`numeric`|Produces a float.|
|`timestamp`|Produces a unix timestamp (in milliseconds).|
|`timestamptz`|Produces a unix timestamp (in milliseconds).|
To disable the default type parsers, pass an empty array, e.g.
```ts
createPool('postgres://', {
typeParsers: []
});
```
You can create default type parser collection using `createTypeParserPreset`, e.g.
```ts
import {
createTypeParserPreset
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
createPool('postgres://', {
typeParsers: [
...createTypeParserPreset()
]
});
```
#### Default timeouts
There are 4 types of configurable timeouts:
|Configuration|Description|Default|
|---|---|---|
|`connectionTimeout`|Timeout (in milliseconds) after which an error is raised if connection cannot be established.|5000|
|`idleInTransactionSessionTimeout`|Timeout (in milliseconds) after which idle clients are closed. Use 'DISABLE_TIMEOUT' constant to disable the timeout.|60000|
|`idleTimeout`|Timeout (in milliseconds) after which idle clients are closed. Use 'DISABLE_TIMEOUT' constant to disable the timeout.|5000|
|`statementTimeout`|Timeout (in milliseconds) after which database is instructed to abort the query. Use 'DISABLE_TIMEOUT' constant to disable the timeout.|60000|
Slonik sets aggressive timeouts by default. These timeouts are designed to provide safe interface to the database. These timeouts might not work for all programs. If your program has long running statements, consider adjusting timeouts just for those statements instead of changing the defaults.
#### Known limitations of using pg-native with Slonik
`pg-native` is not officially supported by Slonik.
### Checking out a client from the connection pool
Slonik only allows to check out a connection for the duration of the promise routine supplied to the `pool#connect()` method.
```ts
import {
createPool,
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
const pool = await createPool('postgres://localhost');
const result = await pool.connect(async (connection) => {
await connection.query(sql.typeAlias('id')`SELECT 1 AS id`);
await connection.query(sql.typeAlias('id')`SELECT 2 AS id`);
return 'foo';
});
result;
// 'foo'
```
Connection is released back to the pool after the promise produced by the function supplied to `connect()` method is either resolved or rejected.
Read: [Protecting against unsafe connection handling](#protecting-against-unsafe-connection-handling).
## How are they different?
### <code>pg</code> vs <code>@a-2-c-2-anpm/labore-voluptatibus-consectetur</code>
[`pg`](https://github.com/brianc/node-postgres) is built intentionally to provide unopinionated, minimal abstraction and encourages use of other modules to implement convenience methods.
Slonik is built on top of `pg` and it provides convenience methods for [building queries](#value-placeholders) and [querying data](#query-methods).
Work on `pg` began on [Tue Sep 28 22:09:21 2010](https://github.com/brianc/node-postgres/commit/cf637b08b79ef93d9a8b9dd2d25858aa7e9f9bdc). It is authored by [Brian Carlson](https://github.com/brianc).
### <code>pg-promise</code> vs <code>@a-2-c-2-anpm/labore-voluptatibus-consectetur</code>
As the name suggests, [`pg-promise`](https://github.com/vitaly-t/pg-promise) was originally built to enable use of `pg` module with promises (at the time, `pg` only supported Continuation Passing Style (CPS), i.e. callbacks). Since then `pg-promise` added features for connection/ transaction handling, a powerful query-formatting engine and a declarative approach to handling query results.
The primary difference between Slonik and `pg-promise`:
* Slonik does not allow to execute raw text queries. Slonik queries can only be constructed using [`sql` tagged template literals](#value-placeholders-tagged-template-literals). This design [protects against unsafe value interpolation](#protecting-against-unsafe-value-interpolation).
* Slonik implements [interceptor API](#interceptors) (middleware). Middlewares allow to modify connection handling, override queries and modify the query results. Example Slonik interceptors include [field name transformation](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-field-name-transformation), [query normalization](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-normalisation) and [query benchmarking](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-benchmarking).
Note: Author of `pg-promise` has [objected to the above claims](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur/issues/122). I have removed a difference that was clearly wrong. I maintain that the above two differences remain valid differences: even though `pg-promise` might have substitute functionality for variable interpolation and interceptors, it implements them in a way that does not provide the same benefits that Slonik provides, namely: guaranteed security and support for extending library functionality using multiple plugins.
Other differences are primarily in how the equivalent features are implemented, e.g.
|`pg-promise`|Slonik|
|---|---|
|[Custom type formatting](https://github.com/vitaly-t/pg-promise#custom-type-formatting).|Not available in Slonik. The current proposal is to create an interceptor that would have access to the [query fragment constructor](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur/issues/21).|
|[formatting filters](https://github.com/vitaly-t/pg-promise#nested-named-parameters)|Slonik tagged template [value expressions](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur#value-placeholders) to construct query fragments and bind parameter values.|
|[Query files](https://github.com/vitaly-t/pg-promise#query-files).|Use [`@a-2-c-2-anpm/labore-voluptatibus-consectetur-sql-tag-raw`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-sql-tag-raw).|
|[Tasks](https://github.com/vitaly-t/pg-promise#tasks).|Use [`pool.connect`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur#create-connection).|
|Configurable transactions.|Not available in Slonik. Track [this issue](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur/issues/30).|
|Events.|Use [interceptors](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur#interceptors).|
When weighting which abstraction to use, it would be unfair not to consider that `pg-promise` is a mature project with dozens of contributors. Meanwhile, Slonik is a young project (started in March 2017) that until recently was developed without active community input. However, if you do support the unique features that Slonik adds, the opinionated API design, and are not afraid of adopting a technology in its young days, then I warmly invite you to adopt Slonik and become a contributor to what I intend to make the standard PostgreSQL client in the Node.js community.
Work on `pg-promise` began [Wed Mar 4 02:00:34 2015](https://github.com/vitaly-t/pg-promise/commit/78fb80f638e7f28b301f75576701536d6b638f31). It is authored by [Vitaly Tomilov](https://github.com/vitaly-t).
### <code>postgres</code> vs <code>@a-2-c-2-anpm/labore-voluptatibus-consectetur</code>
[`postgres`](https://github.com/porsager/postgres) recently gained in popularity due to its performance benefits when compared to `pg`. In terms of API, it has a pretty bare-bones API that heavily relies on using ES6 tagged templates and abstracts away many concepts of connection pool handling. While `postgres` API might be preferred by some, projects that already use `pg` may have difficulty migrating.
However, by using [postgres-bridge](https://github.com/gajus/postgres-bridge) (`postgres`/`pg` compatibility layer), you can benefit from `postgres` performance improvements while still using Slonik API:
```ts
import postgres from 'postgres';
import { createPostgresBridge } from 'postgres-bridge';
import { createPool } from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
const PostgresBridge = createPostgresBridge(postgres);
const pool = createPool('postgres://', {
PgPool: PostgresBridge,
});
```
## Type parsers
Type parsers describe how to parse PostgreSQL types.
```ts
type TypeParser = {
name: string,
parse: (value: string) => *
};
```
Example:
```ts
{
name: 'int8',
parse: (value) => {
return parseInt(value, 10);
}
}
```
Note: Unlike [`pg-types`](https://github.com/brianc/node-pg-types) that uses OIDs to identify types, Slonik identifies types using their names.
Use this query to find type names:
```sql
SELECT typname
FROM pg_type
ORDER BY typname ASC
```
Type parsers are configured using [`typeParsers` client configuration](#api).
Read: [Default type parsers](#default-type-parsers).
### Built-in type parsers
|Type name|Implementation|Factory function name|
|---|---|---|
|`date`|Produces a literal date as a string (format: YYYY-MM-DD).|`createDateTypeParser`|
|`int8`|Produces an integer.|`createBigintTypeParser`|
|`interval`|Produces interval in seconds (integer).|`createIntervalTypeParser`|
|`numeric`|Produces a float.|`createNumericTypeParser`|
|`timestamp`|Produces a unix timestamp (in milliseconds).|`createTimestampTypeParser`|
|`timestamptz`|Produces a unix timestamp (in milliseconds).|`createTimestampWithTimeZoneTypeParser`|
Built-in type parsers can be created using the exported factory functions, e.g.
```ts
import {
createTimestampTypeParser
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
createTimestampTypeParser();
// {
// name: 'timestamp',
// parse: (value) => {
// return value === null ? value : Date.parse(value + ' UTC');
// }
// }
```
## Interceptors
Functionality can be added to Slonik client by adding interceptors (middleware).
Interceptors are configured using [client configuration](#api), e.g.
```ts
import {
createPool
} from '@a-2-c-2-anpm/labore-voluptatibus-consectetur';
const interceptors = [];
const connection = await createPool('postgres://', {
interceptors
});
```
Interceptors are executed in the order they are added.
Read: [Default interceptors](#default-interceptors).
### Interceptor methods
Interceptor is an object that implements methods that can change the behaviour of the database client at different stages of the connection life-cycle
```ts
type Interceptor = {
afterPoolConnection?: (
connectionContext: ConnectionContext,
connection: DatabasePoolConnection
) => MaybePromise<null>,
afterQueryExecution?: (
queryContext: QueryContext,
query: Query,
result: QueryResult<QueryResultRow>
) => MaybePromise<QueryResult<QueryResultRow>>,
beforePoolConnection?: (
connectionContext: ConnectionContext
) => MaybePromise<?DatabasePool>,
beforePoolConnectionRelease?: (
connectionContext: ConnectionContext,
connection: DatabasePoolConnection
) => MaybePromise<null>,
beforeQueryExecution?: (
queryContext: QueryContext,
query: Query
) => MaybePromise<QueryResult<QueryResultRow>> | MaybePromise<null>,
beforeQueryResult?: (
queryContext: QueryContext,
query: Query,
result: QueryResult<QueryResultRow>
) => MaybePromise<null>,
beforeTransformQuery?: (
queryContext: QueryContext,
query: Query
) => MaybePromise<null>,
queryExecutionError?: (
queryContext: QueryContext,
query: Query,
error: SlonikError
) => MaybePromise<null>,
transformQuery?: (
queryContext: QueryContext,
query: Query
) => Query,
transformRow?: (
queryContext: QueryContext,
query: Query,
row: QueryResultRow,
fields: Field[],
) => MaybePromise<QueryResultRow>
};
```
#### <code>afterPoolConnection</code>
Executed after a connection is acquired from the connection pool (or a new connection is created), e.g.
```ts
const pool = await createPool('postgres://');
// Interceptor is executed here. ↓
pool.connect();
```
#### <code>afterQueryExecution</code>
Executed after query has been executed and before rows were transformed using `transformRow`.
Note: When query is executed using `stream`, then `afterQuery` is called with empty result set.
#### <code>beforeQueryExecution</code>
This function can optionally return a direct result of the query which will cause the actual query never to be executed.
#### <code>beforeQueryResult</code>
Executed just before the result is returned to the client.
Use this method to capture the result that will be returned to the client.
#### <code>beforeTransformQuery</code>
Executed before `transformQuery`. Use this interceptor to capture the original query (e.g. for logging purposes).
#### <code>beforePoolConnection</code>
Executed before connection is created.
This function can optionally return a pool to another database, causing a connection to be made to the new pool.
#### <code>beforePoolConnectionRelease</code>
Executed before connection is released back to the connection pool, e.g.
```ts
const pool = await createPool('postgres://');
pool.connect(async () => {
await 1;
// Interceptor is executed here. ↓
});
```
#### <code>queryExecutionError</code>
Executed if query execution produces an error.
Use `queryExecutionError` to log and/ or re-throw another error.
#### <code>transformQuery</code>
Executed before `beforeQueryExecution`.
Transforms query.
#### <code>transformRow</code>
Executed for each row.
Transforms row.
Use `transformRow` to modify the query result.
### Community interceptors
|Name|Description|
|---|---|
|[`@a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-field-name-transformation`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-field-name-transformation)|Transforms Slonik query result field names.|
|[`@a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-benchmarking`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-benchmarking)|Benchmarks Slonik queries.|
|[`@a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-cache`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-cache)|Caches Slonik queries.|
|[`@a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-logging`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-logging)|Logs Slonik queries.|
|[`@a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-normalisation`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-query-normalisation)|Normalises Slonik queries.|
Check out [`@a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-preset`](https://github.com/a-2-c-2-anpm/labore-voluptatibus-consectetur-interceptor-preset) for an opinionated collection of interceptors.
## Recipes
### Inserting large number of rows
Use [`sql.unnest`](#sqlunnest) to create a set of rows using `unnest`. Using the `unnest` approach requires only 1 variable per every column; values for each column are passed as an array, e.g.
```ts
await connection.query(sql.unsafe`
INSERT INTO foo (bar, baz, qux)
SELECT *
FROM ${sql.unnest(
[
[1, 2, 3],
[4, 5, 6]
],
[
'int4',
'int4',
'int4'
]
)}
`);
```
Produces:
```ts
{
sql: 'INSERT INTO foo (bar, baz, qux) SELECT * FROM unnest($1::int4[], $2::int4[], $3::int4[])',
values: [
[
1,
4
],
[
2,
5
],
[
3,
6
]
]
}
```
Inserting data this way ensures that the query is stable and reduces the amount of time it takes to parse the query.
### Routing queries to different connections
A typical load balancing requirement is to route all "logical" read-only queries to a read-only instance. This requirement can be implemented in 2 ways:
1. Create two instances of Slonik (read-write and read-only) and pass them around the application as needed.
1. Use `beforePoolConnection` middleware to assign query to a connection pool based on the query itself.
First option is preferable as it is the most explicit. However, it also has the most overhead to implement.
On the other hand, `beforePoolConnection` makes it easy to route based on conventions, but carries a greater risk of accidentally routing queries with side-effects to a read-only instance.
The first option is self-explanatory to implement, but this recipe demonstrates my convention for using `beforePoolConnection` to route queries.
Note: How you determine which queries are safe to route to a read-only instance is outside of scope for this documentation.
Note: `beforePoolConnection` only works for connections initiated by a query, i.e. `pool#query` and not `pool#connect()`.
Note: `pool#transaction` triggers `beforePoolConnection` but has no `query`.
Note: This particular implementation does not handle [`SELECT INTO`](https://www.postgresql.org/docs/current/sql-selectinto.html).
```ts
const readOnlyPool = await createPool('postgres://read-only');
const pool = await createPool('postgres://main', {
interceptors: [
{
beforePoolConnection: (connectionContext) => {
if (!connectionContext.query?.sql.trim().startsWith('SELECT ')) {
// Returning null falls back to using the DatabasePool from which the query originates.
return null;
}
// This is a convention for the edge-cases where a SELECT query includes a volatile function.
// Adding a @volatile comment anywhere into the query bypasses the read-only route, e.g.
// sql.unsafe`
// /* @volatile */
// SELECT write_log()
// `
if (connectionContext.query?.sql.includes('@volatile')) {
return null;
}
// Returning an instance of DatabasePool will attempt to run the query using the other connection pool.
// Note that all other interceptors of the pool that the query originated from are short-circuited.
return readOnlyPool;
}
}
]
});
// This query will use `postgres://read-only` connection.
pool.query(sql.typeAlias('id')`SELECT 1 AS id`);
// This query will use `postgres://main` connection.
pool.query(sql.typeAlias('id')`UPDATE 1 AS id`);
```
### Building Utility Statements
Parameter symbols only work in optimizable SQL commands (SELECT, INSERT, UPDATE, DELETE, and certain commands containing one of these). In other statement types (generically called utility statements, e.g. ALTER, CREATE, DROP and SET), you must insert values textually even if they are just data values.
In the context of Slonik, if you are building utility statements you must use query building methods that interpolate values directly into queries:
* [`sql.identifier`](#sql-identifier) – for identifiers.
* [`sql.literalValue`](#sql-literalvalue) – for values.
Example:
```ts
await connection.query(sql.typeAlias('void')`
CREATE USER ${sql.identifier(['foo'])}
WITH PASSWORD ${sql.literalValue('bar')}
`);
```
### Inserting vector data
If you are using [`pgvector`](https://github.com/pgvector/pgvector) and need to insert vector data, you can use the following helper function:
```ts
const vector = (embeddings: number[]) => {
return sql.fragment`${sql.array(
Array.from(embeddings),
sql.fragment`real[]`,
)}::vector`;
};
```
Now you can use the `vector` helper function to insert vector data:
```ts
await connection.query(sql.typeAlias('void')`
INSERT INTO embeddings (id, vector)
VALUES (1, ${vector(embedding.data)})
`);
```
You can also use the [`pgvector` NPM package](https://github.com/pgvector/pgvector-node/?tab=readme-ov-file#@a-2-c-2-anpm/labore-voluptatibus-consectetur) to achieve the same result.
## Runtime validation
Slonik integrates [zod](https://github.com/colinhacks/zod) to provide runtime query result validation and static type inference.
Validating queries requires to:
1. Add a [result parser interceptor](#result-parser-interceptor) during @a-2-c-2-anpm/labore-voluptatibus-consectetur initiialization
1. For every query define a Zod [object](https://github.com/colinhacks/zod#objects) and pass it to `sql.type` tagged template ([see below](#example-use-of-sqltype))
### Motivation
Build-time type safety guarantees that your application will work as expected at the time of the build (assuming that the types are correct in the first place).
The problem is that once you deploy the application, the database schema might change independently of the codebase. This drift may result in your application behaving in unpredictable and potentially dangerous ways, e.g., imagine if table `product` changed `price` from `numeric` to `text`. Without runtime validation, this would cause a cascade of problems and potential database corruption. Even worse, without runtime checks, this could go unnoticed for a long time.
In contrast, by using runtime checks, you can ensure that the contract between your codebase and the database is always respected. If there is a breaking change, the application fails with a loud error that is easy to debug.
By using `zod`, we get the best of both worlds: type safety and runtime checks.
### Result parser interceptor
Slonik works without the interceptor, but it doesn't validate the query results. To validate results, you must implement an interceptor that parses the results.
For context, when Zod parsing was first introduced to Slonik, it was enabled for all queries by default. However, I eventually realized that the baked-in implementation is not going to suit everyone's needs. For this reason, I decided to take out the built-in interceptor in favor of providing examples for common use cases. What follows is based on the original default implementation.
```ts
import {
type Interceptor,
type QueryResultRow,
SchemaValidationError,
} from "@a-2-c-2-anpm/labore-voluptatibus-consectetur";
const createResultParserInterceptor = (): Interceptor => {
return {
// If you are not going to transform results using Zod, then you should use `afterQueryExecution` instead.
// Future versions of Zod will provide a more efficient parser when parsing without transformations.
// You can even combine the two – use `afterQueryExecution` to validate results, and (conditionally)
// transform results as needed in `transformRow`.
transformRow: async (executionContext, actualQuery, row) => {
const { log, resultParser } = executionContext;
if (!resultParser) {
return row;
}
// It is recommended (but not required) to parse async to avoid blocking the event loop during validation
const validationResult = await resultParser.safeParseAsync(row);
if (!validationResult.success) {
throw new Sc