A modular, modern SDK for working with YDB in JavaScript/TypeScript. Supports queries, transactions, types, error handling, authentication, and more.
@ydbjs/core: Core connection and utilities@ydbjs/query: YQL queries, transactions, parameters@ydbjs/value: YDB types and values@ydbjs/api: gRPC/Protobuf service definitions@ydbjs/error: YDB error handling@ydbjs/auth: Authentication (tokens, anonymous, metadata)@ydbjs/retry: Flexible retry policies
import { Driver } from '@ydbjs/core'
import { query } from '@ydbjs/query'
const driver = new Driver('grpc://localhost:2136/local')
await driver.ready()
const sql = query(driver)
const resultSets = await sql`SELECT 1 + 1 AS sum`
console.log(resultSets) // [ [ { sum: 2 } ] ]npm install @ydbjs/core @ydbjs/query @ydbjs/value @ydbjs/api @ydbjs/errorParameterized Query:
import { Int64, Optional, PrimitiveType } from '@ydbjs/value'
const sql = query(driver)
await sql`SELECT ${new Optional(new Int64(100n), new PrimitiveType('INT64'))};`Transactions:
await sql.begin(async (tx, signal) => {
await tx`INSERT INTO users (id, name) VALUES (1, 'Alice')`
await tx`UPDATE users SET name = 'Bob' WHERE id = 1`
})Error Handling:
import { YdbError } from '@ydbjs/error'
try {
await sql`SELECT * FROM non_existent_table`
} catch (e) {
if (e instanceof YdbError) {
console.error('YDB Error:', e.message)
}
}- Add a new service? Use
@ydbjs/apifor gRPC definitions. - Work with YDB types? Use
@ydbjs/value. - Implement retries? Use
@ydbjs/retry. - More examples? See package docs and GitHub Examples.
- Build all packages:
npm run build - Run all tests:
npm test - Build a single package:
cd packages/query && npm run build - Generate gRPC/protobuf files (for @ydbjs/api):
cd packages/api && npm run generate
Devcontainer setup includes YDB and Prometheus for local development. See .devcontainer/ for details.
Contributions are welcome! Open issues, submit PRs, and discuss ideas.
Licensed under Apache 2.0.