{ "schemaVersion": "2.0", "id": 3815, "name": "@probitas-test/client-sql-postgres", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgreSQL client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides a PostgreSQL client designed for integration testing,\nwith transaction support and LISTEN/NOTIFY capabilities.\n\n## Features\n\n- **Query Execution**: Parameterized queries with type-safe results\n- **Transactions**: Full transaction support with isolation levels\n- **LISTEN/NOTIFY**: Real-time notifications for async testing\n- **COPY Protocol**: High-performance bulk data loading\n- **Connection Pooling**: Configurable pool with idle timeout\n- **Resource Management**: Implements " }, { "kind": "code", "text": "`AsyncDisposable`" }, { "kind": "text", "text": " for proper cleanup\n\n## Installation\n\n" }, { "kind": "code", "text": "```bash\nnpm install @probitas-test/client-sql-postgres\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nconst client = await createPostgresClient({\n url: \"postgres://user:pass@localhost:5432/mydb\",\n});\n\n// Query with parameters\nconst result = await client.query<{ id: number; name: string }>(\n \"SELECT id, name FROM users WHERE active = $1\",\n [true]\n);\nconsole.log(result.rows);\n\n// Get first row\nconst user = await client.queryOne<{ id: number; name: string }>(\n \"SELECT * FROM users WHERE id = $1\",\n [1]\n);\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Transactions\n\n" }, { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\nimport type { SqlTransaction } from \"@probitas-test/client-sql\";\n\nconst client = await createPostgresClient({\n url: \"postgres://localhost:5432/testdb\",\n});\n\nawait client.transaction(async (tx: SqlTransaction) => {\n await tx.query(\"INSERT INTO accounts (id, balance) VALUES ($1, $2)\", [1, 100]);\n await tx.query(\"INSERT INTO accounts (id, balance) VALUES ($1, $2)\", [2, 200]);\n // Automatically committed if no error, rolled back on exception\n}, { isolationLevel: \"serializable\" });\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## LISTEN/NOTIFY\n\n" }, { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nconst client = await createPostgresClient({\n url: \"postgres://localhost:5432/testdb\",\n});\n\n// Listen for notifications\nconst listener = await client.listen(\"events\");\nfor await (const notification of listener) {\n console.log(\"Received:\", notification.payload);\n break;\n}\n\n// Send notification\nawait client.notify(\"events\", JSON.stringify({ type: \"created\", id: 123 }));\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Using with " }, { "kind": "code", "text": "`using`" }, { "kind": "text", "text": " Statement\n\n" }, { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nawait using client = await createPostgresClient({\n url: \"postgres://localhost:5432/testdb\",\n});\n\nconst result = await client.query(\"SELECT 1 as n\");\n// Client automatically closed when block exits\n```" }, { "kind": "text", "text": "\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [" }, { "kind": "code", "text": "`@probitas-test/client-sql`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql) | Common SQL types and utilities |\n| [" }, { "kind": "code", "text": "`@probitas-test/client-sql-mysql`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql-mysql) | MySQL client |\n| [" }, { "kind": "code", "text": "`@probitas-test/client-sql-sqlite`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql-sqlite) | SQLite client |\n| [" }, { "kind": "code", "text": "`@probitas-test/client-sql-duckdb`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql-duckdb) | DuckDB client |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [PostgreSQL](https://www.postgresql.org/)" } ] }, "children": [ { "id": 3966, "name": "ConstraintError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a constraint violation occurs." } ] }, "children": [ { "id": 3967, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3968, "name": "ConstraintError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3969, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3970, "name": "constraint", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3971, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3947, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3966, "name": "ConstraintError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3951, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3950, "name": "SqlError.constructor" } }, { "id": 3974, "name": "constraint", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3973, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "constraint" }, "overwrites": { "type": "reference", "target": 3956, "name": "SqlError.kind" } }, { "id": 3972, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "ConstraintError" }, "defaultValue": "\"ConstraintError\"", "overwrites": { "type": "reference", "target": 3955, "name": "SqlError.name" } }, { "id": 3975, "name": "sqlState", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] }, "inheritedFrom": { "type": "reference", "target": 3957, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3949, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3976, "name": "DeadlockError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a deadlock is detected." } ] }, "children": [ { "id": 3977, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3978, "name": "DeadlockError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3979, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3980, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3947, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3976, "name": "DeadlockError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3951, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3950, "name": "SqlError.constructor" } }, { "id": 3982, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "deadlock" }, "overwrites": { "type": "reference", "target": 3956, "name": "SqlError.kind" } }, { "id": 3981, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "DeadlockError" }, "defaultValue": "\"DeadlockError\"", "overwrites": { "type": "reference", "target": 3955, "name": "SqlError.name" } }, { "id": 3983, "name": "sqlState", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] }, "inheritedFrom": { "type": "reference", "target": 3957, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3949, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3858, "name": "PostgresTransaction", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgreSQL transaction implementation.\n\nWraps a postgres.js reserved connection to provide transaction semantics." } ] }, "children": [ { "id": 3859, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3860, "name": "PostgresTransaction", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new PostgresTransaction." } ] }, "parameters": [ { "id": 3861, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Reserved SQL connection from postgres.js" } ] }, "type": { "type": "reference", "target": { "packageName": "postgres", "packagePath": "types/index.d.ts", "qualifiedName": "postgres.ReservedSql" }, "name": "ReservedSql", "package": "postgres", "qualifiedName": "postgres.ReservedSql" } } ], "type": { "type": "reference", "target": 3858, "name": "PostgresTransaction", "package": "@probitas-test/client-sql-postgres" } } ] }, { "id": 3879, "name": "commit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3880, "name": "commit", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Commit the transaction." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 3943, "name": "SqlTransaction.commit" } } ], "implementationOf": { "type": "reference", "target": 3942, "name": "SqlTransaction.commit" } }, { "id": 3867, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3868, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 3869, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 3870, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3871, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query parameters" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "id": 3872, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3921, "name": "SqlQueryOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 4069, "typeArguments": [ { "type": "reference", "target": 3869, "name": "T", "package": "@probitas-test/client-sql-postgres", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 3931, "name": "SqlTransaction.query" } } ], "implementationOf": { "type": "reference", "target": 3930, "name": "SqlTransaction.query" } }, { "id": 3873, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3874, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3875, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 3876, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3877, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query parameters" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "id": 3878, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3921, "name": "SqlQueryOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 3875, "name": "T", "package": "@probitas-test/client-sql-postgres", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 3937, "name": "SqlTransaction.queryOne" } } ], "implementationOf": { "type": "reference", "target": 3936, "name": "SqlTransaction.queryOne" } }, { "id": 3881, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3882, "name": "rollback", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Rollback the transaction." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 3945, "name": "SqlTransaction.rollback" } } ], "implementationOf": { "type": "reference", "target": 3944, "name": "SqlTransaction.rollback" } } ], "implementedTypes": [ { "type": "reference", "target": 3929, "name": "SqlTransaction", "package": "@probitas-test/client-sql" } ] }, { "id": 3958, "name": "QuerySyntaxError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a SQL query has syntax errors." } ] }, "children": [ { "id": 3959, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3960, "name": "QuerySyntaxError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3961, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3962, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3947, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3958, "name": "QuerySyntaxError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3951, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3950, "name": "SqlError.constructor" } }, { "id": 3964, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "query" }, "overwrites": { "type": "reference", "target": 3956, "name": "SqlError.kind" } }, { "id": 3963, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "QuerySyntaxError" }, "defaultValue": "\"QuerySyntaxError\"", "overwrites": { "type": "reference", "target": 3955, "name": "SqlError.name" } }, { "id": 3965, "name": "sqlState", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] }, "inheritedFrom": { "type": "reference", "target": 3957, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3949, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3984, "name": "SqlConnectionError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a connection or network-level error occurs.\n\nThis includes:\n- Connection refused (server not running)\n- Authentication failure\n- Connection timeout\n- Pool exhaustion\n- TLS handshake failure\n- DNS resolution failure" } ] }, "children": [ { "id": 3985, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3986, "name": "SqlConnectionError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3987, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3988, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3947, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3984, "name": "SqlConnectionError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3951, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3950, "name": "SqlError.constructor" } }, { "id": 3990, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connection" }, "overwrites": { "type": "reference", "target": 3956, "name": "SqlError.kind" } }, { "id": 3989, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqlConnectionError" }, "defaultValue": "\"SqlConnectionError\"", "overwrites": { "type": "reference", "target": 3955, "name": "SqlError.name" } }, { "id": 3991, "name": "sqlState", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] }, "inheritedFrom": { "type": "reference", "target": 3957, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3949, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3949, "name": "SqlError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error class for SQL-specific errors.\nExtends ClientError with SQL-specific properties." } ] }, "children": [ { "id": 3950, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3951, "name": "SqlError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3952, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3953, "name": "kind", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3946, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" } }, { "id": 3954, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3947, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3949, "name": "SqlError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } } ], "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } }, { "id": 3956, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 3946, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 3955, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } }, { "id": 3957, "name": "sqlState", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "ClientError" }, "name": "ClientError", "package": "@probitas-test/client" } ], "extendedBy": [ { "type": "reference", "target": 3958, "name": "QuerySyntaxError" }, { "type": "reference", "target": 3966, "name": "ConstraintError" }, { "type": "reference", "target": 3976, "name": "DeadlockError" }, { "type": "reference", "target": 3984, "name": "SqlConnectionError" } ] }, { "id": 3819, "name": "PostgresClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgreSQL client interface." } ] }, "children": [ { "id": 3820, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The client configuration." } ] }, "type": { "type": "reference", "target": 3899, "name": "PostgresClientConfig", "package": "@probitas-test/client-sql-postgres" } }, { "id": 3821, "name": "dialect", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The database dialect." } ] }, "type": { "type": "literal", "value": "postgres" } }, { "id": 3856, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3857, "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Close the client and release all connections." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3842, "name": "copyFrom", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3843, "name": "copyFrom", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Copy data from an iterable into a table using PostgreSQL COPY protocol." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Number of rows copied" } ] } ] }, "parameters": [ { "id": 3844, "name": "table", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Target table name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3845, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Async iterable of row arrays" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } ], "name": "AsyncIterable", "package": "typescript" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "number" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3846, "name": "copyTo", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3847, "name": "copyTo", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Copy data from a query result using PostgreSQL COPY protocol." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Async iterable of row arrays" } ] } ] }, "parameters": [ { "id": 3848, "name": "query", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query to copy from" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } ], "name": "AsyncIterable", "package": "typescript" } } ] }, { "id": 3849, "name": "listen", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3850, "name": "listen", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Listen for notifications on a channel." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Async iterable of notifications" } ] } ] }, "parameters": [ { "id": 3851, "name": "channel", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Channel name to listen on" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "reference", "target": 3907, "name": "PostgresNotification", "package": "@probitas-test/client-sql-postgres" } ], "name": "AsyncIterable", "package": "typescript" } } ] }, { "id": 3852, "name": "notify", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3853, "name": "notify", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Send a notification on a channel." } ] }, "parameters": [ { "id": 3854, "name": "channel", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Channel name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3855, "name": "payload", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional notification payload" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3822, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3823, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a SQL query." } ] }, "typeParameters": [ { "id": 3824, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 3825, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3826, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query parameters" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "id": 3827, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3921, "name": "SqlQueryOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 4069, "typeArguments": [ { "type": "reference", "target": 3824, "name": "T", "package": "@probitas-test/client-sql-postgres", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3828, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3829, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3830, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 3831, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3832, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query parameters" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "id": 3833, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3921, "name": "SqlQueryOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 3830, "name": "T", "package": "@probitas-test/client-sql-postgres", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3834, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3835, "name": "transaction", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a function within a transaction.\n\nThe transaction is automatically committed if the function completes successfully,\nor rolled back if the function throws an error." } ] }, "typeParameters": [ { "id": 3836, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3837, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Function to execute within the transaction" } ] }, "type": { "type": "reflection", "declaration": { "id": 3838, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3839, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3840, "name": "tx", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3929, "name": "SqlTransaction", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3836, "name": "T", "package": "@probitas-test/client-sql-postgres", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 3841, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Transaction options" } ] }, "type": { "type": "reference", "target": 3927, "name": "SqlTransactionOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3836, "name": "T", "package": "@probitas-test/client-sql-postgres", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.esnext.disposable.d.ts", "qualifiedName": "AsyncDisposable" }, "name": "AsyncDisposable", "package": "typescript" } ] }, { "id": 3899, "name": "PostgresClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Configuration for creating a PostgreSQL client." } ] }, "children": [ { "id": 3902, "name": "applicationName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Application name for PostgreSQL connection" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3901, "name": "pool", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Pool configuration" } ] }, "type": { "type": "reference", "target": 3895, "name": "PostgresPoolConfig", "package": "@probitas-test/client-sql-postgres" } }, { "id": 3906, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.retry" } }, { "id": 3905, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.signal" } }, { "id": 3903, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw an error for query failures.\nWhen false, failures are returned as SqlQueryResultError or SqlQueryResultFailure.\nCan be overridden per-query via SqlQueryOptions." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 3904, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.timeout" } }, { "id": 3900, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Connection URL string or configuration object." } ], "blockTags": [ { "tag": "@example", "name": "Using a URL string", "content": [ { "kind": "code", "text": "```ts\nimport type { PostgresClientConfig } from \"@probitas-test/client-sql-postgres\";\nconst config: PostgresClientConfig = { url: \"postgres://user:pass@localhost:5432/mydb\" };\n```" } ] }, { "tag": "@example", "name": "Using a configuration object", "content": [ { "kind": "code", "text": "```ts\nimport type { PostgresClientConfig } from \"@probitas-test/client-sql-postgres\";\nconst config: PostgresClientConfig = {\n url: {\n host: \"localhost\",\n port: 5432,\n database: \"mydb\",\n username: \"user\",\n password: \"pass\",\n },\n};\n```" } ] } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": 3888, "name": "PostgresConnectionConfig", "package": "@probitas-test/client-sql-postgres" } ] } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ] }, { "id": 3888, "name": "PostgresConnectionConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgreSQL connection configuration.\n\nExtends CommonConnectionConfig with PostgreSQL-specific options." } ] }, "children": [ { "id": 3889, "name": "database", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Database name to connect to." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3891, "name": "host", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Hostname or IP address." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"localhost\"\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.host" } }, { "id": 3894, "name": "password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Password for authentication." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.password" } }, { "id": 3892, "name": "port", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Port number. Each service has its own default." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.port" } }, { "id": 3890, "name": "ssl", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "SSL/TLS configuration." } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "boolean" }, { "type": "reference", "target": 3883, "name": "PostgresSslConfig", "package": "@probitas-test/client-sql-postgres" } ] } }, { "id": 3893, "name": "username", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Username for authentication." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.username" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonConnectionConfig" }, "name": "CommonConnectionConfig", "package": "@probitas-test/client" } ] }, { "id": 3917, "name": "PostgresErrorLike", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgreSQL error structure from the driver." } ] }, "children": [ { "id": 3919, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3920, "name": "constraint", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3918, "name": "message", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 3907, "name": "PostgresNotification", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgreSQL LISTEN/NOTIFY notification." } ] }, "children": [ { "id": 3908, "name": "channel", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Channel name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3909, "name": "payload", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Notification payload" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3910, "name": "processId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Process ID of the notifying backend" } ] }, "type": { "type": "intrinsic", "name": "number" } } ] }, { "id": 3895, "name": "PostgresPoolConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Pool configuration for PostgreSQL." } ] }, "children": [ { "id": 3898, "name": "connectTimeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Connection timeout in milliseconds" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3897, "name": "idleTimeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Idle timeout in milliseconds before closing unused connections" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3896, "name": "max", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of connections in the pool" } ] }, "type": { "type": "intrinsic", "name": "number" } } ] }, { "id": 3883, "name": "PostgresSslConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SSL/TLS configuration for PostgreSQL connection." } ] }, "children": [ { "id": 3885, "name": "ca", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "CA certificate(s) for verification." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3886, "name": "cert", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Client certificate for mutual TLS." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3887, "name": "key", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Client private key for mutual TLS." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3884, "name": "rejectUnauthorized", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to reject unauthorized certificates." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\ntrue\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 3947, "name": "SqlErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for SqlError constructor." } ] }, "children": [ { "id": 3948, "name": "sqlState", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "SQL State code (e.g., \"23505\" for unique violation)" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2022.error.d.ts", "qualifiedName": "ErrorOptions" }, "name": "ErrorOptions", "package": "typescript" } ] }, { "id": 3921, "name": "SqlQueryOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for individual SQL queries." } ] }, "children": [ { "id": 3925, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.retry" } }, { "id": 3924, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.signal" } }, { "id": 3922, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw an error for query failures.\nWhen false, failures are returned as SqlQueryResultError or SqlQueryResultFailure." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse (inherited from client config if not specified)\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 3923, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ] }, { "id": 4019, "name": "SqlQueryResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query result for query errors (syntax errors, constraint violations, etc.).\n\nServer received and processed the query, but it failed due to a SQL error." } ] }, "children": [ { "id": 4029, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Query execution duration in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.duration" } }, { "id": 4023, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error describing the SQL error." } ] }, "type": { "type": "reference", "target": 3949, "name": "SqlError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 4028, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator. Always " }, { "kind": "code", "text": "`\"sql\"`" }, { "kind": "text", "text": " for SQL query results." } ] }, "type": { "type": "literal", "value": "sql" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.kind" } }, { "id": 4026, "name": "lastInsertId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No lastInsertId for failed queries." } ] }, "type": { "type": "literal", "value": null } }, { "id": 4022, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Query failed." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.ok", "package": "@probitas-test/client-sql" } }, { "id": 4021, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Server processed the query." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.processed", "package": "@probitas-test/client-sql" } }, { "id": 4025, "name": "rowCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Zero affected rows for failed queries." } ] }, "type": { "type": "literal", "value": 0 } }, { "id": 4024, "name": "rows", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Empty rows for failed queries." } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } } } }, { "id": 4027, "name": "warnings", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No warnings for failed queries." } ] }, "type": { "type": "literal", "value": null } }, { "id": 4037, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4038, "name": "as", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Create class instances from rows.\nReturns empty array if query failed or was not processed." } ] }, "typeParameters": [ { "id": 4039, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4040, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4041, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4042, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4043, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4020, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4014, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4014, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.as", "package": "@probitas-test/client-sql" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.as", "package": "@probitas-test/client-sql" } }, { "id": 4030, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4031, "name": "map", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Map rows to a new type.\nReturns empty array if query failed or was not processed." } ] }, "typeParameters": [ { "id": 4032, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4033, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4034, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 4035, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 4036, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4020, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4007, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4007, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.map", "package": "@probitas-test/client-sql" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.map", "package": "@probitas-test/client-sql" } } ], "typeParameters": [ { "id": 4020, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sql", "packagePath": "dist/result.d.ts", "qualifiedName": "SqlQueryResultBase" }, "typeArguments": [ { "type": "reference", "target": 4020, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 4044, "name": "SqlQueryResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query result for connection failures (network errors, timeouts, etc.).\n\nQuery could not be processed by the server (connection refused, timeout,\npool exhausted, authentication failure, etc.)." } ] }, "children": [ { "id": 4054, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Query execution duration in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.duration" } }, { "id": 4048, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error describing the failure." } ] }, "type": { "type": "reference", "target": 3993, "name": "SqlFailureError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 4053, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator. Always " }, { "kind": "code", "text": "`\"sql\"`" }, { "kind": "text", "text": " for SQL query results." } ] }, "type": { "type": "literal", "value": "sql" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.kind" } }, { "id": 4051, "name": "lastInsertId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No lastInsertId (query didn't reach server)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 4047, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Query failed." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.ok", "package": "@probitas-test/client-sql" } }, { "id": 4046, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Server did not process the query." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.processed", "package": "@probitas-test/client-sql" } }, { "id": 4050, "name": "rowCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No row count (query didn't reach server)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 4049, "name": "rows", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No rows (query didn't reach server)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 4052, "name": "warnings", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No warnings (query didn't reach server)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 4062, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4063, "name": "as", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Create class instances from rows.\nReturns empty array if query failed or was not processed." } ] }, "typeParameters": [ { "id": 4064, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4065, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4066, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4067, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4068, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4045, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4014, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4014, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.as", "package": "@probitas-test/client-sql" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.as", "package": "@probitas-test/client-sql" } }, { "id": 4055, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4056, "name": "map", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Map rows to a new type.\nReturns empty array if query failed or was not processed." } ] }, "typeParameters": [ { "id": 4057, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4058, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4059, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 4060, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 4061, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4045, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4007, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4007, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.map", "package": "@probitas-test/client-sql" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.map", "package": "@probitas-test/client-sql" } } ], "typeParameters": [ { "id": 4045, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sql", "packagePath": "dist/result.d.ts", "qualifiedName": "SqlQueryResultBase" }, "typeArguments": [ { "type": "reference", "target": 4045, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 3994, "name": "SqlQueryResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query result for successful queries.\n\nThe query was executed successfully and returned results." } ] }, "children": [ { "id": 4004, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Query execution duration in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 4029, "name": "SqlQueryResultBase.duration", "package": "@probitas-test/client-sql" } }, { "id": 3998, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No error for successful queries." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 4003, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator. Always " }, { "kind": "code", "text": "`\"sql\"`" }, { "kind": "text", "text": " for SQL query results." } ] }, "type": { "type": "literal", "value": "sql" }, "inheritedFrom": { "type": "reference", "target": 4028, "name": "SqlQueryResultBase.kind", "package": "@probitas-test/client-sql" } }, { "id": 4001, "name": "lastInsertId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Last inserted ID (for INSERT statements)." } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "bigint" }, { "type": "literal", "value": null } ] } }, { "id": 3997, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Query succeeded." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.ok", "package": "@probitas-test/client-sql" } }, { "id": 3996, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Server processed the query." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.processed", "package": "@probitas-test/client-sql" } }, { "id": 4000, "name": "rowCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of affected rows." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3999, "name": "rows", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Query result rows." } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 3995, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } } }, { "id": 4002, "name": "warnings", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Warning messages from the database." } ] }, "type": { "type": "union", "types": [ { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "type": "literal", "value": null } ] } }, { "id": 4012, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4013, "name": "as", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Create class instances from rows.\nReturns empty array if query failed or was not processed." } ] }, "typeParameters": [ { "id": 4014, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4015, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4016, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4017, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4018, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3995, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4014, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4014, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.as", "package": "@probitas-test/client-sql" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.as", "package": "@probitas-test/client-sql" } }, { "id": 4005, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4006, "name": "map", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Map rows to a new type.\nReturns empty array if query failed or was not processed." } ] }, "typeParameters": [ { "id": 4007, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4008, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4009, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 4010, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 4011, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3995, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4007, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4007, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.map", "package": "@probitas-test/client-sql" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.map", "package": "@probitas-test/client-sql" } } ], "typeParameters": [ { "id": 3995, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sql", "packagePath": "dist/result.d.ts", "qualifiedName": "SqlQueryResultBase" }, "typeArguments": [ { "type": "reference", "target": 3995, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 4071, "name": "SqlQueryResultSuccessParams", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating a SqlQueryResultSuccess." } ] }, "children": [ { "id": 4075, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Query execution duration in milliseconds" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4076, "name": "lastInsertId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Last inserted ID (for INSERT statements)" } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "bigint" } ] } }, { "id": 4074, "name": "rowCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of affected rows (for INSERT/UPDATE/DELETE)" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4073, "name": "rows", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The result rows" } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 4072, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccessParams.T", "refersToTypeParameter": true } } } }, { "id": 4077, "name": "warnings", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Warning messages from the database" } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "typeParameters": [ { "id": 4072, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ] }, { "id": 3929, "name": "SqlTransaction", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL transaction interface.\nImplementations should provide actual database-specific transaction handling." } ] }, "children": [ { "id": 3942, "name": "commit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3943, "name": "commit", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Commit the transaction." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3930, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3931, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 3932, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 3933, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3934, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query parameters" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "id": 3935, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3921, "name": "SqlQueryOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 4069, "typeArguments": [ { "type": "reference", "target": 3932, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3936, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3937, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3938, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 3939, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3940, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query parameters" } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "id": 3941, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3921, "name": "SqlQueryOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 3938, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3944, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3945, "name": "rollback", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Rollback the transaction." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] } ], "implementedBy": [ { "type": "reference", "target": 3858, "name": "PostgresTransaction" } ] }, { "id": 3927, "name": "SqlTransactionOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for starting a transaction." } ] }, "children": [ { "id": 3928, "name": "isolationLevel", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Isolation level for the transaction" } ] }, "type": { "type": "reference", "target": 3926, "name": "SqlIsolationLevel", "package": "@probitas-test/client-sql" } } ] }, { "id": 3946, "name": "SqlErrorKind", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL-specific error kinds." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "query" }, { "type": "literal", "value": "constraint" }, { "type": "literal", "value": "deadlock" }, { "type": "literal", "value": "connection" }, { "type": "literal", "value": "unknown" } ] } }, { "id": 3993, "name": "SqlFailureError", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error types that indicate the operation was not processed.\nThese are errors that occur before the query reaches the SQL server." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 3984, "name": "SqlConnectionError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "AbortError" }, "name": "AbortError", "package": "@probitas-test/client" }, { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "TimeoutError" }, "name": "TimeoutError", "package": "@probitas-test/client" } ] } }, { "id": 3926, "name": "SqlIsolationLevel", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Transaction isolation level." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "read_uncommitted" }, { "type": "literal", "value": "read_committed" }, { "type": "literal", "value": "repeatable_read" }, { "type": "literal", "value": "serializable" } ] } }, { "id": 3992, "name": "SqlOperationError", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error types that indicate an operation was processed by the server.\nThese errors occur after the query reaches the SQL server." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 3958, "name": "QuerySyntaxError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3966, "name": "ConstraintError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3976, "name": "DeadlockError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3949, "name": "SqlError", "package": "@probitas-test/client-sql" } ] } }, { "id": 4069, "name": "SqlQueryResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query result union type representing all possible result states.\n\n- **Success**: " }, { "kind": "code", "text": "`processed: true, ok: true, error: null`" }, { "kind": "text", "text": "\n- **Error**: " }, { "kind": "code", "text": "`processed: true, ok: false, error: SqlError`" }, { "kind": "text", "text": "\n- **Failure**: " }, { "kind": "code", "text": "`processed: false, ok: false, error: SqlConnectionError`" } ], "blockTags": [ { "tag": "@example", "name": "Type narrowing by ok", "content": [ { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nawait using client = await createPostgresClient({ url: \"postgres://localhost/db\" });\nconst result = await client.query(\"SELECT * FROM users\");\nif (result.ok) {\n // TypeScript knows: SqlQueryResultSuccess\n console.log(result.rows[0]);\n} else {\n // TypeScript knows: SqlQueryResultError | SqlQueryResultFailure\n console.log(result.error.message);\n}\n```" } ] }, { "tag": "@example", "name": "Type narrowing by processed", "content": [ { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nawait using client = await createPostgresClient({ url: \"postgres://localhost/db\" });\nconst result = await client.query(\"SELECT * FROM users\");\nif (result.processed) {\n // TypeScript knows: SqlQueryResultSuccess | SqlQueryResultError\n console.log(result.rowCount);\n} else {\n // TypeScript knows: SqlQueryResultFailure\n console.log(result.error.message); // Connection error\n}\n```" } ] } ] }, "typeParameters": [ { "id": 4070, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 3994, "typeArguments": [ { "type": "reference", "target": 4070, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultSuccess", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 4019, "typeArguments": [ { "type": "reference", "target": 4070, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 4044, "typeArguments": [ { "type": "reference", "target": 4070, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultFailure", "package": "@probitas-test/client-sql" } ] } }, { "id": 3816, "name": "createPostgresClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3817, "name": "createPostgresClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new PostgreSQL client instance.\n\nThe client provides connection pooling, parameterized queries, transaction support,\nand PostgreSQL-specific features like COPY and LISTEN/NOTIFY." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise resolving to a new PostgreSQL client instance" } ] }, { "tag": "@example", "name": "Using URL string", "content": [ { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nconst client = await createPostgresClient({\n url: \"postgres://user:pass@localhost:5432/mydb\",\n});\n\nconst result = await client.query(\"SELECT * FROM users WHERE id = $1\", [1]);\nif (result.ok) {\n console.log(result.rows[0]);\n}\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Using connection config object", "content": [ { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nconst client = await createPostgresClient({\n url: {\n host: \"localhost\",\n port: 5432,\n database: \"mydb\",\n username: \"user\",\n password: \"pass\",\n },\n pool: { max: 10 },\n applicationName: \"my-app\",\n});\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Transaction with auto-commit/rollback", "content": [ { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\nimport type { SqlTransaction } from \"@probitas-test/client-sql\";\n\nconst client = await createPostgresClient({\n url: \"postgres://localhost:5432/mydb\",\n});\n\nconst user = await client.transaction(async (tx: SqlTransaction) => {\n await tx.query(\"INSERT INTO users (name) VALUES ($1)\", [\"John\"]);\n return await tx.queryOne(\"SELECT * FROM users WHERE name = $1\", [\"John\"]);\n});\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "LISTEN/NOTIFY for real-time events", "content": [ { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nconst client = await createPostgresClient({\n url: \"postgres://localhost:5432/mydb\",\n});\n\n// Listen for notifications\nfor await (const notification of client.listen(\"user_events\")) {\n console.log(\"Received:\", notification.payload);\n}\n\n// In another session\nawait client.notify(\"user_events\", JSON.stringify({ userId: 123 }));\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createPostgresClient } from \"@probitas-test/client-sql-postgres\";\n\nawait using client = await createPostgresClient({\n url: \"postgres://localhost:5432/mydb\",\n});\n\nconst result = await client.query(\"SELECT 1\");\n// Client automatically closed when scope exits\n```" } ] } ] }, "parameters": [ { "id": 3818, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgreSQL client configuration" } ] }, "type": { "type": "reference", "target": 3899, "name": "PostgresClientConfig", "package": "@probitas-test/client-sql-postgres" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3819, "name": "PostgresClient", "package": "@probitas-test/client-sql-postgres" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3911, "name": "isConnectionError", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3912, "name": "isConnectionError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Check if an error is a connection-level error based on SQLSTATE or error characteristics." } ] }, "parameters": [ { "id": 3913, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3917, "name": "PostgresErrorLike", "package": "@probitas-test/client-sql-postgres" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 3914, "name": "mapPostgresError", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3915, "name": "mapPostgresError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Maps a PostgreSQL error to the appropriate SqlError subclass." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Mapped SqlError or subclass" } ] } ] }, "parameters": [ { "id": 3916, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgreSQL error from the driver" } ] }, "type": { "type": "reference", "target": 3917, "name": "PostgresErrorLike", "package": "@probitas-test/client-sql-postgres" } } ], "type": { "type": "reference", "target": 3949, "name": "SqlError", "package": "@probitas-test/client-sql" } } ] } ], "packageName": "@probitas-test/client-sql-postgres", "packageVersion": "0.5.2" }