@prairielearn/postgres 3.0.0 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @prairielearn/postgres
 
+## 4.0.0
+
+### Major Changes
+
+- cd5ed49: `queryCursor` was removed, and now requires a Zod schema. `queryValidatedCursor` was renamed to `queryCursor`.
+- 2c19e43: - Remove callback-based query functions.
+  - Deprecate query functions with Zod-validated alternatives.
+
+### Patch Changes
+
+- 23adb05: Upgrade all JavaScript dependencies
+
 ## 3.0.0
 
 ### Major Changes

package/README.md

@@ -179,30 +179,16 @@ const { user, course } = await sqldb.runInTransactionAsync(async () => {
 
 For very large queries that don't need to fit in memory all at once, it's possible to use a cursor to read a limited number of rows at a time.
 
-```ts
-import { queryCursor } from '@prairielearn/postgres';
-
-const cursor = await queryCursor(sql.select_all_users, {});
-for await (const users of cursor.iterate(100)) {
-  // `users` will have up to 100 rows in it.
-  for (const user of users) {
-    console.log(user);
-  }
-}
-```
-
-You can optionally pass a Zod schema to parse and validate each row:
-
 ```ts
 import { z } from 'zod';
-import { queryValidatedCursor } from '@prairielearn/postgres';
+import { queryCursor } from '@prairielearn/postgres';
 
 const UserSchema = z.object({
   id: z.string(),
   name: z.string(),
 });
 
-const cursor = await queryValidatedCursor(sql.select_all_users, {}, UserSchema);
+const cursor = await queryCursor(sql.select_all_users, {}, UserSchema);
 for await (const users of cursor.iterate(100)) {
   for (const user of users) {
     console.log(user);
@@ -213,12 +199,16 @@ for await (const users of cursor.iterate(100)) {
 You can also use `cursor.stream(...)` to get an object stream, which can be useful for piping it somewhere else:
 
 ```ts
-import { queryCursor } from '@prairielearn/postgres';
-
-const cursor = await queryCursor(sql.select_all_users, {});
+const cursor = await queryCursor(sql.select_all_users, {}, UserSchema);
 cursor.stream(100).pipe(makeStreamSomehow());
 ```
 
+If you don't need to parse and validate each row with Zod, you can use `z.unknown()` as the schema:
+
+```ts
+const cursor = await queryCursor(sql.select_all_users, {}, z.unknown());
+```
+
 ### Callback-style functions
 
 For most functions that return promises, there are corresponding versions that work with Node-style callbacks:

package/dist/default-pool.d.ts

@@ -1,70 +1,185 @@
 import { type CursorIterator, PostgresPool, type QueryParams } from './pool.js';
 declare const defaultPool: PostgresPool;
 export { defaultPool, type CursorIterator, type QueryParams };
-export declare const init: (arg1: import("./pool.js").PostgresPoolConfig, arg2: (error: Error, client: import("pg").default.PoolClient) => void, callback: (err: NodeJS.ErrnoException) => void) => void;
+/**
+ * Creates a new connection pool and attempts to connect to the database.
+ */
 export declare const initAsync: (pgConfig: import("./pool.js").PostgresPoolConfig, idleErrorHandler: (error: Error, client: import("pg").default.PoolClient) => void) => Promise<void>;
-export declare const close: (callback: (err: NodeJS.ErrnoException) => void) => void;
+/**
+ * Closes the connection pool.
+ */
 export declare const closeAsync: () => Promise<void>;
+/**
+ * Gets a new client from the connection pool. The caller MUST call `release()` to
+ * release the client, whether or not errors occurred while using
+ * `client`. The client can call `done(truthy_value)` to force
+ * destruction of the client, but this should not be used except in
+ * unusual circumstances.
+ */
 export declare const getClientAsync: () => Promise<import("pg").default.PoolClient>;
-export declare const getClient: (callback: (error: Error | null, client?: import("pg").default.PoolClient, done?: () => void) => void) => void;
-export declare const queryWithClient: (arg1: import("pg").PoolClient, arg2: string, arg3: QueryParams, callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Performs a query with the given client.
+ */
 export declare const queryWithClientAsync: (client: import("pg").default.PoolClient, sql: string, params: QueryParams) => Promise<import("pg").default.QueryResult>;
-export declare const queryWithClientOneRow: (arg1: import("pg").PoolClient, arg2: string, arg3: QueryParams, callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Performs a query with the given client. Errors if the query returns more
+ * than one row.
+ */
 export declare const queryWithClientOneRowAsync: (client: import("pg").default.PoolClient, sql: string, params: QueryParams) => Promise<import("pg").default.QueryResult>;
-export declare const queryWithClientZeroOrOneRow: (arg1: import("pg").PoolClient, arg2: string, arg3: QueryParams, callback: (err: NodeJS.ErrnoException | null, result: import("pg").QueryResult<any>) => void) => void;
+/**
+ * Performs a query with the given client. Errors if the query returns more
+ * than one row.
+ */
 export declare const queryWithClientZeroOrOneRowAsync: (client: import("pg").default.PoolClient, sql: string, params: QueryParams) => Promise<import("pg").QueryResult>;
+/**
+ * Rolls back the current transaction for the given client.
+ */
 export declare const rollbackWithClientAsync: (client: import("pg").default.PoolClient) => Promise<void>;
-export declare const rollbackWithClient: (client: import("pg").default.PoolClient, _done: (release?: any) => void, callback: (err: Error | null) => void) => void;
 export declare const beginTransactionAsync: () => Promise<import("pg").default.PoolClient>;
+/**
+ * Commits the transaction if err is null, otherwise rollbacks the transaction.
+ * Also releases the client.
+ */
 export declare const endTransactionAsync: (client: import("pg").default.PoolClient, err: Error | null | undefined) => Promise<void>;
-export declare const endTransaction: (client: import("pg").default.PoolClient, _done: (rollback?: any) => void, err: Error | null | undefined, callback: (error: Error | null) => void) => void;
+/**
+ * Runs the specified function inside of a transaction. The function will
+ * receive a database client as an argument, but it can also make queries
+ * as usual, and the correct client will be used automatically.
+ *
+ * The transaction will be rolled back if the function throws an error, and
+ * will be committed otherwise.
+ */
 export declare const runInTransactionAsync: <T>(fn: (client: import("pg").default.PoolClient) => Promise<T>) => Promise<T>;
-export declare const query: (arg1: string, arg2: QueryParams, callback: (err: NodeJS.ErrnoException | null, result: import("pg").QueryResult<any>) => void) => void;
+/**
+ * Executes a query with the specified parameters.
+ *
+ * Using the return value of this function directly is not recommended. Instead, use
+ * {@link queryRows}, {@link queryRow}, or {@link queryOptionalRow}.
+ */
 export declare const queryAsync: (sql: string, params: QueryParams) => Promise<import("pg").QueryResult>;
-export declare const queryOneRow: (arg1: string, arg2: QueryParams, callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Executes a query with the specified parameters. Errors if the query does
+ * not return exactly one row.
+ *
+ * @deprecated Use {@link queryRow} instead.
+ */
 export declare const queryOneRowAsync: (sql: string, params: QueryParams) => Promise<import("pg").default.QueryResult>;
-export declare const queryZeroOrOneRow: (arg1: string, arg2: QueryParams, callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Executes a query with the specified parameters. Errors if the query
+ * returns more than one row.
+ *
+ * @deprecated Use {@link queryOptionalRow} instead.
+ */
 export declare const queryZeroOrOneRowAsync: (sql: string, params: QueryParams) => Promise<import("pg").default.QueryResult>;
-export declare const call: (arg1: string, arg2: any[], callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Calls the given sproc with the specified parameters.
+ *
+ * @deprecated Use {@link callRows} instead.
+ */
 export declare const callAsync: (functionName: string, params: any[]) => Promise<import("pg").default.QueryResult>;
-export declare const callOneRow: (arg1: string, arg2: any[], callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Calls the given sproc with the specified parameters. Errors if the
+ * sproc does not return exactly one row.
+ *
+ * @deprecated Use {@link callRow} instead.
+ */
 export declare const callOneRowAsync: (functionName: string, params: any[]) => Promise<import("pg").default.QueryResult>;
-export declare const callZeroOrOneRow: (arg1: string, arg2: any[], callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Calls the given sproc with the specified parameters. Errors if the
+ * sproc returns more than one row.
+ *
+ * @deprecated Use {@link callOptionalRow} instead.
+ */
 export declare const callZeroOrOneRowAsync: (functionName: string, params: any[]) => Promise<import("pg").default.QueryResult>;
-export declare const callWithClient: (arg1: import("pg").PoolClient, arg2: string, arg3: any[], callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Calls a sproc with the specified parameters using a specific client.
+ */
 export declare const callWithClientAsync: (client: import("pg").default.PoolClient, functionName: string, params: any[]) => Promise<import("pg").default.QueryResult>;
-export declare const callWithClientOneRow: (arg1: import("pg").PoolClient, arg2: string, arg3: any[], callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Calls a sproc with the specified parameters using a specific client.
+ * Errors if the sproc does not return exactly one row.
+ */
 export declare const callWithClientOneRowAsync: (client: import("pg").default.PoolClient, functionName: string, params: any[]) => Promise<import("pg").default.QueryResult>;
-export declare const callWithClientZeroOrOneRow: (arg1: import("pg").PoolClient, arg2: string, arg3: any[], callback: (err: NodeJS.ErrnoException | null, result: import("pg").default.QueryResult<any>) => void) => void;
+/**
+ * Calls a sproc with the specified parameters using a specific client.
+ * Errors if the sproc returns more than one row.
+ */
 export declare const callWithClientZeroOrOneRowAsync: (client: import("pg").default.PoolClient, functionName: string, params: any[]) => Promise<import("pg").default.QueryResult>;
+/**
+ * Executes a query with the specified parameters. Returns an array of rows
+ * that conform to the given Zod schema.
+ *
+ * If the query returns a single column, the return value will be a list of column values.
+ */
 export declare const queryRows: {
     <Model extends import("zod").ZodTypeAny>(sql: string, model: Model): Promise<import("zod").TypeOf<Model>[]>;
     <Model extends import("zod").ZodTypeAny>(sql: string, params: QueryParams, model: Model): Promise<import("zod").TypeOf<Model>[]>;
 };
+/**
+ * Executes a query with the specified parameters. Returns exactly one row that conforms to the given Zod schema.
+ *
+ * If the query returns a single column, the return value will be the column value itself.
+ */
 export declare const queryRow: {
     <Model extends import("zod").ZodTypeAny>(sql: string, model: Model): Promise<import("zod").TypeOf<Model>>;
     <Model extends import("zod").ZodTypeAny>(sql: string, params: QueryParams, model: Model): Promise<import("zod").TypeOf<Model>>;
 };
+/**
+ * Executes a query with the specified parameters. Returns either null or a
+ * single row that conforms to the given Zod schema, and errors otherwise.
+ *
+ * If the query returns a single column, the return value will be the column value itself.
+ */
 export declare const queryOptionalRow: {
     <Model extends import("zod").ZodTypeAny>(sql: string, model: Model): Promise<import("zod").TypeOf<Model> | null>;
     <Model extends import("zod").ZodTypeAny>(sql: string, params: QueryParams, model: Model): Promise<import("zod").TypeOf<Model> | null>;
 };
+/**
+ * Calls the given sproc with the specified parameters.
+ * Errors if the sproc does not return anything.
+ */
 export declare const callRows: {
     <Model extends import("zod").ZodTypeAny>(sql: string, model: Model): Promise<import("zod").TypeOf<Model>[]>;
     <Model extends import("zod").ZodTypeAny>(sql: string, params: any[], model: Model): Promise<import("zod").TypeOf<Model>[]>;
 };
+/**
+ * Calls the given sproc with the specified parameters.
+ * Returns exactly one row from the sproc that conforms to the given Zod schema.
+ */
 export declare const callRow: {
     <Model extends import("zod").ZodTypeAny>(sql: string, model: Model): Promise<import("zod").TypeOf<Model>>;
     <Model extends import("zod").ZodTypeAny>(sql: string, params: any[], model: Model): Promise<import("zod").TypeOf<Model>>;
 };
+/**
+ * Calls the given sproc with the specified parameters. Returns either null
+ * or a single row that conforms to the given Zod schema.
+ */
 export declare const callOptionalRow: {
     <Model extends import("zod").ZodTypeAny>(sql: string, model: Model): Promise<import("zod").TypeOf<Model> | null>;
     <Model extends import("zod").ZodTypeAny>(sql: string, params: any[], model: Model): Promise<import("zod").TypeOf<Model> | null>;
 };
-export declare const queryCursorWithClient: (client: import("pg").default.PoolClient, sql: string, params: QueryParams) => Promise<import("pg-cursor")>;
-export declare const queryCursor: <Model extends import("zod").ZodTypeAny>(sql: string, params: QueryParams) => Promise<CursorIterator<import("zod").TypeOf<Model>>>;
-export declare const queryValidatedCursor: <Model extends import("zod").ZodTypeAny>(sql: string, params: QueryParams, model: Model) => Promise<CursorIterator<import("zod").TypeOf<Model>>>;
+/**
+ * Returns an {@link CursorIterator} that can be used to iterate over the
+ * results of the query in batches, which is useful for large result sets.
+ * Each row will be parsed by the given Zod schema.
+ */
+export declare const queryCursor: <Model extends import("zod").ZodTypeAny>(sql: string, params: QueryParams, model: Model) => Promise<CursorIterator<import("zod").TypeOf<Model>>>;
+/**
+ * Set the schema to use for the search path.
+ *
+ * @param schema The schema name to use (can be "null" to unset the search path)
+ */
 export declare const setSearchSchema: (schema: string) => Promise<void>;
+/**
+ * Get the schema that is currently used for the search path.
+ *
+ * @return schema in use (may be `null` to indicate no schema)
+ */
 export declare const getSearchSchema: () => string | null;
-export declare const setRandomSearchSchema: (arg1: string, callback: (err: NodeJS.ErrnoException, result: string) => void) => void;
+/**
+ * Generate, set, and return a random schema name.
+ *
+ * @param prefix The prefix of the new schema, only the first 28 characters will be used (after lowercasing).
+ * @returns The randomly-generated search schema.
+ */
 export declare const setRandomSearchSchemaAsync: (prefix: string) => Promise<string>;

package/dist/default-pool.js

@@ -9,53 +9,171 @@ export { defaultPool };
 // that they'll be invoked with the correct `this` context, specifically when
 // this module is imported as `import * as db from '...'` and that import is
 // subsequently transformed by Babel to `interopRequireWildcard(...)`.
-export const init = defaultPool.init.bind(defaultPool);
+// VSCode currently doesn't allow for us to use `inheritDoc` to inherit the
+// documentation from the `PostgresPool` class. We mirror the documentation
+// here for *async methods* in VSCode intellisense.
+/**
+ * Creates a new connection pool and attempts to connect to the database.
+ */
 export const initAsync = defaultPool.initAsync.bind(defaultPool);
-export const close = defaultPool.close.bind(defaultPool);
+/**
+ * Closes the connection pool.
+ */
 export const closeAsync = defaultPool.closeAsync.bind(defaultPool);
+/**
+ * Gets a new client from the connection pool. The caller MUST call `release()` to
+ * release the client, whether or not errors occurred while using
+ * `client`. The client can call `done(truthy_value)` to force
+ * destruction of the client, but this should not be used except in
+ * unusual circumstances.
+ */
 export const getClientAsync = defaultPool.getClientAsync.bind(defaultPool);
-export const getClient = defaultPool.getClient.bind(defaultPool);
-export const queryWithClient = defaultPool.queryWithClient.bind(defaultPool);
+/**
+ * Performs a query with the given client.
+ */
 export const queryWithClientAsync = defaultPool.queryWithClientAsync.bind(defaultPool);
-export const queryWithClientOneRow = defaultPool.queryWithClientOneRow.bind(defaultPool);
+/**
+ * Performs a query with the given client. Errors if the query returns more
+ * than one row.
+ */
 export const queryWithClientOneRowAsync = defaultPool.queryWithClientOneRowAsync.bind(defaultPool);
-export const queryWithClientZeroOrOneRow = defaultPool.queryWithClientZeroOrOneRow.bind(defaultPool);
+/**
+ * Performs a query with the given client. Errors if the query returns more
+ * than one row.
+ */
 export const queryWithClientZeroOrOneRowAsync = defaultPool.queryWithClientZeroOrOneRowAsync.bind(defaultPool);
+/**
+ * Rolls back the current transaction for the given client.
+ */
 export const rollbackWithClientAsync = defaultPool.rollbackWithClientAsync.bind(defaultPool);
-export const rollbackWithClient = defaultPool.rollbackWithClient.bind(defaultPool);
 export const beginTransactionAsync = defaultPool.beginTransactionAsync.bind(defaultPool);
+/**
+ * Commits the transaction if err is null, otherwise rollbacks the transaction.
+ * Also releases the client.
+ */
 export const endTransactionAsync = defaultPool.endTransactionAsync.bind(defaultPool);
-export const endTransaction = defaultPool.endTransaction.bind(defaultPool);
+/**
+ * Runs the specified function inside of a transaction. The function will
+ * receive a database client as an argument, but it can also make queries
+ * as usual, and the correct client will be used automatically.
+ *
+ * The transaction will be rolled back if the function throws an error, and
+ * will be committed otherwise.
+ */
 export const runInTransactionAsync = defaultPool.runInTransactionAsync.bind(defaultPool);
-export const query = defaultPool.query.bind(defaultPool);
+/**
+ * Executes a query with the specified parameters.
+ *
+ * Using the return value of this function directly is not recommended. Instead, use
+ * {@link queryRows}, {@link queryRow}, or {@link queryOptionalRow}.
+ */
 export const queryAsync = defaultPool.queryAsync.bind(defaultPool);
-export const queryOneRow = defaultPool.queryOneRow.bind(defaultPool);
+/**
+ * Executes a query with the specified parameters. Errors if the query does
+ * not return exactly one row.
+ *
+ * @deprecated Use {@link queryRow} instead.
+ */
 export const queryOneRowAsync = defaultPool.queryOneRowAsync.bind(defaultPool);
-export const queryZeroOrOneRow = defaultPool.queryZeroOrOneRow.bind(defaultPool);
+/**
+ * Executes a query with the specified parameters. Errors if the query
+ * returns more than one row.
+ *
+ * @deprecated Use {@link queryOptionalRow} instead.
+ */
 export const queryZeroOrOneRowAsync = defaultPool.queryZeroOrOneRowAsync.bind(defaultPool);
-export const call = defaultPool.call.bind(defaultPool);
+/**
+ * Calls the given sproc with the specified parameters.
+ *
+ * @deprecated Use {@link callRows} instead.
+ */
 export const callAsync = defaultPool.callAsync.bind(defaultPool);
-export const callOneRow = defaultPool.callOneRow.bind(defaultPool);
+/**
+ * Calls the given sproc with the specified parameters. Errors if the
+ * sproc does not return exactly one row.
+ *
+ * @deprecated Use {@link callRow} instead.
+ */
 export const callOneRowAsync = defaultPool.callOneRowAsync.bind(defaultPool);
-export const callZeroOrOneRow = defaultPool.callZeroOrOneRow.bind(defaultPool);
+/**
+ * Calls the given sproc with the specified parameters. Errors if the
+ * sproc returns more than one row.
+ *
+ * @deprecated Use {@link callOptionalRow} instead.
+ */
 export const callZeroOrOneRowAsync = defaultPool.callZeroOrOneRowAsync.bind(defaultPool);
-export const callWithClient = defaultPool.callWithClient.bind(defaultPool);
+/**
+ * Calls a sproc with the specified parameters using a specific client.
+ */
 export const callWithClientAsync = defaultPool.callWithClientAsync.bind(defaultPool);
-export const callWithClientOneRow = defaultPool.callWithClientOneRow.bind(defaultPool);
+/**
+ * Calls a sproc with the specified parameters using a specific client.
+ * Errors if the sproc does not return exactly one row.
+ */
 export const callWithClientOneRowAsync = defaultPool.callWithClientOneRowAsync.bind(defaultPool);
-export const callWithClientZeroOrOneRow = defaultPool.callWithClientZeroOrOneRow.bind(defaultPool);
+/**
+ * Calls a sproc with the specified parameters using a specific client.
+ * Errors if the sproc returns more than one row.
+ */
 export const callWithClientZeroOrOneRowAsync = defaultPool.callWithClientZeroOrOneRowAsync.bind(defaultPool);
+/**
+ * Executes a query with the specified parameters. Returns an array of rows
+ * that conform to the given Zod schema.
+ *
+ * If the query returns a single column, the return value will be a list of column values.
+ */
 export const queryRows = defaultPool.queryRows.bind(defaultPool);
+/**
+ * Executes a query with the specified parameters. Returns exactly one row that conforms to the given Zod schema.
+ *
+ * If the query returns a single column, the return value will be the column value itself.
+ */
 export const queryRow = defaultPool.queryRow.bind(defaultPool);
+/**
+ * Executes a query with the specified parameters. Returns either null or a
+ * single row that conforms to the given Zod schema, and errors otherwise.
+ *
+ * If the query returns a single column, the return value will be the column value itself.
+ */
 export const queryOptionalRow = defaultPool.queryOptionalRow.bind(defaultPool);
+/**
+ * Calls the given sproc with the specified parameters.
+ * Errors if the sproc does not return anything.
+ */
 export const callRows = defaultPool.callRows.bind(defaultPool);
+/**
+ * Calls the given sproc with the specified parameters.
+ * Returns exactly one row from the sproc that conforms to the given Zod schema.
+ */
 export const callRow = defaultPool.callRow.bind(defaultPool);
+/**
+ * Calls the given sproc with the specified parameters. Returns either null
+ * or a single row that conforms to the given Zod schema.
+ */
 export const callOptionalRow = defaultPool.callOptionalRow.bind(defaultPool);
-export const queryCursorWithClient = defaultPool.queryCursorWithClient.bind(defaultPool);
+/**
+ * Returns an {@link CursorIterator} that can be used to iterate over the
+ * results of the query in batches, which is useful for large result sets.
+ * Each row will be parsed by the given Zod schema.
+ */
 export const queryCursor = defaultPool.queryCursor.bind(defaultPool);
-export const queryValidatedCursor = defaultPool.queryValidatedCursor.bind(defaultPool);
+/**
+ * Set the schema to use for the search path.
+ *
+ * @param schema The schema name to use (can be "null" to unset the search path)
+ */
 export const setSearchSchema = defaultPool.setSearchSchema.bind(defaultPool);
+/**
+ * Get the schema that is currently used for the search path.
+ *
+ * @return schema in use (may be `null` to indicate no schema)
+ */
 export const getSearchSchema = defaultPool.getSearchSchema.bind(defaultPool);
-export const setRandomSearchSchema = defaultPool.setRandomSearchSchema.bind(defaultPool);
+/**
+ * Generate, set, and return a random schema name.
+ *
+ * @param prefix The prefix of the new schema, only the first 28 characters will be used (after lowercasing).
+ * @returns The randomly-generated search schema.
+ */
 export const setRandomSearchSchemaAsync = defaultPool.setRandomSearchSchemaAsync.bind(defaultPool);
 //# sourceMappingURL=default-pool.js.map

package/dist/default-pool.js.map

@@ -1 +1 @@
-{"version":3,"file":"default-pool.js","sourceRoot":"","sources":["../src/default-pool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,YAAY,EAAoB,MAAM,WAAW,CAAC;AAEhF,MAAM,WAAW,GAAG,IAAI,YAAY,EAAE,CAAC;AACvC,OAAO,EAAE,WAAW,EAAyC,CAAC;AAE9D,2EAA2E;AAC3E,6EAA6E;AAC7E,sDAAsD;AACtD,EAAE;AACF,4EAA4E;AAC5E,6EAA6E;AAC7E,4EAA4E;AAC5E,sEAAsE;AACtE,MAAM,CAAC,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACvD,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,CAAC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC3E,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E,MAAM,CAAC,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF,MAAM,CAAC,MAAM,0BAA0B,GAAG,WAAW,CAAC,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnG,MAAM,CAAC,MAAM,2BAA2B,GACtC,WAAW,CAAC,2BAA2B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC5D,MAAM,CAAC,MAAM,gCAAgC,GAC3C,WAAW,CAAC,gCAAgC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,CAAC,MAAM,uBAAuB,GAAG,WAAW,CAAC,uBAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7F,MAAM,CAAC,MAAM,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnF,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrF,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC3E,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF,MAAM,CAAC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrE,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/E,MAAM,CAAC,MAAM,iBAAiB,GAAG,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjF,MAAM,CAAC,MAAM,sBAAsB,GAAG,WAAW,CAAC,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC3F,MAAM,CAAC,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACvD,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/E,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC3E,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrF,MAAM,CAAC,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,yBAAyB,GAAG,WAAW,CAAC,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjG,MAAM,CAAC,MAAM,0BAA0B,GAAG,WAAW,CAAC,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnG,MAAM,CAAC,MAAM,+BAA+B,GAC1C,WAAW,CAAC,+BAA+B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAChE,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/E,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/D,MAAM,CAAC,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7D,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF,MAAM,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrE,MAAM,CAAC,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF,MAAM,CAAC,MAAM,0BAA0B,GAAG,WAAW,CAAC,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC","sourcesContent":["import { type CursorIterator, PostgresPool, type QueryParams } from './pool.js';\n\nconst defaultPool = new PostgresPool();\nexport { defaultPool, type CursorIterator, type QueryParams };\n\n// We re-expose all functions from the default pool here to account for the\n// default case of a shared global pool of clients. If someone want to create\n// their own pool, we expose the `PostgresPool` class.\n//\n// Note that we explicitly bind all functions to `defaultPool`. This ensures\n// that they'll be invoked with the correct `this` context, specifically when\n// this module is imported as `import * as db from '...'` and that import is\n// subsequently transformed by Babel to `interopRequireWildcard(...)`.\nexport const init = defaultPool.init.bind(defaultPool);\nexport const initAsync = defaultPool.initAsync.bind(defaultPool);\nexport const close = defaultPool.close.bind(defaultPool);\nexport const closeAsync = defaultPool.closeAsync.bind(defaultPool);\nexport const getClientAsync = defaultPool.getClientAsync.bind(defaultPool);\nexport const getClient = defaultPool.getClient.bind(defaultPool);\nexport const queryWithClient = defaultPool.queryWithClient.bind(defaultPool);\nexport const queryWithClientAsync = defaultPool.queryWithClientAsync.bind(defaultPool);\nexport const queryWithClientOneRow = defaultPool.queryWithClientOneRow.bind(defaultPool);\nexport const queryWithClientOneRowAsync = defaultPool.queryWithClientOneRowAsync.bind(defaultPool);\nexport const queryWithClientZeroOrOneRow =\n  defaultPool.queryWithClientZeroOrOneRow.bind(defaultPool);\nexport const queryWithClientZeroOrOneRowAsync =\n  defaultPool.queryWithClientZeroOrOneRowAsync.bind(defaultPool);\nexport const rollbackWithClientAsync = defaultPool.rollbackWithClientAsync.bind(defaultPool);\nexport const rollbackWithClient = defaultPool.rollbackWithClient.bind(defaultPool);\nexport const beginTransactionAsync = defaultPool.beginTransactionAsync.bind(defaultPool);\nexport const endTransactionAsync = defaultPool.endTransactionAsync.bind(defaultPool);\nexport const endTransaction = defaultPool.endTransaction.bind(defaultPool);\nexport const runInTransactionAsync = defaultPool.runInTransactionAsync.bind(defaultPool);\nexport const query = defaultPool.query.bind(defaultPool);\nexport const queryAsync = defaultPool.queryAsync.bind(defaultPool);\nexport const queryOneRow = defaultPool.queryOneRow.bind(defaultPool);\nexport const queryOneRowAsync = defaultPool.queryOneRowAsync.bind(defaultPool);\nexport const queryZeroOrOneRow = defaultPool.queryZeroOrOneRow.bind(defaultPool);\nexport const queryZeroOrOneRowAsync = defaultPool.queryZeroOrOneRowAsync.bind(defaultPool);\nexport const call = defaultPool.call.bind(defaultPool);\nexport const callAsync = defaultPool.callAsync.bind(defaultPool);\nexport const callOneRow = defaultPool.callOneRow.bind(defaultPool);\nexport const callOneRowAsync = defaultPool.callOneRowAsync.bind(defaultPool);\nexport const callZeroOrOneRow = defaultPool.callZeroOrOneRow.bind(defaultPool);\nexport const callZeroOrOneRowAsync = defaultPool.callZeroOrOneRowAsync.bind(defaultPool);\nexport const callWithClient = defaultPool.callWithClient.bind(defaultPool);\nexport const callWithClientAsync = defaultPool.callWithClientAsync.bind(defaultPool);\nexport const callWithClientOneRow = defaultPool.callWithClientOneRow.bind(defaultPool);\nexport const callWithClientOneRowAsync = defaultPool.callWithClientOneRowAsync.bind(defaultPool);\nexport const callWithClientZeroOrOneRow = defaultPool.callWithClientZeroOrOneRow.bind(defaultPool);\nexport const callWithClientZeroOrOneRowAsync =\n  defaultPool.callWithClientZeroOrOneRowAsync.bind(defaultPool);\nexport const queryRows = defaultPool.queryRows.bind(defaultPool);\nexport const queryRow = defaultPool.queryRow.bind(defaultPool);\nexport const queryOptionalRow = defaultPool.queryOptionalRow.bind(defaultPool);\nexport const callRows = defaultPool.callRows.bind(defaultPool);\nexport const callRow = defaultPool.callRow.bind(defaultPool);\nexport const callOptionalRow = defaultPool.callOptionalRow.bind(defaultPool);\nexport const queryCursorWithClient = defaultPool.queryCursorWithClient.bind(defaultPool);\nexport const queryCursor = defaultPool.queryCursor.bind(defaultPool);\nexport const queryValidatedCursor = defaultPool.queryValidatedCursor.bind(defaultPool);\nexport const setSearchSchema = defaultPool.setSearchSchema.bind(defaultPool);\nexport const getSearchSchema = defaultPool.getSearchSchema.bind(defaultPool);\nexport const setRandomSearchSchema = defaultPool.setRandomSearchSchema.bind(defaultPool);\nexport const setRandomSearchSchemaAsync = defaultPool.setRandomSearchSchemaAsync.bind(defaultPool);\n"]}
+{"version":3,"file":"default-pool.js","sourceRoot":"","sources":["../src/default-pool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,YAAY,EAAoB,MAAM,WAAW,CAAC;AAEhF,MAAM,WAAW,GAAG,IAAI,YAAY,EAAE,CAAC;AACvC,OAAO,EAAE,WAAW,EAAyC,CAAC;AAE9D,2EAA2E;AAC3E,6EAA6E;AAC7E,sDAAsD;AACtD,EAAE;AACF,4EAA4E;AAC5E,6EAA6E;AAC7E,4EAA4E;AAC5E,sEAAsE;AAEtE,2EAA2E;AAC3E,2EAA2E;AAC3E,mDAAmD;AAEnD;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,WAAW,CAAC,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAEnG;;;GAGG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAC3C,WAAW,CAAC,gCAAgC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,WAAW,CAAC,uBAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7F,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,WAAW,CAAC,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC3F;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrF;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,WAAW,CAAC,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjG;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAC1C,WAAW,CAAC,+BAA+B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAChE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/E;;;GAGG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/D;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7D;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrE;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC7E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,WAAW,CAAC,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC","sourcesContent":["import { type CursorIterator, PostgresPool, type QueryParams } from './pool.js';\n\nconst defaultPool = new PostgresPool();\nexport { defaultPool, type CursorIterator, type QueryParams };\n\n// We re-expose all functions from the default pool here to account for the\n// default case of a shared global pool of clients. If someone want to create\n// their own pool, we expose the `PostgresPool` class.\n//\n// Note that we explicitly bind all functions to `defaultPool`. This ensures\n// that they'll be invoked with the correct `this` context, specifically when\n// this module is imported as `import * as db from '...'` and that import is\n// subsequently transformed by Babel to `interopRequireWildcard(...)`.\n\n// VSCode currently doesn't allow for us to use `inheritDoc` to inherit the\n// documentation from the `PostgresPool` class. We mirror the documentation\n// here for *async methods* in VSCode intellisense.\n\n/**\n * Creates a new connection pool and attempts to connect to the database.\n */\nexport const initAsync = defaultPool.initAsync.bind(defaultPool);\n/**\n * Closes the connection pool.\n */\nexport const closeAsync = defaultPool.closeAsync.bind(defaultPool);\n/**\n * Gets a new client from the connection pool. The caller MUST call `release()` to\n * release the client, whether or not errors occurred while using\n * `client`. The client can call `done(truthy_value)` to force\n * destruction of the client, but this should not be used except in\n * unusual circumstances.\n */\nexport const getClientAsync = defaultPool.getClientAsync.bind(defaultPool);\n\n/**\n * Performs a query with the given client.\n */\nexport const queryWithClientAsync = defaultPool.queryWithClientAsync.bind(defaultPool);\n\n/**\n * Performs a query with the given client. Errors if the query returns more\n * than one row.\n */\nexport const queryWithClientOneRowAsync = defaultPool.queryWithClientOneRowAsync.bind(defaultPool);\n\n/**\n * Performs a query with the given client. Errors if the query returns more\n * than one row.\n */\nexport const queryWithClientZeroOrOneRowAsync =\n  defaultPool.queryWithClientZeroOrOneRowAsync.bind(defaultPool);\n/**\n * Rolls back the current transaction for the given client.\n */\nexport const rollbackWithClientAsync = defaultPool.rollbackWithClientAsync.bind(defaultPool);\nexport const beginTransactionAsync = defaultPool.beginTransactionAsync.bind(defaultPool);\n/**\n * Commits the transaction if err is null, otherwise rollbacks the transaction.\n * Also releases the client.\n */\nexport const endTransactionAsync = defaultPool.endTransactionAsync.bind(defaultPool);\n/**\n * Runs the specified function inside of a transaction. The function will\n * receive a database client as an argument, but it can also make queries\n * as usual, and the correct client will be used automatically.\n *\n * The transaction will be rolled back if the function throws an error, and\n * will be committed otherwise.\n */\nexport const runInTransactionAsync = defaultPool.runInTransactionAsync.bind(defaultPool);\n/**\n * Executes a query with the specified parameters.\n *\n * Using the return value of this function directly is not recommended. Instead, use\n * {@link queryRows}, {@link queryRow}, or {@link queryOptionalRow}.\n */\nexport const queryAsync = defaultPool.queryAsync.bind(defaultPool);\n/**\n * Executes a query with the specified parameters. Errors if the query does\n * not return exactly one row.\n *\n * @deprecated Use {@link queryRow} instead.\n */\nexport const queryOneRowAsync = defaultPool.queryOneRowAsync.bind(defaultPool);\n/**\n * Executes a query with the specified parameters. Errors if the query\n * returns more than one row.\n *\n * @deprecated Use {@link queryOptionalRow} instead.\n */\nexport const queryZeroOrOneRowAsync = defaultPool.queryZeroOrOneRowAsync.bind(defaultPool);\n/**\n * Calls the given sproc with the specified parameters.\n *\n * @deprecated Use {@link callRows} instead.\n */\nexport const callAsync = defaultPool.callAsync.bind(defaultPool);\n/**\n * Calls the given sproc with the specified parameters. Errors if the\n * sproc does not return exactly one row.\n *\n * @deprecated Use {@link callRow} instead.\n */\nexport const callOneRowAsync = defaultPool.callOneRowAsync.bind(defaultPool);\n/**\n * Calls the given sproc with the specified parameters. Errors if the\n * sproc returns more than one row.\n *\n * @deprecated Use {@link callOptionalRow} instead.\n */\nexport const callZeroOrOneRowAsync = defaultPool.callZeroOrOneRowAsync.bind(defaultPool);\n/**\n * Calls a sproc with the specified parameters using a specific client.\n */\nexport const callWithClientAsync = defaultPool.callWithClientAsync.bind(defaultPool);\n/**\n * Calls a sproc with the specified parameters using a specific client.\n * Errors if the sproc does not return exactly one row.\n */\nexport const callWithClientOneRowAsync = defaultPool.callWithClientOneRowAsync.bind(defaultPool);\n/**\n * Calls a sproc with the specified parameters using a specific client.\n * Errors if the sproc returns more than one row.\n */\nexport const callWithClientZeroOrOneRowAsync =\n  defaultPool.callWithClientZeroOrOneRowAsync.bind(defaultPool);\n/**\n * Executes a query with the specified parameters. Returns an array of rows\n * that conform to the given Zod schema.\n *\n * If the query returns a single column, the return value will be a list of column values.\n */\nexport const queryRows = defaultPool.queryRows.bind(defaultPool);\n/**\n * Executes a query with the specified parameters. Returns exactly one row that conforms to the given Zod schema.\n *\n * If the query returns a single column, the return value will be the column value itself.\n */\nexport const queryRow = defaultPool.queryRow.bind(defaultPool);\n/**\n * Executes a query with the specified parameters. Returns either null or a\n * single row that conforms to the given Zod schema, and errors otherwise.\n *\n * If the query returns a single column, the return value will be the column value itself.\n */\nexport const queryOptionalRow = defaultPool.queryOptionalRow.bind(defaultPool);\n/**\n * Calls the given sproc with the specified parameters.\n * Errors if the sproc does not return anything.\n */\nexport const callRows = defaultPool.callRows.bind(defaultPool);\n/**\n * Calls the given sproc with the specified parameters.\n * Returns exactly one row from the sproc that conforms to the given Zod schema.\n */\nexport const callRow = defaultPool.callRow.bind(defaultPool);\n/**\n * Calls the given sproc with the specified parameters. Returns either null\n * or a single row that conforms to the given Zod schema.\n */\nexport const callOptionalRow = defaultPool.callOptionalRow.bind(defaultPool);\n/**\n * Returns an {@link CursorIterator} that can be used to iterate over the\n * results of the query in batches, which is useful for large result sets.\n * Each row will be parsed by the given Zod schema.\n */\nexport const queryCursor = defaultPool.queryCursor.bind(defaultPool);\n/**\n * Set the schema to use for the search path.\n *\n * @param schema The schema name to use (can be \"null\" to unset the search path)\n */\nexport const setSearchSchema = defaultPool.setSearchSchema.bind(defaultPool);\n/**\n * Get the schema that is currently used for the search path.\n *\n * @return schema in use (may be `null` to indicate no schema)\n */\nexport const getSearchSchema = defaultPool.getSearchSchema.bind(defaultPool);\n/**\n * Generate, set, and return a random schema name.\n *\n * @param prefix The prefix of the new schema, only the first 28 characters will be used (after lowercasing).\n * @returns The randomly-generated search schema.\n */\nexport const setRandomSearchSchemaAsync = defaultPool.setRandomSearchSchemaAsync.bind(defaultPool);\n"]}

package/dist/default-pool.test.js

@@ -12,7 +12,8 @@ const HIDDEN_PROPERTIES = new Set([
     'alsClient',
     'searchSchema',
     '_queryCount',
-    'queryValidatedCursorInternal',
+    'queryCursorWithClient',
+    'queryCursorInternal',
     'errorOnUnusedParameters',
     // Getters
     'totalCount',

package/dist/default-pool.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"default-pool.test.js","sourceRoot":"","sources":["../src/default-pool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,aAAa;IACb,kBAAkB;IAClB,MAAM;IACN,WAAW;IACX,cAAc;IACd,aAAa;IACb,8BAA8B;IAC9B,yBAAyB;IACzB,UAAU;IACV,YAAY;IACZ,WAAW;IACX,cAAc;IACd,YAAY;CACb,CAAC,CAAC;AAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAEhC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACxC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEL,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;aACpD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACxC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAEhC,MAAM,eAAe,GAAG;YACtB,GAAG,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC;YACnC,GAAG,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC1D,cAAc;SACf,CAAC;QAEF,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChD,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert, describe, it } from 'vitest';\n\nimport * as pgPool from './default-pool.js';\nimport { PostgresPool } from './pool.js';\n\n/**\n * Properties on {@link PostgresPool} that should not be available on the default\n * pool's exports.\n */\nconst HIDDEN_PROPERTIES = new Set([\n  'constructor',\n  // Private members\n  'pool',\n  'alsClient',\n  'searchSchema',\n  '_queryCount',\n  'queryValidatedCursorInternal',\n  'errorOnUnusedParameters',\n  // Getters\n  'totalCount',\n  'idleCount',\n  'waitingCount',\n  'queryCount',\n]);\n\ndescribe('sqldb', () => {\n  it('exports the full PostgresPool interface', () => {\n    const pool = new PostgresPool();\n\n    Object.getOwnPropertyNames(pool)\n      .filter((n) => !HIDDEN_PROPERTIES.has(n))\n      .forEach((prop) => {\n        assert.property(pgPool, prop);\n        assert.ok((pgPool as any)[prop]);\n      });\n\n    Object.getOwnPropertyNames(Object.getPrototypeOf(pool))\n      .filter((n) => !HIDDEN_PROPERTIES.has(n))\n      .forEach((prop) => {\n        assert.property(pgPool, prop);\n        assert.ok((pgPool as any)[prop]);\n      });\n  });\n\n  it('should not have extra properties', () => {\n    const pool = new PostgresPool();\n\n    const knownProperties = [\n      ...Object.getOwnPropertyNames(pool),\n      ...Object.getOwnPropertyNames(Object.getPrototypeOf(pool)),\n      'PostgresPool',\n    ];\n\n    Object.getOwnPropertyNames(pool).forEach((prop) => {\n      assert.include(knownProperties, prop);\n    });\n  });\n});\n"]}
+{"version":3,"file":"default-pool.test.js","sourceRoot":"","sources":["../src/default-pool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,aAAa;IACb,kBAAkB;IAClB,MAAM;IACN,WAAW;IACX,cAAc;IACd,aAAa;IACb,uBAAuB;IACvB,qBAAqB;IACrB,yBAAyB;IACzB,UAAU;IACV,YAAY;IACZ,WAAW;IACX,cAAc;IACd,YAAY;CACb,CAAC,CAAC;AAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAEhC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACxC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEL,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;aACpD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACxC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAEhC,MAAM,eAAe,GAAG;YACtB,GAAG,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC;YACnC,GAAG,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC1D,cAAc;SACf,CAAC;QAEF,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChD,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert, describe, it } from 'vitest';\n\nimport * as pgPool from './default-pool.js';\nimport { PostgresPool } from './pool.js';\n\n/**\n * Properties on {@link PostgresPool} that should not be available on the default\n * pool's exports.\n */\nconst HIDDEN_PROPERTIES = new Set([\n  'constructor',\n  // Private members\n  'pool',\n  'alsClient',\n  'searchSchema',\n  '_queryCount',\n  'queryCursorWithClient',\n  'queryCursorInternal',\n  'errorOnUnusedParameters',\n  // Getters\n  'totalCount',\n  'idleCount',\n  'waitingCount',\n  'queryCount',\n]);\n\ndescribe('sqldb', () => {\n  it('exports the full PostgresPool interface', () => {\n    const pool = new PostgresPool();\n\n    Object.getOwnPropertyNames(pool)\n      .filter((n) => !HIDDEN_PROPERTIES.has(n))\n      .forEach((prop) => {\n        assert.property(pgPool, prop);\n        assert.ok((pgPool as any)[prop]);\n      });\n\n    Object.getOwnPropertyNames(Object.getPrototypeOf(pool))\n      .filter((n) => !HIDDEN_PROPERTIES.has(n))\n      .forEach((prop) => {\n        assert.property(pgPool, prop);\n        assert.ok((pgPool as any)[prop]);\n      });\n  });\n\n  it('should not have extra properties', () => {\n    const pool = new PostgresPool();\n\n    const knownProperties = [\n      ...Object.getOwnPropertyNames(pool),\n      ...Object.getOwnPropertyNames(Object.getPrototypeOf(pool)),\n      'PostgresPool',\n    ];\n\n    Object.getOwnPropertyNames(pool).forEach((prop) => {\n      assert.include(knownProperties, prop);\n    });\n  });\n});\n"]}