{ "schemaVersion": "2.0", "id": 4167, "name": "@probitas-test/client-sql-sqlite", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQLite client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides a SQLite client designed for integration testing,\nwith transaction support and in-memory database capabilities.\n\n## Features\n\n- **Query Execution**: Parameterized queries with type-safe results\n- **Transactions**: Full transaction support with isolation levels\n- **In-Memory Databases**: Perfect for isolated test scenarios\n- **File-Based Databases**: Persist data for stateful testing\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-sqlite\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createSqliteClient } from \"@probitas-test/client-sql-sqlite\";\n\n// In-memory database for testing\nconst client = await createSqliteClient({\n path: \":memory:\",\n});\n\n// Create table\nawait client.query(`\n CREATE TABLE users (\n id INTEGER PRIMARY KEY,\n name TEXT NOT NULL,\n active INTEGER DEFAULT 1\n )\n`);\n\n// Insert and query with parameters (uses ? placeholders)\nawait client.query(\"INSERT INTO users (name) VALUES (?)\", [\"Alice\"]);\n\nconst result = await client.query<{ id: number; name: string }>(\n \"SELECT id, name FROM users WHERE active = ?\",\n [1]\n);\nconsole.log(result.rows);\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Transactions\n\n" }, { "kind": "code", "text": "```ts\nimport { createSqliteClient } from \"@probitas-test/client-sql-sqlite\";\nimport type { SqlTransaction } from \"@probitas-test/client-sql\";\n\nconst client = await createSqliteClient({ 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 { createSqliteClient } from \"@probitas-test/client-sql-sqlite\";\n\nawait using client = await createSqliteClient({ path: \":memory:\" });\n\nawait client.query(\"CREATE TABLE test (id INTEGER PRIMARY KEY)\");\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-duckdb`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql-duckdb) | DuckDB client |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [SQLite](https://www.sqlite.org/)" } ] }, "children": [ { "id": 4278, "name": "BusyError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when the database is busy." } ] }, "children": [ { "id": 4279, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4280, "name": "BusyError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4281, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4282, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4246, "name": "SqliteErrorOptions", "package": "@probitas-test/client-sql-sqlite" } } ], "type": { "type": "reference", "target": 4278, "name": "BusyError", "package": "@probitas-test/client-sql-sqlite" }, "overwrites": { "type": "reference", "target": 4251, "name": "SqliteError.constructor" } } ], "overwrites": { "type": "reference", "target": 4250, "name": "SqliteError.constructor" } }, { "id": 4285, "name": "extendedCode", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 4255, "name": "SqliteError.extendedCode" } }, { "id": 4286, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 4313, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 4256, "name": "SqliteError.kind" } }, { "id": 4283, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "BusyError" }, "defaultValue": "\"BusyError\"", "overwrites": { "type": "reference", "target": 4254, "name": "SqliteError.name" } }, { "id": 4284, "name": "sqliteKind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "busy" }, "defaultValue": "..." }, { "id": 4287, "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": 4257, "name": "SqliteError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 4249, "name": "SqliteError", "package": "@probitas-test/client-sql-sqlite" } ] }, { "id": 4333, "name": "ConstraintError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a constraint violation occurs." } ] }, "children": [ { "id": 4334, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4335, "name": "ConstraintError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4336, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4337, "name": "constraint", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4338, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4314, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 4333, "name": "ConstraintError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 4318, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 4317, "name": "SqlError.constructor" } }, { "id": 4341, "name": "constraint", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4340, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "constraint" }, "overwrites": { "type": "reference", "target": 4323, "name": "SqlError.kind" } }, { "id": 4339, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "ConstraintError" }, "defaultValue": "\"ConstraintError\"", "overwrites": { "type": "reference", "target": 4322, "name": "SqlError.name" } }, { "id": 4342, "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": 4324, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 4316, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 4258, "name": "DatabaseLockedError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when the database is locked." } ] }, "children": [ { "id": 4259, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4260, "name": "DatabaseLockedError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4261, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4262, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4246, "name": "SqliteErrorOptions", "package": "@probitas-test/client-sql-sqlite" } } ], "type": { "type": "reference", "target": 4258, "name": "DatabaseLockedError", "package": "@probitas-test/client-sql-sqlite" }, "overwrites": { "type": "reference", "target": 4251, "name": "SqliteError.constructor" } } ], "overwrites": { "type": "reference", "target": 4250, "name": "SqliteError.constructor" } }, { "id": 4265, "name": "extendedCode", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 4255, "name": "SqliteError.extendedCode" } }, { "id": 4266, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 4313, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 4256, "name": "SqliteError.kind" } }, { "id": 4263, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "DatabaseLockedError" }, "defaultValue": "\"DatabaseLockedError\"", "overwrites": { "type": "reference", "target": 4254, "name": "SqliteError.name" } }, { "id": 4264, "name": "sqliteKind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "database_locked" }, "defaultValue": "..." }, { "id": 4267, "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": 4257, "name": "SqliteError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 4249, "name": "SqliteError", "package": "@probitas-test/client-sql-sqlite" } ] }, { "id": 4343, "name": "DeadlockError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a deadlock is detected." } ] }, "children": [ { "id": 4344, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4345, "name": "DeadlockError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4346, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4347, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4314, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 4343, "name": "DeadlockError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 4318, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 4317, "name": "SqlError.constructor" } }, { "id": 4349, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "deadlock" }, "overwrites": { "type": "reference", "target": 4323, "name": "SqlError.kind" } }, { "id": 4348, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "DeadlockError" }, "defaultValue": "\"DeadlockError\"", "overwrites": { "type": "reference", "target": 4322, "name": "SqlError.name" } }, { "id": 4350, "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": 4324, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 4316, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 4325, "name": "QuerySyntaxError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a SQL query has syntax errors." } ] }, "children": [ { "id": 4326, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4327, "name": "QuerySyntaxError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4328, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4329, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4314, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 4325, "name": "QuerySyntaxError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 4318, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 4317, "name": "SqlError.constructor" } }, { "id": 4331, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "query" }, "overwrites": { "type": "reference", "target": 4323, "name": "SqlError.kind" } }, { "id": 4330, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "QuerySyntaxError" }, "defaultValue": "\"QuerySyntaxError\"", "overwrites": { "type": "reference", "target": 4322, "name": "SqlError.name" } }, { "id": 4332, "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": 4324, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 4316, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 4268, "name": "ReadonlyDatabaseError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when trying to write to a readonly database." } ] }, "children": [ { "id": 4269, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4270, "name": "ReadonlyDatabaseError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4271, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4272, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4246, "name": "SqliteErrorOptions", "package": "@probitas-test/client-sql-sqlite" } } ], "type": { "type": "reference", "target": 4268, "name": "ReadonlyDatabaseError", "package": "@probitas-test/client-sql-sqlite" }, "overwrites": { "type": "reference", "target": 4251, "name": "SqliteError.constructor" } } ], "overwrites": { "type": "reference", "target": 4250, "name": "SqliteError.constructor" } }, { "id": 4275, "name": "extendedCode", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 4255, "name": "SqliteError.extendedCode" } }, { "id": 4276, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 4313, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 4256, "name": "SqliteError.kind" } }, { "id": 4273, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "ReadonlyDatabaseError" }, "defaultValue": "\"ReadonlyDatabaseError\"", "overwrites": { "type": "reference", "target": 4254, "name": "SqliteError.name" } }, { "id": 4274, "name": "sqliteKind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "readonly" }, "defaultValue": "..." }, { "id": 4277, "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": 4257, "name": "SqliteError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 4249, "name": "SqliteError", "package": "@probitas-test/client-sql-sqlite" } ] }, { "id": 4351, "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": 4352, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4353, "name": "SqlConnectionError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4354, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4355, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4314, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 4351, "name": "SqlConnectionError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 4318, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 4317, "name": "SqlError.constructor" } }, { "id": 4357, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connection" }, "overwrites": { "type": "reference", "target": 4323, "name": "SqlError.kind" } }, { "id": 4356, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqlConnectionError" }, "defaultValue": "\"SqlConnectionError\"", "overwrites": { "type": "reference", "target": 4322, "name": "SqlError.name" } }, { "id": 4358, "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": 4324, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 4316, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 4316, "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": 4317, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4318, "name": "SqlError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4319, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4320, "name": "kind", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4313, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" } }, { "id": 4321, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4314, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 4316, "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": 4323, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 4313, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 4322, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } }, { "id": 4324, "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": 4249, "name": "SqliteError" }, { "type": "reference", "target": 4325, "name": "QuerySyntaxError" }, { "type": "reference", "target": 4333, "name": "ConstraintError" }, { "type": "reference", "target": 4343, "name": "DeadlockError" }, { "type": "reference", "target": 4351, "name": "SqlConnectionError" } ] }, { "id": 4249, "name": "SqliteError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error class for SQLite-specific errors.\nExtends SqlError with SQLite-specific properties like extendedCode." } ] }, "children": [ { "id": 4250, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4251, "name": "SqliteError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4252, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4253, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4246, "name": "SqliteErrorOptions", "package": "@probitas-test/client-sql-sqlite" } } ], "type": { "type": "reference", "target": 4249, "name": "SqliteError", "package": "@probitas-test/client-sql-sqlite" }, "overwrites": { "type": "reference", "target": 4318, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 4317, "name": "SqlError.constructor" } }, { "id": 4255, "name": "extendedCode", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4256, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 4313, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 4323, "name": "SqlError.kind" } }, { "id": 4254, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"SqliteError\"", "overwrites": { "type": "reference", "target": 4322, "name": "SqlError.name" } }, { "id": 4257, "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": 4324, "name": "SqlError.sqlState", "package": "@probitas-test/client-sql" } } ], "extendedTypes": [ { "type": "reference", "target": 4316, "name": "SqlError", "package": "@probitas-test/client-sql" } ], "extendedBy": [ { "type": "reference", "target": 4258, "name": "DatabaseLockedError" }, { "type": "reference", "target": 4268, "name": "ReadonlyDatabaseError" }, { "type": "reference", "target": 4278, "name": "BusyError" } ] }, { "id": 4205, "name": "SqliteTransactionImpl", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL transaction interface.\nImplementations should provide actual database-specific transaction handling." } ] }, "children": [ { "id": 4227, "name": "commit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4228, "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": 4310, "name": "SqlTransaction.commit" } } ], "implementationOf": { "type": "reference", "target": 4309, "name": "SqlTransaction.commit" } }, { "id": 4215, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4216, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 4217, "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": 4218, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4219, "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": 4220, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 4288, "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": 4436, "typeArguments": [ { "type": "reference", "target": 4217, "name": "T", "package": "@probitas-test/client-sql-sqlite", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 4298, "name": "SqlTransaction.query" } } ], "implementationOf": { "type": "reference", "target": 4297, "name": "SqlTransaction.query" } }, { "id": 4221, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4222, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 4223, "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": 4224, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4225, "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": 4226, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 4288, "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": 4223, "name": "T", "package": "@probitas-test/client-sql-sqlite", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 4304, "name": "SqlTransaction.queryOne" } } ], "implementationOf": { "type": "reference", "target": 4303, "name": "SqlTransaction.queryOne" } }, { "id": 4229, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4230, "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": 4312, "name": "SqlTransaction.rollback" } } ], "implementationOf": { "type": "reference", "target": 4311, "name": "SqlTransaction.rollback" } }, { "id": 4206, "name": "begin", "variant": "declaration", "kind": 2048, "flags": { "isStatic": true }, "signatures": [ { "id": 4207, "name": "begin", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Begin a new transaction." } ] }, "parameters": [ { "id": 4208, "name": "db", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client-sql-sqlite", "packagePath": "_driver.ts", "qualifiedName": "Database" }, "name": "Database", "package": "@probitas-test/client-sql-sqlite" } }, { "id": 4209, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4202, "name": "SqliteTransactionOptions", "package": "@probitas-test/client-sql-sqlite" } } ], "type": { "type": "reference", "target": 4205, "name": "SqliteTransactionImpl", "package": "@probitas-test/client-sql-sqlite" } } ] } ], "implementedTypes": [ { "type": "reference", "target": 4296, "name": "SqlTransaction", "package": "@probitas-test/client-sql" } ] }, { "id": 4314, "name": "SqlErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for SqlError constructor." } ] }, "children": [ { "id": 4315, "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": 4246, "name": "SqliteErrorOptions" } ] }, { "id": 4171, "name": "SqliteClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQLite client interface." } ] }, "children": [ { "id": 4172, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The client configuration." } ] }, "type": { "type": "reference", "target": 4231, "name": "SqliteClientConfig", "package": "@probitas-test/client-sql-sqlite" } }, { "id": 4173, "name": "dialect", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The SQL dialect identifier." } ] }, "type": { "type": "literal", "value": "sqlite" } }, { "id": 4194, "name": "backup", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4195, "name": "backup", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Backup the database to a file.\nUses VACUUM INTO for a consistent backup." } ] }, "parameters": [ { "id": 4196, "name": "destPath", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Destination file path for the backup" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4199, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4200, "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": 4174, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4175, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a SQL query." } ] }, "typeParameters": [ { "id": 4176, "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": 4177, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4178, "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": 4179, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 4288, "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": 4436, "typeArguments": [ { "type": "reference", "target": 4176, "name": "T", "package": "@probitas-test/client-sql-sqlite", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4180, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4181, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 4182, "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": 4183, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4184, "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": 4185, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 4288, "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": 4182, "name": "T", "package": "@probitas-test/client-sql-sqlite", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4186, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4187, "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": 4188, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4189, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Function to execute within transaction" } ] }, "type": { "type": "reflection", "declaration": { "id": 4190, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 4191, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 4192, "name": "tx", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4296, "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": 4188, "name": "T", "package": "@probitas-test/client-sql-sqlite", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 4193, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Transaction options" } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 4294, "name": "SqlTransactionOptions", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 4202, "name": "SqliteTransactionOptions", "package": "@probitas-test/client-sql-sqlite" } ] } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 4188, "name": "T", "package": "@probitas-test/client-sql-sqlite", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4197, "name": "vacuum", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4198, "name": "vacuum", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Run VACUUM to rebuild the database file, reclaiming unused space." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.esnext.disposable.d.ts", "qualifiedName": "AsyncDisposable" }, "name": "AsyncDisposable", "package": "typescript" } ] }, { "id": 4231, "name": "SqliteClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Configuration for creating a SQLite client." } ] }, "children": [ { "id": 4232, "name": "path", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Database file path.\nUse \":memory:\" for an in-memory database." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4233, "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": 4238, "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": 4237, "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": 4235, "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": 4236, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.timeout" } }, { "id": 4234, "name": "wal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Enable WAL (Write-Ahead Logging) mode.\nWAL mode provides better concurrency and performance." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\ntrue\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ] }, { "id": 4246, "name": "SqliteErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for SqliteError constructor." } ] }, "children": [ { "id": 4247, "name": "extendedCode", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "SQLite extended error code." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4248, "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": 4315, "name": "SqlErrorOptions.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 4314, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } ] }, { "id": 4202, "name": "SqliteTransactionOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQLite-specific transaction options." } ] }, "children": [ { "id": 4204, "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": 4293, "name": "SqlIsolationLevel", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 4295, "name": "SqlTransactionOptions.isolationLevel" } }, { "id": 4203, "name": "mode", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Transaction behavior mode." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"deferred\"\n```" } ] } ] }, "type": { "type": "reference", "target": 4201, "name": "SqliteTransactionMode", "package": "@probitas-test/client-sql-sqlite" } } ], "extendedTypes": [ { "type": "reference", "target": 4294, "name": "SqlTransactionOptions", "package": "@probitas-test/client-sql" } ] }, { "id": 4288, "name": "SqlQueryOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for individual SQL queries." } ] }, "children": [ { "id": 4292, "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": 4291, "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": 4289, "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": 4290, "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": 4386, "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": 4396, "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": 4390, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error describing the SQL error." } ] }, "type": { "type": "reference", "target": 4316, "name": "SqlError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 4395, "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": 4393, "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": 4389, "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": 4388, "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": 4392, "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": 4391, "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": 4394, "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": 4404, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4405, "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": 4406, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4407, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4408, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4409, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4410, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4387, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4381, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4381, "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": 4397, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4398, "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": 4399, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4400, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4401, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 4402, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 4403, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4387, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4374, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4374, "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": 4387, "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": 4387, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 4411, "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": 4421, "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": 4415, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error describing the failure." } ] }, "type": { "type": "reference", "target": 4360, "name": "SqlFailureError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 4420, "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": 4418, "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": 4414, "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": 4413, "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": 4417, "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": 4416, "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": 4419, "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": 4429, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4430, "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": 4431, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4432, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4433, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4434, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4435, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4412, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4381, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4381, "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": 4422, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4423, "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": 4424, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4425, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4426, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 4427, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 4428, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4412, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4374, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4374, "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": 4412, "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": 4412, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 4361, "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": 4371, "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": 4396, "name": "SqlQueryResultBase.duration", "package": "@probitas-test/client-sql" } }, { "id": 4365, "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": 4370, "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": 4395, "name": "SqlQueryResultBase.kind", "package": "@probitas-test/client-sql" } }, { "id": 4368, "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": 4364, "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": 4363, "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": 4367, "name": "rowCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of affected rows." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4366, "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": 4362, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } } }, { "id": 4369, "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": 4379, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4380, "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": 4381, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4382, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4383, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 4384, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 4385, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4362, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4381, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4381, "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": 4372, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 4373, "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": 4374, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 4375, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 4376, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 4377, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 4378, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 4362, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 4374, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 4374, "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": 4362, "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": 4362, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 4438, "name": "SqlQueryResultSuccessParams", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating a SqlQueryResultSuccess." } ] }, "children": [ { "id": 4442, "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": 4443, "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": 4441, "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": 4440, "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": 4439, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccessParams.T", "refersToTypeParameter": true } } } }, { "id": 4444, "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": 4439, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ] }, { "id": 4296, "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": 4309, "name": "commit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4310, "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": 4297, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4298, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 4299, "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": 4300, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4301, "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": 4302, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 4288, "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": 4436, "typeArguments": [ { "type": "reference", "target": 4299, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4303, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4304, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 4305, "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": 4306, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4307, "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": 4308, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 4288, "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": 4305, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4311, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4312, "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": 4205, "name": "SqliteTransactionImpl" } ] }, { "id": 4294, "name": "SqlTransactionOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for starting a transaction." } ] }, "children": [ { "id": 4295, "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": 4293, "name": "SqlIsolationLevel", "package": "@probitas-test/client-sql" } } ], "extendedBy": [ { "type": "reference", "target": 4202, "name": "SqliteTransactionOptions" } ] }, { "id": 4313, "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": 4360, "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": 4351, "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": 4293, "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": 4245, "name": "SqliteErrorKind", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQLite-specific error kinds." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "database_locked" }, { "type": "literal", "value": "readonly" }, { "type": "literal", "value": "busy" } ] } }, { "id": 4201, "name": "SqliteTransactionMode", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQLite transaction behavior mode.\n\n- \"deferred\": Locks are acquired on first read/write (default)\n- \"immediate\": Acquires RESERVED lock immediately\n- \"exclusive\": Acquires EXCLUSIVE lock immediately" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "deferred" }, { "type": "literal", "value": "immediate" }, { "type": "literal", "value": "exclusive" } ] } }, { "id": 4359, "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": 4325, "name": "QuerySyntaxError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 4333, "name": "ConstraintError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 4343, "name": "DeadlockError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 4316, "name": "SqlError", "package": "@probitas-test/client-sql" } ] } }, { "id": 4436, "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": 4437, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 4361, "typeArguments": [ { "type": "reference", "target": 4437, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultSuccess", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 4386, "typeArguments": [ { "type": "reference", "target": 4437, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 4411, "typeArguments": [ { "type": "reference", "target": 4437, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultFailure", "package": "@probitas-test/client-sql" } ] } }, { "id": 4242, "name": "convertSqliteError", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 4243, "name": "convertSqliteError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Convert a bun:sqlite error to the appropriate error class.\n\nClassification is based on SQLite's message text, which is stable across\ndrivers; the extended result code is kept for diagnostics." } ] }, "parameters": [ { "id": 4244, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "target": 4316, "name": "SqlError", "package": "@probitas-test/client-sql" } } ] }, { "id": 4168, "name": "createSqliteClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 4169, "name": "createSqliteClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new SQLite client instance.\n\nThe client provides parameterized queries, transaction support,\nWAL mode for better concurrency, and SQLite-specific features like backup and vacuum." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise resolving to a new SQLite client instance" } ] }, { "tag": "@example", "name": "Using file-based database", "content": [ { "kind": "code", "text": "```ts\nimport { createSqliteClient } from \"@probitas-test/client-sql-sqlite\";\n\nconst client = await createSqliteClient({\n path: \"./data.db\",\n});\n\nconst result = await client.query<{ id: number; name: string }>(\n \"SELECT * FROM users WHERE id = ?\",\n [1],\n);\nif (result.ok) {\n console.log(result.rows[0]); // { id: 1, name: \"Alice\" }\n}\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Using in-memory database", "content": [ { "kind": "code", "text": "```ts\nimport { createSqliteClient } from \"@probitas-test/client-sql-sqlite\";\n\nconst client = await createSqliteClient({\n path: \":memory:\",\n});\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Transaction with auto-commit/rollback", "content": [ { "kind": "code", "text": "```ts\nimport { createSqliteClient } from \"@probitas-test/client-sql-sqlite\";\nimport type { SqlTransaction } from \"@probitas-test/client-sql\";\n\nconst client = await createSqliteClient({ path: \":memory:\" });\nconst user = await client.transaction(async (tx: SqlTransaction) => {\n await tx.query(\"INSERT INTO users (name) VALUES (?)\", [\"Alice\"]);\n const result = await tx.query<{ id: number }>(\"SELECT last_insert_rowid() as id\");\n if (!result.ok) throw result.error;\n return result.rows[0];\n});\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Database backup", "content": [ { "kind": "code", "text": "```ts\nimport { createSqliteClient } from \"@probitas-test/client-sql-sqlite\";\n\nconst client = await createSqliteClient({ path: \"./data.db\" });\nawait client.backup(\"./backup.db\");\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createSqliteClient } from \"@probitas-test/client-sql-sqlite\";\n\nawait using client = await createSqliteClient({ path: \"./data.db\" });\n\nconst result = await client.query(\"SELECT 1\");\n// Client automatically closed when scope exits\n```" } ] } ] }, "parameters": [ { "id": 4170, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQLite client configuration" } ] }, "type": { "type": "reference", "target": 4231, "name": "SqliteClientConfig", "package": "@probitas-test/client-sql-sqlite" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 4171, "name": "SqliteClient", "package": "@probitas-test/client-sql-sqlite" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4239, "name": "isConnectionError", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 4240, "name": "isConnectionError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Check if an error is a connection-level error." } ] }, "parameters": [ { "id": 4241, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ] } ], "packageName": "@probitas-test/client-sql-sqlite", "packageVersion": "0.6.1" }