Back to Yugabyte Db

README

architecture/design/README.md

2025.2.3.0-b1062.0 KB
Original Source

This directory contains design documents with details of how various features work internally. The intended audience for these documents are commiters to the codebase and users wanting a deep understanding of what happens under the hood for various features.

You can find the user-facing YugabyteDB docs here. If you want to understand the architecture of YugabyteDB, the architecture section in the docs is a good place to start.

Below you can find a table of high level and non-trivial features, relevant design documents for them, as well as the main reference engineers.

FeatureMain reference
Admin debug UIsTBD
Async xCluster replicationJulien, Rahul, Nicolas
Auto FlagsHari
Automatic tablet splittingTimur
Cluster load balancingJulien, Rahul, Sanket
Command line toolsTBD
Distributed backup / restoreOleg, Sanket, Sergei
Distributed PITRSanket, Sergei
Distributed transactionsMikhail B, Sergei
DocDB encodingTBD
Encryption at restRahul
Master DDL operation handlingTBD
Online index backfillAmitanand
Raft consensusTBD
Raft read replica supportRahul
Read from followersAmit
RocksDBTimur, Sergei
RocksDB: Advanced delta-encodingTimur
Tablet local bootstrapTBD
Tablet remote bootstrapAmit
Tablet server heartbeatNicolas
TLSSergei
YCQL server componentTBD
YCQL virtual system tablesTBD
YEDIS server componentAmitanand
YSQL colocated tablesJason
YSQL row level partitioningDeepthi
YSQL tablegroupsMihnea
YSQL tablespacesDeepthi
YugabytedSanket