Docs Home
Quickstart
Quickstart
CockroachDB Cloud
Create an Account
Create a CockroachDB Cloud Cluster
Create a CockroachDB Cloud Cluster
Connect to Your Cluster
Connect to Your Cluster
Learn CockroachDB SQL
Use the Cloud API
Manage Your Cluster
Manage Your Cluster
Security Overview
Authentication Overview
Single Sign-On (SSO)
Configure Cloud Organization SSO
Access Management Overview and FAQ
Managing Access in CockroachDB Cloud
Network Authorization
Create Private Clusters
Egress Perimeter Controls (Preview)
SQL Audit Logging
Export Cloud Organization Audit Logs
Migration Overview
Migrate from Oracle
Migrate from PostgreSQL
Migrate from MySQL
Migrate from CSV
Migrate from Avro
Import Performance Best Practices
Tune Performance
Move into Production
Cluster Overview Page
Alerts Page
Tools Page
Statements Page
Sessions Page
Transactions Page
Databases Page
Troubleshoot Your Cluster
Take and Restore Customer-Owned Backups
Use Managed-Service Backups
Upgrade Policy
Upgrade a cluster
Manage Billing
Deploy a Python To-Do App with Flask, Kubernetes, and CockroachDB Cloud
Stream a Changefeed to Snowflake
Cloud Release Notes
CockroachDB Self-Hosted
Install CockroachDB
Install CockroachDB
Install CockroachDB
Install CockroachDB
From Binary
From Binary
In Kubernetes
In Kubernetes
In Docker
In Docker
In Docker
Simulate a Multi-Region Cluster on localhost
Learn CockroachDB SQL
Replication & Rebalancing
Fault Tolerance & Recovery
Multi-Region Performance
Serializable Transactions
Spatial Data
Cross-Cloud Migration
Orchestration with Kubernetes
JSON Support
SQL Tuning with EXPLAIN
Overview
Install a driver or ORM
Connect to a Cluster
Connect to a Cluster
Use Connection Pools
Overview
Create a Database
Create a User-defined Schema
Create a Table
Add Secondary Indexes
Change and Remove Objects
Online Schema Changes
Use Computed Columns
Group Columns into Families
Index a Subset of Rows
Index Sequential Keys
Index JSON and Array Data
Index Spatial Data
Scale to Multi-region
Insert Data
Update Data
Bulk-update Data
Delete Data
Bulk-delete Data
Select Rows of Data
Reusable Views
Subqueries
Create Temporary Tables
Paginate Results
AS OF SYSTEM TIME
Follower Reads
Query Spatial Data
Transactions
Test Your Application Locally
Log Events
Monitor CockroachDB Apps in the DB Console
Troubleshoot Common Problems
Overview
Performance Best Practices
Use the EXPLAIN statement
Performance tuning recipes
Overview
Go
Go
Go
Go
Java
Java
Java
Java
JavaScript/TypeScript (Node.js)
JavaScript/TypeScript (Node.js)
JavaScript/TypeScript (Node.js)
JavaScript/TypeScript (Node.js)
JavaScript/TypeScript (Node.js)
Python
Python
Python
Ruby
Ruby
C# (.NET)
Rust
Spring Boot with JDBC
Spring Boot with JPA
Overview
Overview
Global Application Use-case
Multi-region Database Schema
Set up a Development Environment
Develop a Global Application
Deploy a Global Application
Supported by Cockroach Labs
Supported by the Community
Alembic
Flyway
Liquibase
DBeaver GUI
IntelliJ IDEA
Google Cloud Run
AWS Lambda
Production Checklist
Overview
Choosing a multi-region configuration
When to use ZONE vs. REGION Survival Goals
When to use REGIONAL vs. GLOBAL tables
Data Domiciling
Migrate to Multi-region SQL
Overview
Development
Basic Production
Regional Tables
Global Tables
Follower Reads
Follow-the-Workload
Overview
On-Premises
On-Premises
AWS
AWS
Azure
Azure
Digital Ocean
Digital Ocean
Google Cloud Platform GCE
Google Cloud Platform GCE
Overview
Kubernetes Single-Cluster Deployment
Kubernetes Single-Cluster Deployment
Operate CockroachDB on Kubernetes
Monitor CockroachDB on Kubernetes
OpenShift Single-Cluster Deployment
Kubernetes Multi-Cluster Deployment
Kubernetes Performance Optimization
Full and Incremental Backups
Backups with Revision History and Point-in-time Restore
Encrypted Backup and Restore
Locality-aware Backup and Restore
Scheduled Backups
Cloud Storage
Userfile Storage
Local File Server
Overview
Benchmarking Instructions
Benchmarking Instructions
Benchmarking Instructions
Benchmarking Instructions
Tuning Best Practices
Performance tuning recipes
Improving statement performance
Tuning with EXPLAIN
Overview
Authentication
Encryption
Authorization
SQL Audit Logging
GSSAPI Authentication
Single Sign-on
Overview
Enable the Node Map
Use Prometheus and Alertmanager
Cluster API
Overview
Datadog
Kibana
Overview
Configure Logs
Logging Use Cases
Upgrade to CockroachDB v21.1
Online Schema Changes
Manage Long-Running Queries
Decommission Nodes
Rotate Security Certificates
Disaster Recovery
Replication Controls
Stream Data Out of CockroachDB
Overview
Table Partitioning
Migration Overview
Migrate from Oracle
Migrate from Postgres
Migrate from MySQL
Migrate from CSV
Migrate from Avro
Migrate from Shapefiles
Migrate from OpenStreetMap
Migrate from GeoJSON
Migrate from GeoPackage
Export Spatial Data
Import Performance Best Practices
Overview
Common Errors
Troubleshoot Cluster Setup
Troubleshoot Query Behavior
Understand Debug Logs
Replication Reports
Support Resources
File an Issue
Product FAQs
SQL FAQs
Operational FAQs
Availability FAQs
Licensing FAQs
CockroachDB in Comparison
Latest Production Release
All Releases
v25.1
v24.3
v24.2
v24.1
Release Support Policy
Known Limitations
CockroachDB Cloud
CockroachDB Kubernetes Operator
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Technical Advisories
Unsupported Versions
Architecture
SQL Layer
Transaction Layer
Distribution Layer
Replication Layer
Storage Layer
Life of a Distributed Transaction
Reads and Writes Overview
SQL
Full SQL Grammar
Keywords & Identifiers
Constants
Selection Queries
Table Expressions
Common Table Expressions
Scalar Expressions
NULL Handling
Overview
ADD COLUMN
ADD CONSTRAINT
ADD REGION (Enterprise)
ALTER COLUMN
ALTER DATABASE
ALTER INDEX
ALTER PARTITION (Enterprise)
ALTER PRIMARY KEY
ALTER RANGE
ALTER ROLE
ALTER SCHEMA
ALTER SEQUENCE
ALTER TABLE
ALTER TYPE
ALTER USER
AS OF SYSTEM TIME
EXPERIMENTAL_AUDIT
ALTER VIEW
BACKUP
BEGIN
CANCEL JOB
CANCEL QUERY
CANCEL SESSION
COMMENT ON
COMMIT
CONFIGURE ZONE
CONVERT TO SCHEMA
COPY FROM
CREATE CHANGEFEED (Enterprise)
CREATE DATABASE
CREATE INDEX
CREATE ROLE
CREATE SCHEDULE FOR BACKUP
CREATE SCHEMA
CREATE SEQUENCE
CREATE STATISTICS
CREATE TABLE
CREATE TABLE AS
CREATE TYPE
CREATE USER
CREATE VIEW
DELETE
DROP COLUMN
DROP CONSTRAINT
DROP DATABASE
DROP REGION (Enterprise)
DROP TYPE
DROP INDEX
DROP ROLE
DROP SCHEDULES
DROP SCHEMA
DROP SEQUENCE
DROP TABLE
DROP USER
DROP VIEW
EXPERIMENTAL CHANGEFEED FOR
EXPLAIN
EXPLAIN ANALYZE
EXPORT
GRANT
IMPORT
IMPORT INTO
INSERT
JOIN
LIMIT/OFFSET
ORDER BY
OWNER TO
PARTITION BY (Enterprise)
PAUSE JOB
PAUSE SCHEDULES
REASSIGN OWNED
REFRESH
RENAME COLUMN
RENAME CONSTRAINT
RENAME DATABASE
RENAME INDEX
RENAME TABLE
RELEASE SAVEPOINT
RESET <session variable>
RESET CLUSTER SETTING
RESTORE
RESUME JOB
RESUME SCHEDULES
REVOKE
ROLLBACK
SAVEPOINT
SELECT
SELECT FOR UPDATE
SET <session variable>
SET CLUSTER SETTING
SET LOCALITY
SET PRIMARY REGION (Enterprise)
SET SCHEMA
SET TRANSACTION
SHOW <session variables>
SHOW BACKUP
SHOW CLUSTER SETTING
SHOW COLUMNS
SHOW CONSTRAINTS
SHOW CREATE
SHOW DATABASES
SHOW ENUMS
SHOW FULL TABLE SCANS
SHOW GRANTS
SHOW INDEX
SHOW JOBS
SHOW LOCALITY
SHOW PARTITIONS (Enterprise)
SHOW RANGES
SHOW RANGE FOR ROW
SHOW REGIONS
SHOW ROLES
SHOW SCHEDULES
SHOW SCHEMAS
SHOW SEQUENCES
SHOW SESSIONS
SHOW STATEMENTS
SHOW STATISTICS
SHOW SAVEPOINT STATUS
SHOW TABLES
SHOW TRACE FOR SESSION
SHOW TRANSACTIONS
SHOW TYPES
SHOW USERS
SHOW ZONE CONFIGURATIONS
SPLIT AT
SURVIVE {ZONE,REGION} FAILURE
TRUNCATE
UNSPLIT AT
UPDATE
UPSERT
VALIDATE CONSTRAINT
WITH
Overview
ARRAY
BIT
BOOL
BYTES
COLLATE
DATE
DECIMAL
ENUM
FLOAT
INET
INT
INTERVAL
JSONB
SERIAL
STRING
TIME
TIMESTAMP
UUID
Overview
Check
Default Value
Foreign Key
Not Null
Primary Key
Unique
Functions and Operators
Window Functions
Name Resolution
Overview
crdb_internal
information_schema
pg_catalog
pg_extension
Cluster Settings
Indexes
Cost-Based Optimizer
Vectorized Execution Engine
Load-Based Splitting
CLI
Client Connection Parameters
cockroach start
cockroach init
cockroach start-single-node
cockroach cert
cockroach quit
cockroach sql
cockroach sqlfmt
cockroach node
cockroach nodelocal upload
cockroach auth-session
cockroach dump
cockroach demo
cockroach debug ballast
cockroach debug encryption-active-key
cockroach debug list-files
cockroach debug merge-logs
cockroach debug zip
cockroach statement-diag
cockroach gen
cockroach userfile upload
cockroach userfile list
cockroach userfile get
cockroach userfile delete
cockroach version
cockroach workload
cockroach import
DB Console
Cluster Overview Page
Overview Dashboard
Hardware Dashboard
Runtime Dashboard
SQL Dashboard
Storage Dashboard
Replication Dashboard
Changefeeds Dashboard
Custom Chart
Databases Page
Sessions Page
Statements Page
Transactions Page
Network Latency Page
Jobs Page
Advanced Debug Page
Cluster API
Logging
Log formats
Notable event types
Diagnostics Reporting
Cloud Release Notes