v2.23 Preview Preview release - not for production v2024.1 STS Stable release with standard-term support v2.20 LTS Stable release with long-term support v2.18 STS Stable release with standard-term support v2.14 LTS Stable release with long-term support Unsupported versions

API

YugabyteDB API reference

SQL APIs

YugabyteDB supports two flavors of distributed SQL:

  • YSQL is a fully-relational SQL API that is wire compatible with the SQL language in PostgreSQL. It is best fit for RDBMS workloads that need horizontal write scalability and global data distribution while also using relational modeling features such as JOINs, distributed transactions and referential integrity (such as foreign keys).
  • YCQL is a semi-relational SQL API that is best fit for internet-scale OLTP and HTAP applications needing massive data ingestion and blazing-fast queries. It supports distributed transactions, strongly consistent secondary indexes and a native JSON column type. YCQL has its roots in the Cassandra Query Language.

Note that the APIs are isolated and independent from one another, and you need to select an API first before undertaking detailed database schema and query design and implementation.

YSQL reference
API reference for Yugabyte Structured Query Language (YSQL).
YCQL reference
API reference for Yugabyte Cloud Query Language (YCQL).

Client shells

YugabyteDB ships with command line interface (CLI) shells for interacting with each SQL API.

ysqlsh reference
CLI for interacting with YugabyteDB using YSQL.
ycqlsh reference
CLI for interacting with YugabyteDB using YCQL.

Management APIs

YugabyteDB Anywhere and Aeon both provide APIs that can be used to deploy and manage universes, query system status, manage accounts, and more.

YugabyteDB Anywhere API
Manage YugabyteDB Anywhere using the API.
API Documentation
YugabyteDB Aeon API
Manage YugabyteDB Aeon using the API.
API Documentation