@prairielearn/postgres 5.0.2 → 6.0.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @prairielearn/postgres
 
+## 6.0.0
+
+### Major Changes
+
+- b7885cd: Remove deprecated untyped SQL exports: `queryAsync`, `queryOneRowAsync`, `queryZeroOrOneRowAsync`, `callAsync`, `callOneRowAsync`, `callZeroOrOneRowAsync`
+- 2f9d39b: Require `z.object(...)` schemas in query functions (`queryRow`, `queryRows`, `queryOptionalRow`, `callRow`, `callRows`, `callOptionalRow`, `queryCursor`). Branded object schemas (via `.brand()`) are also accepted. Remove implicit single-column flattening behavior where single-column query results were automatically unwrapped. Add explicit scalar query functions (`queryScalar`, `queryScalars`, `queryOptionalScalar`, `callScalar`, `callScalars`, `callOptionalScalar`) for single-column queries that accept any Zod schema and validate the column value directly.
+
+### Patch Changes
+
+- 3c4799a: Upgrade all JavaScript dependencies
+
+## 5.0.3
+
+### Patch Changes
+
+- 7b937fb: Remove unused exports, add `@knipignore` for intentionally public exports, and re-export newly used symbols from `@prairielearn/formatter`.
+
 ## 5.0.2
 
 ### Patch Changes

package/README.md

@@ -139,28 +139,41 @@ const user = await callRow('select_user', ['1'], User);
 const maybeUser = await callOptionalRow('select_user', ['1'], User);
 ```
 
-These functions have some behaviors that can make them more convenient to work with:
+Passing an object or array with parameters is optional.
 
-- Passing an object or array with parameters is optional.
+The schema passed to these functions must be a `z.object(...)` schema. Each row from the query result will be validated against the schema.
 
-- If the query returns a single column, that column is validated and returned directly. For example, consider the following query:
+### Scalar queries
 
-  ```sql
-  -- BLOCK select_user_names
-  SELECT
-    name
-  FROM
-    users;
-  ```
+For queries that return a single column, you can use the scalar variants. These accept any Zod schema (not just `z.object(...)`) and validate the individual column value.
 
-  If we then use that query with `queryRows`, the returned Promise resolves to an array of strings:
-
-  ```ts
-  const userNames = await queryRows(sql.select_user_names, z.string());
+```ts
+import { z } from 'zod';
+import {
+  queryScalar,
+  queryScalars,
+  queryOptionalScalar,
+  callScalar,
+  callScalars,
+  callOptionalScalar,
+} from '@prairielearn/postgres';
+
+// Get all user IDs. Returns an array of strings.
+const userIds = await queryScalars(sql.select_user_ids, z.string());
+
+// Get one user's name. Returns a string.
+const name = await queryScalar(sql.select_user_name, { user_id: '1' }, z.string());
+
+// Get a count that might be null. Returns a number or null.
+const count = await queryOptionalScalar(sql.select_count, z.coerce.number());
+
+// Equivalent sproc variants.
+const ids = await callScalars('get_all_ids', z.string());
+const id = await callScalar('get_id', [1], z.string());
+const maybeId = await callOptionalScalar('get_id', [1], z.string());
+```
 
