This page provides an overview of database schemas in CockroachDB.
The follow-up pages listed in What's next provide best practices for designing a database schema that optimizes performance and storage resources.
Database schema objects
The following sections provide a brief overview of the logical objects that make up a database schema in CockroachDB.
For detailed documentation on object name resolution, see Name Resolution.
Database objects make up the first level of the CockroachDB naming hierarchy. They contain schemas.
All CockroachDB clusters include a preloaded database named
defaultdb. Rather than using the
defaultdb database, we recommend creating your own database.
For guidance on creating databases, see Create a Database.
To avoid confusion with the general term "database", throughout this guide we refer to the logical object as a database, to CockroachDB by name, and to a deployment of CockroachDB as a cluster.
Schemas make up the second level of the naming hierarchy. Each schema belongs to a single database. Schemas contain tables and other objects, like views and sequences.
All CockroachDB clusters include a preloaded schema named
public. CockroachDB also supports creating your own user-defined schema.
For guidance on creating user-defined schemas, see Create a User-defined Schema.
To avoid confusion with the general term "schema", in this guide we refer to the logical object as a user-defined schema, and to the relationship structure of logical objects in a cluster as a database schema.
Tables, belong to the third and lowest level of the naming hierarchy. Each table can belong to a single schema.
Tables contain rows of data. Each value in a row of data belongs to a particular column. Each column allows values of data of a single data type. Columns can be further qualified with column-level constraints, or computed with scalar expressions.
For guidance on defining tables, see Tables.
An index is a copy of the rows in a single table, sorted by a column or set of columns. CockroachDB queries use indexes to more efficiently find data in a table, given the values of a particular column. Each index belongs to a single table.
The two main types of indexes are the primary index, an index on the row-identifying primary key columns, and the secondary index, an index created on non-primary-key columns of your choice.
For guidance on defining primary keys, see Select primary key columns. For guidance on defining secondary indexes, see Secondary Indexes.
CockroachDB supports some specialized types of indexes, designed to improve query performance in specific use cases. For guidance on specialized indexes, see the following pages:
- Index a Subset of Rows
- Index Sequential Keys
- Index JSON and Array Data
- Index Expressions
- Index Spatial Data
CockroachDB supports several other objects at the third level of the naming hierarchy, including reusable views, sequences, and temporary objects.
A view is a stored and named selection query.
For guidance on using views, see Views.
A sequence creates and stores sequential data.
For guidance on using sequences, see the
CREATE SEQUENCE syntax page.
A temporary object is an object, such as a table, view, or sequence, that is not stored to persistent memory.
For guidance on using temporary objects, see Temporary Tables.
Control access to objects
CockroachDB supports both user-based and role-based access control. With roles, or with direct assignment, you can grant a SQL user the privileges required to view, modify, and delete database schema objects.
By default, the user that creates an object is that object's owner. Object owners have all privileges required to view, modify, or delete that object and the data stored within it.
For more information about ownership, privileges, and authorization, see Authorization.
Executing database schema changes
We do not recommend using client drivers or ORM frameworks to execute database schema changes. As a best practice, we recommend creating database schemas and performing database schema changes with one of the following methods:
Use a database schema migration tool.
CockroachDB is compatible with most PostgreSQL database schema migration tools, including Flyway and Liquibase. For a tutorial on performing database schema changes using Liquibase, see our Liquibase tutorial. For a tutorial on performing schema changes with Flyway, see our Flyway tutorial.
Use the CockroachDB SQL client.
The CockroachDB SQL client allows you to execute commands from the command line, or through the CockroachDB SQL shell interface. From the command line, you can pass a string to the client for execution, or you can pass a
.sqlfile populated with SQL commands. From the SQL shell, you can execute SQL commands directly. Throughout the guide, we pass a
.sqlfile to the SQL client to perform most database schema changes.
Object size and scaling considerations
CockroachDB does not place hard limits on most database objects. Extremely large attributes are not supported in certain scenarios as described in this section.
The following table lists specific limits imposed by CockroachDB.
|Role names||63 bytes||Other restrictions apply.|
|User names||63 bytes||These are equivalent to role names.|
|Identifier length||128 bytes||This limit is specified in the
Quantity of tables and other schema objects
CockroachDB has been shown to perform well with clusters containing 2,500 tables. Greater numbers are possible, depending on the complexity of the tables (number of columns and indexes) and hardware specifications.
As you scale to a large number of tables, note that:
- The amount of RAM per node is the limiting factor for the number of tables and other schema objects the cluster can support. This includes columns, indexes, GIN indexes, constraints, and partitions. Increasing RAM is likely to have the greatest impact on the number of these objects that a cluster can support, while increasing the number of nodes will not have a substantial effect.
- The number of databases or schemas on the cluster has minimal impact on the total number of tables that it can support.
See the Hardware section for additional recommendations based on your expected workloads.
Quantity of rows
CockroachDB can support any number of rows by adding additional nodes and storage.
You might also be interested in the following pages: