Skip to content
프로젝트

ydb-platform/ydb-js-sdk has 82 GitHub stars and 50 forks. Star changes are not measured yet. Last checked 2026-11-18 11:39 UTC. Last push 2026-11-10.

이 수치를 측정하는 방법

측정된 스타 증가

in 24h
업데이트 지연
in 7 days
기록 수집 중
in 15 days
기록 수집 중
in 1 month
기록 수집 중

서로 겹치는 기간의 순증가량이며 일별 합계가 아닙니다. 측정값이 없으면 비워 둡니다. 스타는 관심도를 나타내며 품질을 보장하지 않습니다.

소개

YDB JavaScript/TypeScript SDK

데이터

README.md

Original

YDB JavaScript SDK

Docs codecov

Modern, modular SDK for YDB in TypeScript/JavaScript.

  • Type‑safe YQL queries with tagged templates
  • Automatic parameter binding and transactions
  • Rich value/type system with @ydbjs/value
  • Clear errors, retries, and diagnostics

Other versions


Packages


Quick Start

1) Install

npm install @ydbjs/core @ydbjs/query

TypeScript projects require TypeScript 7 or later.

2) Connect and Query

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 } ] ]

Documentation

Project docs:


Examples

Examples

  • Parameterized 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)
  }
}

AI Assistant Configuration

For projects using YDB SDK, you can configure AI assistants (GitHub Copilot, Cursor, etc.) to generate secure YQL code.

Multiple example configuration files are provided in packages/query/ai-instructions/:

  • .cursorrules.example - Cursor AI instructions
  • .instructions.example.md - General AI assistant guidelines
  • .copilot-instructions.example.md - GitHub Copilot specific
  • .ai-instructions.example.md - Alternative general format

Copy the appropriate file to your project root to enable secure AI code generation that follows YDB security best practices.


FAQ

  • Add a new service? Use @ydbjs/api for gRPC definitions.
  • Work with YDB types? Use @ydbjs/value.
  • Implement retries? Use @ydbjs/retry.
  • More examples? See package docs, local examples, or explore ydb-js-examples repository with comprehensive real-world examples.

Developer Guide

  • Build: npm run build
  • Test (all): npm test
  • Lint: npm run lint