{ "schemaVersion": "2.0", "id": 3410, "name": "@probitas-test/client-sql-mysql", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MySQL client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides a MySQL client designed for integration testing,\nwith transaction support and prepared statement capabilities.\n\n## Features\n\n- **Query Execution**: Parameterized queries with type-safe results\n- **Transactions**: Full transaction support with isolation levels\n- **Prepared Statements**: Automatic parameter escaping and type conversion\n- **Connection Pooling**: Configurable pool with idle timeout\n- **Resource Management**: Implements " }, { "kind": "code", "text": "`AsyncDisposable`" }, { "kind": "text", "text": " for proper cleanup\n\n## Installation\n\n" }, { "kind": "code", "text": "```bash\nnpm install @probitas-test/client-sql-mysql\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createMySqlClient } from \"@probitas-test/client-sql-mysql\";\n\nconst client = await createMySqlClient({\n url: {\n host: \"localhost\",\n port: 3306,\n username: \"root\",\n password: \"secret\",\n database: \"mydb\",\n },\n});\n\n// Query with parameters (uses ? placeholders)\nconst result = await client.query<{ id: number; name: string }>(\n \"SELECT id, name FROM users WHERE active = ?\",\n [true]\n);\nconsole.log(result.rows);\n\n// Get first row\nconst user = await client.queryOne<{ id: number; name: string }>(\n \"SELECT * FROM users WHERE id = ?\",\n [1]\n);\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Transactions\n\n" }, { "kind": "code", "text": "```ts\nimport { createMySqlClient } from \"@probitas-test/client-sql-mysql\";\nimport type { SqlTransaction } from \"@probitas-test/client-sql\";\n\nconst client = await createMySqlClient({ url: \"mysql://localhost:3306/testdb\" });\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}, { isolationLevel: \"serializable\" });\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 { createMySqlClient } from \"@probitas-test/client-sql-mysql\";\n\nawait using client = await createMySqlClient({\n url: { host: \"localhost\", username: \"root\", database: \"testdb\" },\n});\n\nconst result = await client.query(\"SELECT 1 as n\");\n// Client automatically closed when block exits\n```" }, { "kind": "text", "text": "\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [" }, { "kind": "code", "text": "`@probitas-test/client-sql`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql) | Common SQL types and utilities |\n| [" }, { "kind": "code", "text": "`@probitas-test/client-sql-postgres`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql-postgres) | PostgreSQL client |\n| [" }, { "kind": "code", "text": "`@probitas-test/client-sql-sqlite`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql-sqlite) | SQLite client |\n| [" }, { "kind": "code", "text": "`@probitas-test/client-sql-duckdb`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-sql-duckdb) | DuckDB client |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [MySQL](https://www.mysql.com/)" } ] }, "children": [ { "id": 3549, "name": "AccessDeniedError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when access is denied (wrong credentials)." } ] }, "children": [ { "id": 3550, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3551, "name": "AccessDeniedError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3552, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3553, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3537, "name": "MySqlErrorOptions", "package": "@probitas-test/client-sql-mysql" } } ], "type": { "type": "reference", "target": 3549, "name": "AccessDeniedError", "package": "@probitas-test/client-sql-mysql" }, "overwrites": { "type": "reference", "target": 3542, "name": "MySqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3541, "name": "MySqlError.constructor" } }, { "id": 3556, "name": "errno", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 3546, "name": "MySqlError.errno" } }, { "id": 3557, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 3594, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 3547, "name": "MySqlError.kind" } }, { "id": 3555, "name": "mysqlKind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "access_denied" }, "defaultValue": "..." }, { "id": 3554, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "AccessDeniedError" }, "defaultValue": "\"AccessDeniedError\"", "overwrites": { "type": "reference", "target": 3545, "name": "MySqlError.name" } }, { "id": 3558, "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": 3548, "name": "MySqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3540, "name": "MySqlError", "package": "@probitas-test/client-sql-mysql" } ] }, { "id": 3559, "name": "ConnectionRefusedError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when connection is refused." } ] }, "children": [ { "id": 3560, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3561, "name": "ConnectionRefusedError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3562, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3563, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3537, "name": "MySqlErrorOptions", "package": "@probitas-test/client-sql-mysql" } } ], "type": { "type": "reference", "target": 3559, "name": "ConnectionRefusedError", "package": "@probitas-test/client-sql-mysql" }, "overwrites": { "type": "reference", "target": 3542, "name": "MySqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3541, "name": "MySqlError.constructor" } }, { "id": 3566, "name": "errno", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 3546, "name": "MySqlError.errno" } }, { "id": 3567, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 3594, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 3547, "name": "MySqlError.kind" } }, { "id": 3565, "name": "mysqlKind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connection_refused" }, "defaultValue": "..." }, { "id": 3564, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "ConnectionRefusedError" }, "defaultValue": "\"ConnectionRefusedError\"", "overwrites": { "type": "reference", "target": 3545, "name": "MySqlError.name" } }, { "id": 3568, "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": 3548, "name": "MySqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3540, "name": "MySqlError", "package": "@probitas-test/client-sql-mysql" } ] }, { "id": 3614, "name": "ConstraintError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a constraint violation occurs." } ] }, "children": [ { "id": 3615, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3616, "name": "ConstraintError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3617, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3618, "name": "constraint", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3619, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3595, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3614, "name": "ConstraintError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3599, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3598, "name": "SqlError.constructor" } }, { "id": 3622, "name": "constraint", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3621, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "constraint" }, "overwrites": { "type": "reference", "target": 3604, "name": "SqlError.kind" } }, { "id": 3620, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "ConstraintError" }, "defaultValue": "\"ConstraintError\"", "overwrites": { "type": "reference", "target": 3603, "name": "SqlError.name" } }, { "id": 3623, "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": 3605, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3597, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3624, "name": "DeadlockError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a deadlock is detected." } ] }, "children": [ { "id": 3625, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3626, "name": "DeadlockError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3627, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3628, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3595, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3624, "name": "DeadlockError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3599, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3598, "name": "SqlError.constructor" } }, { "id": 3630, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "deadlock" }, "overwrites": { "type": "reference", "target": 3604, "name": "SqlError.kind" } }, { "id": 3629, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "DeadlockError" }, "defaultValue": "\"DeadlockError\"", "overwrites": { "type": "reference", "target": 3603, "name": "SqlError.name" } }, { "id": 3631, "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": 3605, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3597, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3540, "name": "MySqlError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error class for MySQL-specific errors.\nExtends SqlError with MySQL-specific properties like errno." } ] }, "children": [ { "id": 3541, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3542, "name": "MySqlError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3543, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3544, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3537, "name": "MySqlErrorOptions", "package": "@probitas-test/client-sql-mysql" } } ], "type": { "type": "reference", "target": 3540, "name": "MySqlError", "package": "@probitas-test/client-sql-mysql" }, "overwrites": { "type": "reference", "target": 3599, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3598, "name": "SqlError.constructor" } }, { "id": 3546, "name": "errno", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3547, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "reference", "target": 3594, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "inheritedFrom": { "type": "reference", "target": 3604, "name": "SqlError.kind" } }, { "id": 3545, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"MySqlError\"", "overwrites": { "type": "reference", "target": 3603, "name": "SqlError.name" } }, { "id": 3548, "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": 3605, "name": "SqlError.sqlState", "package": "@probitas-test/client-sql" } } ], "extendedTypes": [ { "type": "reference", "target": 3597, "name": "SqlError", "package": "@probitas-test/client-sql" } ], "extendedBy": [ { "type": "reference", "target": 3549, "name": "AccessDeniedError" }, { "type": "reference", "target": 3559, "name": "ConnectionRefusedError" } ] }, { "id": 3465, "name": "MySqlTransactionImpl", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MySQL-specific transaction interface.\nExtends SqlTransaction with MySQL-specific features." } ] }, "children": [ { "id": 3487, "name": "commit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3488, "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": 3462, "name": "MySqlTransaction.commit" } } ], "implementationOf": { "type": "reference", "target": 3461, "name": "MySqlTransaction.commit" } }, { "id": 3475, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3476, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 3477, "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": 3478, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3479, "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": 3480, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3569, "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": 3717, "typeArguments": [ { "type": "reference", "target": 3477, "name": "T", "package": "@probitas-test/client-sql-mysql", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 3450, "name": "MySqlTransaction.query" } } ], "implementationOf": { "type": "reference", "target": 3449, "name": "MySqlTransaction.query" } }, { "id": 3481, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3482, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3483, "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": 3484, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3485, "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": 3486, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3569, "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": 3483, "name": "T", "package": "@probitas-test/client-sql-mysql", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": 3456, "name": "MySqlTransaction.queryOne" } } ], "implementationOf": { "type": "reference", "target": 3455, "name": "MySqlTransaction.queryOne" } }, { "id": 3497, "name": "releaseSavepoint", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3498, "name": "releaseSavepoint", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Release a savepoint." } ] }, "parameters": [ { "id": 3499, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Savepoint name" } ] }, "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" }, "implementationOf": { "type": "reference", "target": 3447, "name": "MySqlTransaction.releaseSavepoint" } } ], "implementationOf": { "type": "reference", "target": 3446, "name": "MySqlTransaction.releaseSavepoint" } }, { "id": 3489, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3490, "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": 3464, "name": "MySqlTransaction.rollback" } } ], "implementationOf": { "type": "reference", "target": 3463, "name": "MySqlTransaction.rollback" } }, { "id": 3494, "name": "rollbackToSavepoint", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3495, "name": "rollbackToSavepoint", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Rollback to a savepoint." } ] }, "parameters": [ { "id": 3496, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Savepoint name" } ] }, "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" }, "implementationOf": { "type": "reference", "target": 3444, "name": "MySqlTransaction.rollbackToSavepoint" } } ], "implementationOf": { "type": "reference", "target": 3443, "name": "MySqlTransaction.rollbackToSavepoint" } }, { "id": 3491, "name": "savepoint", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3492, "name": "savepoint", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a savepoint." } ] }, "parameters": [ { "id": 3493, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Savepoint name" } ] }, "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" }, "implementationOf": { "type": "reference", "target": 3441, "name": "MySqlTransaction.savepoint" } } ], "implementationOf": { "type": "reference", "target": 3440, "name": "MySqlTransaction.savepoint" } }, { "id": 3466, "name": "begin", "variant": "declaration", "kind": 2048, "flags": { "isStatic": true }, "signatures": [ { "id": 3467, "name": "begin", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Begin a new transaction." } ] }, "parameters": [ { "id": 3468, "name": "connection", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 3469, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3575, "name": "SqlTransactionOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3465, "name": "MySqlTransactionImpl", "package": "@probitas-test/client-sql-mysql" } ], "name": "Promise", "package": "typescript" } } ] } ], "implementedTypes": [ { "type": "reference", "target": 3439, "name": "MySqlTransaction", "package": "@probitas-test/client-sql-mysql" } ] }, { "id": 3606, "name": "QuerySyntaxError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a SQL query has syntax errors." } ] }, "children": [ { "id": 3607, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3608, "name": "QuerySyntaxError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3609, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3610, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3595, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3606, "name": "QuerySyntaxError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3599, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3598, "name": "SqlError.constructor" } }, { "id": 3612, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "query" }, "overwrites": { "type": "reference", "target": 3604, "name": "SqlError.kind" } }, { "id": 3611, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "QuerySyntaxError" }, "defaultValue": "\"QuerySyntaxError\"", "overwrites": { "type": "reference", "target": 3603, "name": "SqlError.name" } }, { "id": 3613, "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": 3605, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3597, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3632, "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": 3633, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3634, "name": "SqlConnectionError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3635, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3636, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3595, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3632, "name": "SqlConnectionError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": 3599, "name": "SqlError.constructor" } } ], "overwrites": { "type": "reference", "target": 3598, "name": "SqlError.constructor" } }, { "id": 3638, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connection" }, "overwrites": { "type": "reference", "target": 3604, "name": "SqlError.kind" } }, { "id": 3637, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqlConnectionError" }, "defaultValue": "\"SqlConnectionError\"", "overwrites": { "type": "reference", "target": 3603, "name": "SqlError.name" } }, { "id": 3639, "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": 3605, "name": "SqlError.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3597, "name": "SqlError", "package": "@probitas-test/client-sql" } ] }, { "id": 3597, "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": 3598, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3599, "name": "SqlError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3600, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3601, "name": "kind", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3594, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" } }, { "id": 3602, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 3595, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": 3597, "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": 3604, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 3594, "name": "SqlErrorKind", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 3603, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } }, { "id": 3605, "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": 3540, "name": "MySqlError" }, { "type": "reference", "target": 3606, "name": "QuerySyntaxError" }, { "type": "reference", "target": 3614, "name": "ConstraintError" }, { "type": "reference", "target": 3624, "name": "DeadlockError" }, { "type": "reference", "target": 3632, "name": "SqlConnectionError" } ] }, { "id": 3414, "name": "MySqlClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MySQL client interface." } ] }, "children": [ { "id": 3415, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The client configuration." } ] }, "type": { "type": "reference", "target": 3522, "name": "MySqlClientConfig", "package": "@probitas-test/client-sql-mysql" } }, { "id": 3416, "name": "dialect", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The SQL dialect identifier." } ] }, "type": { "type": "literal", "value": "mysql" } }, { "id": 3437, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3438, "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Close the client and release all connections." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3417, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3418, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a SQL query." } ] }, "typeParameters": [ { "id": 3419, "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": 3420, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3421, "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": 3422, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3569, "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": 3717, "typeArguments": [ { "type": "reference", "target": 3419, "name": "T", "package": "@probitas-test/client-sql-mysql", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3423, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3424, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3425, "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": 3426, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3427, "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": 3428, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3569, "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": 3425, "name": "T", "package": "@probitas-test/client-sql-mysql", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3429, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3430, "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": 3431, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3432, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Function to execute within transaction" } ] }, "type": { "type": "reflection", "declaration": { "id": 3433, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3434, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3435, "name": "tx", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3577, "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": 3431, "name": "T", "package": "@probitas-test/client-sql-mysql", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 3436, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Transaction options" } ] }, "type": { "type": "reference", "target": 3575, "name": "SqlTransactionOptions", "package": "@probitas-test/client-sql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3431, "name": "T", "package": "@probitas-test/client-sql-mysql", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.esnext.disposable.d.ts", "qualifiedName": "AsyncDisposable" }, "name": "AsyncDisposable", "package": "typescript" } ] }, { "id": 3522, "name": "MySqlClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Configuration for creating a MySQL client." } ] }, "children": [ { "id": 3524, "name": "pool", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Connection pool configuration." } ] }, "type": { "type": "reference", "target": 3508, "name": "MySqlPoolConfig", "package": "@probitas-test/client-sql-mysql" } }, { "id": 3529, "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": 3528, "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": 3526, "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": 3527, "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": 3525, "name": "timezone", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Timezone for the connection." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3523, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Connection URL or configuration.\n\nCan be a connection URL string (e.g., \"mysql://user:pass@host:port/database\")\nor a detailed MySqlConnectionConfig object." } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": 3514, "name": "MySqlConnectionConfig", "package": "@probitas-test/client-sql-mysql" } ] } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ] }, { "id": 3514, "name": "MySqlConnectionConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MySQL connection configuration.\n\nExtends CommonConnectionConfig with MySQL-specific options." } ] }, "children": [ { "id": 3517, "name": "charset", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Character set." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3515, "name": "database", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Database name to connect to." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3518, "name": "host", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Hostname or IP address." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"localhost\"\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.host" } }, { "id": 3521, "name": "password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Password for authentication." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.password" } }, { "id": 3519, "name": "port", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Port number. Each service has its own default." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.port" } }, { "id": 3516, "name": "tls", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "TLS configuration." } ] }, "type": { "type": "reference", "target": 3503, "name": "MySqlTlsConfig", "package": "@probitas-test/client-sql-mysql" } }, { "id": 3520, "name": "username", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Username for authentication." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.username" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonConnectionConfig" }, "name": "CommonConnectionConfig", "package": "@probitas-test/client" } ] }, { "id": 3537, "name": "MySqlErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for MySqlError constructor." } ] }, "children": [ { "id": 3538, "name": "errno", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "MySQL error code (e.g., 1045, 1062)." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3539, "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": 3596, "name": "SqlErrorOptions.sqlState" } } ], "extendedTypes": [ { "type": "reference", "target": 3595, "name": "SqlErrorOptions", "package": "@probitas-test/client-sql" } ] }, { "id": 3508, "name": "MySqlPoolConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Connection pool configuration." } ] }, "children": [ { "id": 3509, "name": "connectionLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of connections in the pool." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n10\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3513, "name": "idleTimeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Time in milliseconds before connection is considered idle." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n10000\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3510, "name": "minConnections", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Minimum number of idle connections." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n0\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3511, "name": "queueLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of connection requests the pool will queue." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n0 (unlimited)\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3512, "name": "waitForConnections", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to wait for connections to become available." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\ntrue\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 3503, "name": "MySqlTlsConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "TLS/SSL configuration for MySQL connections." } ] }, "children": [ { "id": 3504, "name": "ca", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Root CA certificate (PEM format)." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3505, "name": "cert", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Client certificate (PEM format)." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3506, "name": "key", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Client private key (PEM format)." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3507, "name": "rejectUnauthorized", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Skip server certificate verification (use only for testing)." } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 3439, "name": "MySqlTransaction", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MySQL-specific transaction interface.\nExtends SqlTransaction with MySQL-specific features." } ] }, "children": [ { "id": 3461, "name": "commit", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3462, "name": "commit", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "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" }, "inheritedFrom": { "type": "reference", "target": 3591, "name": "SqlTransaction.commit" } } ], "inheritedFrom": { "type": "reference", "target": 3590, "name": "SqlTransaction.commit" } }, { "id": 3449, "name": "query", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3450, "name": "query", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 3451, "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": 3452, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3453, "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": 3454, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3569, "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": 3717, "typeArguments": [ { "type": "reference", "target": 3451, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 3579, "name": "SqlTransaction.query" } } ], "inheritedFrom": { "type": "reference", "target": 3578, "name": "SqlTransaction.query" } }, { "id": 3455, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3456, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3457, "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": 3458, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3459, "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": 3460, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3569, "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": 3457, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 3585, "name": "SqlTransaction.queryOne" } } ], "inheritedFrom": { "type": "reference", "target": 3584, "name": "SqlTransaction.queryOne" } }, { "id": 3446, "name": "releaseSavepoint", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3447, "name": "releaseSavepoint", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Release a savepoint." } ] }, "parameters": [ { "id": 3448, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Savepoint name" } ] }, "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": 3463, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3464, "name": "rollback", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "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" }, "inheritedFrom": { "type": "reference", "target": 3593, "name": "SqlTransaction.rollback" } } ], "inheritedFrom": { "type": "reference", "target": 3592, "name": "SqlTransaction.rollback" } }, { "id": 3443, "name": "rollbackToSavepoint", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3444, "name": "rollbackToSavepoint", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Rollback to a savepoint." } ] }, "parameters": [ { "id": 3445, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Savepoint name" } ] }, "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": 3440, "name": "savepoint", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3441, "name": "savepoint", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a savepoint." } ] }, "parameters": [ { "id": 3442, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Savepoint name" } ] }, "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" } } ] } ], "extendedTypes": [ { "type": "reference", "target": 3577, "name": "SqlTransaction", "package": "@probitas-test/client-sql" } ], "implementedBy": [ { "type": "reference", "target": 3465, "name": "MySqlTransactionImpl" } ] }, { "id": 3595, "name": "SqlErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for SqlError constructor." } ] }, "children": [ { "id": 3596, "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": 3537, "name": "MySqlErrorOptions" } ] }, { "id": 3569, "name": "SqlQueryOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for individual SQL queries." } ] }, "children": [ { "id": 3573, "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": 3572, "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": 3570, "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": 3571, "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": 3667, "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": 3677, "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": 3671, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error describing the SQL error." } ] }, "type": { "type": "reference", "target": 3597, "name": "SqlError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 3676, "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": 3674, "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": 3670, "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": 3669, "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": 3673, "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": 3672, "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": 3675, "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": 3685, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3686, "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": 3687, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3688, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3689, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3690, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3691, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3668, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3662, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3662, "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": 3678, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3679, "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": 3680, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3681, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3682, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3683, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3684, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3668, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3655, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3655, "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": 3668, "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": 3668, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultError.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 3692, "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": 3702, "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": 3696, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error describing the failure." } ] }, "type": { "type": "reference", "target": 3641, "name": "SqlFailureError", "package": "@probitas-test/client-sql" }, "overwrites": { "type": "reference", "target": -1, "name": "SqlQueryResultBase.error", "package": "@probitas-test/client-sql" } }, { "id": 3701, "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": 3699, "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": 3695, "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": 3694, "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": 3698, "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": 3697, "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": 3700, "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": 3710, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3711, "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": 3712, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3713, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3714, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3715, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3716, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3693, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3662, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3662, "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": 3703, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3704, "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": 3705, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3706, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3707, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3708, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3709, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3693, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3655, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3655, "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": 3693, "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": 3693, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultFailure.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 3642, "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": 3652, "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": 3677, "name": "SqlQueryResultBase.duration", "package": "@probitas-test/client-sql" } }, { "id": 3646, "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": 3651, "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": 3676, "name": "SqlQueryResultBase.kind", "package": "@probitas-test/client-sql" } }, { "id": 3649, "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": 3645, "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": 3644, "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": 3648, "name": "rowCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of affected rows." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 3647, "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": 3643, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } } }, { "id": 3650, "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": 3660, "name": "as", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3661, "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": 3662, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3663, "name": "ctor", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3664, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 3665, "name": "ctor", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 3666, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3643, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3662, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3662, "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": 3653, "name": "map", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "signatures": [ { "id": 3654, "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": 3655, "name": "U", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 3656, "name": "mapper", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 3657, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 3658, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 3659, "name": "row", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 3643, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 3655, "name": "U", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } } ] } } } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 3655, "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": 3643, "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": 3643, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccess.T", "refersToTypeParameter": true } ], "name": "SqlQueryResultBase", "package": "@probitas-test/client-sql" } ] }, { "id": 3719, "name": "SqlQueryResultSuccessParams", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating a SqlQueryResultSuccess." } ] }, "children": [ { "id": 3723, "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": 3724, "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": 3722, "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": 3721, "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": 3720, "name": "T", "package": "@probitas-test/client-sql", "qualifiedName": "SqlQueryResultSuccessParams.T", "refersToTypeParameter": true } } } }, { "id": 3725, "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": 3720, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ] }, { "id": 3577, "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": 3590, "name": "commit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3591, "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": 3578, "name": "query", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3579, "name": "query", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query within the transaction." } ] }, "typeParameters": [ { "id": 3580, "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": 3581, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3582, "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": 3583, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3569, "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": 3717, "typeArguments": [ { "type": "reference", "target": 3451, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResult", "package": "@probitas-test/client-sql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3584, "name": "queryOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3585, "name": "queryOne", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Execute a query and return the first row or undefined." } ] }, "typeParameters": [ { "id": 3586, "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": 3587, "name": "sql", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQL query string" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 3588, "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": 3589, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional query options" } ] }, "type": { "type": "reference", "target": 3569, "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": 3457, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "undefined" } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3592, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 3593, "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" } } ] } ], "extendedBy": [ { "type": "reference", "target": 3439, "name": "MySqlTransaction" } ] }, { "id": 3575, "name": "SqlTransactionOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for starting a transaction." } ] }, "children": [ { "id": 3576, "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": 3574, "name": "SqlIsolationLevel", "package": "@probitas-test/client-sql" } } ] }, { "id": 3536, "name": "MySqlErrorKind", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MySQL-specific error kinds." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "access_denied" }, { "type": "literal", "value": "connection_refused" } ] } }, { "id": 3594, "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": 3641, "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": 3632, "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": 3574, "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": 3640, "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": 3606, "name": "QuerySyntaxError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3614, "name": "ConstraintError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3624, "name": "DeadlockError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3597, "name": "SqlError", "package": "@probitas-test/client-sql" } ] } }, { "id": 3717, "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": 3718, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 3642, "typeArguments": [ { "type": "reference", "target": 3718, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultSuccess", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3667, "typeArguments": [ { "type": "reference", "target": 3718, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultError", "package": "@probitas-test/client-sql" }, { "type": "reference", "target": 3692, "typeArguments": [ { "type": "reference", "target": 3718, "name": "T", "package": "@probitas-test/client-sql", "refersToTypeParameter": true } ], "name": "SqlQueryResultFailure", "package": "@probitas-test/client-sql" } ] } }, { "id": 3533, "name": "convertMySqlError", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3534, "name": "convertMySqlError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Convert a mysql2 error to the appropriate error class." } ] }, "parameters": [ { "id": 3535, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "target": 3597, "name": "SqlError", "package": "@probitas-test/client-sql" } } ] }, { "id": 3411, "name": "createMySqlClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3412, "name": "createMySqlClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new MySQL client instance with connection pooling.\n\nThe client provides connection pooling, parameterized queries, transaction support,\nand automatic result type mapping." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise resolving to a new MySQL client instance" } ] }, { "tag": "@example", "name": "Using URL string", "content": [ { "kind": "code", "text": "```ts\nimport { createMySqlClient } from \"@probitas-test/client-sql-mysql\";\n\nconst client = await createMySqlClient({\n url: \"mysql://user:password@localhost:3306/testdb\",\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 connection config object", "content": [ { "kind": "code", "text": "```ts\nimport { createMySqlClient } from \"@probitas-test/client-sql-mysql\";\n\nconst client = await createMySqlClient({\n url: {\n host: \"localhost\",\n port: 3306,\n username: \"root\",\n password: \"password\",\n database: \"testdb\",\n },\n pool: { connectionLimit: 20 },\n});\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Transaction with auto-commit/rollback", "content": [ { "kind": "code", "text": "```ts\nimport { createMySqlClient } from \"@probitas-test/client-sql-mysql\";\nimport type { SqlTransaction } from \"@probitas-test/client-sql\";\n\nconst client = await createMySqlClient({ url: \"mysql://localhost:3306/testdb\" });\nconst user = await client.transaction(async (tx: SqlTransaction) => {\n await tx.query(\"INSERT INTO users (name) VALUES (?)\", [\"Alice\"]);\n return await tx.queryOne(\"SELECT LAST_INSERT_ID() as id\");\n});\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createMySqlClient } from \"@probitas-test/client-sql-mysql\";\n\nawait using client = await createMySqlClient({\n url: \"mysql://localhost:3306/testdb\",\n});\n\nconst result = await client.query(\"SELECT 1\");\n// Client automatically closed when scope exits\n```" } ] } ] }, "parameters": [ { "id": 3413, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MySQL client configuration" } ] }, "type": { "type": "reference", "target": 3522, "name": "MySqlClientConfig", "package": "@probitas-test/client-sql-mysql" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 3414, "name": "MySqlClient", "package": "@probitas-test/client-sql-mysql" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 3530, "name": "isConnectionError", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 3531, "name": "isConnectionError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Check if an error is a connection-level error." } ] }, "parameters": [ { "id": 3532, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ] } ], "packageName": "@probitas-test/client-sql-mysql", "packageVersion": "0.5.2" }