ydb/README.md

YDB Platform

Website | Documentation | Official Repository | YouTube Channel

YDB is an open-source Distributed SQL Database that combines high availability and scalability with strict consistency and ACID transactions.

Main YDB Advantages

YDB was designed from scratch as a response to growing demand for scalable interactive web services. Scalability, strict consistency and effective cross-row transactions were a must for such OLTP-like workload. YDB was built by people with strong background in databases and distributed systems, who had an experience of developing No-SQL database and the Map-Reduce system for one of the largest search engines in the world. We found that YDB's flexible design allows us to build more services on top of it including persistent queues and virtual block devices.

Basic YDB features:

• Fault-tolerant configuration that survive disk, node, rack or even datacenter outage;
• Horizontal scalability;
• Automatic disaster recovery with minimum latency disruptions for applications;
• SQL dialect (YQL) for data manipulation and scheme definition;
• ACID transactions across multiple nodes and tables with strict consistency.

Fault-tolerant configurations

YDB could be deployed in three availability zones. Cluster remains available for both reads and writes during complete outage of a single zone.

Availability zones and regions are covered in more detail in documentation.

Horizontal scalability

Unlike traditional relational databases YDB scales out providing developers with capability to simply extend cluster with computation or storage resources to handle increasing load.

Current production installations have more than 10,000 nodes, store petabytes of data and handle more than 100,000 distributed transactions per second.

Automatic disaster recovery

YDB Platform has built-in automatic recovery support to survive a hardware failure. After unpredictable disk, node, rack or even datacenter failure YDB platform remains fully available for reads and writes and restores required data redundancy automatically.

Supported platforms

Minimal system requirements

YDB runs on x86 64bit platforms with minimum 8 GB of RAM.

Operating systems

We have major experience running production systems on 64-bit x86 machines working under Ubuntu Linux.

For development purposes we test that YDB could be built and run under latest versions of MacOS and Microsoft Windows on a regular basis.

Getting started in 5 minutes

1. Install YDB using pre-built executables, build it from source or use Docker container.
2. Install command line interace tool to work with scheme and run queries.
3. Start local cluster or container and run YQL query via YDB CLI.
4. Access Embedded UI via browser for schema navigation, query execution and other database development related tasks.
5. Run available example application.
6. Develop an application using YDB SDK

How to build

Prerequisites

In order to build ydbd you should have following tools installed on your system:

1. Git command line tool
2. Python

Build process

1. git clone https://github.com/ydb-platform/ydb.git
2. cd ydb/apps/ydbd
3. ../../../ya make -r

How to deploy

• Deploy a cluster using Kubernetes.
• Deploy a cluster using pre-built executables.

How to contribute

We are glad to welcome new contributors!

1. Please read contributor's guide.
2. We can accept your work to YDB Platform after you have read contributor's license agreement (aka CLA).
3. Please don't forget to add a note to your pull request, that you agree to the terms of the CLA.

More information can be found in CONTRIBUTING file.

Success stories

See YDB Platform official web site for the latest success stories and projects using YDB Platform.