The SQL Layer of CockroachDB's architecture exposes its SQL API to developers, and converts these statements into key-value operations used by the rest of the database.
Once CockroachDB has been deployed, developers need nothing more than a connection string to the cluster and SQL statements to start working.
Because CockroachDB's nodes all behave symmetrically, developers can send requests to any node (which means CockroachDB works well with load balancers). Whichever node receives the request acts as the "gateway node," as other layers process the request.
When developers send requests to the cluster, they arrive as SQL statements, but data is ultimately written to and read from the storage layer as key-value (KV) pairs. To handle this, the SQL layer converts SQL statements into a plan of KV operations, which it passes along to the Transaction Layer.
Interactions with Other Layers
In relationship to other layers in CockroachDB, the SQL Layer:
- Sends requests to the Transaction Layer.
Developers experience data stored in CockroachDB in a relational structure, i.e., rows and columns. Sets of rows and columns are organized into tables. Collections of tables are organized into databases. Your cluster can contain many databases.
Because of this structure, CockroachDB provides typical relational features like constraints (e.g., foreign keys). This lets application developers trust that the database will ensure consistent structuring of the application's data; data validation doesn't need to be built into the application logic separately.
CockroachDB implements a large portion of the ANSI SQL standard to manifest its relational structure. You can view all of the SQL features CockroachDB supports here.
Importantly, through the SQL API, we also let developers use ACID-semantic transactions just like they would through any SQL database (
ISOLATION LEVELS, etc.)
PostgreSQL Wire Protocol
SQL queries reach your cluster through the PostgreSQL wire protocol. This makes connecting your application to the cluster simple by supporting most PostgreSQL-compatible drivers, as well as many PostgreSQL ORMs, such as GORM (Go) and Hibernate (Java).
SQL Parser, Planner, Executor
After your node ultimately receives a SQL request from a client, CockroachDB parses the statement, creates a query plan, and then executes the plan.
Received queries are parsed against our
yacc file (which describes our supported syntax), and converts the string version of each query into Abstract Syntax Trees (AST).
Planning and semantic analysis
With the AST, CockroachDB begins semantic analysis, which includes checking whether the query is valid, resolving names, eliminating unneeded intermediate computations, and finalizing which data types to use for intermediate results.
At the same time, CockroachDB starts planning the query's execution by generating a tree of
planNodes. Each of the
planNodes contain a set of code that uses KV operations; this is ultimately how SQL statements are converted into KV operations.
You can see the
planNodes a query generates using
planNodes are then executed, which begins by communicating with the Transaction Layer.
This step also includes encoding values from your statements, as well as decoding values returned from lower layers.
Though SQL queries are written in parsable strings, lower layers of CockroachDB deal primarily in bytes. This means at the SQL layer, in query execution, CockroachDB must convert row data from their SQL representation as strings into bytes, and convert bytes returned from lower layers into SQL data that can be passed back to the client.
It's also important––for indexed columns––that this byte encoding preserve the same sort order as the data type it represents. This is because of the way CockroachDB ultimately stores data in a sorted key-value map; storing bytes in the same order as the data it represents lets us efficiently scan KV data.
However, for non-indexed columns (e.g., non-
PRIMARY KEY columns), CockroachDB instead uses an encoding (known as "value encoding") which consumes less space but does not preserve ordering.
You can find more exhaustive detail in the Encoding Tech Note.
Because CockroachDB is a distributed database, we've developed a Distributed SQL (DistSQL) optimization tool for some queries, which can dramatically speed up queries that involve many ranges. Though DistSQL's architecture is worthy of its own documentation, this cursory explanation can provide some insight into how it works.
In non-distributed queries, the coordinating node receives all of the rows that match its query, and then performs any computations on the entire data set.
However, for DistSQL-compatible queries, each node does computations on the rows it contains, and then sends the results (instead of the entire rows) to the coordinating node. The coordinating node then aggregates the results from each node, and finally returns a single response to the client.
This dramatically reduces the amount of data brought to the coordinating node, and leverages the well-proven concept of parallel computing, ultimately reducing the time it takes for complex queries to complete. In addition, this processes data on the node that already stores it, which lets CockroachDB handle row-sets that are larger than an individual node's storage.
To run SQL statements in a distributed fashion, we introduce a couple of concepts:
- Logical plan: Similar to the AST/
planNodetree described above, it represents the abstract (non-distributed) data flow through computation stages.
- Physical plan: A physical plan is conceptually a mapping of the logical plan nodes to physical machines running
cockroach. Logical plan nodes are replicated and specialized depending on the cluster topology. Like
planNodesabove, these components of the physical plan are scheduled and run on the cluster.
You can find much greater detail in the DistSQL RFC.
Technical Interactions with Other Layers
SQL & Transaction Layer
KV operations from executed
planNodes are sent to the Transaction Layer.
Learn how CockroachDB handles concurrent requests in the Transaction Layer.