Contents
Getting started
- Overview
- Creating a database
- Authentication
- YDB command line interface (CLI)
- YQL query language
- YDB SDK
- Single-node cluster deployment
- Useful links
- How to edit the documentation
Concepts
- Overview
- Terms and definitions
- Connecting to a database
- Authentication
- Data model and schema
- Serverless and Dedicated operation modes
- Transactions
- Secondary indexes
- Change Data Capture (CDC)
- Time to Live (TTL)
- Scan queries
- Database limits
- YDB cluster
Practical guidelines
- Custom attributes in tables
Recommendations
Managing databases
Managing a cluster
YQL
Working with the YDB CLI
- Overview
- Installation
- All commands in alphabetical order
- Service commands
- Connecting to and authenticating with a database
- Global parameters
- YDB CLI commands
  - table attribute add
  - table attribute drop
- Working with the DB schema
- Operations with data
- Importing and exporting data
- Working with topics
- YQL execution
- Managing long running operations
- Managing profiles
- Information services
- Load testing
Working with the YDB SDK
- Overview
- Installation
- Authentication
- Working with topics
- Test app
  - Overview
  - C++
  - C# (.NET)
  - Go
  - Java
  - Node.js
  - PHP
  - Python
  - Archive
    - Go v1
    - Go v2
- Handling errors in the API
- gRPC API
  - Overview
  - Health Check API
- Code recipes
- Comparison of SDK features
Questions and answers
Downloads
Public talks
What's new
- Changelog
- Security changelog

How to participate in the development of documentation

The source code of the YDB documentation is open and published at https://github.com/ydb-platform/ydb/tree/main/ydb/docs.

The YDB team accepts requests for edits and updates to the YDB documentation, which anyone can offer through Pull Requests on github.com.

Before creating a pull request, see the documentation development requirements described in the articles of this section and check the build locally.

Was the article helpful?