{ "schemaVersion": "2.0", "id": 3053, "name": "@probitas-test/client-sql-duckdb", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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 " }, { "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-duckdb\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/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```" }, { "kind": "text", "text": "\n\n## Transactions\n\n" }, { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/client-sql-duckdb\";\nimport type { SqlTransaction } from \"@probitas-test/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```" }, { "kind": "text", "text": "\n\n## Using with " }, { "kind": "code", "text": "`using`" }, { "kind": "text", "text": " Statement\n\n" }, { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/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```" }, { "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-postgres`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql-postgres) | PostgreSQL client |\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\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [DuckDB](https://duckdb.org/)" } ] }, "children": [ { "id": 3154, "name": "CatalogError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown for catalog errors (table not found, etc.)." } ] }, "children": [ { "id": 3155, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3156, "name": "CatalogError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3157, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3158, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3132, "name": "DuckDbErrorOptions", "package": "@probitas-test/client-sql-duckdb" } } ], "type": { "type": "reference", "target": 3154, "name": "CatalogError", "package": "@probitas-test/client-sql-duckdb" }, "overwrites": { "type": "reference", "target": 3137, "name": "DuckDbError.constructor" } } ], "overwrites": { "type": "reference", "target": 3136, "name": "DuckDbError.constructor" } }, { "id": 3160, "name": "duckdbKind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "catalog" }, "defaultValue": "..." }, { "id": 3161, "name": "errorType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 3141, "name": "DuckDbError.errorType" } }, { "id": 3162, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 3189, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 3142, "name": "DuckDbError.kind" } }, { "id": 3159, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "CatalogError" }, "defaultValue": "\"CatalogError\"", "overwrites": { "type": "reference", "target": 3140, "name": "DuckDbError.name" } }, { "id": 3163, "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": 3143, "name": "DuckDbError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3135, "name": "DuckDbError", "package": "@probitas-test/client-sql-duckdb" } ] }, { "id": 3209, "name": "ConstraintError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a constraint violation occurs." } ] }, "children": [ { "id": 3210, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3211, "name": "ConstraintError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3212, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3213, "name": "constraint", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3214, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3190, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3209, "name": "ConstraintError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3194, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3193, "name": "SqlError.constructor" } }, { "id": 3217, "name": "constraint", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3216, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "constraint" }, "overwrites": { "type": "reference", "target": 3199, "name": "SqlError.kind" } }, { "id": 3215, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "ConstraintError" }, "defaultValue": "\"ConstraintError\"", "overwrites": { "type": "reference", "target": 3198, "name": "SqlError.name" } }, { "id": 3218, "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": 3200, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3192, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3219, "name": "DeadlockError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a deadlock is detected." } ] }, "children": [ { "id": 3220, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3221, "name": "DeadlockError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3222, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3223, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3190, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3219, "name": "DeadlockError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3194, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3193, "name": "SqlError.constructor" } }, { "id": 3225, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "deadlock" }, "overwrites": { "type": "reference", "target": 3199, "name": "SqlError.kind" } }, { "id": 3224, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "DeadlockError" }, "defaultValue": "\"DeadlockError\"", "overwrites": { "type": "reference", "target": 3198, "name": "SqlError.name" } }, { "id": 3226, "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": 3200, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3192, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3135, "name": "DuckDbError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error class for DuckDB-specific errors.\nExtends SqlError with DuckDB-specific properties." } ] }, "children": [ { "id": 3136, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3137, "name": "DuckDbError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3138, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3139, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3132, "name": "DuckDbErrorOptions", "package": "@probitas-test/client-sql-duckdb" } } ], "type": { "type": "reference", "target": 3135, "name": "DuckDbError", "package": "@probitas-test/client-sql-duckdb" }, "overwrites": { "type": "reference", "target": 3194, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3193, "name": "SqlError.constructor" } }, { "id": 3141, "name": "errorType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3142, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 3189, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 3199, "name": "SqlError.kind" } }, { "id": 3140, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"DuckDbError\"", "overwrites": { "type": "reference", "target": 3198, "name": "SqlError.name" } }, { "id": 3143, "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": 3200, "name": "SqlError.sqlState", "package": "@probitas-test/client-sql" } } ], "extendedTypes": [ { "type": "reference", "target": 3192, "name": "SqlError", "package": "@probitas-test/client-sql" } ], "extendedBy": [ { "type": "reference", "target": 3144, "name": "IoError" }, { "type": "reference", "target": 3154, "name": "CatalogError" } ] }, { "id": 3092, "name": "DuckDbTransactionImpl", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL transaction interface.\nImplementations should provide actual database-specific transaction handling." } ] }, "children": [ { "id": 3114, "name": "commit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3115, "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": 3186, "name": "SqlTransaction.commit" } } ], "implementationOf": { "type": "reference", "target": 3185, "name": "SqlTransaction.commit" } }, { "id": 3102, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3103, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 3104, "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": 3105, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3106, "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": 3107, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3164, "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": 3312, "typeArguments": [ { "type": "reference", "target": 3104, "name": "T", "package": "@probitas-test/client-sql-duckdb", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 3174, "name": "SqlTransaction.query" } } ], "implementationOf": { "type": "reference", "target": 3173, "name": "SqlTransaction.query" } }, { "id": 3108, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3109, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3110, "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": 3111, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3112, "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": 3113, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3164, "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": 3110, "name": "T", "package": "@probitas-test/client-sql-duckdb", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 3180, "name": "SqlTransaction.queryOne" } } ], "implementationOf": { "type": "reference", "target": 3179, "name": "SqlTransaction.queryOne" } }, { "id": 3116, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3117, "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": 3188, "name": "SqlTransaction.rollback" } } ], "implementationOf": { "type": "reference", "target": 3187, "name": "SqlTransaction.rollback" } }, { "id": 3093, "name": "begin", "variant": "declaration", "kind": 2048, "flags": { "isStatic": true }, "signatures": [ { "id": 3094, "name": "begin", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Begin a new transaction." } ] }, "parameters": [ { "id": 3095, "name": "conn", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "packageName": "@duckdb/node-api", "packagePath": "lib/DuckDBConnection.d.ts", "qualifiedName": "DuckDBConnection" }, "name": "DuckDBConnection", "package": "@duckdb/node-api" } }, { "id": 3096, "name": "_options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3090, "name": "DuckDbTransactionOptions", "package": "@probitas-test/client-sql-duckdb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3092, "name": "DuckDbTransactionImpl", "package": "@probitas-test/client-sql-duckdb" } ], "name": "Promise", "package": "typescript" } } ] } ], "implementedTypes": [ { "type": "reference", "target": 3172, "name": "SqlTransaction", "package": "@probitas-test/client-sql" } ] }, { "id": 3144, "name": "IoError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown for IO-related errors (file not found, permission denied, etc.)." } ] }, "children": [ { "id": 3145, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3146, "name": "IoError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3147, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3148, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3132, "name": "DuckDbErrorOptions", "package": "@probitas-test/client-sql-duckdb" } } ], "type": { "type": "reference", "target": 3144, "name": "IoError", "package": "@probitas-test/client-sql-duckdb" }, "overwrites": { "type": "reference", "target": 3137, "name": "DuckDbError.constructor" } } ], "overwrites": { "type": "reference", "target": 3136, "name": "DuckDbError.constructor" } }, { "id": 3150, "name": "duckdbKind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "io" }, "defaultValue": "..." }, { "id": 3151, "name": "errorType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 3141, "name": "DuckDbError.errorType" } }, { "id": 3152, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 3189, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 3142, "name": "DuckDbError.kind" } }, { "id": 3149, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "IoError" }, "defaultValue": "\"IoError\"", "overwrites": { "type": "reference", "target": 3140, "name": "DuckDbError.name" } }, { "id": 3153, "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": 3143, "name": "DuckDbError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3135, "name": "DuckDbError", "package": "@probitas-test/client-sql-duckdb" } ] }, { "id": 3201, "name": "QuerySyntaxError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a SQL query has syntax errors." } ] }, "children": [ { "id": 3202, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3203, "name": "QuerySyntaxError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3204, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3205, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3190, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3201, "name": "QuerySyntaxError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3194, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3193, "name": "SqlError.constructor" } }, { "id": 3207, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "query" }, "overwrites": { "type": "reference", "target": 3199, "name": "SqlError.kind" } }, { "id": 3206, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "QuerySyntaxError" }, "defaultValue": "\"QuerySyntaxError\"", "overwrites": { "type": "reference", "target": 3198, "name": "SqlError.name" } }, { "id": 3208, "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": 3200, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3192, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3227, "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": 3228, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3229, "name": "SqlConnectionError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3230, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3231, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3190, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3227, "name": "SqlConnectionError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3194, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3193, "name": "SqlError.constructor" } }, { "id": 3233, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connection" }, "overwrites": { "type": "reference", "target": 3199, "name": "SqlError.kind" } }, { "id": 3232, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqlConnectionError" }, "defaultValue": "\"SqlConnectionError\"", "overwrites": { "type": "reference", "target": 3198, "name": "SqlError.name" } }, { "id": 3234, "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": 3200, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3192, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3192, "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": 3193, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3194, "name": "SqlError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3195, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3196, "name": "kind", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3189, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" } }, { "id": 3197, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3190, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3192, "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": 3199, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 3189, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 3198, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } }, { "id": 3200, "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": 3135, "name": "DuckDbError" }, { "type": "reference", "target": 3201, "name": "QuerySyntaxError" }, { "type": "reference", "target": 3209, "name": "ConstraintError" }, { "type": "reference", "target": 3219, "name": "DeadlockError" }, { "type": "reference", "target": 3227, "name": "SqlConnectionError" } ] }, { "id": 3057, "name": "DuckDbClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "DuckDB client interface." } ] }, "children": [ { "id": 3058, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The client configuration." } ] }, "type": { "type": "reference", "target": 3118, "name": "DuckDbClientConfig", "package": "@probitas-test/client-sql-duckdb" } }, { "id": 3059, "name": "dialect", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The SQL dialect identifier." } ] }, "type": { "type": "literal", "value": "duckdb" } }, { "id": 3088, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3089, "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Close the database connection." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3060, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3061, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a SQL query." } ] }, "typeParameters": [ { "id": 3062, "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": 3063, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3064, "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": 3065, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3164, "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": 3312, "typeArguments": [ { "type": "reference", "target": 3062, "name": "T", "package": "@probitas-test/client-sql-duckdb", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3084, "name": "queryCsv", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3085, "name": "queryCsv", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Query a CSV file directly.\nDuckDB can read CSV files without importing them." } ] }, "typeParameters": [ { "id": 3086, "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": 3087, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Path to the CSV file" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3312, "typeArguments": [ { "type": "reference", "target": 3086, "name": "T", "package": "@probitas-test/client-sql-duckdb", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3066, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3067, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3068, "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": 3069, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3070, "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": 3071, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3164, "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": 3068, "name": "T", "package": "@probitas-test/client-sql-duckdb", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3080, "name": "queryParquet", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3081, "name": "queryParquet", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Query a Parquet file directly.\nDuckDB can read Parquet files without importing them." } ] }, "typeParameters": [ { "id": 3082, "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": 3083, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Path to the Parquet file" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3312, "typeArguments": [ { "type": "reference", "target": 3082, "name": "T", "package": "@probitas-test/client-sql-duckdb", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3072, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3073, "name": "transaction", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a function within a transaction.\nAutomatically commits on success or rolls back on error." } ] }, "typeParameters": [ { "id": 3074, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3075, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Function to execute within transaction" } ] }, "type": { "type": "reflection", "declaration": { "id": 3076, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3077, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3078, "name": "tx", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3172, "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": 3074, "name": "T", "package": "@probitas-test/client-sql-duckdb", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 3079, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Transaction options" } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 3170, "name": "SqlTransactionOptions", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3090, "name": "DuckDbTransactionOptions", "package": "@probitas-test/client-sql-duckdb" } ] } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3074, "name": "T", "package": "@probitas-test/client-sql-duckdb", "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": 3118, "name": "DuckDbClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Configuration for creating a DuckDB client." } ] }, "children": [ { "id": 3119, "name": "path", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Database file path.\nUse " }, { "kind": "code", "text": "`:memory:`" }, { "kind": "text", "text": " or omit for an in-memory database." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3120, "name": "readonly", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Open the database in read-only mode." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 3124, "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": 3123, "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": 3121, "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": 3122, "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": 3132, "name": "DuckDbErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for DuckDbError constructor." } ] }, "children": [ { "id": 3133, "name": "errorType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "DuckDB error type if available." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3134, "name": "sqlState", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "SQL State code (e.g., \"23505\" for unique violation)" } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 3191, "name": "SqlErrorOptions.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3190, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } ] }, { "id": 3090, "name": "DuckDbTransactionOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "DuckDB-specific transaction options." } ] }, "children": [ { "id": 3091, "name": "isolationLevel", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Isolation level for the transaction" } ] }, "type": { "type": "reference", "target": 3169, "name": "SqlIsolationLevel", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 3171, "name": "SqlTransactionOptions.isolationLevel" } } ], "extendedTypes": [ { "type": "reference", "target": 3170, "name": "SqlTransactionOptions", "package": "@probitas-test/client-sql" } ] }, { "id": 3190, "name": "SqlErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for SqlError constructor." } ] }, "children": [ { "id": 3191, "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" } ], "extendedBy": [ { "type": "reference", "target": 3132, "name": "DuckDbErrorOptions" } ] }, { "id": 3164, "name": "SqlQueryOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for individual SQL queries." } ] }, "children": [ { "id": 3168, "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": 3167, "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": 3165, "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": 3166, "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": 3262, "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": 3272, "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": 3266, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error describing the SQL error." } ] }, "type": { "type": "reference", "target": 3192, "name": "SqlError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 3271, "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": 3269, "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": 3265, "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": 3264, "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": 3268, "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": 3267, "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": 3270, "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": 3280, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3281, "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": 3282, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3283, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3284, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3285, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3286, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3263, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3257, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3257, "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": 3273, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3274, "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": 3275, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3276, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3277, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3278, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3279, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3263, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3250, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3250, "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": 3263, "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": 3263, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 3287, "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": 3297, "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": 3291, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error describing the failure." } ] }, "type": { "type": "reference", "target": 3236, "name": "SqlFailureError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 3296, "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": 3294, "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": 3290, "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": 3289, "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": 3293, "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": 3292, "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": 3295, "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": 3305, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3306, "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": 3307, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3308, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3309, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3310, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3311, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3288, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3257, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3257, "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": 3298, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3299, "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": 3300, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3301, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3302, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3303, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3304, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3288, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3250, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3250, "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": 3288, "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": 3288, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 3237, "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": 3247, "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": 3272, "name": "SqlQueryResultBase.duration", "package": "@probitas-test/client-sql" } }, { "id": 3241, "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": 3246, "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": 3271, "name": "SqlQueryResultBase.kind", "package": "@probitas-test/client-sql" } }, { "id": 3244, "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": 3240, "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": 3239, "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": 3243, "name": "rowCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of affected rows." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3242, "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": 3238, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } } }, { "id": 3245, "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": 3255, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3256, "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": 3257, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3258, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3259, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3260, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3261, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3238, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3257, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3257, "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": 3248, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3249, "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": 3250, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3251, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3252, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3253, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3254, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3238, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3250, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3250, "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": 3238, "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": 3238, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 3314, "name": "SqlQueryResultSuccessParams", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating a SqlQueryResultSuccess." } ] }, "children": [ { "id": 3318, "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": 3319, "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": 3317, "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": 3316, "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": 3315, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccessParams.T", "refersToTypeParameter": true } } } }, { "id": 3320, "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": 3315, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ] }, { "id": 3172, "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": 3185, "name": "commit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3186, "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": 3173, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3174, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 3175, "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": 3176, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3177, "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": 3178, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3164, "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": 3312, "typeArguments": [ { "type": "reference", "target": 3175, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3179, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3180, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3181, "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": 3182, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3183, "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": 3184, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3164, "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": 3181, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3187, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3188, "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": 3092, "name": "DuckDbTransactionImpl" } ] }, { "id": 3170, "name": "SqlTransactionOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for starting a transaction." } ] }, "children": [ { "id": 3171, "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": 3169, "name": "SqlIsolationLevel", "package": "@probitas-test/client-sql" } } ], "extendedBy": [ { "type": "reference", "target": 3090, "name": "DuckDbTransactionOptions" } ] }, { "id": 3131, "name": "DuckDbErrorKind", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "DuckDB-specific error kinds." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "io" }, { "type": "literal", "value": "catalog" }, { "type": "literal", "value": "parser" }, { "type": "literal", "value": "binder" } ] } }, { "id": 3189, "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": 3236, "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": 3227, "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": 3169, "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": 3235, "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": 3201, "name": "QuerySyntaxError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3209, "name": "ConstraintError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3219, "name": "DeadlockError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3192, "name": "SqlError", "package": "@probitas-test/client-sql" } ] } }, { "id": 3312, "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": 3313, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 3237, "typeArguments": [ { "type": "reference", "target": 3313, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultSuccess", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3262, "typeArguments": [ { "type": "reference", "target": 3313, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3287, "typeArguments": [ { "type": "reference", "target": 3313, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultFailure", "package": "@probitas-test/client-sql" } ] } }, { "id": 3125, "name": "convertDuckDbError", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3126, "name": "convertDuckDbError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Convert a DuckDB error to the appropriate error class.\n\nDuckDB errors are classified based on message content analysis." } ] }, "parameters": [ { "id": 3127, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "target": 3192, "name": "SqlError", "package": "@probitas-test/client-sql" } } ] }, { "id": 3054, "name": "createDuckDbClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3055, "name": "createDuckDbClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise resolving to a new DuckDB client instance" } ] }, { "tag": "@example", "name": "Using in-memory database (default)", "content": [ { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/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```" } ] }, { "tag": "@example", "name": "Using file-based database", "content": [ { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/client-sql-duckdb\";\n\nconst client = await createDuckDbClient({\n path: \"./data.duckdb\",\n});\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Query Parquet files directly", "content": [ { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/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```" } ] }, { "tag": "@example", "name": "Query CSV files directly", "content": [ { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/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```" } ] }, { "tag": "@example", "name": "Transaction with auto-commit/rollback", "content": [ { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/client-sql-duckdb\";\nimport type { SqlTransaction } from \"@probitas-test/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```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createDuckDbClient } from \"@probitas-test/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```" } ] } ] }, "parameters": [ { "id": 3056, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "DuckDB client configuration" } ] }, "type": { "type": "reference", "target": 3118, "name": "DuckDbClientConfig", "package": "@probitas-test/client-sql-duckdb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3057, "name": "DuckDbClient", "package": "@probitas-test/client-sql-duckdb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3128, "name": "isConnectionError", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3129, "name": "isConnectionError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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." } ] }, "parameters": [ { "id": 3130, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ] } ], "packageName": "@probitas-test/client-sql-duckdb", "packageVersion": "0.5.2" }