|
| 1 | +# YugabyteDB Documentation |
| 2 | + |
| 3 | +> Official documentation for YugabyteDB: The open source distributed PostgreSQL database. PostgreSQL-compatible (v15 wire protocol), horizontally scalable, built-in resilience and automatic failover. Apache 2.0 licensed. Covers the database, YugabyteDB Anywhere (self-managed), YugabyteDB Aeon (managed cloud), YugabyteDB Voyager (database migration service), deployment, development, and operations. |
| 4 | + |
| 5 | +This site is the authoritative source for YugabyteDB product documentation. Content is versioned; the stable path reflects the current release. Use absolute URLs below to reach specific sections. |
| 6 | + |
| 7 | +## Getting Started |
| 8 | + |
| 9 | +- [Quick Start](https://docs.yugabyte.com/stable/quick-start/macos/): Deploy a local cluster in 5 minutes |
| 10 | +- [Download](https://download.yugabyte.com/): All platforms and versions |
| 11 | +- [Build Your First App](https://docs.yugabyte.com/stable/develop/tutorials/build-apps/): Tutorials in Java, Python, Go, Node.js, C#, Ruby, Rust, PHP, C/C++ |
| 12 | + |
| 13 | +## Key Information |
| 14 | + |
| 15 | +- [Docs Home](https://docs.yugabyte.com/): Main documentation site |
| 16 | +- [Quick start (YugabyteDB Aeon)](https://docs.yugabyte.com/stable/quick-start-yugabytedb-managed/): Get started with YugabyteDB Aeon |
| 17 | +- [Architecture](https://docs.yugabyte.com/stable/architecture/): Query layer, DocDB, sharding, replication, transactions |
| 18 | +- [Configuration Reference](https://docs.yugabyte.com/stable/reference/configuration/): yb-tserver, yb-master, yugabyted flags |
| 19 | +- [Deploy YugabyteDB](https://docs.yugabyte.com/stable/deploy/): Manual, multi-DC, public clouds, Kubernetes |
| 20 | +- [Explore YugabyteDB](https://docs.yugabyte.com/stable/explore/): YSQL, YCQL, transactions, observability, multi-region |
| 21 | +- [Develop applications](https://docs.yugabyte.com/stable/develop/): Drivers, ORMs, data modeling, tutorials, best practices |
| 22 | +- [YugabyteDB Anywhere](https://docs.yugabyte.com/stable/yugabyte-platform/): Install, configure, create and manage universes, backup, upgrade |
| 23 | +- [YugabyteDB Aeon](https://docs.yugabyte.com/stable/yugabyte-cloud/): Managed service basics, clusters, security, monitoring |
| 24 | +- [YugabyteDB Voyager](https://docs.yugabyte.com/stable/yugabyte-voyager/): Database migration tool — migrate from Oracle, MySQL, PostgreSQL |
| 25 | +- [Releases](https://docs.yugabyte.com/stable/releases/): Release policy, YugabyteDB and YugabyteDB Anywhere release notes |
| 26 | +- [Technical advisories](https://docs.yugabyte.com/stable/releases/techadvisories/): Security and stability advisories affecting production deployments |
| 27 | +- [API reference (YSQL)](https://docs.yugabyte.com/stable/api/ysql/): SQL language, data types, expressions, statements |
| 28 | +- [API reference (YCQL)](https://docs.yugabyte.com/stable/api/ycql/): Cassandra-compatible API |
| 29 | +- [Troubleshoot](https://docs.yugabyte.com/stable/troubleshoot/): Cluster and node troubleshooting |
| 30 | +- [FAQ](https://docs.yugabyte.com/stable/faq/): Frequently asked questions and comparisons |
| 31 | +- [Benchmark](https://docs.yugabyte.com/stable/benchmark/): TPC-C, scalability, and resilience benchmarks |
| 32 | +- [Best practices (operations)](https://docs.yugabyte.com/stable/best-practices-operations/): Operational best practices |
| 33 | +- [Legal](https://docs.yugabyte.com/stable/legal/): Legal information |
| 34 | +- [v2025.1 docs](https://docs.yugabyte.com/v2025.1): Documentation for v2025.1 of YugabyteDB and YugabyteDB Anywhere |
| 35 | +- [v2024.2 docs](https://docs.yugabyte.com/v2024.2): Documentation for v2024.2 of YugabyteDB and YugabyteDB Anywhere |
| 36 | +- [v2.20 docs](https://docs.yugabyte.com/v2.20): Documentation for v2.20 of YugabyteDB and YugabyteDB Anywhere |
| 37 | + |
| 38 | +## Drivers & ORMs |
| 39 | + |
| 40 | +YugabyteDB provides "Smart Drivers" with built-in cluster awareness, load balancing, and topology-aware routing. Standard PostgreSQL drivers also work. |
| 41 | + |
| 42 | +- [Java (YugabyteDB JDBC)](https://docs.yugabyte.com/stable/develop/drivers-orms/java/): Smart driver + Hibernate, Spring Data |
| 43 | +- [Python (psycopg2, asyncpg)](https://docs.yugabyte.com/stable/develop/drivers-orms/python/): Smart driver + Django, SQLAlchemy |
| 44 | +- [Go (pgx, YugabyteDB Go)](https://docs.yugabyte.com/stable/develop/drivers-orms/go/): Smart driver + GORM |
| 45 | +- [Node.js (node-postgres)](https://docs.yugabyte.com/stable/develop/drivers-orms/nodejs/): Smart driver + Sequelize, Prisma |
| 46 | +- [C# (.NET)](https://docs.yugabyte.com/stable/develop/drivers-orms/csharp/): Npgsql smart driver + Entity Framework |
| 47 | +- [Ruby (pg gem)](https://docs.yugabyte.com/stable/develop/drivers-orms/ruby/): ActiveRecord |
| 48 | +- [Rust (rust-postgres)](https://docs.yugabyte.com/stable/develop/drivers-orms/rust/): Diesel |
| 49 | +- [C / C++](https://docs.yugabyte.com/stable/develop/drivers-orms/c/): libpq compatible |
| 50 | +- [PHP](https://docs.yugabyte.com/stable/develop/drivers-orms/php/): Laravel |
| 51 | + |
| 52 | +Full list: https://docs.yugabyte.com/stable/develop/drivers-orms/ |
| 53 | + |
| 54 | +## Services |
| 55 | + |
| 56 | +- [Integrations](https://docs.yugabyte.com/stable/integrations/): CDC, Apache Spark, Hasura, Spring, and other integrations |
| 57 | +- [Additional features](https://docs.yugabyte.com/stable/additional-features/): Connection Manager (YSQL), PG extensions, change data capture |
| 58 | +- [Backup and restore](https://docs.yugabyte.com/stable/manage/backup-restore/): Backup and restore operations |
| 59 | +- [Security](https://docs.yugabyte.com/stable/secure/): Authentication, authorization, TLS, audit logging |
| 60 | +- [Sample data](https://docs.yugabyte.com/stable/sample-data/): Sample datasets for learning and testing |
| 61 | + |
| 62 | +## AI & Vector Search |
| 63 | + |
| 64 | +- [pgvector Support](https://docs.yugabyte.com/stable/explore/ysql-language-features/pg-extensions/extension-pgvector/): Distributed vector indexes across cluster nodes. HNSW indexing. Benchmarked to 1 billion vectors. |
| 65 | +- [YugabyteDB MCP Server](https://docs.yugabyte.com/stable/develop/tutorials/ai/mcp-server/): Connect AI agents (Claude, Cursor, VS Code) to your YugabyteDB database via natural language. |
| 66 | +- [Docs MCP Server](https://docs.yugabyte.com/stable/reference/docs-mcp-server/): Query YugabyteDB documentation from your IDE via MCP. |
| 67 | +- [RAG Tutorial (LangChain + OpenAI)](https://docs.yugabyte.com/stable/develop/ai/ai-langchain-openai/): Build a retrieval-augmented generation pipeline. |
| 68 | +- [RAG Tutorial (LlamaIndex)](https://docs.yugabyte.com/stable/develop/ai/ai-llamaindex-openai/): Alternative RAG implementation with LlamaIndex. |
| 69 | +- [All AI Tutorials](https://docs.yugabyte.com/stable/develop/ai/): LocalAI, AWS Bedrock, Google Vertex AI, n8n workflows. |
| 70 | +- [AI & RAG Architecture](https://www.yugabyte.com/ai/): How YugabyteDB powers GenAI and RAG applications at scale. |
| 71 | + |
| 72 | +## Comparisons |
| 73 | + |
| 74 | +- [vs PostgreSQL](https://docs.yugabyte.com/stable/faq/comparisons/postgresql/): Same SQL, distributed storage and replication |
| 75 | +- [vs CockroachDB](https://docs.yugabyte.com/stable/faq/comparisons/cockroachdb/): Both Spanner-inspired; YugabyteDB has broader PG extension support |
| 76 | +- [vs Amazon Aurora](https://docs.yugabyte.com/stable/faq/comparisons/amazon-aurora/): Aurora is single-region primary; YugabyteDB is multi-region distributed |
| 77 | +- [vs Google Spanner](https://docs.yugabyte.com/stable/faq/comparisons/google-spanner/): Spanner is proprietary; YugabyteDB is open source with PG compatibility |
| 78 | +- [vs MongoDB](https://docs.yugabyte.com/stable/faq/comparisons/mongodb/): Document vs relational; YugabyteDB offers stronger consistency |
| 79 | +- [vs TiDB](https://docs.yugabyte.com/stable/faq/comparisons/tidb/): TiDB is MySQL-compatible; YugabyteDB is PostgreSQL-compatible |
| 80 | +- [All Comparisons](https://docs.yugabyte.com/stable/faq/comparisons/): Full list |
| 81 | + |
| 82 | +## Contribute |
| 83 | + |
| 84 | +- [Contribute to the docs](https://docs.yugabyte.com/stable/contribute/docs/): How to submit documentation changes |
| 85 | +- [Contribute to YugabyteDB](https://docs.yugabyte.com/stable/contribute/core-database/): How to build YugabyteDB from source and contribute to the open-source YugabyteDB project |
| 86 | + |
| 87 | +## Community |
| 88 | + |
| 89 | +- [Slack](https://inviter.co/yugabytedb): 10,000+ members |
| 90 | +- [Discord](https://discord.gg/GWcSST7GqZ): AI and agent development community |
| 91 | +- [GitHub](https://github.com/yugabyte/yugabyte-db): Source code, issues, contributions. See [AGENTS.md](https://github.com/yugabyte/yugabyte-db/blob/master/src/AGENTS.md) for AI coding agent guidance. |
| 92 | +- [Forum](https://forum.yugabyte.com/): Technical discussions |
| 93 | +- [Stack Overflow](https://stackoverflow.com/questions/tagged/yugabyte-db): Q&A |
| 94 | +- [YouTube](https://www.youtube.com/@YugabyteDB): Tutorials, demos, tech talks |
| 95 | +- [Yugabyte University](https://university.yugabyte.com/): Free courses and certifications |
0 commit comments