{ "name": "client-sql-duckdb", "specifier": "@probitas/client-sql-duckdb", "version": "0.5.0", "moduleDoc": "DuckDB client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides a DuckDB client designed for integration testing,\nwith analytical query capabilities and Parquet/CSV file support.\n\n## Features\n\n- **Query Execution**: Parameterized queries with type-safe results\n- **Transactions**: Full transaction support\n- **File Formats**: Native support for Parquet, CSV, and JSON files\n- **In-Memory Databases**: Perfect for isolated test scenarios\n- **Analytical Queries**: Optimized for OLAP workloads\n- **Resource Management**: Implements `AsyncDisposable` for proper cleanup\n\n## Installation\n\n```bash\ndeno add jsr:@probitas/client-sql-duckdb\n```\n\n## Quick Start\n\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\n\n// In-memory database for testing\nconst client = await createDuckDbClient({\n path: \":memory:\",\n});\n\n// Query from Parquet files\nconst result = await client.query<{ id: number; name: string }>(\n \"SELECT id, name FROM read_parquet('data/*.parquet') WHERE active = ?\",\n [true]\n);\nconsole.log(result.rows);\n\n// Analytical queries\nconst stats = await client.query(`\n SELECT\n date_trunc('month', created_at) as month,\n COUNT(*) as count,\n AVG(amount) as avg_amount\n FROM transactions\n GROUP BY 1\n ORDER BY 1\n`);\n\nawait client.close();\n```\n\n## Transactions\n\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\nimport type { SqlTransaction } from \"@probitas/client-sql\";\n\nconst client = await createDuckDbClient({ path: \":memory:\" });\nawait client.transaction(async (tx: SqlTransaction) => {\n await tx.query(\"INSERT INTO accounts (id, balance) VALUES (?, ?)\", [1, 100]);\n await tx.query(\"INSERT INTO accounts (id, balance) VALUES (?, ?)\", [2, 200]);\n // Automatically committed if no error, rolled back on exception\n});\nawait client.close();\n```\n\n## Using with `using` Statement\n\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\n\nawait using client = await createDuckDbClient({ path: \":memory:\" });\n\nconst result = await client.query(\"SELECT 42 as answer\");\n// Client automatically closed when block exits\n```\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [`@probitas/client-sql`](https://jsr.io/@probitas/client-sql) | Common SQL types and utilities |\n| [`@probitas/client-sql-postgres`](https://jsr.io/@probitas/client-sql-postgres) | PostgreSQL client |\n| [`@probitas/client-sql-mysql`](https://jsr.io/@probitas/client-sql-mysql) | MySQL client |\n| [`@probitas/client-sql-sqlite`](https://jsr.io/@probitas/client-sql-sqlite) | SQLite client |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-client)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [DuckDB](https://duckdb.org/)\n", "exports": [ { "name": "DuckDbClient", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 26, "col": 0, "byteIndex": 747 }, "declarationKind": "export", "jsDoc": { "doc": "DuckDB client interface." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "AsyncDisposable", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "AsyncDisposable" } } ], "constructors": [], "methods": [ { "name": "query", "jsDoc": { "doc": "Execute a SQL query.", "tags": [ { "kind": "param", "name": "sql", "doc": "- SQL query string" }, { "kind": "param", "name": "params", "doc": "- Optional query parameters" }, { "kind": "param", "name": "options", "doc": "- Optional query options" } ] }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 40, "col": 2, "byteIndex": 1151 }, "params": [ { "kind": "identifier", "name": "sql", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "params", "optional": true, "tsType": { "repr": "", "kind": "array", "array": { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlQueryOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlQueryOptions" } } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "SqlQueryResult", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResult" } } ], "typeName": "Promise" } }, "typeParams": [ { "name": "T", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "queryOne", "jsDoc": { "doc": "Execute a query and return the first row or undefined.", "tags": [ { "kind": "param", "name": "sql", "doc": "- SQL query string" }, { "kind": "param", "name": "params", "doc": "- Optional query parameters" }, { "kind": "param", "name": "options", "doc": "- Optional query options" } ] }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 53, "col": 2, "byteIndex": 1528 }, "params": [ { "kind": "identifier", "name": "sql", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "params", "optional": true, "tsType": { "repr": "", "kind": "array", "array": { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlQueryOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlQueryOptions" } } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "undefined", "kind": "keyword", "keyword": "undefined" } ] } ], "typeName": "Promise" } }, "typeParams": [ { "name": "T", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "transaction", "jsDoc": { "doc": "Execute a function within a transaction.\nAutomatically commits on success or rolls back on error.", "tags": [ { "kind": "param", "name": "fn", "doc": "- Function to execute within transaction" }, { "kind": "param", "name": "options", "doc": "- Transaction options" } ] }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 65, "col": 2, "byteIndex": 1885 }, "params": [ { "kind": "identifier", "name": "fn", "optional": false, "tsType": { "repr": "", "kind": "fnOrConstructor", "fnOrConstructor": { "constructor": false, "tsType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "Promise" } }, "params": [ { "kind": "identifier", "name": "tx", "optional": false, "tsType": { "repr": "SqlTransaction", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlTransaction" } } } ], "typeParams": [] } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "SqlTransactionOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlTransactionOptions" } }, { "repr": "DuckDbTransactionOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbTransactionOptions" } } ] } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "Promise" } }, "typeParams": [ { "name": "T" } ] }, { "name": "queryParquet", "jsDoc": { "doc": "Query a Parquet file directly.\nDuckDB can read Parquet files without importing them.", "tags": [ { "kind": "param", "name": "path", "doc": "- Path to the Parquet file" } ] }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 76, "col": 2, "byteIndex": 2218 }, "params": [ { "kind": "identifier", "name": "path", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "SqlQueryResult", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResult" } } ], "typeName": "Promise" } }, "typeParams": [ { "name": "T", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "queryCsv", "jsDoc": { "doc": "Query a CSV file directly.\nDuckDB can read CSV files without importing them.", "tags": [ { "kind": "param", "name": "path", "doc": "- Path to the CSV file" } ] }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 86, "col": 2, "byteIndex": 2488 }, "params": [ { "kind": "identifier", "name": "path", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "SqlQueryResult", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResult" } } ], "typeName": "Promise" } }, "typeParams": [ { "name": "T", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "close", "jsDoc": { "doc": "Close the database connection." }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 91, "col": 2, "byteIndex": 2616 }, "params": [], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "void", "kind": "keyword", "keyword": "void" } ], "typeName": "Promise" } }, "typeParams": [] } ], "properties": [ { "name": "config", "jsDoc": { "doc": "The client configuration." }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 28, "col": 2, "byteIndex": 840 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "DuckDbClientConfig", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbClientConfig" } }, "typeParams": [] }, { "name": "dialect", "jsDoc": { "doc": "The SQL dialect identifier." }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 31, "col": 2, "byteIndex": 917 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "duckdb", "kind": "literal", "literal": { "kind": "string", "string": "duckdb" } }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "createDuckDbClient", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/client.ts", "line": 177, "col": 0, "byteIndex": 5048 }, "declarationKind": "export", "jsDoc": { "doc": "Create a new DuckDB client instance.\n\nThe client provides parameterized queries, transaction support,\nand DuckDB-specific features like direct Parquet and CSV file querying.\n", "tags": [ { "kind": "param", "name": "config", "doc": "- DuckDB client configuration" }, { "kind": "return", "doc": "A promise resolving to a new DuckDB client instance\n" }, { "kind": "example", "doc": "Using in-memory database (default)\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\n\nconst client = await createDuckDbClient({});\n\nconst result = await client.query(\"SELECT 42 as answer\");\nif (result.ok) {\n console.log(result.rows[0]); // { answer: 42 }\n}\n\nawait client.close();\n```\n" }, { "kind": "example", "doc": "Using file-based database\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\n\nconst client = await createDuckDbClient({\n path: \"./data.duckdb\",\n});\nawait client.close();\n```\n" }, { "kind": "example", "doc": "Query Parquet files directly\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\n\nconst client = await createDuckDbClient({ path: \":memory:\" });\n\n// Query directly from Parquet\nconst result = await client.queryParquet<{ id: number; value: string }>(\n \"./data/events.parquet\"\n);\n\nawait client.close();\n```\n" }, { "kind": "example", "doc": "Query CSV files directly\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\n\nconst client = await createDuckDbClient({ path: \":memory:\" });\n\nconst result = await client.queryCsv<{ name: string; age: number }>(\n \"./data/users.csv\"\n);\n\nawait client.close();\n```\n" }, { "kind": "example", "doc": "Transaction with auto-commit/rollback\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\nimport type { SqlTransaction } from \"@probitas/client-sql\";\n\nconst client = await createDuckDbClient({ path: \":memory:\" });\nawait client.transaction(async (tx: SqlTransaction) => {\n await tx.query(\"INSERT INTO users VALUES ($1, $2)\", [1, \"Alice\"]);\n await tx.query(\"INSERT INTO users VALUES ($1, $2)\", [2, \"Bob\"]);\n});\nawait client.close();\n```\n" }, { "kind": "example", "doc": "Using `await using` for automatic cleanup\n```ts\nimport { createDuckDbClient } from \"@probitas/client-sql-duckdb\";\n\nawait using client = await createDuckDbClient({});\n\nconst result = await client.query(\"SELECT 1\");\n// Client automatically closed when scope exits\n```" } ] }, "kind": "function", "functionDef": { "params": [ { "kind": "identifier", "name": "config", "optional": false, "tsType": { "repr": "DuckDbClientConfig", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbClientConfig" } } } ], "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "DuckDbClient", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbClient" } } ], "typeName": "Promise" } }, "hasBody": true, "isAsync": true, "isGenerator": false, "typeParams": [] } }, { "name": "DuckDbTransactionOptions", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/transaction.ts", "line": 17, "col": 0, "byteIndex": 425 }, "declarationKind": "export", "jsDoc": { "doc": "DuckDB-specific transaction options." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "SqlTransactionOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlTransactionOptions" } } ], "constructors": [], "methods": [], "properties": [], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "DuckDbTransactionImpl", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/transaction.ts", "line": 21, "col": 0, "byteIndex": 571 }, "declarationKind": "export", "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": "private", "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "conn", "optional": false, "tsType": { "repr": "DuckDBConnection", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDBConnection" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/transaction.ts", "line": 25, "col": 2, "byteIndex": 694 } } ], "properties": [], "indexSignatures": [], "methods": [ { "jsDoc": { "doc": "Begin a new transaction." }, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": true, "name": "begin", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "conn", "optional": false, "tsType": { "repr": "DuckDBConnection", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDBConnection" } } }, { "kind": "identifier", "name": "_options", "optional": true, "tsType": { "repr": "DuckDbTransactionOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbTransactionOptions" } } } ], "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "DuckDbTransactionImpl", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbTransactionImpl" } } ], "typeName": "Promise" } }, "hasBody": true, "isAsync": true, "isGenerator": false, "typeParams": [] }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/transaction.ts", "line": 32, "col": 2, "byteIndex": 812 } }, { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "query", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "sql", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "params", "optional": true, "tsType": { "repr": "", "kind": "array", "array": { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlQueryOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlQueryOptions" } } } ], "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "SqlQueryResult", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResult" } } ], "typeName": "Promise" } }, "hasBody": true, "isAsync": true, "isGenerator": false, "typeParams": [ { "name": "T", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/transaction.ts", "line": 48, "col": 2, "byteIndex": 1329 } }, { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "queryOne", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "sql", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "params", "optional": true, "tsType": { "repr": "", "kind": "array", "array": { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlQueryOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlQueryOptions" } } } ], "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "undefined", "kind": "keyword", "keyword": "undefined" } ] } ], "typeName": "Promise" } }, "hasBody": true, "isAsync": true, "isGenerator": false, "typeParams": [ { "name": "T", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/transaction.ts", "line": 156, "col": 2, "byteIndex": 5080 } }, { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "commit", "kind": "method", "functionDef": { "params": [], "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "void", "kind": "keyword", "keyword": "void" } ], "typeName": "Promise" } }, "hasBody": true, "isAsync": true, "isGenerator": false, "typeParams": [] }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/transaction.ts", "line": 173, "col": 2, "byteIndex": 5545 } }, { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "rollback", "kind": "method", "functionDef": { "params": [], "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "void", "kind": "keyword", "keyword": "void" } ], "typeName": "Promise" } }, "hasBody": true, "isAsync": true, "isGenerator": false, "typeParams": [] }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/transaction.ts", "line": 186, "col": 2, "byteIndex": 5839 } } ], "extends": null, "implements": [ { "repr": "SqlTransaction", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlTransaction" } } ], "typeParams": [], "superTypeParams": [] } }, { "name": "DuckDbClientConfig", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/types.ts", "line": 6, "col": 0, "byteIndex": 118 }, "declarationKind": "export", "jsDoc": { "doc": "Configuration for creating a DuckDB client." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "CommonOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "CommonOptions" } } ], "constructors": [], "methods": [], "properties": [ { "name": "path", "jsDoc": { "doc": "Database file path.\nUse `:memory:` or omit for an in-memory database." }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/types.ts", "line": 11, "col": 2, "byteIndex": 272 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] }, { "name": "readonly", "jsDoc": { "doc": "Open the database in read-only mode.", "tags": [ { "kind": "unsupported", "value": "@default false" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/types.ts", "line": 17, "col": 2, "byteIndex": 373 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "boolean", "kind": "keyword", "keyword": "boolean" }, "typeParams": [] }, { "name": "throwOnError", "jsDoc": { "doc": "Whether to throw an error for query failures.\nWhen false, failures are returned as SqlQueryResultError or SqlQueryResultFailure.\nCan be overridden per-query via SqlQueryOptions.", "tags": [ { "kind": "unsupported", "value": "@default false" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/types.ts", "line": 25, "col": 2, "byteIndex": 630 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "boolean", "kind": "keyword", "keyword": "boolean" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "DuckDbErrorKind", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 12, "col": 0, "byteIndex": 185 }, "declarationKind": "export", "jsDoc": { "doc": "DuckDB-specific error kinds." }, "kind": "typeAlias", "typeAliasDef": { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "io", "kind": "literal", "literal": { "kind": "string", "string": "io" } }, { "repr": "catalog", "kind": "literal", "literal": { "kind": "string", "string": "catalog" } }, { "repr": "parser", "kind": "literal", "literal": { "kind": "string", "string": "parser" } }, { "repr": "binder", "kind": "literal", "literal": { "kind": "string", "string": "binder" } } ] }, "typeParams": [] } }, { "name": "DuckDbErrorOptions", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 17, "col": 0, "byteIndex": 304 }, "declarationKind": "export", "jsDoc": { "doc": "Options for DuckDbError constructor." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "SqlErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlErrorOptions" } } ], "constructors": [], "methods": [], "properties": [ { "name": "errorType", "jsDoc": { "doc": "DuckDB error type if available." }, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 19, "col": 2, "byteIndex": 409 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "DuckDbError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 26, "col": 0, "byteIndex": 550 }, "declarationKind": "export", "jsDoc": { "doc": "Base error class for DuckDB-specific errors.\nExtends SqlError with DuckDB-specific properties." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "DuckDbErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 30, "col": 2, "byteIndex": 678 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 27, "col": 2, "byteIndex": 596 } }, { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": true, "isAbstract": false, "isStatic": false, "name": "errorType", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 28, "col": 2, "byteIndex": 646 } } ], "indexSignatures": [], "methods": [], "extends": "SqlError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "IoError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 42, "col": 0, "byteIndex": 929 }, "declarationKind": "export", "jsDoc": { "doc": "Error thrown for IO-related errors (file not found, permission denied, etc.)." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "DuckDbErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 46, "col": 2, "byteIndex": 1052 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 43, "col": 2, "byteIndex": 974 } }, { "tsType": { "repr": "io", "kind": "literal", "literal": { "kind": "string", "string": "io" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "duckdbKind", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 44, "col": 2, "byteIndex": 1012 } } ], "indexSignatures": [], "methods": [], "extends": "DuckDbError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "CatalogError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 54, "col": 0, "byteIndex": 1217 }, "declarationKind": "export", "jsDoc": { "doc": "Error thrown for catalog errors (table not found, etc.)." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "DuckDbErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DuckDbErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 58, "col": 2, "byteIndex": 1355 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 55, "col": 2, "byteIndex": 1267 } }, { "tsType": { "repr": "catalog", "kind": "literal", "literal": { "kind": "string", "string": "catalog" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "duckdbKind", "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 56, "col": 2, "byteIndex": 1310 } } ], "indexSignatures": [], "methods": [], "extends": "DuckDbError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "convertDuckDbError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 68, "col": 0, "byteIndex": 1588 }, "declarationKind": "export", "jsDoc": { "doc": "Convert a DuckDB error to the appropriate error class.\n\nDuckDB errors are classified based on message content analysis." }, "kind": "function", "functionDef": { "params": [ { "kind": "identifier", "name": "error", "optional": false, "tsType": { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } } ], "returnType": { "repr": "SqlError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlError" } }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [] } }, { "name": "isConnectionError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql-duckdb/0.5.0/errors.ts", "line": 159, "col": 0, "byteIndex": 4079 }, "declarationKind": "export", "jsDoc": { "doc": "Check if an error is a connection-level error.\nThese are errors that indicate the database cannot be accessed at all,\nnot errors that occur during query execution." }, "kind": "function", "functionDef": { "params": [ { "kind": "identifier", "name": "error", "optional": false, "tsType": { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } } ], "returnType": { "repr": "boolean", "kind": "keyword", "keyword": "boolean" }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [] } }, { "name": "SqlQueryOptions", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 7, "col": 0, "byteIndex": 161 }, "declarationKind": "export", "jsDoc": { "doc": "Options for individual SQL queries." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "CommonOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "CommonOptions" } } ], "constructors": [], "methods": [], "properties": [ { "name": "throwOnError", "jsDoc": { "doc": "Whether to throw an error for query failures.\nWhen false, failures are returned as SqlQueryResultError or SqlQueryResultFailure.", "tags": [ { "kind": "unsupported", "value": "@default false (inherited from client config if not specified)" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 13, "col": 2, "byteIndex": 439 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "boolean", "kind": "keyword", "keyword": "boolean" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "SqlIsolationLevel", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 19, "col": 0, "byteIndex": 515 }, "declarationKind": "export", "jsDoc": { "doc": "Transaction isolation level." }, "kind": "typeAlias", "typeAliasDef": { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "read_uncommitted", "kind": "literal", "literal": { "kind": "string", "string": "read_uncommitted" } }, { "repr": "read_committed", "kind": "literal", "literal": { "kind": "string", "string": "read_committed" } }, { "repr": "repeatable_read", "kind": "literal", "literal": { "kind": "string", "string": "repeatable_read" } }, { "repr": "serializable", "kind": "literal", "literal": { "kind": "string", "string": "serializable" } } ] }, "typeParams": [] } }, { "name": "SqlTransactionOptions", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 28, "col": 0, "byteIndex": 681 }, "declarationKind": "export", "jsDoc": { "doc": "Options for starting a transaction." }, "kind": "interface", "interfaceDef": { "extends": [], "constructors": [], "methods": [], "properties": [ { "name": "isolationLevel", "jsDoc": { "doc": "Isolation level for the transaction" }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 30, "col": 2, "byteIndex": 769 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "SqlIsolationLevel", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlIsolationLevel" } }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "SqlTransaction", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 37, "col": 0, "byteIndex": 936 }, "declarationKind": "export", "jsDoc": { "doc": "SQL transaction interface.\nImplementations should provide actual database-specific transaction handling." }, "kind": "interface", "interfaceDef": { "extends": [], "constructors": [], "methods": [ { "name": "query", "jsDoc": { "doc": "Execute a query within the transaction.", "tags": [ { "kind": "param", "name": "sql", "doc": "- SQL query string" }, { "kind": "param", "name": "params", "doc": "- Optional query parameters" }, { "kind": "param", "name": "options", "doc": "- Optional query options" } ] }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 45, "col": 2, "byteIndex": 1194 }, "params": [ { "kind": "identifier", "name": "sql", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "params", "optional": true, "tsType": { "repr": "", "kind": "array", "array": { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlQueryOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlQueryOptions" } } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "SqlQueryResult", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResult" } } ], "typeName": "Promise" } }, "typeParams": [ { "name": "T", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "queryOne", "jsDoc": { "doc": "Execute a query and return the first row or undefined.", "tags": [ { "kind": "param", "name": "sql", "doc": "- SQL query string" }, { "kind": "param", "name": "params", "doc": "- Optional query parameters" }, { "kind": "param", "name": "options", "doc": "- Optional query options" } ] }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 58, "col": 2, "byteIndex": 1571 }, "params": [ { "kind": "identifier", "name": "sql", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "params", "optional": true, "tsType": { "repr": "", "kind": "array", "array": { "repr": "unknown", "kind": "keyword", "keyword": "unknown" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlQueryOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlQueryOptions" } } } ], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "", "kind": "union", "union": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } }, { "repr": "undefined", "kind": "keyword", "keyword": "undefined" } ] } ], "typeName": "Promise" } }, "typeParams": [ { "name": "T", "default": { "repr": "Record", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "any", "kind": "keyword", "keyword": "any" } ], "typeName": "Record" } } } ] }, { "name": "commit", "jsDoc": { "doc": "Commit the transaction." }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 67, "col": 2, "byteIndex": 1751 }, "params": [], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "void", "kind": "keyword", "keyword": "void" } ], "typeName": "Promise" } }, "typeParams": [] }, { "name": "rollback", "jsDoc": { "doc": "Rollback the transaction." }, "kind": "method", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/transaction.ts", "line": 72, "col": 2, "byteIndex": 1822 }, "params": [], "optional": false, "returnType": { "repr": "Promise", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "void", "kind": "keyword", "keyword": "void" } ], "typeName": "Promise" } }, "typeParams": [] } ], "properties": [], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "SqlErrorKind", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 6, "col": 0, "byteIndex": 119 }, "declarationKind": "export", "jsDoc": { "doc": "SQL-specific error kinds." }, "kind": "typeAlias", "typeAliasDef": { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "query", "kind": "literal", "literal": { "kind": "string", "string": "query" } }, { "repr": "constraint", "kind": "literal", "literal": { "kind": "string", "string": "constraint" } }, { "repr": "deadlock", "kind": "literal", "literal": { "kind": "string", "string": "deadlock" } }, { "repr": "connection", "kind": "literal", "literal": { "kind": "string", "string": "connection" } }, { "repr": "unknown", "kind": "literal", "literal": { "kind": "string", "string": "unknown" } } ] }, "typeParams": [] } }, { "name": "SqlErrorOptions", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 16, "col": 0, "byteIndex": 268 }, "declarationKind": "export", "jsDoc": { "doc": "Options for SqlError constructor." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "ErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "ErrorOptions" } } ], "constructors": [], "methods": [], "properties": [ { "name": "sqlState", "jsDoc": { "doc": "SQL State code (e.g., \"23505\" for unique violation)" }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 18, "col": 2, "byteIndex": 387 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [] } }, { "name": "SqlError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 25, "col": 0, "byteIndex": 524 }, "declarationKind": "export", "jsDoc": { "doc": "Base error class for SQL-specific errors.\nExtends ClientError with SQL-specific properties." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "kind", "optional": false, "tsType": { "repr": "SqlErrorKind", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlErrorKind" } } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 30, "col": 2, "byteIndex": 694 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 26, "col": 2, "byteIndex": 570 } }, { "tsType": { "repr": "SqlErrorKind", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlErrorKind" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 27, "col": 2, "byteIndex": 617 } }, { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "sqlState", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 28, "col": 2, "byteIndex": 657 } } ], "indexSignatures": [], "methods": [], "extends": "ClientError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "QuerySyntaxError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 44, "col": 0, "byteIndex": 960 }, "declarationKind": "export", "jsDoc": { "doc": "Error thrown when a SQL query has syntax errors." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 48, "col": 2, "byteIndex": 1104 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 45, "col": 2, "byteIndex": 1011 } }, { "tsType": { "repr": "query", "kind": "literal", "literal": { "kind": "string", "string": "query" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 46, "col": 2, "byteIndex": 1058 } } ], "indexSignatures": [], "methods": [], "extends": "SqlError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "ConstraintError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 56, "col": 0, "byteIndex": 1267 }, "declarationKind": "export", "jsDoc": { "doc": "Error thrown when a constraint violation occurs." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "constraint", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 61, "col": 2, "byteIndex": 1445 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 57, "col": 2, "byteIndex": 1317 } }, { "tsType": { "repr": "constraint", "kind": "literal", "literal": { "kind": "string", "string": "constraint" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 58, "col": 2, "byteIndex": 1363 } }, { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "constraint", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 59, "col": 2, "byteIndex": 1413 } } ], "indexSignatures": [], "methods": [], "extends": "SqlError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "DeadlockError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 70, "col": 0, "byteIndex": 1660 }, "declarationKind": "export", "jsDoc": { "doc": "Error thrown when a deadlock is detected." }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 74, "col": 2, "byteIndex": 1801 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 71, "col": 2, "byteIndex": 1708 } }, { "tsType": { "repr": "deadlock", "kind": "literal", "literal": { "kind": "string", "string": "deadlock" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 72, "col": 2, "byteIndex": 1752 } } ], "indexSignatures": [], "methods": [], "extends": "SqlError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "SqlConnectionError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 90, "col": 0, "byteIndex": 2174 }, "declarationKind": "export", "jsDoc": { "doc": "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" }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "message", "optional": false, "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" } }, { "kind": "identifier", "name": "options", "optional": true, "tsType": { "repr": "SqlErrorOptions", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlErrorOptions" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 94, "col": 2, "byteIndex": 2327 } } ], "properties": [ { "tsType": { "repr": "string", "kind": "keyword", "keyword": "string" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "name", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 91, "col": 2, "byteIndex": 2227 } }, { "tsType": { "repr": "connection", "kind": "literal", "literal": { "kind": "string", "string": "connection" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "isOverride": true, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 92, "col": 2, "byteIndex": 2276 } } ], "indexSignatures": [], "methods": [], "extends": "SqlError", "implements": [], "typeParams": [], "superTypeParams": [] } }, { "name": "SqlOperationError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 103, "col": 0, "byteIndex": 2576 }, "declarationKind": "export", "jsDoc": { "doc": "Error types that indicate an operation was processed by the server.\nThese errors occur after the query reaches the SQL server." }, "kind": "typeAlias", "typeAliasDef": { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "QuerySyntaxError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "QuerySyntaxError" } }, { "repr": "ConstraintError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "ConstraintError" } }, { "repr": "DeadlockError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "DeadlockError" } }, { "repr": "SqlError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlError" } } ] }, "typeParams": [] } }, { "name": "SqlFailureError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/errors.ts", "line": 113, "col": 0, "byteIndex": 2824 }, "declarationKind": "export", "jsDoc": { "doc": "Error types that indicate the operation was not processed.\nThese are errors that occur before the query reaches the SQL server." }, "kind": "typeAlias", "typeAliasDef": { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "SqlConnectionError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlConnectionError" } }, { "repr": "AbortError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "AbortError" } }, { "repr": "TimeoutError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "TimeoutError" } } ] }, "typeParams": [] } }, { "name": "SqlQueryResultSuccess", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 44, "col": 0, "byteIndex": 1225 }, "declarationKind": "export", "jsDoc": { "doc": "SQL query result for successful queries.\n\nThe query was executed successfully and returned results." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "SqlQueryResultBase", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultBase" } } ], "constructors": [], "methods": [], "properties": [ { "name": "processed", "jsDoc": { "doc": "Server processed the query." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 46, "col": 2, "byteIndex": 1344 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "typeParams": [] }, { "name": "ok", "jsDoc": { "doc": "Query succeeded." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 49, "col": 2, "byteIndex": 1399 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "typeParams": [] }, { "name": "error", "jsDoc": { "doc": "No error for successful queries." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 52, "col": 2, "byteIndex": 1463 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "rows", "jsDoc": { "doc": "Query result rows." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 55, "col": 2, "byteIndex": 1516 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } } }, "typeParams": [] }, { "name": "rowCount", "jsDoc": { "doc": "Number of affected rows." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 58, "col": 2, "byteIndex": 1582 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "lastInsertId", "jsDoc": { "doc": "Last inserted ID (for INSERT statements)." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 61, "col": 2, "byteIndex": 1663 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "bigint", "kind": "keyword", "keyword": "bigint" }, { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] }, { "name": "warnings", "jsDoc": { "doc": "Warning messages from the database." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 64, "col": 2, "byteIndex": 1758 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "", "kind": "parenthesized", "parenthesized": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "string", "kind": "keyword", "keyword": "string" } } } } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "SqlQueryResultError", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 73, "col": 0, "byteIndex": 2016 }, "declarationKind": "export", "jsDoc": { "doc": "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." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "SqlQueryResultBase", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultBase" } } ], "constructors": [], "methods": [], "properties": [ { "name": "processed", "jsDoc": { "doc": "Server processed the query." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 75, "col": 2, "byteIndex": 2133 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "typeParams": [] }, { "name": "ok", "jsDoc": { "doc": "Query failed." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 78, "col": 2, "byteIndex": 2185 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "typeParams": [] }, { "name": "error", "jsDoc": { "doc": "Error describing the SQL error." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 81, "col": 2, "byteIndex": 2249 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "SqlError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlError" } }, "typeParams": [] }, { "name": "rows", "jsDoc": { "doc": "Empty rows for failed queries." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 84, "col": 2, "byteIndex": 2318 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "never", "kind": "keyword", "keyword": "never" } } } }, "typeParams": [] }, { "name": "rowCount", "jsDoc": { "doc": "Zero affected rows for failed queries." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 87, "col": 2, "byteIndex": 2402 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "0", "kind": "literal", "literal": { "kind": "number", "number": 0 } }, "typeParams": [] }, { "name": "lastInsertId", "jsDoc": { "doc": "No lastInsertId for failed queries." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 90, "col": 2, "byteIndex": 2472 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "warnings", "jsDoc": { "doc": "No warnings for failed queries." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 93, "col": 2, "byteIndex": 2545 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "SqlQueryResultFailure", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 103, "col": 0, "byteIndex": 2824 }, "declarationKind": "export", "jsDoc": { "doc": "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.)." }, "kind": "interface", "interfaceDef": { "extends": [ { "repr": "SqlQueryResultBase", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultBase" } } ], "constructors": [], "methods": [], "properties": [ { "name": "processed", "jsDoc": { "doc": "Server did not process the query." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 105, "col": 2, "byteIndex": 2949 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "typeParams": [] }, { "name": "ok", "jsDoc": { "doc": "Query failed." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 108, "col": 2, "byteIndex": 3002 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "typeParams": [] }, { "name": "error", "jsDoc": { "doc": "Error describing the failure." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 111, "col": 2, "byteIndex": 3064 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "SqlFailureError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlFailureError" } }, "typeParams": [] }, { "name": "rows", "jsDoc": { "doc": "No rows (query didn't reach server)." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 114, "col": 2, "byteIndex": 3146 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "rowCount", "jsDoc": { "doc": "No row count (query didn't reach server)." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 117, "col": 2, "byteIndex": 3221 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "lastInsertId", "jsDoc": { "doc": "No lastInsertId (query didn't reach server)." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 120, "col": 2, "byteIndex": 3303 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] }, { "name": "warnings", "jsDoc": { "doc": "No warnings (query didn't reach server)." }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 123, "col": 2, "byteIndex": 3385 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "SqlQueryResult", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 164, "col": 0, "byteIndex": 4775 }, "declarationKind": "export", "jsDoc": { "doc": "SQL query result union type representing all possible result states.\n\n- **Success**: `processed: true, ok: true, error: null`\n- **Error**: `processed: true, ok: false, error: SqlError`\n- **Failure**: `processed: false, ok: false, error: SqlConnectionError`\n", "tags": [ { "kind": "example", "doc": "Type narrowing by ok\n```ts\nimport { createPostgresClient } from \"@probitas/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```\n" }, { "kind": "example", "doc": "Type narrowing by processed\n```ts\nimport { createPostgresClient } from \"@probitas/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```" } ] }, "kind": "typeAlias", "typeAliasDef": { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "SqlQueryResultSuccess", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultSuccess" } }, { "repr": "SqlQueryResultError", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultError" } }, { "repr": "SqlQueryResultFailure", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultFailure" } } ] }, "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "SqlQueryResultSuccessParams", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 173, "col": 0, "byteIndex": 4996 }, "declarationKind": "export", "jsDoc": { "doc": "Parameters for creating a SqlQueryResultSuccess." }, "kind": "interface", "interfaceDef": { "extends": [], "constructors": [], "methods": [], "properties": [ { "name": "rows", "jsDoc": { "doc": "The result rows" }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 175, "col": 2, "byteIndex": 5079 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } } }, "typeParams": [] }, { "name": "rowCount", "jsDoc": { "doc": "Number of affected rows (for INSERT/UPDATE/DELETE)" }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 178, "col": 2, "byteIndex": 5171 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "duration", "jsDoc": { "doc": "Query execution duration in milliseconds" }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 181, "col": 2, "byteIndex": 5251 }, "params": [], "readonly": true, "computed": false, "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "typeParams": [] }, { "name": "lastInsertId", "jsDoc": { "doc": "Last inserted ID (for INSERT statements)" }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 184, "col": 2, "byteIndex": 5331 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "bigint", "kind": "keyword", "keyword": "bigint" }, { "repr": "string", "kind": "keyword", "keyword": "string" } ] }, "typeParams": [] }, { "name": "warnings", "jsDoc": { "doc": "Warning messages from the database" }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 187, "col": 2, "byteIndex": 5419 }, "params": [], "readonly": true, "computed": false, "optional": true, "tsType": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "string", "kind": "keyword", "keyword": "string" } } } }, "typeParams": [] } ], "callSignatures": [], "indexSignatures": [], "typeParams": [ { "name": "T", "default": { "repr": "any", "kind": "keyword", "keyword": "any" } } ] } }, { "name": "SqlQueryResultSuccessImpl", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 194, "col": 0, "byteIndex": 5526 }, "declarationKind": "export", "jsDoc": { "doc": "Implementation of SqlQueryResultSuccess.", "tags": [ { "kind": "internal" } ] }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "params", "optional": false, "tsType": { "repr": "SqlQueryResultSuccessParams", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultSuccessParams" } } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 205, "col": 2, "byteIndex": 5924 } } ], "properties": [ { "tsType": { "repr": "sql", "kind": "literal", "literal": { "kind": "string", "string": "sql" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 195, "col": 2, "byteIndex": 5608 } }, { "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 196, "col": 2, "byteIndex": 5642 } }, { "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 197, "col": 2, "byteIndex": 5680 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 198, "col": 2, "byteIndex": 5711 } }, { "tsType": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "rows", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 199, "col": 2, "byteIndex": 5736 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "rowCount", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 200, "col": 2, "byteIndex": 5767 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 201, "col": 2, "byteIndex": 5796 } }, { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "bigint", "kind": "keyword", "keyword": "bigint" }, { "repr": "string", "kind": "keyword", "keyword": "string" }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "lastInsertId", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 202, "col": 2, "byteIndex": 5825 } }, { "tsType": { "repr": "", "kind": "union", "union": [ { "repr": "", "kind": "parenthesized", "parenthesized": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "string", "kind": "keyword", "keyword": "string" } } } } }, { "repr": "null", "kind": "keyword", "keyword": "null" } ] }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "warnings", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 203, "col": 2, "byteIndex": 5874 } } ], "indexSignatures": [], "methods": [ { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "map", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "mapper", "optional": false, "tsType": { "repr": "", "kind": "fnOrConstructor", "fnOrConstructor": { "constructor": false, "tsType": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } }, "params": [ { "kind": "identifier", "name": "row", "optional": false, "tsType": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } ], "typeParams": [] } } } ], "returnType": { "repr": "", "kind": "array", "array": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } } }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [ { "name": "U" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 213, "col": 2, "byteIndex": 6186 } }, { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "as", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "ctor", "optional": false, "tsType": { "repr": "", "kind": "fnOrConstructor", "fnOrConstructor": { "constructor": true, "tsType": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } }, "params": [ { "kind": "identifier", "name": "row", "optional": false, "tsType": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } ], "typeParams": [] } } } ], "returnType": { "repr": "", "kind": "array", "array": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } } }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [ { "name": "U" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 221, "col": 2, "byteIndex": 6350 } } ], "extends": null, "implements": [ { "repr": "SqlQueryResultSuccess", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultSuccess" } } ], "typeParams": [ { "name": "T" } ], "superTypeParams": [] } }, { "name": "SqlQueryResultErrorImpl", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 234, "col": 0, "byteIndex": 6580 }, "declarationKind": "export", "jsDoc": { "doc": "Implementation of SqlQueryResultError.", "tags": [ { "kind": "internal" } ] }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "error", "optional": false, "tsType": { "repr": "SqlError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlError" } } }, { "kind": "identifier", "name": "duration", "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 245, "col": 2, "byteIndex": 6954 } } ], "properties": [ { "tsType": { "repr": "sql", "kind": "literal", "literal": { "kind": "string", "string": "sql" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 235, "col": 2, "byteIndex": 6658 } }, { "tsType": { "repr": "true", "kind": "literal", "literal": { "kind": "boolean", "boolean": true } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 236, "col": 2, "byteIndex": 6692 } }, { "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 237, "col": 2, "byteIndex": 6730 } }, { "tsType": { "repr": "SqlError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlError" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 238, "col": 2, "byteIndex": 6762 } }, { "tsType": { "repr": "", "kind": "typeOperator", "typeOperator": { "operator": "readonly", "tsType": { "repr": "", "kind": "array", "array": { "repr": "never", "kind": "keyword", "keyword": "never" } } } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "rows", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 239, "col": 2, "byteIndex": 6790 } }, { "tsType": { "repr": "0", "kind": "literal", "literal": { "kind": "number", "number": 0 } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "rowCount", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 240, "col": 2, "byteIndex": 6830 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 241, "col": 2, "byteIndex": 6864 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "lastInsertId", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 242, "col": 2, "byteIndex": 6893 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "warnings", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 243, "col": 2, "byteIndex": 6925 } } ], "indexSignatures": [], "methods": [ { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "map", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "_mapper", "optional": false, "tsType": { "repr": "", "kind": "fnOrConstructor", "fnOrConstructor": { "constructor": false, "tsType": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } }, "params": [ { "kind": "identifier", "name": "row", "optional": false, "tsType": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } ], "typeParams": [] } } } ], "returnType": { "repr": "", "kind": "array", "array": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } } }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [ { "name": "U" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 250, "col": 2, "byteIndex": 7064 } }, { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "as", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "_ctor", "optional": false, "tsType": { "repr": "", "kind": "fnOrConstructor", "fnOrConstructor": { "constructor": true, "tsType": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } }, "params": [ { "kind": "identifier", "name": "row", "optional": false, "tsType": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } ], "typeParams": [] } } } ], "returnType": { "repr": "", "kind": "array", "array": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } } }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [ { "name": "U" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 254, "col": 2, "byteIndex": 7124 } } ], "extends": null, "implements": [ { "repr": "SqlQueryResultError", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultError" } } ], "typeParams": [ { "name": "T" } ], "superTypeParams": [] } }, { "name": "SqlQueryResultFailureImpl", "isDefault": false, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 263, "col": 0, "byteIndex": 7250 }, "declarationKind": "export", "jsDoc": { "doc": "Implementation of SqlQueryResultFailure.", "tags": [ { "kind": "internal" } ] }, "kind": "class", "classDef": { "isAbstract": false, "constructors": [ { "accessibility": null, "hasBody": true, "name": "constructor", "params": [ { "kind": "identifier", "name": "error", "optional": false, "tsType": { "repr": "SqlFailureError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlFailureError" } } }, { "kind": "identifier", "name": "duration", "optional": false, "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" } } ], "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 274, "col": 2, "byteIndex": 7614 } } ], "properties": [ { "tsType": { "repr": "sql", "kind": "literal", "literal": { "kind": "string", "string": "sql" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "kind", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 264, "col": 2, "byteIndex": 7332 } }, { "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "processed", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 265, "col": 2, "byteIndex": 7366 } }, { "tsType": { "repr": "false", "kind": "literal", "literal": { "kind": "boolean", "boolean": false } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "ok", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 266, "col": 2, "byteIndex": 7405 } }, { "tsType": { "repr": "SqlFailureError", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "SqlFailureError" } }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "error", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 267, "col": 2, "byteIndex": 7437 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "rows", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 268, "col": 2, "byteIndex": 7472 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "rowCount", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 269, "col": 2, "byteIndex": 7496 } }, { "tsType": { "repr": "number", "kind": "keyword", "keyword": "number" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "duration", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 270, "col": 2, "byteIndex": 7524 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "lastInsertId", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 271, "col": 2, "byteIndex": 7553 } }, { "tsType": { "repr": "null", "kind": "keyword", "keyword": "null" }, "readonly": true, "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "warnings", "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 272, "col": 2, "byteIndex": 7585 } } ], "indexSignatures": [], "methods": [ { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "map", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "_mapper", "optional": false, "tsType": { "repr": "", "kind": "fnOrConstructor", "fnOrConstructor": { "constructor": false, "tsType": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } }, "params": [ { "kind": "identifier", "name": "row", "optional": false, "tsType": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } ], "typeParams": [] } } } ], "returnType": { "repr": "", "kind": "array", "array": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } } }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [ { "name": "U" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 279, "col": 2, "byteIndex": 7731 } }, { "accessibility": null, "optional": false, "isAbstract": false, "isStatic": false, "name": "as", "kind": "method", "functionDef": { "params": [ { "kind": "identifier", "name": "_ctor", "optional": false, "tsType": { "repr": "", "kind": "fnOrConstructor", "fnOrConstructor": { "constructor": true, "tsType": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } }, "params": [ { "kind": "identifier", "name": "row", "optional": false, "tsType": { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } } ], "typeParams": [] } } } ], "returnType": { "repr": "", "kind": "array", "array": { "repr": "U", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "U" } } }, "hasBody": true, "isAsync": false, "isGenerator": false, "typeParams": [ { "name": "U" } ] }, "location": { "filename": "https://jsr.io/@probitas/client-sql/0.5.0/result.ts", "line": 283, "col": 2, "byteIndex": 7791 } } ], "extends": null, "implements": [ { "repr": "SqlQueryResultFailure", "kind": "typeRef", "typeRef": { "typeParams": [ { "repr": "T", "kind": "typeRef", "typeRef": { "typeParams": null, "typeName": "T" } } ], "typeName": "SqlQueryResultFailure" } } ], "typeParams": [ { "name": "T" } ], "superTypeParams": [] } } ] }