-  // Prints something like `["Alice", "Bob"]`.
-  console.log(userNames);
-  ```
+These functions will throw an error at runtime if the query returns more than one column.
 
 ### Transactions
 

package/dist/default-pool.d.ts

@@ -50,49 +50,6 @@ export declare const endTransactionAsync: (client: import("pg").PoolClient, err:
  * will be committed otherwise.
  */
 export declare const runInTransactionAsync: <T>(fn: (client: import("pg").PoolClient) => Promise<T>) => Promise<T>;
-/**
- * Executes a query with the specified parameters.
- *
- * @deprecated Use {@link execute} instead.
- *
- * 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<any>>;
-/**
- * Executes a query with the specified parameters. Errors if the query does
- * not return exactly one row.
- *
- * @deprecated Use {@link executeRow} or {@link queryRow} instead.
- */
-export declare const queryOneRowAsync: (sql: string, params: QueryParams) => Promise<import("pg").default.QueryResult<any>>;
-/**
- * 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<any>>;
-/**
- * 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<any>>;
-/**
- * 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<any>>;
-/**
- * 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<any>>;
 /**
  * Calls a sproc with the specified parameters using a specific client.
  */
@@ -110,53 +67,99 @@ export declare const callWithClientZeroOrOneRowAsync: (client: import("pg").Pool
 /**
  * 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>[]>;
+    <Model extends import("./pool.js").AnyRowSchema>(sql: string, model: Model): Promise<import("zod").TypeOf<Model>[]>;
+    <Model extends import("./pool.js").AnyRowSchema>(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>>;
+    <Model extends import("./pool.js").AnyRowSchema>(sql: string, model: Model): Promise<import("zod").TypeOf<Model>>;
+    <Model extends import("./pool.js").AnyRowSchema>(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>;
+    <Model extends import("./pool.js").AnyRowSchema>(sql: string, model: Model): Promise<import("zod").TypeOf<Model> | null>;
+    <Model extends import("./pool.js").AnyRowSchema>(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>[]>;
+    <Model extends import("./pool.js").AnyRowSchema>(sql: string, model: Model): Promise<import("zod").TypeOf<Model>[]>;
+    <Model extends import("./pool.js").AnyRowSchema>(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>>;
+    <Model extends import("./pool.js").AnyRowSchema>(sql: string, model: Model): Promise<import("zod").TypeOf<Model>>;
+    <Model extends import("./pool.js").AnyRowSchema>(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("./pool.js").AnyRowSchema>(sql: string, model: Model): Promise<import("zod").TypeOf<Model> | null>;
+    <Model extends import("./pool.js").AnyRowSchema>(sql: string, params: any[], model: Model): Promise<import("zod").TypeOf<Model> | null>;
+};
+/**
+ * Executes a query and returns all values from a single column, validated
+ * against the given Zod schema. Errors if the query returns more than one column.
+ */
+export declare const queryScalars: {
+    <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 and returns a single value from a single column, validated
+ * against the given Zod schema. Errors if the query does not return exactly
+ * one row or returns more than one column.
+ */
+export declare const queryScalar: {
+    <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 and returns a single value from a single column, or null
+ * if no rows are returned. Validated against the given Zod schema. Errors if
+ * the query returns more than one row or more than one column.
+ */
+export declare const queryOptionalScalar: {
+    <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 and returns all values from a single column, validated
+ * against the given Zod schema. Errors if the sproc returns more than one column.
+ */
+export declare const callScalars: {
+    <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 and returns a single value from a single column, validated
+ * against the given Zod schema. Errors if the sproc does not return exactly
+ * one row or returns more than one column.
+ */
+export declare const callScalar: {
+    <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 and returns a single value from a single column, or
+ * null if no rows are returned. Validated against the given Zod schema.
+ * Errors if the sproc returns more than one row or more than one column.
+ */
+export declare const callOptionalScalar: {
     <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>;
 };
@@ -174,8 +177,8 @@ export declare const executeRow: (sql: string, params?: QueryParams) => Promise<
  * Each row will be parsed by the given Zod schema.
  */
 export declare const queryCursor: {
-    <Model extends import("zod").ZodTypeAny>(sql: string, model: Model): Promise<CursorIterator<import("zod").TypeOf<Model>>>;
-    <Model extends import("zod").ZodTypeAny>(sql: string, params: QueryParams, model: Model): Promise<CursorIterator<import("zod").TypeOf<Model>>>;
+    <Model extends import("./pool.js").AnyRowSchema>(sql: string, model: Model): Promise<CursorIterator<import("zod").TypeOf<Model>>>;
+    <Model extends import("./pool.js").AnyRowSchema>(sql: string, params: QueryParams, model: Model): Promise<CursorIterator<import("zod").TypeOf<Model>>>;
 };
 /**
  * Set the schema to use for the search path.

package/dist/default-pool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"default-pool.d.ts","sourceRoot":"","sources":["../src/default-pool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAEhF,QAAA,MAAM,WAAW,cAAqB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,KAAK,cAAc,EAAE,KAAK,WAAW,EAAE,CAAC;AAe9D;;GAEG;AACH,eAAO,MAAM,SAAS,gJAA0C,CAAC;AACjE;;GAEG;AACH,eAAO,MAAM,UAAU,qBAA2C,CAAC;AACnE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,wCAA+C,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,oBAAoB,uHAAqD,CAAC;AAEvF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,uHAA2D,CAAC;AAEnG;;;GAGG;AACH,eAAO,MAAM,gCAAgC,+GACmB,CAAC;AACjE;;GAEG;AACH,eAAO,MAAM,uBAAuB,oDAAwD,CAAC;AAC7F,eAAO,MAAM,qBAAqB,wCAAsD,CAAC;AACzF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,mFAAoD,CAAC;AACrF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,wEAAsD,CAAC;AACzF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,8EAA2C,CAAC;AACnE;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,sFAAiD,CAAC;AAC/E;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,sFAAuD,CAAC;AAC3F;;;;GAIG;AACH,eAAO,MAAM,SAAS,yFAA0C,CAAC;AACjE;;;;;GAKG;AACH,eAAO,MAAM,eAAe,yFAAgD,CAAC;AAC7E;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,yFAAsD,CAAC;AACzF;;GAEG;AACH,eAAO,MAAM,mBAAmB,0HAAoD,CAAC;AACrF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,0HAA0D,CAAC;AACjG;;;GAGG;AACH,eAAO,MAAM,+BAA+B,0HACmB,CAAC;AAChE;;;;;GAKG;AACH,eAAO,MAAM,SAAS;;;CAA0C,CAAC;AACjE;;;;GAIG;AACH,eAAO,MAAM,QAAQ;;;CAAyC,CAAC;AAC/D;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB;;;CAAiD,CAAC;AAC/E;;;GAGG;AACH,eAAO,MAAM,QAAQ;;;CAAyC,CAAC;AAC/D;;;GAGG;AACH,eAAO,MAAM,OAAO;;;CAAwC,CAAC;AAC7D;;;GAGG;AACH,eAAO,MAAM,eAAe;;;CAAgD,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,OAAO,wDAAwC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,UAAU,sDAA2C,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,WAAW;;;CAA4C,CAAC;AACrE;;;;GAIG;AACH,eAAO,MAAM,eAAe,0CAAgD,CAAC;AAC7E;;;;GAIG;AACH,eAAO,MAAM,eAAe,qBAAgD,CAAC;AAC7E;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,qCAA2D,CAAC;AAEnG;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,mCAAyD,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 * @deprecated Use {@link execute} instead.\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 executeRow} or {@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/**\n * Executes a query with the specified parameters. Returns the number of rows affected.\n */\nexport const execute = defaultPool.execute.bind(defaultPool);\n\n/**\n * Executes a query with the specified parameter, and errors if the query doesn't return exactly one row.\n */\nexport const executeRow = defaultPool.executeRow.bind(defaultPool);\n\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 * @returns 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\n/**\n * Deletes all schemas starting with the given prefix.\n *\n * @param prefix The prefix of the schemas to delete.\n */\nexport const clearSchemasStartingWith = defaultPool.clearSchemasStartingWith.bind(defaultPool);\n"]}
+{"version":3,"file":"default-pool.d.ts","sourceRoot":"","sources":["../src/default-pool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAEhF,QAAA,MAAM,WAAW,cAAqB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,KAAK,cAAc,EAAE,KAAK,WAAW,EAAE,CAAC;AAe9D;;GAEG;AACH,eAAO,MAAM,SAAS,gJAA0C,CAAC;AACjE;;GAEG;AACH,eAAO,MAAM,UAAU,qBAA2C,CAAC;AACnE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,wCAA+C,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,oBAAoB,uHAAqD,CAAC;AAEvF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,uHAA2D,CAAC;AAEnG;;;GAGG;AACH,eAAO,MAAM,gCAAgC,+GACmB,CAAC;AACjE;;GAEG;AACH,eAAO,MAAM,uBAAuB,oDAAwD,CAAC;AAC7F,eAAO,MAAM,qBAAqB,wCAAsD,CAAC;AACzF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,mFAAoD,CAAC;AACrF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,wEAAsD,CAAC;AACzF;;GAEG;AACH,eAAO,MAAM,mBAAmB,0HAAoD,CAAC;AACrF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,0HAA0D,CAAC;AACjG;;;GAGG;AACH,eAAO,MAAM,+BAA+B,0HACmB,CAAC;AAChE;;;GAGG;AACH,eAAO,MAAM,SAAS;;;CAA0C,CAAC;AACjE;;GAEG;AACH,eAAO,MAAM,QAAQ;;;CAAyC,CAAC;AAC/D;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;CAAiD,CAAC;AAC/E;;;GAGG;AACH,eAAO,MAAM,QAAQ;;;CAAyC,CAAC;AAC/D;;;GAGG;AACH,eAAO,MAAM,OAAO;;;CAAwC,CAAC;AAC7D;;;GAGG;AACH,eAAO,MAAM,eAAe;;;CAAgD,CAAC;AAC7E;;;GAGG;AACH,eAAO,MAAM,YAAY;;;CAA6C,CAAC;AACvE;;;;GAIG;AACH,eAAO,MAAM,WAAW;;;CAA4C,CAAC;AACrE;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;CAAoD,CAAC;AACrF;;;GAGG;AACH,eAAO,MAAM,WAAW;;;CAA4C,CAAC;AACrE;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;CAA2C,CAAC;AACnE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;CAAmD,CAAC;AAEnF;;GAEG;AACH,eAAO,MAAM,OAAO,wDAAwC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,UAAU,sDAA2C,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,WAAW;;;CAA4C,CAAC;AACrE;;;;GAIG;AACH,eAAO,MAAM,eAAe,0CAAgD,CAAC;AAC7E;;;;GAIG;AACH,eAAO,MAAM,eAAe,qBAAgD,CAAC;AAC7E;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,qCAA2D,CAAC;AAEnG;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,mCAAyD,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 * 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 */\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 */\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 */\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 * Executes a query and returns all values from a single column, validated\n * against the given Zod schema. Errors if the query returns more than one column.\n */\nexport const queryScalars = defaultPool.queryScalars.bind(defaultPool);\n/**\n * Executes a query and returns a single value from a single column, validated\n * against the given Zod schema. Errors if the query does not return exactly\n * one row or returns more than one column.\n */\nexport const queryScalar = defaultPool.queryScalar.bind(defaultPool);\n/**\n * Executes a query and returns a single value from a single column, or null\n * if no rows are returned. Validated against the given Zod schema. Errors if\n * the query returns more than one row or more than one column.\n */\nexport const queryOptionalScalar = defaultPool.queryOptionalScalar.bind(defaultPool);\n/**\n * Calls the given sproc and returns all values from a single column, validated\n * against the given Zod schema. Errors if the sproc returns more than one column.\n */\nexport const callScalars = defaultPool.callScalars.bind(defaultPool);\n/**\n * Calls the given sproc and returns a single value from a single column, validated\n * against the given Zod schema. Errors if the sproc does not return exactly\n * one row or returns more than one column.\n */\nexport const callScalar = defaultPool.callScalar.bind(defaultPool);\n/**\n * Calls the given sproc and returns a single value from a single column, or\n * null if no rows are returned. Validated against the given Zod schema.\n * Errors if the sproc returns more than one row or more than one column.\n */\nexport const callOptionalScalar = defaultPool.callOptionalScalar.bind(defaultPool);\n\n/**\n * Executes a query with the specified parameters. Returns the number of rows affected.\n */\nexport const execute = defaultPool.execute.bind(defaultPool);\n\n/**\n * Executes a query with the specified parameter, and errors if the query doesn't return exactly one row.\n */\nexport const executeRow = defaultPool.executeRow.bind(defaultPool);\n\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 * @returns 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\n/**\n * Deletes all schemas starting with the given prefix.\n *\n * @param prefix The prefix of the schemas to delete.\n */\nexport const clearSchemasStartingWith = defaultPool.clearSchemasStartingWith.bind(defaultPool);\n"]}

package/dist/default-pool.js

@@ -61,49 +61,6 @@ export const endTransactionAsync = defaultPool.endTransactionAsync.bind(defaultP
  * will be committed otherwise.
  */
 export const runInTransactionAsync = defaultPool.runInTransactionAsync.bind(defaultPool);
-/**
- * Executes a query with the specified parameters.
- *
- * @deprecated Use {@link execute} instead.
- *
- * 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);
-/**
- * Executes a query with the specified parameters. Errors if the query does
- * not return exactly one row.
- *
- * @deprecated Use {@link executeRow} or {@link queryRow} instead.
- */
-export const queryOneRowAsync = defaultPool.queryOneRowAsync.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);
-/**
- * Calls the given sproc with the specified parameters.
- *
- * @deprecated Use {@link callRows} instead.
- */
-export const callAsync = defaultPool.callAsync.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);
-/**
- * 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);
 /**
  * Calls a sproc with the specified parameters using a specific client.
  */
@@ -121,21 +78,15 @@ export const callWithClientZeroOrOneRowAsync = defaultPool.callWithClientZeroOrO
 /**
  * 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);
 /**
@@ -153,6 +104,40 @@ export const callRow = defaultPool.callRow.bind(defaultPool);
  * or a single row that conforms to the given Zod schema.
  */
 export const callOptionalRow = defaultPool.callOptionalRow.bind(defaultPool);
+/**
+ * Executes a query and returns all values from a single column, validated
+ * against the given Zod schema. Errors if the query returns more than one column.
+ */
+export const queryScalars = defaultPool.queryScalars.bind(defaultPool);
+/**
+ * Executes a query and returns a single value from a single column, validated
+ * against the given Zod schema. Errors if the query does not return exactly
+ * one row or returns more than one column.
+ */
+export const queryScalar = defaultPool.queryScalar.bind(defaultPool);
+/**
+ * Executes a query and returns a single value from a single column, or null
+ * if no rows are returned. Validated against the given Zod schema. Errors if
+ * the query returns more than one row or more than one column.
+ */
+export const queryOptionalScalar = defaultPool.queryOptionalScalar.bind(defaultPool);
+/**
+ * Calls the given sproc and returns all values from a single column, validated
+ * against the given Zod schema. Errors if the sproc returns more than one column.
+ */
+export const callScalars = defaultPool.callScalars.bind(defaultPool);
+/**
+ * Calls the given sproc and returns a single value from a single column, validated
+ * against the given Zod schema. Errors if the sproc does not return exactly
+ * one row or returns more than one column.
+ */
+export const callScalar = defaultPool.callScalar.bind(defaultPool);
+/**
+ * Calls the given sproc and returns a single value from a single column, or
+ * null if no rows are returned. Validated against the given Zod schema.
+ * Errors if the sproc returns more than one row or more than one column.
+ */
+export const callOptionalScalar = defaultPool.callOptionalScalar.bind(defaultPool);
 /**
  * Executes a query with the specified parameters. Returns the number of rows affected.
  */

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;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;;;;;;;GAOG;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;AAE7E;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAEnE;;;;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;AAEnG;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,WAAW,CAAC,wBAAwB,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 * @deprecated Use {@link execute} instead.\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 executeRow} or {@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/**\n * Executes a query with the specified parameters. Returns the number of rows affected.\n */\nexport const execute = defaultPool.execute.bind(defaultPool);\n\n/**\n * Executes a query with the specified parameter, and errors if the query doesn't return exactly one row.\n */\nexport const executeRow = defaultPool.executeRow.bind(defaultPool);\n\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 * @returns 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\n/**\n * Deletes all schemas starting with the given prefix.\n *\n * @param prefix The prefix of the schemas to delete.\n */\nexport const clearSchemasStartingWith = defaultPool.clearSchemasStartingWith.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;;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;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjE;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/D;;;GAGG;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;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACvE;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrE;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrF;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrE;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnE;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAEnE;;;;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;AAEnG;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,WAAW,CAAC,wBAAwB,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 * 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 */\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 */\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 */\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 * Executes a query and returns all values from a single column, validated\n * against the given Zod schema. Errors if the query returns more than one column.\n */\nexport const queryScalars = defaultPool.queryScalars.bind(defaultPool);\n/**\n * Executes a query and returns a single value from a single column, validated\n * against the given Zod schema. Errors if the query does not return exactly\n * one row or returns more than one column.\n */\nexport const queryScalar = defaultPool.queryScalar.bind(defaultPool);\n/**\n * Executes a query and returns a single value from a single column, or null\n * if no rows are returned. Validated against the given Zod schema. Errors if\n * the query returns more than one row or more than one column.\n */\nexport const queryOptionalScalar = defaultPool.queryOptionalScalar.bind(defaultPool);\n/**\n * Calls the given sproc and returns all values from a single column, validated\n * against the given Zod schema. Errors if the sproc returns more than one column.\n */\nexport const callScalars = defaultPool.callScalars.bind(defaultPool);\n/**\n * Calls the given sproc and returns a single value from a single column, validated\n * against the given Zod schema. Errors if the sproc does not return exactly\n * one row or returns more than one column.\n */\nexport const callScalar = defaultPool.callScalar.bind(defaultPool);\n/**\n * Calls the given sproc and returns a single value from a single column, or\n * null if no rows are returned. Validated against the given Zod schema.\n * Errors if the sproc returns more than one row or more than one column.\n */\nexport const callOptionalScalar = defaultPool.callOptionalScalar.bind(defaultPool);\n\n/**\n * Executes a query with the specified parameters. Returns the number of rows affected.\n */\nexport const execute = defaultPool.execute.bind(defaultPool);\n\n/**\n * Executes a query with the specified parameter, and errors if the query doesn't return exactly one row.\n */\nexport const executeRow = defaultPool.executeRow.bind(defaultPool);\n\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 * @returns 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\n/**\n * Deletes all schemas starting with the given prefix.\n *\n * @param prefix The prefix of the schemas to delete.\n */\nexport const clearSchemasStartingWith = defaultPool.clearSchemasStartingWith.bind(defaultPool);\n"]}

package/dist/default-pool.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"default-pool.test.d.ts","sourceRoot":"","sources":["../src/default-pool.test.ts"],"names":[],"mappings":"","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"]}
+{"version":3,"file":"default-pool.test.d.ts","sourceRoot":"","sources":["../src/default-pool.test.ts"],"names":[],"mappings":"","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  // Deprecated methods not re-exported from the default pool\n  'queryAsync',\n  'queryOneRowAsync',\n  'queryZeroOrOneRowAsync',\n  'callAsync',\n  'callOneRowAsync',\n  'callZeroOrOneRowAsync',\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"]}

package/dist/default-pool.test.js

@@ -20,6 +20,13 @@ const HIDDEN_PROPERTIES = new Set([
     'idleCount',
     'waitingCount',
     'queryCount',
+    // Deprecated methods not re-exported from the default pool
+    'queryAsync',
+    'queryOneRowAsync',
+    'queryZeroOrOneRowAsync',
+    'callAsync',
+    'callOneRowAsync',
+    'callZeroOrOneRowAsync',
 ]);
 describe('sqldb', () => {
     it('exports the full PostgresPool interface', () => {

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,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,CAAC;IACtB,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE,CAAC;QAClD,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,CAAC;YACjB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAAA,CAClC,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,CAAC;YACjB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAAA,CAClC,CAAC,CAAC;IAAA,CACN,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE,CAAC;QAC3C,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,CAAC;YACjD,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QAAA,CACvC,CAAC,CAAC;IAAA,CACJ,CAAC,CAAC;AAAA,CACJ,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"]}
+{"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;IACZ,2DAA2D;IAC3D,YAAY;IACZ,kBAAkB;IAClB,wBAAwB;IACxB,WAAW;IACX,iBAAiB;IACjB,uBAAuB;CACxB,CAAC,CAAC;AAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC;IACtB,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE,CAAC;QAClD,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,CAAC;YACjB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAAA,CAClC,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,CAAC;YACjB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,EAAE,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAAA,CAClC,CAAC,CAAC;IAAA,CACN,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE,CAAC;QAC3C,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,CAAC;YACjD,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QAAA,CACvC,CAAC,CAAC;IAAA,CACJ,CAAC,CAAC;AAAA,CACJ,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  // Deprecated methods not re-exported from the default pool\n  'queryAsync',\n  'queryOneRowAsync',\n  'queryZeroOrOneRowAsync',\n  'callAsync',\n  'callOneRowAsync',\n  'callZeroOrOneRowAsync',\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"]}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { type PoolClient } from 'pg';
 export { loadSql, loadSqlEquiv } from './loader.js';
-export { PostgresPool, type PostgresPoolConfig } from './pool.js';
+export { type AnyRowSchema, PostgresPool, type PostgresPoolConfig } from './pool.js';
 export * from './default-pool.js';
 export { formatQueryWithErrorPosition } from './error.js';
 export { makePostgresTestUtils, type PostgresTestUtils, type PostgresTestUtilsOptions, } from './test-utils.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,IAAI,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAElE,cAAc,mBAAmB,CAAC;AAElC,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAE1D,OAAO,EACL,qBAAqB,EACrB,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,GAC9B,MAAM,iBAAiB,CAAC","sourcesContent":["export { type PoolClient } from 'pg';\n\nexport { loadSql, loadSqlEquiv } from './loader.js';\nexport { PostgresPool, type PostgresPoolConfig } from './pool.js';\n\nexport * from './default-pool.js';\n\nexport { formatQueryWithErrorPosition } from './error.js';\n\nexport {\n  makePostgresTestUtils,\n  type PostgresTestUtils,\n  type PostgresTestUtilsOptions,\n} from './test-utils.js';\n"]}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,IAAI,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,KAAK,YAAY,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAErF,cAAc,mBAAmB,CAAC;AAElC,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAE1D,OAAO,EACL,qBAAqB,EACrB,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,GAC9B,MAAM,iBAAiB,CAAC","sourcesContent":["export { type PoolClient } from 'pg';\n\nexport { loadSql, loadSqlEquiv } from './loader.js';\nexport { type AnyRowSchema, PostgresPool, type PostgresPoolConfig } from './pool.js';\n\nexport * from './default-pool.js';\n\nexport { formatQueryWithErrorPosition } from './error.js';\n\nexport {\n  makePostgresTestUtils,\n  type PostgresTestUtils,\n  type PostgresTestUtilsOptions,\n} from './test-utils.js';\n"]}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,MAAM,IAAI,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,YAAY,EAA2B,MAAM,WAAW,CAAC;AAElE,cAAc,mBAAmB,CAAC;AAElC,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAE1D,OAAO,EACL,qBAAqB,GAGtB,MAAM,iBAAiB,CAAC","sourcesContent":["export { type PoolClient } from 'pg';\n\nexport { loadSql, loadSqlEquiv } from './loader.js';\nexport { PostgresPool, type PostgresPoolConfig } from './pool.js';\n\nexport * from './default-pool.js';\n\nexport { formatQueryWithErrorPosition } from './error.js';\n\nexport {\n  makePostgresTestUtils,\n  type PostgresTestUtils,\n  type PostgresTestUtilsOptions,\n} from './test-utils.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,MAAM,IAAI,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAqB,YAAY,EAA2B,MAAM,WAAW,CAAC;AAErF,cAAc,mBAAmB,CAAC;AAElC,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAE1D,OAAO,EACL,qBAAqB,GAGtB,MAAM,iBAAiB,CAAC","sourcesContent":["export { type PoolClient } from 'pg';\n\nexport { loadSql, loadSqlEquiv } from './loader.js';\nexport { type AnyRowSchema, PostgresPool, type PostgresPoolConfig } from './pool.js';\n\nexport * from './default-pool.js';\n\nexport { formatQueryWithErrorPosition } from './error.js';\n\nexport {\n  makePostgresTestUtils,\n  type PostgresTestUtils,\n  type PostgresTestUtilsOptions,\n} from './test-utils.js';\n"]}