YugabyteDB
    OR Ask AIAsk AI
    • Star us on Github YugabyteDB Github
    • Join us on Slack YugabyteDB Community Slack
    • Start Now
      • YugabyteDB Aeon
        YugabyteDB AeonTry our fully-managed cloud DBaaS for free.No credit card requiredSign up
      • YugabyteDB
        YugabyteDBTry our open source distributed SQL database on your laptop.Download
    • Products
      • YugabyteDB
        YugabyteDBThe open source distributed SQL database
      • YugabyteDB Anywhere
        YugabyteDB AnywhereSelf-managed cloud DBaaS
      • YugabyteDB Aeon
        YugabyteDB AeonFully-managed cloud DBaaS
      • YugabyteDB Voyager
        YugabyteDB VoyagerDatabase migration service
    • Tutorials
    • Integrations
    • API
      • SQL APIs
      • YSQL
        YSQL
      • YCQL
        YCQL
      • Clients
      • ysqlsh
        ysqlsh
      • ycqlsh
        ycqlsh
      • Management APIs
      • YugabyteDB Anywhere API
        YugabyteDB Anywhere API
      • YugabyteDB Aeon API
        YugabyteDB Aeon API
    • FAQ
    • Releases
      • YugabyteDB
        YugabyteDB
      • YugabyteDB Anywhere
        YugabyteDB Anywhere
      • YugabyteDB Aeon
        YugabyteDB Aeon
      • YugabyteDB Voyager
        YugabyteDB Voyager
      • YugabyteDB Clients
        YugabyteDB Clients
      • Tech Advisories
        Tech Advisories
    Docs Menu
    YugabyteDB
    YugabyteDBThe open source distributed SQL database
    • YugabyteDB
      YugabyteDBThe open source distributed SQL database
    • YugabyteDB Anywhere
      YugabyteDB AnywhereSelf-managed cloud DBaaS
    • YugabyteDB Aeon
      YugabyteDB AeonFully-managed cloud DBaaS
    • YugabyteDB Voyager
      YugabyteDB VoyagerDatabase migration service
    • Overview
    • Quick Start
    • Explore
      • SQL features
        • Schemas and tables
        • Data types
        • Read data
        • Write data
        • Expressions and operators
        • JSON support
        • Indexes
          • Primary keys
          • Secondary indexes
          • Unique indexes
          • Partial indexes
          • Covering indexes
          • Expression indexes
          • GIN indexes
          • Index backfill
        • Advanced features
          • Collations
          • Cursors
          • Foreign data wrappers
          • Savepoints
          • Stored procedures
          • Table partitioning
          • Triggers
          • Synchronize snapshots
          • Views
        • PostgreSQL extensions
          • Install extensions
          • Anonymizer
          • auto_explain
          • file_fdw
          • fuzzystrmatch
          • HypoPG
          • passwordcheck
          • pg_cron
          • pg_partman
          • pg_stat_statements
          • pgcrypto
          • pgvector
          • postgres_fdw
          • postgresql-hll
          • spi
          • tablefunc
          • uuid-ossp
      • Beyond PostgreSQL
        • Follower reads
        • Geo-placement
        • Configurable data sharding
        • xCluster - Asynchronous replication
        • Cluster topology
        • Cluster-aware drivers
        • Topology-aware drivers
        • Built-in connection pooling
        • Gen-AI apps
        • Decouple storage and compute
      • YCQL features
        • Cassandra feature support
        • Keyspaces and tables
        • Data types
        • Indexes and constraints
          • Primary keys
          • Secondary indexes
          • Unique indexes
          • Partial indexes
          • Covering indexes
          • Secondary indexes with JSONB
        • JSON support
      • Horizontal scalability
        • Horizontal vs vertical
        • Data distribution
        • Adding nodes
        • Scaling reads
        • Scaling writes
        • Scaling transactions
        • Large datasets
        • Scale out a universe
      • Resiliency
        • Node failures
        • Rack failures
        • Zone failures
        • Region failures
        • Periodic maintenance
        • Transactions
      • Transactions
        • Distributed transactions
        • Isolation levels
        • Explicit locking
      • Colocation
      • Multi-region deployments
        • Synchronous (3+ regions)
        • Row-level geo-partitioning
        • Read replicas
      • Change data capture
      • Cluster management
        • Point-in-time recovery
      • Observability
        • Prometheus integration
        • Grafana dashboard
        • Live queries
        • Tablet metadata
        • Terminated queries
        • Data transfer status
        • Lock insights
        • Active Session History
        • Logs
      • Query tuning
        • Get query statistics
        • Column statistics
        • Analyze queries
        • Query diagnostics
        • Optimize YSQL queries
      • Security
    • Develop
      • Data modeling
        • Primary keys
        • Secondary indexes
        • Hot shards
        • Partitioning tables
        • Common patterns
          • Time series
            • Global ordering by time
            • Ordering by time per entity
            • Automatic data expiration
            • Partition data by time
          • Key-value
          • Job queue
      • Build global applications
        • Global database
        • Duplicate indexes
        • Active-active multi-master
        • Active-active single-master
        • Latency-optimized geo-partitioning
        • Locality-optimized geo-partitioning
        • Follower reads
        • Read replicas
        • Real world scenarios
          • Global and geo-local tables
      • Build multi-cloud applications
        • Multi-cloud setup
        • Multi-cloud migration
        • Hybrid cloud
      • Learn app development
        • Transactions
          • Transaction retries
          • Performance tuning
          • Global applications
          • Error codes
        • Text search
          • Pattern matching
          • Similarity search
          • Full-text search
          • Phonetic search
        • Aggregations
        • Batch operations
        • Date and time
        • Strings and text
        • TTL for data expiration
      • Best practices
      • Drivers and ORMs
        • Smart drivers
        • Java
          • JDBC Drivers
          • Connect an app
          • Use an ORM
        • Go
          • Go Drivers
          • Connect an app
          • Use an ORM
        • Python
          • Python Drivers
          • Connect an app
          • Use an ORM
        • Node.js
          • Node.js Drivers
          • Connect an app
          • Use an ORM
        • Elixir
          • Phoenix
        • C
          • Connect an app
        • C++
          • Connect an app
        • C#
          • C# Drivers
          • Connect an app
          • Use an ORM
        • Ruby
          • Connect an app
          • Use an ORM
        • PHP
          • Connect an app
          • Use an ORM
        • Rust
          • Rust Drivers
          • Connect an app
          • Use an ORM
        • Build apps using ORMs
          • Java
          • Go
          • Python
          • Node.js
          • C#
          • Rust
          • PHP
        • Scala
          • Connect an app
        • Additional drivers
      • Change data capture
        • PostgreSQL protocol
          • Key concepts
          • Get started
          • Monitor
          • Advanced configuration
          • Advanced topics
          • Best practices
          • YugabyteDB connector
            • Connector properties
        • gRPC protocol
          • Get started
          • Monitor
          • YugabyteDB gRPC Connector
      • Quality of service
        • Rate limiting connections
        • Write-heavy workloads
        • Transaction priorities
      • Cloud-native development
        • Codespaces
        • Gitpod
      • Enhanced PG compatibility
      • PG15 features
    • Secure
      • Security checklist
      • Enable authentication
        • Enable users
        • Create login profiles
        • Configure client authentication
      • Authentication methods
        • Password authentication
        • LDAP authentication
        • Host-based authentication
        • Trust authentication
      • Role-based access control
        • Overview
        • Manage users and roles
        • Grant privileges
        • Row-level security
        • Column-level security
      • Encryption in transit
        • Create server certificates
        • Enable encryption in transit
        • Connect to clusters
        • TLS and authentication
      • Encryption at rest
      • Column-level encryption
      • Audit logging
        • Trace statements
        • Configure audit logging
        • Session-level audit logging
        • Object-level audit logging
      • Vulnerability disclosure policy
    • Launch and Manage
      • Deploy
        • Deployment checklist
        • Manual deployment
          • 1. System configuration
          • 2. Install software
          • 3. Start YB-Masters
          • 4. Start YB-TServers
          • 5. Verify deployment
        • Kubernetes
          • Single-zone
            • Open Source
            • Amazon EKS
            • Google Kubernetes Engine
            • Azure Kubernetes Service
          • Multi-zone
            • Amazon EKS
            • Google Kubernetes Engine
          • Multi-cluster
            • Google Kubernetes Engine
          • Best practices
          • Connect Clients
        • Public clouds
          • Amazon Web Services
          • Google Cloud Platform
          • Microsoft Azure
        • Multi-DC deployments
          • Three+ data center (3DC)
          • xCluster
            • Transactional
              • Setup
              • Failover
              • Switchover
              • Manual DDL changes
            • Non-transactional
          • Read replicas
      • Manage
        • Backup and restore
          • Export and import
          • Distributed snapshots
          • Point-in-time recovery
          • Instant database cloning
          • Time travel query
        • Migrate
          • Export data
          • Import data
          • Verify migration
          • Migrate from PostgreSQL
        • Change cluster configuration
        • Diagnostics reporting
        • Upgrade YugabyteDB
          • YSQL major upgrade
      • Monitor
        • Metrics
          • Throughput+latency metrics
          • Connection metrics
          • Cache and storage metrics
          • Raft metrics
          • YB-Master metrics
          • xCluster
        • xCluster
      • Troubleshoot
        • Cluster-level issues
          • YCQL API connection issues
          • Recover YB-TServer and YB-Master
          • Replace a failed YB-TServer
          • Replace a failed YB-Master
          • Manual remote bootstrap of failed peer
          • Recover YB-TServer from crash loop
          • Performance issues
        • Node-level issues
          • Check servers
          • System statistics
          • Disk failure
          • Disk full
          • Common error messages
        • YSQL issues
        • Other issues
    • Reference
      • Key concepts
      • Architecture
        • Design goals
        • YQL - Query layer
          • Query Planner
          • Join Strategies
        • System catalog
        • DocDB - Storage layer
          • Data model
          • Packed rows
          • LSM & SST
          • Performance
        • Sharding
          • Hash and range sharding
          • Tablet splitting
        • Replication
          • Raft
          • Synchronous
          • xCluster
          • Read replicas
          • CDC using PostgreSQL protocol
          • CDC using gRPC protocol
        • Transactions
          • Fundamentals
          • Distributed transactions
          • Transactional I/O path
          • Single-row transactions
          • Isolation levels
          • Concurrency control
          • Transaction priorities
          • Read Committed
          • Read Restart error
        • YB-Master
        • YB-TServer
      • CLIs
        • yb-admin
        • yb-ts-cli
        • ysql_dump
        • ysql_dumpall
        • yb-ctl
        • yb-docker-ctl
      • Configuration
        • yugabyted
        • yb-master
        • yb-tserver
        • Operating systems
        • Default ports
      • Resource guide
      • Sample datasets
        • Chinook
        • Northwind
        • PgExercises
        • SportsDB
        • Retail Analytics
      • Misc
        • YEDIS
          • Quick start
          • Develop
            • Build an application
            • C#
            • C++
            • Go
            • Java
            • NodeJS
            • Python
          • API reference
            • APPEND
            • AUTH
            • CONFIG
            • CREATEDB
            • DELETEDB
            • LISTDB
            • SELECT
            • DEL
            • ECHO
            • EXISTS
            • EXPIRE
            • EXPIREAT
            • FLUSHALL
            • FLUSHDB
            • GET
            • GETRANGE
            • GETSET
            • HDEL
            • HEXISTS
            • HGET
            • HGETALL
            • HINCRBY
            • HKEYS
            • HLEN
            • HMGET
            • HMSET
            • HSET
            • HSTRLEN
            • HVALS
            • INCR
            • INCRBY
            • KEYS
            • MONITOR
            • PEXPIRE
            • PEXPIREAT
            • PTTL
            • ROLE
            • SADD
            • SCARD
            • RENAME
            • SET
            • SETEX
            • PSETEX
            • SETRANGE
            • SISMEMBER
            • SMEMBERS
            • SREM
            • STRLEN
            • ZRANGE
            • TSADD
            • TSCARD
            • TSGET
            • TSLASTN
            • TSRANGEBYTIME
            • TSREM
            • TSREVRANGEBYTIME
            • TTL
            • ZADD
            • ZCARD
            • ZRANGEBYSCORE
            • ZREM
            • ZREVRANGE
            • ZSCORE
            • PUBSUB
            • PUBLISH
            • SUBSCRIBE
            • UNSUBSCRIBE
            • PSUBSCRIBE
            • PUNSUBSCRIBE
        • Legal
          • Third-party software
    • Benchmark
      • TPC-C
        • Run benchmark
        • Testing horizontal scalability
        • Testing high scale workloads
      • sysbench
      • YCSB
      • Key-value workload
      • Large datasets
      • Scalability
        • Scaling queries
      • Resilience
        • Jepsen testing
    • Contribute
      • Core database
        • Contribution checklist
        • Build the source
        • Configure a CLion project
        • Build and test
        • Coding style
      • Documentation
        • Docs checklist
        • Docs layout
        • Build the docs
          • Editor setup
        • Edit the docs
          • Docs page structure
          • Widgets and shortcodes
          • Syntax diagrams
          • Page with elements
        • Style guide
    • Download
    • Join our community
      • Slack
      • Yugabyte University
      • GitHub
      • Yugabyte Friday Tech Talks
      • Forum
    • Contact Support
    1. YugabyteDB
    2. Contribute
    3. Documentation

    Contribute to the documentation

    How to contribute to the YugabyteDB documentation
    • Contribute List Contribute
      Report a doc issue Suggest new content Edit this page Contributor guide
    Contribution checklist
    Explore the contribution process, from start to finish.
    Docs layout
    Find the right page or section.
    Build the docs
    Run the docs site on your local machine.
    Edit the docs
    Fork the repository and edit the docs.
    Style guide
    Read the YugabyteDB documentation style guide.
    YugabyteDB
    © 2025 Yugabyte, Inc. All Rights ReservedPrivacy Policy | Terms of Service