@@ -13,7 +13,6 @@ This tutorial shows you how to manually deploy a secure multi-node CockroachDB c
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v1.0/monitor-cockroachdb-with-prometheus.md b/v1.0/monitor-cockroachdb-with-prometheus.md
index 15f36b4266d..9edd0e7a8be 100644
--- a/v1.0/monitor-cockroachdb-with-prometheus.md
+++ b/v1.0/monitor-cockroachdb-with-prometheus.md
@@ -1,14 +1,13 @@
---
title: Monitor CockroachDB with Prometheus
summary: Use Prometheus to monitor CockroachDB.
-toc: false
+toc: true
---
CockroachDB generates detailed time series metrics for each node in a cluster. This page shows you how to pull these metrics into [Prometheus](https://prometheus.io/), an open source tool for storing, aggregating, and querying time series data. It also shows you how to connect [Grafana](https://grafana.com/) and [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) to Prometheus for flexible data visualizations and notifications.
{{site.data.alerts.callout_success}}All files used in this tutorial can be found in the
monitoring directory of the CockroachDB repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.0/multi-active-availability.md b/v1.0/multi-active-availability.md
index d8716ea43ac..4d18cefce2f 100644
--- a/v1.0/multi-active-availability.md
+++ b/v1.0/multi-active-availability.md
@@ -1,12 +1,11 @@
---
title: Multi-Active Availability
summary: Learn about CockroachDB's high availability model, known as Multi-Active Availability.
-toc: false
+toc: true
---
CockroachDB's availability model is described as "Multi-Active Availability." In essence, multi-active availability provides benefits similar to traditional notions of high availability, but also lets you read and write from every node in your cluster without generating any conflicts.
-
## What is High Availability?
diff --git a/v1.0/not-null.md b/v1.0/not-null.md
index c65ce9f276e..9d1c3ce8130 100644
--- a/v1.0/not-null.md
+++ b/v1.0/not-null.md
@@ -1,12 +1,11 @@
---
title: Not Null Constraint
summary: The NOT NULL constraint specifies the column may not contain NULL values.
-toc: false
+toc: true
---
The Not Null [constraint](constraints.html) specifies a column may not contain *NULL* values.
-
## Details
diff --git a/v1.0/null-handling.md b/v1.0/null-handling.md
index e2d8ada42fd..d6022d3c1de 100644
--- a/v1.0/null-handling.md
+++ b/v1.0/null-handling.md
@@ -1,14 +1,13 @@
---
title: NULL Handling
summary: Learn how NULL values are handled in CockroachDB SQL.
-toc: false
+toc: true
---
This page summarizes how `NULL` values are handled in CockroachDB SQL. Each topic is demonstrated via the [built-in SQL client](use-the-built-in-sql-client.html), using the table data in the first section, [NULLs and Logic](#nulls-and-logic).
{{site.data.alerts.callout_info}}When using the built-in client, NULL values are displayed using the word NULL. This distinguishes them from a character field that contains an empty string ("").{{site.data.alerts.end}}
-
## NULLs and Logic
diff --git a/v1.0/operational-faqs.md b/v1.0/operational-faqs.md
index 3c45097cc6e..4f629f9c15e 100644
--- a/v1.0/operational-faqs.md
+++ b/v1.0/operational-faqs.md
@@ -1,10 +1,9 @@
---
title: Operational FAQs
summary: Get answers to frequently asked questions about operating CockroachDB.
-toc: false
+toc: true
---
-
## Why is my process hanging when I try to start it in the background?
diff --git a/v1.0/orchestrate-cockroachdb-with-docker-swarm-insecure.md b/v1.0/orchestrate-cockroachdb-with-docker-swarm-insecure.md
index 2118de1a50b..c826b0937f4 100644
--- a/v1.0/orchestrate-cockroachdb-with-docker-swarm-insecure.md
+++ b/v1.0/orchestrate-cockroachdb-with-docker-swarm-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Docker Swarm
summary: How to orchestrate the deployment and management of an insecure three-node CockroachDB cluster as a Docker swarm.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ This page shows you how to orchestrate the deployment and management of an insec
If you plan to use CockroachDB in production, we recommend using a secure cluster instead. Select **Secure** above for instructions.
-
## Before You Begin
diff --git a/v1.0/orchestrate-cockroachdb-with-docker-swarm.md b/v1.0/orchestrate-cockroachdb-with-docker-swarm.md
index da800443ba0..89a9dd29bf8 100644
--- a/v1.0/orchestrate-cockroachdb-with-docker-swarm.md
+++ b/v1.0/orchestrate-cockroachdb-with-docker-swarm.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Docker Swarm
summary: How to orchestrate the deployment and management of a secure three-node CockroachDB cluster as a Docker swarm.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ This page shows you how to orchestrate the deployment and management of a secure
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Before You Begin
diff --git a/v1.0/orchestrate-cockroachdb-with-kubernetes.md b/v1.0/orchestrate-cockroachdb-with-kubernetes.md
index 2a5733636df..9d06445ec5b 100644
--- a/v1.0/orchestrate-cockroachdb-with-kubernetes.md
+++ b/v1.0/orchestrate-cockroachdb-with-kubernetes.md
@@ -1,14 +1,13 @@
---
title: Orchestrate CockroachDB with Kubernetes
summary: How to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with Kubernetes.
-toc: false
+toc: true
---
This page shows you how to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with [Kubernetes](http://kubernetes.io/), using the [StatefulSet](http://kubernetes.io/docs/concepts/abstractions/controllers/statefulsets/) feature.
{{site.data.alerts.callout_danger}}Deploying an insecure cluster is not recommended for data in production. We'll update this page after improving the process to deploy secure clusters.{{site.data.alerts.end}}
-
## Step 1. Choose your deployment environment
diff --git a/v1.0/orchestrate-cockroachdb-with-mesosphere-insecure.md b/v1.0/orchestrate-cockroachdb-with-mesosphere-insecure.md
index 8f2765940f6..b8223eeee30 100644
--- a/v1.0/orchestrate-cockroachdb-with-mesosphere-insecure.md
+++ b/v1.0/orchestrate-cockroachdb-with-mesosphere-insecure.md
@@ -1,14 +1,13 @@
---
title: Orchestrate CockroachDB with Mesosphere DC/OS (Insecure)
summary: How to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with Mesosphere DC/OS.
-toc: false
+toc: true
---
This page shows you how to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with [Mesosphere DC/OS](https://mesosphere.com/).
{{site.data.alerts.callout_danger}}Deploying an insecure cluster is not recommended for data in production. We'll update this page once it's possible to orchestrate a secure cluster with Mesosphere DC/OS.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.0/porting-postgres.md b/v1.0/porting-postgres.md
index b79c1f31248..c1c78deb395 100644
--- a/v1.0/porting-postgres.md
+++ b/v1.0/porting-postgres.md
@@ -1,7 +1,7 @@
---
title: Porting from PostgreSQL
summary: Porting an application from PostgreSQL
-toc: false
+toc: true
---
Although CockroachDB supports PostgreSQL syntax and drivers, it does not offer exact compatibility. This page documents the known list of differences between PostgreSQL and CockroachDB for identical input. That is, a SQL statement of the type listed here will behave differently than in PostgreSQL. Porting an existing application to CockroachDB will require changing these expressions.
@@ -10,7 +10,6 @@ Note that some of these differences only apply to rare inputs, and so no change
{{site.data.alerts.callout_info}}This document currently only covers how to rewrite SQL expressions. It does not discuss strategies for porting applications that use SQL features CockroachDB does not currently support, such as arrays or the
When querying a table, CockroachDB uses the fastest index. For more information about that process, see Index Selection in CockroachDB.{{site.data.alerts.end}} - ## Required Privileges diff --git a/v1.1/create-security-certificates-openssl.md b/v1.1/create-security-certificates-openssl.md index 0e28559e707..c299af9128c 100644 --- a/v1.1/create-security-certificates-openssl.md +++ b/v1.1/create-security-certificates-openssl.md @@ -1,7 +1,7 @@ --- title: Create Security Certificates summary: A secure CockroachDB cluster uses TLS for encrypted inter-node and client-node communication. -toc: false +toc: true ---
ENUM type.{{site.data.alerts.end}}
-
### Overflow of `float`
diff --git a/v1.0/primary-key.md b/v1.0/primary-key.md
index bfa836fe515..1ea86152be2 100644
--- a/v1.0/primary-key.md
+++ b/v1.0/primary-key.md
@@ -1,7 +1,7 @@
---
title: Primary Key Constraint
summary: The Primary Key constraint specifies that the columns can be used to uniquely identify rows in a table.
-toc: false
+toc: true
---
The Primary Key [constraint](constraints.html) specifies that the constrained columns' values must uniquely identify each row.
@@ -10,7 +10,6 @@ Unlike other constraints which have very specific uses, the Primary Key constrai
{{site.data.alerts.callout_info}}A table's primary key can only be specified in the CREATE TABLE statement. It can't be changed later using ALTER TABLE, though it is possible to go through a process to create a new table with the new primary key you want and then migrate the data.{{site.data.alerts.end}}
-
## Details
diff --git a/v1.0/privileges.md b/v1.0/privileges.md
index 85fa4ed20bd..555e85d75f0 100644
--- a/v1.0/privileges.md
+++ b/v1.0/privileges.md
@@ -1,7 +1,7 @@
---
title: Privileges
summary: Privileges are granted to users at the database and table levels. They are not yet supported for other granularities such as columns or rows.
-toc: false
+toc: true
---
In CockroachDB, privileges are granted to [users](create-and-manage-users.html) at the database and table levels. They are not yet supported for other granularities such as columns or rows.
@@ -10,7 +10,6 @@ When a user connects to a database, either via the [built-in SQL client](use-the
For the privileges required by specific statements, see the documentation for the respective [SQL statement](sql-statements.html).
-
## Supported Privileges
diff --git a/v1.0/query-behavior-troubleshooting.md b/v1.0/query-behavior-troubleshooting.md
index 35f6ed8795d..f74bdf2d18e 100644
--- a/v1.0/query-behavior-troubleshooting.md
+++ b/v1.0/query-behavior-troubleshooting.md
@@ -1,12 +1,11 @@
---
title: Query Behavior Troubleshooting
summary: Learn how to troubleshoot issues with specific queries with CockroachDB
-toc: false
+toc: true
---
If a query returns an unexpected result or takes longer than expected to process, this page will help you troubleshoot the issue.
-
## Correctness Issues
diff --git a/v1.0/recommended-production-settings.md b/v1.0/recommended-production-settings.md
index 236a917f2f2..3159c12ebe7 100644
--- a/v1.0/recommended-production-settings.md
+++ b/v1.0/recommended-production-settings.md
@@ -1,13 +1,12 @@
---
title: Recommended Production Settings
summary: Recommended settings for production deployments.
-toc: false
+toc: true
toc_not_nested: true
---
This page provides recommended settings for production deployments.
-
## Hardware
diff --git a/v1.0/release-savepoint.md b/v1.0/release-savepoint.md
index 95e59846e47..5ceb8d388d4 100644
--- a/v1.0/release-savepoint.md
+++ b/v1.0/release-savepoint.md
@@ -1,7 +1,7 @@
---
title: RELEASE SAVEPOINT cockroach_restart
summary: Commit a transaction's changes once there are no retryable errors with the RELEASE SAVEPOINT cockroach_restart statement in CockroachDB.
-toc: false
+toc: true
---
When using [client-side transaction retries](transactions.html#client-side-transaction-retries), the `RELEASE SAVEPOINT cockroach_restart` statement commits the transaction.
@@ -12,7 +12,6 @@ Despite committing the transaction, you must still issue a [`COMMIT`](commit-tra
{{site.data.alerts.callout_danger}}CockroachDB’s SAVEPOINT implementation only supports the cockroach_restart savepoint and does not support all savepoint functionality, such as nested transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/rename-column.md b/v1.0/rename-column.md
index 335a5b53b9f..983753c7cfa 100644
--- a/v1.0/rename-column.md
+++ b/v1.0/rename-column.md
@@ -1,14 +1,13 @@
---
title: RENAME COLUMN
summary: The RENAME COLUMN statement changes the name of a column in a table.
-toc: false
+toc: true
---
The `RENAME COLUMN` [statement](sql-statements.html) changes the name of a column in a table.
{{site.data.alerts.callout_info}}It is not possible to rename a column referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/rename-database.md b/v1.0/rename-database.md
index 65bb1009913..5b727274e0f 100644
--- a/v1.0/rename-database.md
+++ b/v1.0/rename-database.md
@@ -1,14 +1,13 @@
---
title: RENAME DATABASE
summary: The RENAME DATABASE statement changes the name of a database.
-toc: false
+toc: true
---
The `RENAME DATABASE` [statement](sql-statements.html) changes the name of a database.
{{site.data.alerts.callout_info}}It is not possible to rename a database referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/rename-index.md b/v1.0/rename-index.md
index 9d15e4b8379..0bb70689d62 100644
--- a/v1.0/rename-index.md
+++ b/v1.0/rename-index.md
@@ -1,14 +1,13 @@
---
title: RENAME INDEX
summary: The RENAME INDEX statement changes the name of an index for a table.
-toc: false
+toc: true
---
The `RENAME INDEX` [statement](sql-statements.html) changes the name of an index for a table.
{{site.data.alerts.callout_info}}It is not possible to rename an index referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/rename-table.md b/v1.0/rename-table.md
index de1265477b0..b82c94b7cee 100644
--- a/v1.0/rename-table.md
+++ b/v1.0/rename-table.md
@@ -1,14 +1,13 @@
---
title: RENAME TABLE
summary: The RENAME TABLE statement changes the name of a table.
-toc: false
+toc: true
---
The `RENAME TABLE` [statement](sql-statements.html) changes the name of a table. It can also be used to move a table from one database to another.
{{site.data.alerts.callout_info}}It is not possible to rename a table referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.0/restore.md b/v1.0/restore.md
index 7e13bd3f44c..ae2ed2bb1f0 100644
--- a/v1.0/restore.md
+++ b/v1.0/restore.md
@@ -1,7 +1,7 @@
---
title: RESTORE
summary: Restore your CockroachDB cluster to a cloud storage services such as AWS S3, Google Cloud Storage, or other NFS.
-toc: false
+toc: true
---
{{site.data.alerts.callout_danger}}The RESTORE feature is only available to our enterprise license only users. For non-enterprise restores, see Restore Data.{{site.data.alerts.end}}
@@ -10,7 +10,6 @@ The `RESTORE` [statement](sql-statements.html) restores your cluster's schemas a
Because CockroachDB is designed with high fault tolerance, restores are designed primarily for disaster recovery, i.e., restarting your cluster if it loses a majority of its nodes. Isolated issues (such as small-scale node outages) do not require any intervention.
-
## Functional Details
diff --git a/v1.0/revoke.md b/v1.0/revoke.md
index bd4b8126bfd..159984adf64 100644
--- a/v1.0/revoke.md
+++ b/v1.0/revoke.md
@@ -1,14 +1,13 @@
---
title: REVOKE
summary: The REVOKE statement revokes privileges from users.
-toc: false
+toc: true
---
The `REVOKE` [statement](sql-statements.html) revokes [privileges](privileges.html) from users.
For the list of privileges that can be granted to and revoked from users, see [`GRANT`](grant.html).
-
## Synopsis
diff --git a/v1.0/rollback-transaction.md b/v1.0/rollback-transaction.md
index 77a690e3022..c604ad6ec84 100644
--- a/v1.0/rollback-transaction.md
+++ b/v1.0/rollback-transaction.md
@@ -1,14 +1,13 @@
---
title: ROLLBACK
summary: Abort the current transaction, discarding all updates made by statements included in the transaction with the ROLLBACK statement in CockroachDB.
-toc: false
+toc: true
---
The `ROLLBACK` [statement](sql-statements.html) aborts the current [transaction](transactions.html), discarding all updates made by statements included in the transaction.
When using [client-side transaction retries](transactions.html#client-side-transaction-retries), use `ROLLBACK TO SAVEPOINT cockroach_restart` to handle a transaction that needs to be retried (identified via the `40001` error code or `retry transaction` string in the error message), and then re-execute the statements you want the transaction to contain.
-
## Synopsis
diff --git a/v1.0/savepoint.md b/v1.0/savepoint.md
index 5b054ed8dcb..fb50dac988d 100644
--- a/v1.0/savepoint.md
+++ b/v1.0/savepoint.md
@@ -1,14 +1,13 @@
---
title: SAVEPOINT
summary: Identify your intent to retry aborted transactions with the SAVEPOINT cockroach_restart statement in CockroachDB.
-toc: false
+toc: true
---
The `SAVEPOINT cockroach_restart` statement defines the intent to retry [transactions](transactions.html) using the CockroachDB-provided function for client-side transaction retries. For more information, see [Transaction Retries](transactions.html#transaction-retries).
{{site.data.alerts.callout_danger}}CockroachDB’s SAVEPOINT implementation only supports the cockroach_restart savepoint and does not support all savepoint functionality, such as nested transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/secure-a-cluster.md b/v1.0/secure-a-cluster.md
index c12bc69fb01..5990ae4e121 100644
--- a/v1.0/secure-a-cluster.md
+++ b/v1.0/secure-a-cluster.md
@@ -1,7 +1,7 @@
---
title: Start a Local Cluster (Secure)
summary: Run a secure multi-node CockroachDB cluster locally, using TLS certificates to encrypt network communication.
-toc: false
+toc: true
asciicast: true
---
@@ -14,7 +14,6 @@ Once you’ve [installed CockroachDB](install-cockroachdb.html), it’s simple t
{{site.data.alerts.callout_info}}Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see Manual Deployment, Cloud Deployment, or Orchestration.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.0/select.md b/v1.0/select.md
index b6d16d5ac54..e1ce7dc9553 100644
--- a/v1.0/select.md
+++ b/v1.0/select.md
@@ -1,12 +1,11 @@
---
title: SELECT
summary: The SELECT statement retrieves data from a table.
-toc: false
+toc: true
---
The `SELECT` [statement](sql-statements.html) retrieves data from a table.
-
## Synopsis
diff --git a/v1.0/serial.md b/v1.0/serial.md
index b0090f2fdc3..84fc9d781e1 100644
--- a/v1.0/serial.md
+++ b/v1.0/serial.md
@@ -1,7 +1,7 @@
---
title: SERIAL
summary: The SERIAL data type defaults to a unique 64-bit signed integer that is the combination of the insert timestamp and the ID of the node.
-toc: false
+toc: true
---
The `SERIAL` [data type](data-types.html) is a column data type that, on insert, generates a default integer from the timestamp and ID of the node executing the insert. This combination is likely to be globally unique except in extreme cases (see this [example](create-table.html#create-a-table-with-auto-generated-unique-row-ids) for more details). Also, because value generation does not require talking to other nodes, it is much faster than sequentially auto-incrementing a value, which requires distributed coordination.
@@ -12,7 +12,6 @@ issue or chat
with us on Gitter.
{{site.data.alerts.end}}
-
## Aliases
diff --git a/v1.0/set-cluster-setting.md b/v1.0/set-cluster-setting.md
index 95640f642a8..020d5e5182f 100644
--- a/v1.0/set-cluster-setting.md
+++ b/v1.0/set-cluster-setting.md
@@ -1,14 +1,13 @@
---
title: SET CLUSTER SETTING
summary: The SET CLUSTER SETTING statement configures one cluster setting.
-toc: false
+toc: true
---
The `SET CLUSTER SETTING` [statement](sql-statements.html) modifies a [cluster-wide setting](cluster-settings.html).
{{site.data.alerts.callout_danger}}Many cluster settings are intended for tuning CockroachDB internals. Before changing these settings, we strongly encourage you to discuss your goals with CockroachDB; otherwise, you use them at your own risk.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/set-transaction.md b/v1.0/set-transaction.md
index 5d2865f4214..7b9ef0fa1ae 100644
--- a/v1.0/set-transaction.md
+++ b/v1.0/set-transaction.md
@@ -1,14 +1,13 @@
---
title: SET TRANSACTION
summary: The SET TRANSACTION statement sets the transaction isolation level and/or priority for the current session or for an individual transaction.
-toc: false
+toc: true
---
The `SET TRANSACTION` [statement](sql-statements.html) sets the transaction isolation level or priority after you [`BEGIN`](begin-transaction.html) it but before executing the first statement that manipulates a database.
{{site.data.alerts.callout_info}}You can also set the session's default isolation level.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/set-vars.md b/v1.0/set-vars.md
index a99e85ee496..4bcf362f2c0 100644
--- a/v1.0/set-vars.md
+++ b/v1.0/set-vars.md
@@ -1,7 +1,7 @@
---
title: SET (session settings)
summary: The SET statement modifies the current settings for the client session.
-toc: false
+toc: true
redirect_from:
- set-application-name.html
- set-database.html
@@ -13,7 +13,6 @@ session setting variables. These can also be queried via [`SHOW`](show-vars.html
{{site.data.alerts.callout_danger}}In some cases, client drivers can drop and restart the connection to the server. When this happens, any session configurations made with SET statements are lost. It is therefore more reliable to configure the session in the client's connection string. For examples in different languages, see the Build an App with CockroachDB tutorials.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.0/show-cluster-setting.md b/v1.0/show-cluster-setting.md
index 32e304ce8ad..e69f9e5376c 100644
--- a/v1.0/show-cluster-setting.md
+++ b/v1.0/show-cluster-setting.md
@@ -1,7 +1,7 @@
---
title: SHOW CLUSTER SETTING
summary: The SHOW CLUSTER SETTING statement displays the current cluster settings.
-toc: false
+toc: true
---
The `SHOW CLUSTER SETTING` [statement](sql-statements.html) can
@@ -9,7 +9,6 @@ display the value of either one or all of the
[cluster settings](cluster-settings.html). These can also be configured
via [`SET CLUSTER SETTING`](set-cluster-setting.html).
-
## Required Privileges
diff --git a/v1.0/show-columns.md b/v1.0/show-columns.md
index 35eee928bb9..ec142909238 100644
--- a/v1.0/show-columns.md
+++ b/v1.0/show-columns.md
@@ -1,12 +1,11 @@
---
title: SHOW COLUMNS
summary: The SHOW COLUMNS statement shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
-toc: false
+toc: true
---
The `SHOW COLUMNS` [statement](sql-statements.html) shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
-
## Required Privileges
diff --git a/v1.0/show-constraints.md b/v1.0/show-constraints.md
index 409694637ae..40e1912bb0a 100644
--- a/v1.0/show-constraints.md
+++ b/v1.0/show-constraints.md
@@ -1,14 +1,13 @@
---
title: SHOW CONSTRAINTS
summary: The SHOW CONSTRAINTS statement lists the constraints on a table.
-toc: false
+toc: true
---
The `SHOW CONSTRAINTS` [statement](sql-statements.html) lists all named [constraints](constraints.html) as well as any unnamed Check constraints on a table.
{{site.data.alerts.callout_danger}}The SHOW CONSTRAINTS statement is under development; the exact output will continue to change.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.0/show-create-table.md b/v1.0/show-create-table.md
index 93dfe7c83b3..6a8b662499c 100644
--- a/v1.0/show-create-table.md
+++ b/v1.0/show-create-table.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE TABLE
summary: The SHOW CREATE TABLE statement shows the CREATE TABLE statement that would create a carbon copy of the specified table.
-toc: false
+toc: true
---
The `SHOW CREATE TABLE` [statement](sql-statements.html) shows the `CREATE TABLE` statement that would create a carbon copy of the specified table.
-
## Required Privileges
diff --git a/v1.0/show-create-view.md b/v1.0/show-create-view.md
index 05646e189ff..0d233b11667 100644
--- a/v1.0/show-create-view.md
+++ b/v1.0/show-create-view.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE VIEW
summary: The SHOW CREATE VIEW statement shows the CREATE VIEW statement that would create a carbon copy of the specified view.
-toc: false
+toc: true
---
The `SHOW CREATE VIEW` [statement](sql-statements.html) shows the `CREATE VIEW` statement that would create a carbon copy of the specified [view](views.html).
-
## Required Privileges
diff --git a/v1.0/show-databases.md b/v1.0/show-databases.md
index 671d7725b49..0d0b73edff3 100644
--- a/v1.0/show-databases.md
+++ b/v1.0/show-databases.md
@@ -2,12 +2,11 @@
title: SHOW DATABASES
summary: The SHOW DATABASES statement lists all database in the CockroachDB cluster.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW DATABASES` [statement](sql-statements.html) lists all database in the CockroachDB cluster.
-
## Synopsis
diff --git a/v1.0/show-grants.md b/v1.0/show-grants.md
index 30dba32b520..9712944bc1c 100644
--- a/v1.0/show-grants.md
+++ b/v1.0/show-grants.md
@@ -2,12 +2,11 @@
title: SHOW GRANTS
summary: The SHOW GRANTS statement lists the privileges granted to users.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW GRANTS` [statement](sql-statements.html) lists the [privileges](privileges.html) granted to users.
-
## Synopsis
diff --git a/v1.0/show-index.md b/v1.0/show-index.md
index 63870e6d18f..a1078513c72 100644
--- a/v1.0/show-index.md
+++ b/v1.0/show-index.md
@@ -1,12 +1,11 @@
---
title: SHOW INDEX
summary: The SHOW INDEX statement returns index information for a table.
-toc: false
+toc: true
---
The `SHOW INDEX` [statement](sql-statements.html) returns index information for a table.
-
## Required Privileges
diff --git a/v1.0/show-tables.md b/v1.0/show-tables.md
index e99a0ecd30d..7757a675f03 100644
--- a/v1.0/show-tables.md
+++ b/v1.0/show-tables.md
@@ -2,14 +2,13 @@
title: SHOW TABLES
summary: The SHOW TABLES statement lists the tables in a database.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW TABLES` [statement](sql-statements.html) lists the tables in a database. Tables can be standard tables as well as virtual tables representing [views](views.html).
{{site.data.alerts.callout_info}}While a table is being dropped, SHOW TABLES will list the table with a (dropped) suffix.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/show-users.md b/v1.0/show-users.md
index 9f526ad4d58..c6b3cc40db1 100644
--- a/v1.0/show-users.md
+++ b/v1.0/show-users.md
@@ -1,12 +1,11 @@
---
title: SHOW USERS
summary: The SHOW USERS statement lists the users for all databases.
-toc: false
+toc: true
---
The `SHOW USERS` [statement](sql-statements.html) lists the users for all databases.
-
## Synopsis
diff --git a/v1.0/show-vars.md b/v1.0/show-vars.md
index 42a6f3a1f97..13d170ea47f 100644
--- a/v1.0/show-vars.md
+++ b/v1.0/show-vars.md
@@ -1,7 +1,7 @@
---
title: SHOW (session settings)
summary: The SHOW statement displays the current settings for the client session.
-toc: false
+toc: true
redirect_from:
- show-all.html
- show-transaction.html
@@ -11,7 +11,6 @@ redirect_from:
The `SHOW` [statement](sql-statements.html) can display the value of either one or all of
the session setting variables. Some of these can also be configured via [`SET`](set-vars.html).
-
## Required Privileges
diff --git a/v1.0/sql-constants.md b/v1.0/sql-constants.md
index 3a3d522716e..01fa69828bd 100644
--- a/v1.0/sql-constants.md
+++ b/v1.0/sql-constants.md
@@ -1,12 +1,11 @@
---
title: Constant Values
summary: SQL Constants represent a simple value that doesn't change.
-toc: false
+toc: true
---
SQL Constants represent a simple value that doesn't change.
-
## Introduction
diff --git a/v1.0/sql-dump.md b/v1.0/sql-dump.md
index 498dfe889c1..182b7c2d745 100644
--- a/v1.0/sql-dump.md
+++ b/v1.0/sql-dump.md
@@ -1,7 +1,7 @@
---
title: SQL Dump (Export)
summary: Learn how to dump schemas and data from a CockroachDB cluster.
-toc: false
+toc: true
---
The `cockroach dump` [command](cockroach-commands.html) outputs the SQL statements required to recreate one or more tables and all their rows (also known as a *dump*). This command can be used to back up or export each database in a cluster. The output should also be suitable for importing into other relational databases, with minimal adjustments.
@@ -16,7 +16,6 @@ When `cockroach dump` is executed:
{{site.data.alerts.callout_info}}The user must have the SELECT privilege on the target table(s).{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/sql-expressions.md b/v1.0/sql-expressions.md
index f3b265c10e5..2d42100f262 100644
--- a/v1.0/sql-expressions.md
+++ b/v1.0/sql-expressions.md
@@ -1,7 +1,7 @@
---
title: Value Expressions
summary: Value expressions allow the computation of new values from basic parts.
-toc: false
+toc: true
---
Most SQL statements can contain *value expressions* that compute new
@@ -16,7 +16,6 @@ structured as a table.
The following sections provide details on each of these options.
-
## Constants
diff --git a/v1.0/sql-faqs.md b/v1.0/sql-faqs.md
index dd69848be53..8715acec395 100644
--- a/v1.0/sql-faqs.md
+++ b/v1.0/sql-faqs.md
@@ -1,10 +1,9 @@
---
title: SQL FAQs
summary: Get answers to frequently asked questions about CockroachDB SQL.
-toc: false
+toc: true
---
-
## How do I bulk insert data into CockroachDB?
diff --git a/v1.0/sql-feature-support.md b/v1.0/sql-feature-support.md
index ec6cffdb0de..c3470b53ff5 100644
--- a/v1.0/sql-feature-support.md
+++ b/v1.0/sql-feature-support.md
@@ -3,7 +3,6 @@ title: SQL Feature Support in CockroachDB v1.0
summary: Find CockroachDB's conformance to the SQL standard and which common extensions it supports.
---
-
## Overview
diff --git a/v1.0/sql-name-resolution.md b/v1.0/sql-name-resolution.md
index 886c60c2e2d..7d0c578fe93 100644
--- a/v1.0/sql-name-resolution.md
+++ b/v1.0/sql-name-resolution.md
@@ -1,7 +1,7 @@
---
title: Name Resolution
summary: Table and function names can exist in multiple places. Resolution decides which one to use.
-toc: false
+toc: true
---
A SQL client can have access to multiple databases side-by-side. The
@@ -13,7 +13,6 @@ which `orders` table is being considered?
This page details how CockroachDB performs **name resolution** to answer
this question.
-
## Overview
diff --git a/v1.0/sql-statements.md b/v1.0/sql-statements.md
index 052c5a5763e..edcc54801d1 100644
--- a/v1.0/sql-statements.md
+++ b/v1.0/sql-statements.md
@@ -1,12 +1,11 @@
---
title: SQL Statements
summary: SQL statements supported by CockroachDB.
-toc: false
+toc: true
---
CockroachDB supports the following SQL statements. Click a statement for more details.
-
## Data Manipulation Statements
diff --git a/v1.0/start-a-local-cluster.md b/v1.0/start-a-local-cluster.md
index 6df402b3cc4..a4c462d95d5 100644
--- a/v1.0/start-a-local-cluster.md
+++ b/v1.0/start-a-local-cluster.md
@@ -1,7 +1,7 @@
---
title: Start a Local Cluster (Insecure)
summary: Run an insecure multi-node CockroachDB cluster locally with each node listening on a different port.
-toc: false
+toc: true
toc_not_nested: true
asciicast: true
---
@@ -15,7 +15,6 @@ Once you’ve [installed CockroachDB](install-cockroachdb.html), it’s simple t
{{site.data.alerts.callout_info}}Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see Manual Deployment, Cloud Deployment, or Orchestration.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.0/start-a-node.md b/v1.0/start-a-node.md
index 20a316477d9..2b1deee655d 100644
--- a/v1.0/start-a-node.md
+++ b/v1.0/start-a-node.md
@@ -1,14 +1,13 @@
---
title: Start a Node
summary: To start a new CockroachDB cluster, or add a node to an existing cluster, run the cockroach start command.
-toc: false
+toc: true
---
To start a new CockroachDB cluster, or add a node to an existing cluster, run the `cockroach start` [command](cockroach-commands.html) with appropriate flags.
{{site.data.alerts.callout_info}}Node-level settings are defined by flags passed to the cockroach start command and cannot be changed without stopping and restarting the node. In contrast, some cluster-wide settings are defined via SQL statements and can be updated anytime after a cluster has been started. For more details, see Cluster Settings.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/stop-a-node.md b/v1.0/stop-a-node.md
index 27e2b9c8310..2f54cd1055b 100644
--- a/v1.0/stop-a-node.md
+++ b/v1.0/stop-a-node.md
@@ -1,12 +1,11 @@
---
title: Stop a Node
summary: Learn how to stop a node.
-toc: false
+toc: true
---
This page shows you how to use the `cockroach quit` [command](cockroach-commands.html) to stop a node.
-
## Overview
diff --git a/v1.0/string.md b/v1.0/string.md
index 585e0f01fa0..4e570858389 100644
--- a/v1.0/string.md
+++ b/v1.0/string.md
@@ -1,14 +1,13 @@
---
title: STRING
summary: The STRING data type stores a string of Unicode characters.
-toc: false
+toc: true
---
The `STRING` [data type](data-types.html) stores a string of Unicode characters.
-
## Aliases
diff --git a/v1.0/table-expressions.md b/v1.0/table-expressions.md
index 42e3e2b14c8..1a1b80f6b4d 100644
--- a/v1.0/table-expressions.md
+++ b/v1.0/table-expressions.md
@@ -1,13 +1,12 @@
---
title: Table Expressions
summary: Table expressions define a data source in SELECT and INSERT statements.
-toc: false
+toc: true
---
Table expressions define a data source in the `FROM` clause of
[`SELECT`](select.html) and [`INSERT`](insert.html) statements.
-
## Introduction
diff --git a/v1.0/timestamp.md b/v1.0/timestamp.md
index d100b00a96b..044d571f54d 100644
--- a/v1.0/timestamp.md
+++ b/v1.0/timestamp.md
@@ -1,12 +1,11 @@
---
title: TIMESTAMP
summary: The TIMESTAMP data type stores a date and time pair in UTC, whereas TIMESTAMPTZ stores a date and time pair with a time zone offset from UTC.
-toc: false
+toc: true
---
The `TIMESTAMP` [data type](data-types.html) stores a date and time pair in UTC.
-
## Time Zone Details
diff --git a/v1.0/transactions.md b/v1.0/transactions.md
index 6dee7b81c1f..807eb35c79f 100644
--- a/v1.0/transactions.md
+++ b/v1.0/transactions.md
@@ -1,14 +1,13 @@
---
title: Transactions
summary: CockroachDB supports bundling multiple SQL statements into a single all-or-nothing transaction.
-toc: false
+toc: true
---
CockroachDB supports bundling multiple SQL statements into a single all-or-nothing transaction. Each transaction guarantees [ACID semantics](https://en.wikipedia.org/wiki/ACID) spanning arbitrary tables and rows, even when data is distributed. If a transaction succeeds, all mutations are applied together with virtual simultaneity. If any part of a transaction fails, the entire transaction is aborted, and the database is left unchanged. CockroachDB guarantees that while a transaction is pending, it is isolated from other concurrent transactions.
{{site.data.alerts.callout_info}}For a detailed discussion of CockroachDB transaction semantics, see How CockroachDB Does Distributed Atomic Transactions and Serializable, Lockless, Distributed: Isolation in CockroachDB. Note that the explanation of the transaction model described in this blog post is slightly out of date. See the Transaction Retries section for more details.{{site.data.alerts.end}}
-
## SQL Statements
diff --git a/v1.0/truncate.md b/v1.0/truncate.md
index b86140c8606..20a19b2ff11 100644
--- a/v1.0/truncate.md
+++ b/v1.0/truncate.md
@@ -1,14 +1,13 @@
---
title: TRUNCATE
summary: The TRUNCATE statement deletes all rows from specified tables.
-toc: false
+toc: true
---
The `TRUNCATE` [statement](sql-statements.html) deletes all rows from specified tables.
{{site.data.alerts.callout_info}}The TRUNCATE removes all rows from a table by dropping the table and recreating a new table with the same name. For large tables, this is much more performant than deleting each of the rows. However, for smaller tables, it's more performant to use a DELETE statement without a WHERE clause.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.0/unique.md b/v1.0/unique.md
index 69f946128e5..05c371025ec 100644
--- a/v1.0/unique.md
+++ b/v1.0/unique.md
@@ -1,12 +1,11 @@
---
title: Unique Constraint
summary: The Unique constraint specifies that each non-NULL value in the constrained column must be unique.
-toc: false
+toc: true
---
The Unique [constraint](constraints.html) specifies that each non-*NULL* value in the constrained column must be unique.
-
## Details
diff --git a/v1.0/update.md b/v1.0/update.md
index ff1bbd99303..238d3e86d7e 100644
--- a/v1.0/update.md
+++ b/v1.0/update.md
@@ -1,12 +1,11 @@
---
title: UPDATE
summary: The UPDATE statement updates rows in a table.
-toc: false
+toc: true
---
The `UPDATE` [statement](sql-statements.html) updates rows in a table.
-
## Required Privileges
diff --git a/v1.0/upgrade-cockroach-version.md b/v1.0/upgrade-cockroach-version.md
index a6048705048..71f2b2edc10 100644
--- a/v1.0/upgrade-cockroach-version.md
+++ b/v1.0/upgrade-cockroach-version.md
@@ -1,7 +1,7 @@
---
title: Upgrade a Cluster's Version
summary: Learn how to upgrade your CockroachDB cluster to a new version.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ Because of CockroachDB's [multi-active availability](multi-active-availability.h
{{site.data.alerts.callout_info}}This page shows you how to upgrade from v1.0 to a patch release in the 1.0.x series. To upgrade from v1.0.x to v1.1, see the 1.1 version of this page.{{site.data.alerts.end}}
-
## Step 1. Prepare to upgrade
diff --git a/v1.0/upsert.md b/v1.0/upsert.md
index 7a21e871cc5..5d68b0dcb40 100644
--- a/v1.0/upsert.md
+++ b/v1.0/upsert.md
@@ -1,12 +1,11 @@
---
title: UPSERT
summary: The UPSERT statement inserts rows when values do not violate uniqueness constraints, and it updates rows when values do violate uniqueness constraints.
-toc: false
+toc: true
---
The `UPSERT` [statement](sql-statements.html) is short-hand for [`INSERT ON CONFLICT`](insert.html). It inserts rows in cases where specified values do not violate uniqueness constraints, and it updates rows in cases where values do violate uniqueness constraints.
-
## Considerations
diff --git a/v1.0/use-the-built-in-sql-client.md b/v1.0/use-the-built-in-sql-client.md
index 903e0ad6203..65405bd1341 100644
--- a/v1.0/use-the-built-in-sql-client.md
+++ b/v1.0/use-the-built-in-sql-client.md
@@ -1,14 +1,13 @@
---
title: Use the Built-in SQL Client
summary: CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line.
-toc: false
+toc: true
---
CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line. To use this client, run the `cockroach sql` [command](cockroach-commands.html) as described below.
To exit the interactive shell, use `\q` or `ctrl-d`.
-
## Synopsis
diff --git a/v1.0/view-node-details.md b/v1.0/view-node-details.md
index 43dbfad2816..81c1c9ae3e2 100644
--- a/v1.0/view-node-details.md
+++ b/v1.0/view-node-details.md
@@ -1,12 +1,11 @@
---
title: View Node Details
summary: To view details for each node in the cluster, use the cockroach node command with the appropriate subcommands and flags.
-toc: false
+toc: true
---
To view details for each node in the cluster, use the `cockroach node` [command](cockroach-commands.html) with the appropriate subcommands and flags.
-
## Subcommands
diff --git a/v1.0/views.md b/v1.0/views.md
index fa53598161d..5c611f8e982 100644
--- a/v1.0/views.md
+++ b/v1.0/views.md
@@ -1,12 +1,11 @@
---
title: Views
summary:
-toc: false
+toc: true
---
A view is a stored `SELECT` query represented as a virtual table. Unlike a standard table, a view is not part of the physical schema; instead, it is a virtual table that forms dynamically when requested.
-
## Why Use Views?
diff --git a/v1.1/add-column.md b/v1.1/add-column.md
index dccd50534b1..c0207233c09 100644
--- a/v1.1/add-column.md
+++ b/v1.1/add-column.md
@@ -1,12 +1,11 @@
---
title: ADD COLUMN
summary: Use the ADD COLUMN statement to add columns to tables.
-toc: false
+toc: true
---
The `ADD COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and adds columns to tables.
-
## Synopsis
diff --git a/v1.1/add-constraint.md b/v1.1/add-constraint.md
index 1ee4d3c776e..c9eb112ac7f 100644
--- a/v1.1/add-constraint.md
+++ b/v1.1/add-constraint.md
@@ -1,7 +1,7 @@
---
title: ADD CONSTRAINT
summary: Use the ADD CONSTRAINT statement to add constraints to columns.
-toc: false
+toc: true
---
The `ADD CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and can add the following [constraints](constraints.html) to columns:
@@ -13,7 +13,6 @@ The `ADD CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` a
{{site.data.alerts.callout_info}}
The Primary Key and Not Null constraints can only be applied through CREATE TABLE. The Default constraint is managed through ALTER COLUMN.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/admin-ui-access-and-navigate.md b/v1.1/admin-ui-access-and-navigate.md
index 461aedbe479..be717c4e4c8 100644
--- a/v1.1/admin-ui-access-and-navigate.md
+++ b/v1.1/admin-ui-access-and-navigate.md
@@ -1,10 +1,9 @@
---
title: Access and Navigate the CockroachDB Admin UI
summary: Learn how to access and navigate the Admin UI.
-toc: false
+toc: true
---
-
## Access the Admin UI
diff --git a/v1.1/admin-ui-databases-page.md b/v1.1/admin-ui-databases-page.md
index 7596df45566..b3de8ba3fa8 100644
--- a/v1.1/admin-ui-databases-page.md
+++ b/v1.1/admin-ui-databases-page.md
@@ -1,11 +1,10 @@
---
title: Database Page
-toc: false
+toc: true
---
The **Databases** page of the Admin UI provides details of the databases configured, the tables in each database, and the grants assigned to each user.
-
## Tables View
diff --git a/v1.1/admin-ui-jobs-page.md b/v1.1/admin-ui-jobs-page.md
index d8072edc877..6d99be0debd 100644
--- a/v1.1/admin-ui-jobs-page.md
+++ b/v1.1/admin-ui-jobs-page.md
@@ -1,11 +1,10 @@
---
title: Jobs Page
-toc: false
+toc: true
---
New in v1.1: The **Jobs** page of the Admin UI provides details about the backup/restore jobs as well as schema changes performed across all nodes in the cluster. To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then click **Jobs** in the left-hand navigation bar.
-
## Job Details
diff --git a/v1.1/admin-ui-overview-dashboard.md b/v1.1/admin-ui-overview-dashboard.md
index d82ac6ac73d..484d605db96 100644
--- a/v1.1/admin-ui-overview-dashboard.md
+++ b/v1.1/admin-ui-overview-dashboard.md
@@ -1,12 +1,11 @@
---
title: Overview Dashboard
summary: The Overview dashboard lets you monitor important SQL performance, replication, and storage metrics.
-toc: false
+toc: true
---
On [accessing the CockroachDB Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), the **Overview** is shown by default. This dashboard lets you monitor important SQL performance, replication, and storage metrics.
-
The **Overview** dashboard displays the following time series graphs:
diff --git a/v1.1/admin-ui-replication-dashboard.md b/v1.1/admin-ui-replication-dashboard.md
index b316fe6cf7a..4394f5e847d 100644
--- a/v1.1/admin-ui-replication-dashboard.md
+++ b/v1.1/admin-ui-replication-dashboard.md
@@ -1,12 +1,11 @@
---
title: Replication Dashboard
summary: The Replication dashboard lets you monitor the replication metrics for your cluster.
-toc: false
+toc: true
---
The **Replication** dashboard in the CockroachDB Admin UI enables you to monitor the replication metrics for your cluster. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then select **Dashboard** > **Replication**.
-
## Review of CockroachDB terminology
diff --git a/v1.1/admin-ui-runtime-dashboard.md b/v1.1/admin-ui-runtime-dashboard.md
index 0864612bc1f..699f74320f9 100644
--- a/v1.1/admin-ui-runtime-dashboard.md
+++ b/v1.1/admin-ui-runtime-dashboard.md
@@ -1,11 +1,10 @@
---
title: Runtime Dashboard
-toc: false
+toc: true
---
The **Runtime** dashboard in the CockroachDB Admin UI lets you monitor runtime metrics for you cluster, such as node count, CPU time, and memory usage. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then select **Dashboard** > **Runtime**.
-
The **Runtime** dashboard displays the following time series graphs:
diff --git a/v1.1/admin-ui-sql-dashboard.md b/v1.1/admin-ui-sql-dashboard.md
index e204532b0d3..4d594681572 100644
--- a/v1.1/admin-ui-sql-dashboard.md
+++ b/v1.1/admin-ui-sql-dashboard.md
@@ -1,12 +1,11 @@
---
title: SQL Dashboard
summary: The SQL dashboard lets you monitor the performance of your SQL queries.
-toc: false
+toc: true
---
The **SQL** dashboard in the CockroachDB Admin UI lets you monitor the performance of your SQL queries. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then select **Dashboard** > **SQL**.
-
The **SQL** dashboard displays the following time series graphs:
diff --git a/v1.1/admin-ui-storage-dashboard.md b/v1.1/admin-ui-storage-dashboard.md
index baaa36a5e3f..c306be474ac 100644
--- a/v1.1/admin-ui-storage-dashboard.md
+++ b/v1.1/admin-ui-storage-dashboard.md
@@ -1,12 +1,11 @@
---
title: Storage Dashboard
summary: The Storage dashboard lets you monitor the storage utilization for your cluster.
-toc: false
+toc: true
---
The **Storage** dashboard in the CockroachDB Admin UI lets you monitor the storage utilization for your cluster. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then selecte **Dashboard** > **Storage**.
-
The **Storage** dashboard displays the following time series graphs:
diff --git a/v1.1/alter-column.md b/v1.1/alter-column.md
index d1667d96258..4d06c8fc9b6 100644
--- a/v1.1/alter-column.md
+++ b/v1.1/alter-column.md
@@ -1,14 +1,13 @@
---
title: ALTER COLUMN
summary: Use the ALTER COLUMN statement to set, change, or drop a column's Default constraint or to drop the Not Null constraint.
-toc: false
+toc: true
---
The `ALTER COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and sets, changes, or drops a column's [Default constraint](default-value.html) or drops the [Not Null constraint](not-null.html).
{{site.data.alerts.callout_info}}To manage other constraints, see ADD CONSTRAINT and DROP CONSTRAINT{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/alter-table.md b/v1.1/alter-table.md
index 05a1f776e01..5be5ec157f3 100644
--- a/v1.1/alter-table.md
+++ b/v1.1/alter-table.md
@@ -1,14 +1,13 @@
---
title: ALTER TABLE
summary: Use the ALTER TABLE statement to change the schema of a table.
-toc: false
+toc: true
---
The `ALTER TABLE` [statement](sql-statements.html) applies a schema change to a table.
{{site.data.alerts.callout_info}}To understand how CockroachDB changes schema elements without requiring table locking or other user-visible downtime, see Online Schema Changes in CockroachDB.{{site.data.alerts.end}}
-
## Subcommands
diff --git a/v1.1/alter-view.md b/v1.1/alter-view.md
index 870c7d88d1c..f920fc805e5 100644
--- a/v1.1/alter-view.md
+++ b/v1.1/alter-view.md
@@ -1,14 +1,13 @@
---
title: ALTER VIEW
summary: The ALTER VIEW statement changes the name of a view.
-toc: false
+toc: true
---
The `ALTER VIEW` [statement](sql-statements.html) changes the name of a [view](views.html).
{{site.data.alerts.callout_info}}It is not currently possible to change the SELECT statement executed by a view. Instead, you must drop the existing view and create a new view. Also, it is not currently possible to rename a view that other views depend on, but this ability may be added in the future (see this issue).{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/architecture/distribution-layer.md b/v1.1/architecture/distribution-layer.md
index 8df2db35ae6..7f7b84ffdca 100644
--- a/v1.1/architecture/distribution-layer.md
+++ b/v1.1/architecture/distribution-layer.md
@@ -1,14 +1,13 @@
---
title: Distribution Layer
summary:
-toc: false
+toc: true
---
The Distribution Layer of CockroachDB's architecture provides a unified view of your cluster's data.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v1.1/architecture/overview.md b/v1.1/architecture/overview.md
index 7c83d2c0b01..4ed3fb4194e 100644
--- a/v1.1/architecture/overview.md
+++ b/v1.1/architecture/overview.md
@@ -1,7 +1,7 @@
---
title: Architecture Overview
summary:
-toc: false
+toc: true
key: cockroachdb-architecture.html
redirect_from: index.html
---
@@ -10,7 +10,6 @@ CockroachDB was designed to create the open-source database our developers would
However, you definitely do not need to understand the underlying architecture to use CockroachDB. These pages give serious users and database enthusiasts a high-level framework to explain what's happening under the hood.
-
## Using this Guide
diff --git a/v1.1/architecture/replication-layer.md b/v1.1/architecture/replication-layer.md
index 00791150395..a0000adbbf0 100644
--- a/v1.1/architecture/replication-layer.md
+++ b/v1.1/architecture/replication-layer.md
@@ -1,14 +1,13 @@
---
title: Replication Layer
summary:
-toc: false
+toc: true
---
The Replication Layer of CockroachDB's architecture copies data between nodes and ensures consistency between these copies by implementing our consensus algorithm.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v1.1/architecture/sql-layer.md b/v1.1/architecture/sql-layer.md
index 2550906f04c..f6d80c92033 100644
--- a/v1.1/architecture/sql-layer.md
+++ b/v1.1/architecture/sql-layer.md
@@ -1,14 +1,13 @@
---
title: SQL Layer
summary:
-toc: false
+toc: true
---
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.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v1.1/architecture/storage-layer.md b/v1.1/architecture/storage-layer.md
index d0fd16c54d1..5b875a9910c 100644
--- a/v1.1/architecture/storage-layer.md
+++ b/v1.1/architecture/storage-layer.md
@@ -1,14 +1,13 @@
---
title: Storage Layer
summary:
-toc: false
+toc: true
---
The Storage Layer of CockroachDB's architecture reads and writes data to disk.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v1.1/architecture/transaction-layer.md b/v1.1/architecture/transaction-layer.md
index bd66c5f0080..edae0985024 100644
--- a/v1.1/architecture/transaction-layer.md
+++ b/v1.1/architecture/transaction-layer.md
@@ -1,14 +1,13 @@
---
title: Transaction Layer
summary:
-toc: false
+toc: true
---
The Transaction Layer of CockroachDB's architecture implements support for ACID transactions by coordinating concurrent operations.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v1.1/array.md b/v1.1/array.md
index cfb96275919..01a39ace4fd 100644
--- a/v1.1/array.md
+++ b/v1.1/array.md
@@ -1,14 +1,13 @@
---
title: ARRAY
summary: The ARRAY data type stores one-dimensional, 1-indexed, homogenous arrays of any non-array data types
-toc: false
+toc: true
---
New in v1.1:The `ARRAY` data type stores one-dimensional, 1-indexed, homogenous arrays of any non-array [data type](data-types.html).
The `ARRAY` data type is useful for ensuring compatibility with ORMs and other tools. However, if such compatibility is not a concern, it's more flexible to design your schema with normalized tables.
-
{{site.data.alerts.callout_info}} CockroachDB does not support nested arrays, creating database indexes on arrays, and ordering by arrays.{{site.data.alerts.end}}
diff --git a/v1.1/backup.md b/v1.1/backup.md
index 4ad92910ce5..d56bf42b226 100644
--- a/v1.1/backup.md
+++ b/v1.1/backup.md
@@ -1,7 +1,7 @@
---
title: BACKUP
summary: Back up your CockroachDB cluster to a cloud storage services such as AWS S3, Google Cloud Storage, or other NFS.
-toc: false
+toc: true
---
{{site.data.alerts.callout_danger}}The BACKUP feature is only available to enterprise users. For non-enterprise backups, see cockroach dump.{{site.data.alerts.end}}
@@ -10,7 +10,6 @@ CockroachDB's `BACKUP` [statement](sql-statements.html) creates full or incremen
Because CockroachDB is designed with high fault tolerance, these backups are designed primarily for disaster recovery (i.e., if your cluster loses a majority of its nodes) through [`RESTORE`](restore.html). Isolated issues (such as small-scale node outages) do not require any intervention.
-
## Functional Details
diff --git a/v1.1/begin-transaction.md b/v1.1/begin-transaction.md
index 4b0e12720e1..236ffd5beb0 100644
--- a/v1.1/begin-transaction.md
+++ b/v1.1/begin-transaction.md
@@ -1,14 +1,13 @@
---
title: BEGIN
summary: Initiate a SQL transaction with the BEGIN statement in CockroachDB.
-toc: false
+toc: true
---
The `BEGIN` [statement](sql-statements.html) initiates a [transaction](transactions.html), which either successfully executes all of the statements it contains or none at all.
{{site.data.alerts.callout_danger}}When using transactions, your application should include logic to retry transactions that are aborted to break a dependency cycle between concurrent transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/bool.md b/v1.1/bool.md
index c9bb93d300f..b7bdd457701 100644
--- a/v1.1/bool.md
+++ b/v1.1/bool.md
@@ -1,12 +1,11 @@
---
title: BOOL
summary: The BOOL data type stores Boolean values of false or true.
-toc: false
+toc: true
---
The `BOOL` [data type](data-types.html) stores a Boolean value of `false` or `true`.
-
## Aliases
diff --git a/v1.1/build-a-c++-app-with-cockroachdb.md b/v1.1/build-a-c++-app-with-cockroachdb.md
index 11a753d5371..9bcc68f09a8 100644
--- a/v1.1/build-a-c++-app-with-cockroachdb.md
+++ b/v1.1/build-a-c++-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a C++ App with CockroachDB
summary: Learn how to use CockroachDB from a simple C++ application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple C++ application with CockroachDB usin
We have tested the [C++ libpqxx driver](https://github.com/jtv/libpqxx) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-clojure-app-with-cockroachdb.md b/v1.1/build-a-clojure-app-with-cockroachdb.md
index 1d8c66430e2..49fd6493902 100644
--- a/v1.1/build-a-clojure-app-with-cockroachdb.md
+++ b/v1.1/build-a-clojure-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Clojure App with CockroachDB
summary: Learn how to use CockroachDB from a simple Clojure application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple Clojure application with CockroachDB
We have tested the [Clojure java.jdbc driver](http://clojure-doc.org/articles/ecosystem/java_jdbc/home.html) in conjunction with the [PostgreSQL JDBC driver](https://jdbc.postgresql.org/) enough to claim **beta-level** support, so that combination is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-csharp-app-with-cockroachdb.md b/v1.1/build-a-csharp-app-with-cockroachdb.md
index 1e6957b688d..95142b122d7 100644
--- a/v1.1/build-a-csharp-app-with-cockroachdb.md
+++ b/v1.1/build-a-csharp-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a C# (.NET) App with CockroachDB
summary: Learn how to use CockroachDB from a simple C# (.NET) application with a low-level client driver.
-toc: false
+toc: true
twitter: true
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple C# (.NET) application with CockroachD
We have tested the [.NET Npgsql driver](http://www.npgsql.org/) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-go-app-with-cockroachdb-gorm.md b/v1.1/build-a-go-app-with-cockroachdb-gorm.md
index 2dc9697c69f..394237e5551 100644
--- a/v1.1/build-a-go-app-with-cockroachdb-gorm.md
+++ b/v1.1/build-a-go-app-with-cockroachdb-gorm.md
@@ -1,7 +1,7 @@
---
title: Build a Go App with CockroachDB
summary: Learn how to use CockroachDB from a simple Go application with the GORM ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Go pq driver](https://godoc.org/github.com/lib/pq) and the [
{{site.data.alerts.callout_success}}For a more realistic use of GORM with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/build-a-go-app-with-cockroachdb.md b/v1.1/build-a-go-app-with-cockroachdb.md
index 378c69a891d..e40d2421ec4 100644
--- a/v1.1/build-a-go-app-with-cockroachdb.md
+++ b/v1.1/build-a-go-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Go App with CockroachDB
summary: Learn how to use CockroachDB from a simple Go application with the Go pq driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Go application with CockroachDB using
We have tested the [Go pq driver](https://godoc.org/github.com/lib/pq) and the [GORM ORM](http://jinzhu.me/gorm/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-java-app-with-cockroachdb-hibernate.md b/v1.1/build-a-java-app-with-cockroachdb-hibernate.md
index 38e1e2b931b..f022637fe2b 100644
--- a/v1.1/build-a-java-app-with-cockroachdb-hibernate.md
+++ b/v1.1/build-a-java-app-with-cockroachdb-hibernate.md
@@ -1,7 +1,7 @@
---
title: Build a Java App with CockroachDB
summary: Learn how to use CockroachDB from a simple Java application with the Hibernate ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Java jdbc driver](https://jdbc.postgresql.org/) and the [Hib
{{site.data.alerts.callout_success}}For a more realistic use of Hibernate with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/build-a-java-app-with-cockroachdb.md b/v1.1/build-a-java-app-with-cockroachdb.md
index 88119ed2daf..86d4b4d5024 100644
--- a/v1.1/build-a-java-app-with-cockroachdb.md
+++ b/v1.1/build-a-java-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Java App with CockroachDB
summary: Learn how to use CockroachDB from a simple Java application with the jdbc driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Java application with CockroachDB usi
We have tested the [Java jdbc driver](https://jdbc.postgresql.org/) and the [Hibernate ORM](http://hibernate.org/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-nodejs-app-with-cockroachdb-sequelize.md b/v1.1/build-a-nodejs-app-with-cockroachdb-sequelize.md
index 99b8b87ec4f..7512379e33a 100644
--- a/v1.1/build-a-nodejs-app-with-cockroachdb-sequelize.md
+++ b/v1.1/build-a-nodejs-app-with-cockroachdb-sequelize.md
@@ -1,7 +1,7 @@
---
title: Build a Node.js App with CockroachDB
summary: Learn how to use CockroachDB from a simple Node.js application with the Sequelize ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Node.js pg driver](https://www.npmjs.com/package/pg) and the
{{site.data.alerts.callout_success}}For a more realistic use of Sequelize with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/build-a-nodejs-app-with-cockroachdb.md b/v1.1/build-a-nodejs-app-with-cockroachdb.md
index 9c15f19ea0a..98a09794f11 100644
--- a/v1.1/build-a-nodejs-app-with-cockroachdb.md
+++ b/v1.1/build-a-nodejs-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Node.js App with CockroachDB
summary: Learn how to use CockroachDB from a simple Node.js application with the Node.js pg driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Node.js application with CockroachDB
We have tested the [Node.js pg driver](https://www.npmjs.com/package/pg) and the [Sequelize ORM](https://sequelize.readthedocs.io/en/v3/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-php-app-with-cockroachdb.md b/v1.1/build-a-php-app-with-cockroachdb.md
index 233cdb55968..68060a5a61e 100644
--- a/v1.1/build-a-php-app-with-cockroachdb.md
+++ b/v1.1/build-a-php-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a PHP App with CockroachDB
summary: Learn how to use CockroachDB from a simple PHP application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple PHP application with CockroachDB usin
We have tested the [php-pgsql driver](http://php.net/manual/en/book.pgsql.php) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-python-app-with-cockroachdb-sqlalchemy.md b/v1.1/build-a-python-app-with-cockroachdb-sqlalchemy.md
index a497f97dedc..3bf3e7c60c2 100644
--- a/v1.1/build-a-python-app-with-cockroachdb-sqlalchemy.md
+++ b/v1.1/build-a-python-app-with-cockroachdb-sqlalchemy.md
@@ -1,7 +1,7 @@
---
title: Build a Python App with CockroachDB
summary: Learn how to use CockroachDB from a simple Python application with the SQLAlchemy ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Python psycopg2 driver](http://initd.org/psycopg/docs/) and
{{site.data.alerts.callout_success}}For a more realistic use of SQLAlchemy with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/build-a-python-app-with-cockroachdb.md b/v1.1/build-a-python-app-with-cockroachdb.md
index 0915a3d09c4..1d3820d51be 100644
--- a/v1.1/build-a-python-app-with-cockroachdb.md
+++ b/v1.1/build-a-python-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Python App with CockroachDB
summary: Learn how to use CockroachDB from a simple Python application with the psycopg2 driver.
-toc: false
+toc: true
asciicast: true
twitter: false
---
@@ -15,7 +15,6 @@ This tutorial shows you how build a simple Python application with CockroachDB u
We have tested the [Python psycopg2 driver](http://initd.org/psycopg/docs/) and the [SQLAlchemy ORM](https://docs.sqlalchemy.org/en/latest/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-ruby-app-with-cockroachdb-activerecord.md b/v1.1/build-a-ruby-app-with-cockroachdb-activerecord.md
index 8b5118fafdc..4a392ea91a1 100644
--- a/v1.1/build-a-ruby-app-with-cockroachdb-activerecord.md
+++ b/v1.1/build-a-ruby-app-with-cockroachdb-activerecord.md
@@ -1,7 +1,7 @@
---
title: Build a Ruby App with CockroachDB
summary: Learn how to use CockroachDB from a simple Ruby application with the ActiveRecord ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Ruby pg driver](https://rubygems.org/gems/pg) and the [Activ
{{site.data.alerts.callout_success}}For a more realistic use of ActiveRecord with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/build-a-ruby-app-with-cockroachdb.md b/v1.1/build-a-ruby-app-with-cockroachdb.md
index b7b45ac898f..d7bc607ce24 100644
--- a/v1.1/build-a-ruby-app-with-cockroachdb.md
+++ b/v1.1/build-a-ruby-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Ruby App with CockroachDB
summary: Learn how to use CockroachDB from a simple Ruby application with the pg client driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Ruby application with CockroachDB usi
We have tested the [Ruby pg driver](https://rubygems.org/gems/pg) and the [ActiveRecord ORM](http://guides.rubyonrails.org/active_record_basics.html) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/build-a-rust-app-with-cockroachdb.md b/v1.1/build-a-rust-app-with-cockroachdb.md
index 099bdfb24fe..afec3fd4eb5 100644
--- a/v1.1/build-a-rust-app-with-cockroachdb.md
+++ b/v1.1/build-a-rust-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Rust App with CockroachDB
summary: Learn how to use CockroachDB from a simple Rust application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple Rust application with CockroachDB usi
We have tested the Rust postgres driver enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v1.1/bytes.md b/v1.1/bytes.md
index 4f618d5af3c..fff91bfa684 100644
--- a/v1.1/bytes.md
+++ b/v1.1/bytes.md
@@ -1,12 +1,11 @@
---
title: BYTES
summary: The BYTES data type stores binary strings of variable length.
-toc: false
+toc: true
---
The `BYTES` [data type](data-types.html) stores binary strings of variable length.
-
## Aliases
diff --git a/v1.1/cancel-job.md b/v1.1/cancel-job.md
index 13fe2dda1d6..a4f1a2f8068 100644
--- a/v1.1/cancel-job.md
+++ b/v1.1/cancel-job.md
@@ -1,12 +1,11 @@
---
title: CANCEL JOB
summary: The CANCEL JOB statement stops long-running jobs, which include enterprise BACKUP and RESTORE tasks.
-toc: false
+toc: true
---
New in v1.1: The `CANCEL JOB` [statement](sql-statements.html) lets you stop long-running jobs, which include enterprise [`BACKUP`](backup.html) and [`RESTORE`](restore.html) tasks.
-
## Limitations
diff --git a/v1.1/cancel-query.md b/v1.1/cancel-query.md
index 627cecf5d0c..d9748ba381d 100644
--- a/v1.1/cancel-query.md
+++ b/v1.1/cancel-query.md
@@ -1,12 +1,11 @@
---
title: CANCEL QUERY
summary: The CANCEL QUERY statement cancels a running SQL query.
-toc: false
+toc: true
---
New in v1.1: The `CANCEL QUERY` [statement](sql-statements.html) cancels a running SQL query.
-
## Considerations
diff --git a/v1.1/check.md b/v1.1/check.md
index cfa19b7005c..30d75601874 100644
--- a/v1.1/check.md
+++ b/v1.1/check.md
@@ -1,12 +1,11 @@
---
title: CHECK Constraint
summary: The CHECK constraint specifies that values for the column in INSERT or UPDATE statements must satisfy a Boolean expression.
-toc: false
+toc: true
---
The `CHECK` [constraint](constraints.html) specifies that values for the column in [`INSERT`](insert.html) or [`UPDATE`](update.html) statements must return `TRUE` or `NULL` for a Boolean expression. If any values return `FALSE`, the entire statement is rejected.
-
## Details
diff --git a/v1.1/cluster-settings.md b/v1.1/cluster-settings.md
index 6ff008e6d73..74403554279 100644
--- a/v1.1/cluster-settings.md
+++ b/v1.1/cluster-settings.md
@@ -1,14 +1,13 @@
---
title: Cluster Settings
summary: Learn about cluster settings that apply to all nodes of a CockroachDB cluster.
-toc: false
+toc: true
---
This page shows you how to view and change CockroachDB's **cluster-wide settings**.
{{site.data.alerts.callout_info}}In contrast to cluster-wide settings, node-level settings apply to a single node. They are defined by flags passed to the cockroach start command when starting a node and cannot be changed without stopping and restarting the node. For more details, see Start a Node.{{site.data.alerts.end}}
-
## Overview
diff --git a/v1.1/cluster-setup-troubleshooting.md b/v1.1/cluster-setup-troubleshooting.md
index 7884b8a8586..a1f5c21cbb8 100644
--- a/v1.1/cluster-setup-troubleshooting.md
+++ b/v1.1/cluster-setup-troubleshooting.md
@@ -1,12 +1,11 @@
---
title: Troubleshoot Cluster Setup
summary: Learn how to troubleshoot issues with starting CockroachDB clusters
-toc: false
+toc: true
---
If you're having trouble starting or scaling your cluster, this page will help you troubleshoot the issue.
-
## Before You Begin
diff --git a/v1.1/cockroach-commands.md b/v1.1/cockroach-commands.md
index 9f8e6f7b58e..609ce991745 100644
--- a/v1.1/cockroach-commands.md
+++ b/v1.1/cockroach-commands.md
@@ -1,14 +1,13 @@
---
title: Cockroach Commands
summary: Learn the commands for configuring, starting, and managing a CockroachDB cluster.
-toc: false
+toc: true
---
This page introduces the `cockroach` commands for configuring, starting, and managing a CockroachDB cluster, as well as logging flags that can be set on any command and environment variables that can be used in place of certain flags.
You can run `cockroach help` in your shell to get similar guidance.
-
## Commands
diff --git a/v1.1/collate.md b/v1.1/collate.md
index 74017ff1296..232420fcaf6 100644
--- a/v1.1/collate.md
+++ b/v1.1/collate.md
@@ -1,7 +1,7 @@
---
title: COLLATE
summary: The COLLATE feature lets you sort strings according to language- and country-specific rules.
-toc: false
+toc: true
redirect_from: collatedstring.html
---
@@ -9,7 +9,6 @@ The `COLLATE` feature lets you sort [`STRING`](string.html) values according to
Collated strings are important because different languages have [different rules for alphabetic order](https://en.wikipedia.org/wiki/Alphabetical_order#Language-specific_conventions), especially with respect to accented letters. For example, in German accented letters are sorted with their unaccented counterparts, while in Swedish they are placed at the end of the alphabet. A collation is a set of rules used for ordering and usually corresponds to a language, though some languages have multiple collations with different rules for sorting; for example Portuguese has separate collations for Brazilian and European dialects (`pt-BR` and `pt-PT` respectively).
-
## Details
diff --git a/v1.1/column-families.md b/v1.1/column-families.md
index e7911fc00b4..3659971b7eb 100644
--- a/v1.1/column-families.md
+++ b/v1.1/column-families.md
@@ -1,14 +1,13 @@
---
title: Column Families
summary: A column family is a group of columns in a table that are stored as a single key-value pair in the underlying key-value store.
-toc: false
+toc: true
---
A column family is a group of columns in a table that are stored as a single key-value pair in the underlying key-value store. The reduced number of keys results in a smaller storage overhead and, even more significantly, in improved performance during `INSERT`, `UPDATE`, and `DELETE` operations.
This page explains how CockroachDB organizes columns into families as well as cases in which you might want to manually override the default behavior.
-
## Default Behavior
diff --git a/v1.1/commit-transaction.md b/v1.1/commit-transaction.md
index d001cc10c59..24a267258c5 100644
--- a/v1.1/commit-transaction.md
+++ b/v1.1/commit-transaction.md
@@ -1,7 +1,7 @@
---
title: COMMIT
summary: Commit a transaction with the COMMIT statement in CockroachDB.
-toc: false
+toc: true
---
The `COMMIT` [statement](sql-statements.html) commits the current [transaction](transactions.html) or, when using [client-side transaction retries](transactions.html#client-side-transaction-retries), clears the connection to allow new transactions to begin.
@@ -10,7 +10,6 @@ When using [client-side transaction retries](transactions.html#client-side-trans
For non-retryable transactions, if statements in the transaction [generated any errors](transactions.html#error-handling), `COMMIT` is equivalent to `ROLLBACK`, which aborts the transaction and discards *all* updates made by its statements.
-
## Synopsis
diff --git a/v1.1/configure-replication-zones.md b/v1.1/configure-replication-zones.md
index c972efe7acf..883dbd8a8c4 100644
--- a/v1.1/configure-replication-zones.md
+++ b/v1.1/configure-replication-zones.md
@@ -2,7 +2,7 @@
title: Configure Replication Zones
summary: In CockroachDB, you use replication zones to control the number and location of replicas for specific sets of data.
keywords: ttl, time to live, availability zone
-toc: false
+toc: true
---
In CockroachDB, you use **replication zones** to control the number and location of replicas for specific sets of data, both when replicas are first added and when they are rebalanced to maintain cluster equilibrium. Initially, there is a single, default replication zone for the entire cluster. You can adjust this default zone as well as add zones for individual databases and tables as needed. For example, you might use the default zone to replicate most data in a cluster normally within a single datacenter, while creating a specific zone to more highly replicate a certain database or table across multiple datacenters and geographies.
@@ -11,7 +11,6 @@ This page explains how replication zones work and how to use the `cockroach zone
{{site.data.alerts.callout_info}}Currently, only the root user can configure replication zones.{{site.data.alerts.end}}
-
## Overview
diff --git a/v1.1/connection-parameters.md b/v1.1/connection-parameters.md
index d0e7acd3206..36f35f636cb 100644
--- a/v1.1/connection-parameters.md
+++ b/v1.1/connection-parameters.md
@@ -1,7 +1,7 @@
---
title: Client Connection Parameters
summary: This page describes the parameters used to establish a client connection.
-toc: false
+toc: true
---
Client applications, including client [`cockroach`
@@ -10,7 +10,6 @@ connection to a CockroachDB cluster. The client connection parameters
determine which CockroachDB cluster they connect to, and how to
establish this network connection.
-
## Supported Connection Parameters
diff --git a/v1.1/constraints.md b/v1.1/constraints.md
index c03fd8eeef0..9a6392d832d 100644
--- a/v1.1/constraints.md
+++ b/v1.1/constraints.md
@@ -1,14 +1,13 @@
---
title: Constraints
summary: Constraints offer additional data integrity by enforcing conditions on the data within a column.
-toc: false
+toc: true
---
Constraints offer additional data integrity by enforcing conditions on the data within a column. Whenever values are manipulated (inserted, deleted, or updated), constraints are checked and modifications that violate constraints are rejected.
For example, the Unique constraint requires that all values in a column be unique from one another (except *NULL* values). If you attempt to write a duplicate value, the constraint rejects the entire statement.
-
## Supported Constraints
diff --git a/v1.1/contribute-to-cockroachdb.md b/v1.1/contribute-to-cockroachdb.md
index 4b76624d5fb..9af5c2c67e5 100644
--- a/v1.1/contribute-to-cockroachdb.md
+++ b/v1.1/contribute-to-cockroachdb.md
@@ -1,12 +1,11 @@
---
title: Contribute to CockroachDB
summary: Contribute to the development of CockroachDB.
-toc: false
+toc: true
---
We made CockroachDB open source to empower developers to fix and extend the product to better meet their needs. Nothing thrills us more than people so passionate about the product that they‘re willing to spend their own time to learn the codebase and give back to the community. We created this doc so we can support contributors in a way that doesn’t sacrifice precious bandwidth that we use to serve our users and otherwise meet our business goals.
-
## Introduction
diff --git a/v1.1/create-a-file-server.md b/v1.1/create-a-file-server.md
index 1a7102950a6..c2ea71cfe7b 100644
--- a/v1.1/create-a-file-server.md
+++ b/v1.1/create-a-file-server.md
@@ -1,7 +1,7 @@
---
title: Create a File Server for Imports and Backups
summary: Learn how to create a simple file server for use with CockroachDB IMPORT and BACKUP
-toc: false
+toc: true
---
If you need a location to store files for the [`IMPORT`](import.html) process or [CockroachDB enterprise backups](backup.html), but don't have access to (or simply can't use) cloud storage providers, you can easily create your own file server. You can then use this file server by leveraging support for our HTTP Export Storage API.
@@ -11,7 +11,6 @@ This is especially useful for:
- Implementing a compatibility layer in front of custom or proprietary storage providers for which CockroachDB does not yet have native support
- Using on-premises storage
-
## HTTP Export Storage API
diff --git a/v1.1/create-and-manage-users.md b/v1.1/create-and-manage-users.md
index 633b2bf66a9..9765f062484 100644
--- a/v1.1/create-and-manage-users.md
+++ b/v1.1/create-and-manage-users.md
@@ -1,14 +1,13 @@
---
title: Create & Manage Users
summary: To create and manage your cluster's users (which lets you control SQL-level privileges), use the cockroach user command with appropriate flags.
-toc: false
+toc: true
---
To create, manage, and remove your cluster's users (which lets you control SQL-level [privileges](privileges.html)), use the `cockroach user` [command](cockroach-commands.html) with appropriate flags.
{{site.data.alerts.callout_success}}You can also use the CREATE USER and DROP USER statements to create and remove users.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v1.1/create-database.md b/v1.1/create-database.md
index bf39733d2dd..e066a0e5baf 100644
--- a/v1.1/create-database.md
+++ b/v1.1/create-database.md
@@ -1,12 +1,11 @@
---
title: CREATE DATABASE
summary: The CREATE DATABASE statement creates a new CockroachDB database.
-toc: false
+toc: true
---
The `CREATE DATABASE` [statement](sql-statements.html) creates a new CockroachDB database.
-
## Required Privileges
diff --git a/v1.1/create-index.md b/v1.1/create-index.md
old mode 100755
new mode 100644
index 4e85b633ad7..4658294cb47
--- a/v1.1/create-index.md
+++ b/v1.1/create-index.md
@@ -1,14 +1,13 @@
---
title: CREATE INDEX
summary: The CREATE INDEX statement creates an index for a table. Indexes improve your database's performance by helping SQL quickly locate data.
-toc: false
+toc: true
---
The `CREATE INDEX` [statement](sql-statements.html) creates an index for a table. [Indexes](indexes.html) improve your database's performance by helping SQL locate data without having to look through every row of a table.
{{site.data.alerts.callout_info}}Indexes are automatically created for a table's PRIMARY KEY and UNIQUE columns.When querying a table, CockroachDB uses the fastest index. For more information about that process, see Index Selection in CockroachDB.{{site.data.alerts.end}} - ## Required Privileges diff --git a/v1.1/create-security-certificates-openssl.md b/v1.1/create-security-certificates-openssl.md index 0e28559e707..c299af9128c 100644 --- a/v1.1/create-security-certificates-openssl.md +++ b/v1.1/create-security-certificates-openssl.md @@ -1,7 +1,7 @@ --- title: Create Security Certificates summary: A secure CockroachDB cluster uses TLS for encrypted inter-node and client-node communication. -toc: false +toc: true ---
@@ -11,7 +11,6 @@ toc: false
A secure CockroachDB cluster uses [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) for encrypted inter-node and client-node communication, which requires CA, node, and client certificates and keys. To create these certificates and keys, use the `cockroach cert` [commands](cockroach-commands.html) with the appropriate subcommands and flags, or use [`openssl` commands](https://wiki.openssl.org/index.php/).
-
## Subcommands
diff --git a/v1.1/create-security-certificates.md b/v1.1/create-security-certificates.md
index 97cc855e316..b8c795edc33 100644
--- a/v1.1/create-security-certificates.md
+++ b/v1.1/create-security-certificates.md
@@ -1,7 +1,7 @@
---
title: Create Security Certificates
summary: A secure CockroachDB cluster uses TLS for encrypted inter-node and client-node communication.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ A secure CockroachDB cluster uses [TLS](https://en.wikipedia.org/wiki/Transport_
{{site.data.alerts.callout_success}}For details about when and how to change security certificates without restarting nodes, see Rotate Security Certificates.{{site.data.alerts.end}}
-
## How Security Certificates Work
diff --git a/v1.1/create-table-as.md b/v1.1/create-table-as.md
index b110a894704..76e267b33ff 100644
--- a/v1.1/create-table-as.md
+++ b/v1.1/create-table-as.md
@@ -1,12 +1,11 @@
---
title: CREATE TABLE AS
summary: The CREATE TABLE AS statement persists the result of a query into the database for later reuse.
-toc: false
+toc: true
---
The `CREATE TABLE ... AS` statement creates a new table from a [selection clause](selection-clauses.html).
-
## Intended Use
diff --git a/v1.1/create-table.md b/v1.1/create-table.md
index 9af7b0ee252..530ae1e079f 100644
--- a/v1.1/create-table.md
+++ b/v1.1/create-table.md
@@ -1,12 +1,11 @@
---
title: CREATE TABLE
summary: The CREATE TABLE statement creates a new table in a database.
-toc: false
+toc: true
---
The `CREATE TABLE` [statement](sql-statements.html) creates a new table in a database.
-
## Required Privileges
diff --git a/v1.1/create-user.md b/v1.1/create-user.md
index c7346a213e0..243ec31e87d 100644
--- a/v1.1/create-user.md
+++ b/v1.1/create-user.md
@@ -1,14 +1,13 @@
---
title: CREATE USER
summary: The CREATE USER statement creates SQL users, which let you control privileges on your databases and tables.
-toc: false
+toc: true
---
The `CREATE USER` [statement](sql-statements.html) creates SQL users, which let you control [privileges](privileges.html) on your databases and tables.
{{site.data.alerts.callout_success}}You can also use the
cockroach user set command to create and manage users.{{site.data.alerts.end}}
-
## Considerations
@@ -17,7 +16,6 @@ The `CREATE USER` [statement](sql-statements.html) creates SQL users, which let
- On secure clusters, you must [create client certificates for users](create-security-certificates.html#create-the-certificate-and-key-pair-for-a-client) and users must [authenticate their access to the cluster](#user-authentication).
- {% include {{ page.version.version }}/misc/remove-user-callout.html %}
-
## Required Privileges
diff --git a/v1.1/create-view.md b/v1.1/create-view.md
index e8a44c1f953..43cbe6584c2 100644
--- a/v1.1/create-view.md
+++ b/v1.1/create-view.md
@@ -1,12 +1,11 @@
---
title: CREATE VIEW
summary: The CREATE VIEW statement creates a .
-toc: false
+toc: true
---
The `CREATE VIEW` statement creates a new [view](views.html), which is a stored `SELECT` query represented as a virtual table.
-
## Required Privileges
diff --git a/v1.1/date.md b/v1.1/date.md
index 134fb6a9034..5674436799a 100644
--- a/v1.1/date.md
+++ b/v1.1/date.md
@@ -1,12 +1,11 @@
---
title: DATE
summary: The DATE data type stores a year, month, and day.
-toc: false
+toc: true
---
The `DATE` [data type](data-types.html) stores a year, month, and day.
-
## Syntax
diff --git a/v1.1/debug-and-error-logs.md b/v1.1/debug-and-error-logs.md
index 9ce2049ad92..12a73bc1d1c 100644
--- a/v1.1/debug-and-error-logs.md
+++ b/v1.1/debug-and-error-logs.md
@@ -1,12 +1,11 @@
---
title: Understand Debug & Error Logs
summary: Learn how to find and read CockroachDB error logs
-toc: false
+toc: true
---
If you need to [troubleshoot](troubleshooting-overview.html) issues with your cluster, you can check a node's logs, which include details about certain node-level and range-level events, such as errors. For example, if CockroachDB crashes, it normally logs a stack trace to what caused the problem.
-
## Details
diff --git a/v1.1/debug-zip.md b/v1.1/debug-zip.md
index f9e780751d3..b5cd49fc803 100644
--- a/v1.1/debug-zip.md
+++ b/v1.1/debug-zip.md
@@ -1,7 +1,7 @@
---
title: Collect Debug Information from Your Cluster
summary: Learn the commands for collecting debug information from all nodes in your cluster.
-toc: false
+toc: true
---
The `debug zip` [command](cockroach-commands.html) connects to your cluster and gathers the following information from each active node into a single file (inactive nodes are not included):
@@ -16,7 +16,6 @@ The `debug zip` [command](cockroach-commands.html) connects to your cluster and
{{site.data.alerts.callout_danger}}The file produced by cockroach debug zip can contain highly sensitive, unanonymized information, such as usernames, passwords, and possibly your table's data. You should share this data only with Cockroach Labs developers and only after determining the most secure method of delivery.{{site.data.alerts.end}}
-
## Details
diff --git a/v1.1/decimal.md b/v1.1/decimal.md
index 57d8a46a520..09f17484dcc 100644
--- a/v1.1/decimal.md
+++ b/v1.1/decimal.md
@@ -1,12 +1,11 @@
---
title: DECIMAL
summary: The DECIMAL data type stores exact, fixed-point numbers.
-toc: false
+toc: true
---
The `DECIMAL` [data type](data-types.html) stores exact, fixed-point numbers. This type is used when it is important to preserve exact precision, for example, with monetary data.
-
## Aliases
diff --git a/v1.1/default-value.md b/v1.1/default-value.md
index 501b3afbe05..8d21bfa1f24 100644
--- a/v1.1/default-value.md
+++ b/v1.1/default-value.md
@@ -1,12 +1,11 @@
---
title: Default Value Constraint
summary: The Default Value constraint specifies a value to populate a column with if none is provided.
-toc: false
+toc: true
---
The Default Value [constraint](constraints.html) specifies a value to write into the constrained column if one is not defined in an `INSERT` statement. The value may be either a hard-coded literal or an expression that is evaluated at the time the row is created.
-
## Details
diff --git a/v1.1/delete.md b/v1.1/delete.md
index 7aebff1ea5c..a3967e10933 100644
--- a/v1.1/delete.md
+++ b/v1.1/delete.md
@@ -1,14 +1,13 @@
---
title: DELETE
summary: The DELETE statement deletes rows from a table.
-toc: false
+toc: true
---
The `DELETE` [statement](sql-statements.html) deletes rows from a table.
{{site.data.alerts.callout_info}}To delete columns, see DROP COLUMN.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/demo-automatic-cloud-migration.md b/v1.1/demo-automatic-cloud-migration.md
index 18d7e889f26..934366a97bd 100644
--- a/v1.1/demo-automatic-cloud-migration.md
+++ b/v1.1/demo-automatic-cloud-migration.md
@@ -1,12 +1,11 @@
---
title: Cross-Cloud Migration
summary: Use a local cluster to simulate migrating from one cloud platform to another.
-toc: false
+toc: true
---
CockroachDB's flexible [replication controls](configure-replication-zones.html) make it trivially easy to run a single CockroachDB cluster across cloud platforms and to migrate data from one cloud to another without any service interruption. This page walks you through a local simulation of the process.
-
## Watch a Live Demo
diff --git a/v1.1/demo-automatic-rebalancing.md b/v1.1/demo-automatic-rebalancing.md
index 018efc79007..e9a7c883955 100644
--- a/v1.1/demo-automatic-rebalancing.md
+++ b/v1.1/demo-automatic-rebalancing.md
@@ -1,12 +1,11 @@
---
title: Automatic Rebalancing
summary: Use a local cluster to explore how CockroachDB automatically rebalances data as you scale.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB automatically rebalances data as you scale. Starting with a 3-node local cluster, you'll lower the maximum size for a single range, the unit of data that is replicated in CockroachDB. You'll then download and run the `block_writer` example program, which continuously inserts data into your cluster, and watch the replica count quickly increase as ranges split. You'll then add 2 more nodes and watch how CockroachDB automatically rebalances replicas to efficiently use all available capacity.
-
## Before You Begin
diff --git a/v1.1/demo-data-replication.md b/v1.1/demo-data-replication.md
index 14413c6e78a..a52b7d60c19 100644
--- a/v1.1/demo-data-replication.md
+++ b/v1.1/demo-data-replication.md
@@ -1,12 +1,11 @@
---
title: Data Replication
summary: Use a local cluster to explore how CockroachDB replicates and distributes data.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB replicates and distributes data. Starting with a 1-node local cluster, you'll write some data, add 2 nodes, and watch how the data is replicated automatically. You'll then update the cluster to replicate 5 ways, add 2 more nodes, and again watch how all existing replicas are re-replicated to the new nodes.
-
## Before You Begin
diff --git a/v1.1/demo-fault-tolerance-and-recovery.md b/v1.1/demo-fault-tolerance-and-recovery.md
index 1b478804230..1a47ad6d49e 100644
--- a/v1.1/demo-fault-tolerance-and-recovery.md
+++ b/v1.1/demo-fault-tolerance-and-recovery.md
@@ -1,12 +1,11 @@
---
title: Fault Tolerance & Recovery
summary: Use a local cluster to explore how CockroachDB remains available during, and recovers after, failure.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB remains available during, and recovers after, failure. Starting with a 3-node local cluster, you'll remove a node and see how the cluster continues uninterrupted. You'll then write some data while the node is offline, rejoin the node, and see how it catches up with the rest of the cluster. Finally, you'll add a fourth node, remove a node again, and see how missing replicas eventually re-replicate to the new node.
-
## Before You Begin
diff --git a/v1.1/demo-follow-the-workload.md b/v1.1/demo-follow-the-workload.md
index ae01f1df0a7..3b58aa925cd 100644
--- a/v1.1/demo-follow-the-workload.md
+++ b/v1.1/demo-follow-the-workload.md
@@ -1,12 +1,11 @@
---
title: Follow-the-Workload
summary: CockroachDB can dynamically optimize read latency for the location from which most of the workload is originating.
-toc: false
+toc: true
---
"Follow-the-workload" refers to CockroachDB's ability to dynamically optimize read latency for the location from which most of the workload is originating. This page explains how "follow-the-workload" works and walks you through a simple demonstration using a local cluster.
-
## Overview
diff --git a/v1.1/deploy-a-test-cluster.md b/v1.1/deploy-a-test-cluster.md
index b5cecb7511a..1aa68d21d9a 100644
--- a/v1.1/deploy-a-test-cluster.md
+++ b/v1.1/deploy-a-test-cluster.md
@@ -1,14 +1,13 @@
---
title: Deploy a Test Cluster
summary: Use CockroachDB's CloudFormation template to deploy a Kubernetes-orchestrated test cluster on AWS.
-toc: false
+toc: true
---
This page shows you the easiest way to test an insecure, multi-node CockroachDB cluster, using CockroachDB's [AWS CloudFormation](https://aws.amazon.com/cloudformation/) template to simplify setup and [Kubernetes](https://kubernetes.io/) to automate deployment, maintenance, and load balancing of client workloads.
{{site.data.alerts.callout_success}}To evaluate pre-release functionality from our roadmap, use the v2.0 version of this page.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/deploy-cockroachdb-on-aws-insecure.md b/v1.1/deploy-cockroachdb-on-aws-insecure.md
index 14c1ce8fba6..bd2cc8d4569 100644
--- a/v1.1/deploy-cockroachdb-on-aws-insecure.md
+++ b/v1.1/deploy-cockroachdb-on-aws-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on AWS EC2 (Insecure)
summary: Learn how to deploy CockroachDB on Amazon's AWS EC2 platform.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-aws.md b/v1.1/deploy-cockroachdb-on-aws.md
index bc4c5e9b301..83007874352 100644
--- a/v1.1/deploy-cockroachdb-on-aws.md
+++ b/v1.1/deploy-cockroachdb-on-aws.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on AWS EC2
summary: Learn how to deploy CockroachDB on Amazon's AWS EC2 platform.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-digital-ocean-insecure.md b/v1.1/deploy-cockroachdb-on-digital-ocean-insecure.md
index c9f6bd2b093..c3b0e487243 100644
--- a/v1.1/deploy-cockroachdb-on-digital-ocean-insecure.md
+++ b/v1.1/deploy-cockroachdb-on-digital-ocean-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Digital Ocean (Insecure)
summary: Learn how to deploy CockroachDB on Digital Ocean.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-connect-to-your-droplet-with-ssh
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-digital-ocean.md b/v1.1/deploy-cockroachdb-on-digital-ocean.md
index 0ed964a13db..697bb9b7868 100644
--- a/v1.1/deploy-cockroachdb-on-digital-ocean.md
+++ b/v1.1/deploy-cockroachdb-on-digital-ocean.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Digital Ocean
summary: Learn how to deploy CockroachDB on Digital Ocean.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-connect-to-your-droplet-with-ssh
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-google-cloud-platform-insecure.md b/v1.1/deploy-cockroachdb-on-google-cloud-platform-insecure.md
index 9f381bc1c61..4b27e7373e7 100644
--- a/v1.1/deploy-cockroachdb-on-google-cloud-platform-insecure.md
+++ b/v1.1/deploy-cockroachdb-on-google-cloud-platform-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Google Cloud Platform GCE (Insecure)
summary: Learn how to deploy CockroachDB on Google Cloud Platform's Compute Engine.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://cloud.google.com/compute/docs/instances/connecting-to-instance
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-google-cloud-platform.md b/v1.1/deploy-cockroachdb-on-google-cloud-platform.md
index 3bc7da2f339..7deced4c24a 100644
--- a/v1.1/deploy-cockroachdb-on-google-cloud-platform.md
+++ b/v1.1/deploy-cockroachdb-on-google-cloud-platform.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Google Cloud Platform GCE
summary: Learn how to deploy CockroachDB on Google Cloud Platform's Compute Engine.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://cloud.google.com/compute/docs/instances/connecting-to-instance
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-microsoft-azure-insecure.md b/v1.1/deploy-cockroachdb-on-microsoft-azure-insecure.md
index 52d6c27f151..760bfe6f624 100644
--- a/v1.1/deploy-cockroachdb-on-microsoft-azure-insecure.md
+++ b/v1.1/deploy-cockroachdb-on-microsoft-azure-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Microsoft Azure (Insecure)
summary: Learn how to deploy CockroachDB on Microsoft Azure.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-microsoft-azure.md b/v1.1/deploy-cockroachdb-on-microsoft-azure.md
index d070743f833..15a960e297e 100644
--- a/v1.1/deploy-cockroachdb-on-microsoft-azure.md
+++ b/v1.1/deploy-cockroachdb-on-microsoft-azure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Microsoft Azure
summary: Learn how to deploy CockroachDB on Microsoft Azure.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-premises-insecure.md b/v1.1/deploy-cockroachdb-on-premises-insecure.md
index db94a9a4870..2bde9e32f93 100644
--- a/v1.1/deploy-cockroachdb-on-premises-insecure.md
+++ b/v1.1/deploy-cockroachdb-on-premises-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB On-Premises (Insecure)
summary: Learn how to manually deploy an insecure, multi-node CockroachDB cluster on multiple machines.
-toc: false
+toc: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys--2
redirect_from: manual-deployment-insecure.html
---
@@ -15,7 +15,6 @@ This tutorial shows you how to manually deploy an insecure multi-node CockroachD
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v1.1/deploy-cockroachdb-on-premises.md b/v1.1/deploy-cockroachdb-on-premises.md
index 49dfe5953e6..10d9f757a38 100644
--- a/v1.1/deploy-cockroachdb-on-premises.md
+++ b/v1.1/deploy-cockroachdb-on-premises.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB On-Premises
summary: Learn how to manually deploy a secure, multi-node CockroachDB cluster on multiple machines.
-toc: false
+toc: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys--2
---
@@ -14,7 +14,6 @@ This tutorial shows you how to manually deploy a secure multi-node CockroachDB c
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v1.1/diagnostics-reporting.md b/v1.1/diagnostics-reporting.md
index dae56597b0c..031f1ffd3f0 100644
--- a/v1.1/diagnostics-reporting.md
+++ b/v1.1/diagnostics-reporting.md
@@ -1,7 +1,7 @@
---
title: Diagnostics Reporting
summary: Learn about the diagnostic details that get shared with CockroachDB and how to opt out of sharing.
-toc: false
+toc: true
---
By default, the Admin UI and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
@@ -10,7 +10,6 @@ This page explains the details that get shared and how to opt out of sharing.
{{site.data.alerts.callout_success}}For insights into your cluster's performance and health, use the built-in Admin UI or a third-party monitoring tool like Prometheus.{{site.data.alerts.end}}
-
## What Gets Shared
diff --git a/v1.1/drop-column.md b/v1.1/drop-column.md
index 3b882bb64ba..71c6f014a72 100644
--- a/v1.1/drop-column.md
+++ b/v1.1/drop-column.md
@@ -1,12 +1,11 @@
---
title: DROP COLUMN
summary: Use the ALTER COLUMN statement to remove columns from tables.
-toc: false
+toc: true
---
The `DROP COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and removes columns from a table.
-
## Synopsis
diff --git a/v1.1/drop-constraint.md b/v1.1/drop-constraint.md
index 3748820d140..a322366aa99 100644
--- a/v1.1/drop-constraint.md
+++ b/v1.1/drop-constraint.md
@@ -1,14 +1,13 @@
---
title: DROP CONSTRAINT
summary: Use the ALTER CONSTRAINT statement to remove constraints from columns.
-toc: false
+toc: true
---
The `DROP CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and removes Check and Foreign Key constraints from columns.
{{site.data.alerts.callout_info}}For information about removing other constraints, see Constraints: Remove Constraints.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/drop-database.md b/v1.1/drop-database.md
index 594cf56ac8c..cc68dfd7440 100644
--- a/v1.1/drop-database.md
+++ b/v1.1/drop-database.md
@@ -1,12 +1,11 @@
---
title: DROP DATABASE
summary: The DROP DATABASE statement removes a database and all its objects from a CockroachDB cluster.
-toc: false
+toc: true
---
The `DROP DATABASE` [statement](sql-statements.html) removes a database and all its objects from a CockroachDB cluster.
-
## Required Privileges
diff --git a/v1.1/drop-index.md b/v1.1/drop-index.md
index a74def76a13..2f4b6cd6d94 100644
--- a/v1.1/drop-index.md
+++ b/v1.1/drop-index.md
@@ -1,12 +1,11 @@
---
title: DROP INDEX
summary: The DROP INDEX statement removes indexes from tables.
-toc: false
+toc: true
---
The `DROP INDEX` [statement](sql-statements.html) removes indexes from tables.
-
## Synopsis
diff --git a/v1.1/drop-table.md b/v1.1/drop-table.md
index ad021cfa2bc..21002cc5844 100644
--- a/v1.1/drop-table.md
+++ b/v1.1/drop-table.md
@@ -1,12 +1,11 @@
---
title: DROP TABLE
summary: The DROP TABLE statement removes a table and all its indexes from a database.
-toc: false
+toc: true
---
The `DROP TABLE` [statement](sql-statements.html) removes a table and all its indexes from a database.
-
## Required Privileges
diff --git a/v1.1/drop-user.md b/v1.1/drop-user.md
index 4295ab9cfe9..d8eeb94aa50 100644
--- a/v1.1/drop-user.md
+++ b/v1.1/drop-user.md
@@ -1,7 +1,7 @@
---
title: DROP USER
summary: The DROP USER statement removes one or more SQL users.
-toc: false
+toc: true
---
New in v1.1: The `DROP USER` [statement](sql-statements.html) removes one or more SQL users.
@@ -10,7 +10,6 @@ toc: false
{{site.data.alerts.callout_danger}}{% include {{ page.version.version }}/misc/remove-user-callout.html %}{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/drop-view.md b/v1.1/drop-view.md
index 47811050948..e3d4a54637b 100644
--- a/v1.1/drop-view.md
+++ b/v1.1/drop-view.md
@@ -1,12 +1,11 @@
---
title: DROP VIEW
summary: The DROP VIEW statement removes a view from a database.
-toc: false
+toc: true
---
The `DROP VIEW` [statement](sql-statements.html) removes a [view](views.html) from a database.
-
## Required Privileges
diff --git a/v1.1/enterprise-licensing.md b/v1.1/enterprise-licensing.md
index 9a8505f8f0b..7b18870f84b 100644
--- a/v1.1/enterprise-licensing.md
+++ b/v1.1/enterprise-licensing.md
@@ -1,14 +1,13 @@
---
title: Enterprise Licensing
summary: Request and set trial and enterprise license keys for CockroachDB
-toc: false
+toc: true
---
CockroachDB distributes a single binary that contains both core and [enterprise features](https://www.cockroachlabs.com/pricing/). You can use core features without any license key. However, to use the enterprise features, you need either a trial or an enterprise license key.
This page shows you how to obtain and set trial and enterprise license keys for CockroachDB.
-
## Types of Licenses
diff --git a/v1.1/explain.md b/v1.1/explain.md
index e6e3f71e7d8..ac1e388a122 100644
--- a/v1.1/explain.md
+++ b/v1.1/explain.md
@@ -1,12 +1,11 @@
---
title: EXPLAIN
summary: The EXPLAIN statement provides information you can use to optimize SQL queries.
-toc: false
+toc: true
---
The `EXPLAIN` [statement](sql-statements.html) returns CockroachDB's query plan for an [explainable statement](#explainable-statements). You can then use this information to optimize the query.
-
## Explainable Statements
diff --git a/v1.1/float.md b/v1.1/float.md
index 73c499d239b..35c73108988 100644
--- a/v1.1/float.md
+++ b/v1.1/float.md
@@ -1,14 +1,13 @@
---
title: FLOAT
summary: The FLOAT data type stores inexact, floating-point numbers with up to 17 digits in total and at least one digit to the right of the decimal point.
-toc: false
+toc: true
---
CockroachDB supports various inexact, floating-point number [data types](data-types.html) with up to 17 digits of decimal precision.
They are handled internally using the [standard double-precision (64-bit binary-encoded) IEEE754 format](https://en.wikipedia.org/wiki/IEEE_floating_point).
-
## Names and Aliases
diff --git a/v1.1/foreign-key.md b/v1.1/foreign-key.md
index 379d5203b40..f27ee943035 100644
--- a/v1.1/foreign-key.md
+++ b/v1.1/foreign-key.md
@@ -1,7 +1,7 @@
---
title: Foreign Key Constraint
summary: The Foreign Key constraint specifies a column can contain only values exactly matching existing values from the column it references.
-toc: false
+toc: true
---
The Foreign Key [constraint](constraints.html) specifies that all of a column's values must exactly match existing values from the column it references, enforcing referential integrity.
@@ -13,7 +13,6 @@ For example, if you create a foreign key on `orders.customer` that references `c
{{site.data.alerts.callout_success}}If you plan to use Foreign Keys in your schema, consider using interleaved tables, which can dramatically improve query performance.{{site.data.alerts.end}}
-
## Details
diff --git a/v1.1/frequently-asked-questions.md b/v1.1/frequently-asked-questions.md
index 3415eb2fb2c..274ca0f601e 100644
--- a/v1.1/frequently-asked-questions.md
+++ b/v1.1/frequently-asked-questions.md
@@ -2,10 +2,9 @@
title: Frequently Asked Questions
summary: CockroachDB FAQ - What is CockroachDB? How does it work? What makes it different from other databases?
tags: postgres, cassandra, google cloud spanner
-toc: false
+toc: true
---
-
## What is CockroachDB?
diff --git a/v1.1/functions-and-operators.md b/v1.1/functions-and-operators.md
index 0ed37064f8c..4439478f97a 100644
--- a/v1.1/functions-and-operators.md
+++ b/v1.1/functions-and-operators.md
@@ -1,14 +1,13 @@
---
title: Functions and Operators
summary: CockroachDB supports many built-in functions, aggregate functions, and operators.
-toc: false
+toc: true
---
CockroachDB supports the following SQL functions and operators.
{{site.data.alerts.callout_success}}In the built-in SQL shell, use \hf [function] to get inline help about a specific function.{{site.data.alerts.end}}
-
## Built-in Functions
diff --git a/v1.1/generate-cockroachdb-resources.md b/v1.1/generate-cockroachdb-resources.md
index 3686c2fd6f9..03b318076d7 100644
--- a/v1.1/generate-cockroachdb-resources.md
+++ b/v1.1/generate-cockroachdb-resources.md
@@ -1,12 +1,11 @@
---
title: Generate CockroachDB Resources
summary: Use cockroach gen to generate command-line interface utlities, such as man pages, and example data.
-toc: false
+toc: true
---
The `cockroach gen` command can generate command-line interface (CLI) utilities ([`man` pages](https://en.wikipedia.org/wiki/Man_page) and a`bash` autocompletion script), example SQL data suitable to populate test databases, and an HAProxy configuration file for load balancing a running cluster.
-
## Subcommands
diff --git a/v1.1/grant.md b/v1.1/grant.md
index c22d0bf8604..0df2e2d4107 100644
--- a/v1.1/grant.md
+++ b/v1.1/grant.md
@@ -1,14 +1,13 @@
---
title: GRANT
summary: The GRANT statement grants user privileges for interacting with specific databases and tables.
-toc: false
+toc: true
---
The `GRANT` [statement](sql-statements.html) lets you control each [user's](create-and-manage-users.html) SQL [privileges](privileges.html) for interacting with specific databases and tables.
For privileges required by specific statements, see the documentation for the respective [SQL statement](sql-statements.html).
-
## Synopsis
diff --git a/v1.1/import-data.md b/v1.1/import-data.md
index 28530eb9188..518c272fa18 100644
--- a/v1.1/import-data.md
+++ b/v1.1/import-data.md
@@ -1,14 +1,13 @@
---
title: Import Data
summary: Learn how to import data into a CockroachDB cluster.
-toc: false
+toc: true
---
CockroachDB supports importing data from CSV/TSV or SQL dump files.
{{site.data.alerts.callout_info}}To import/restore data from CockroachDB-generated enterprise license backups, see RESTORE.{{site.data.alerts.end}}
-
## Import from Tabular Data (CSV)
diff --git a/v1.1/import.md b/v1.1/import.md
index 5c82bcb4c68..a281d20a98c 100644
--- a/v1.1/import.md
+++ b/v1.1/import.md
@@ -1,7 +1,7 @@
---
title: IMPORT (Experimental)
summary: Import CSV data into your CockroachDB cluster.
-toc: false
+toc: true
---
The `IMPORT` [statement](sql-statements.html) imports tabular data (e.g. CSVs) into a single table.
@@ -10,7 +10,6 @@ The `IMPORT` [statement](sql-statements.html) imports tabular data (e.g. CSVs) i
{{site.data.alerts.callout_info}}For details about importing SQL dumps, see Import Data.{{site.data.alerts.end}}
-
## Glossary
diff --git a/v1.1/indexes.md b/v1.1/indexes.md
old mode 100755
new mode 100644
index 4adac16e98a..102182bbc87
--- a/v1.1/indexes.md
+++ b/v1.1/indexes.md
@@ -1,13 +1,12 @@
---
title: Indexes
summary: Indexes improve your database's performance by helping SQL locate data without having to look through every row of a table.
-toc: false
+toc: true
toc_not_nested: true
---
Indexes improve your database's performance by helping SQL locate data without having to look through every row of a table.
-
## How Do Indexes Work?
diff --git a/v1.1/information-schema.md b/v1.1/information-schema.md
index f8f251b3c32..35c1d1744f9 100644
--- a/v1.1/information-schema.md
+++ b/v1.1/information-schema.md
@@ -1,7 +1,7 @@
---
title: Information Schema
summary: The information_schema database contains read-only views that you can use for introspection into your database's tables, columns, indexes, and views.
-toc: false
+toc: true
---
CockroachDB represents your cluster's schema in a database called `information_schema`, which contains read-only [views](views.html) that you can use for introspection into your database's tables, columns, indexes, and views.
@@ -10,7 +10,6 @@ This notion of an information schema is part of the SQL standard, which means it
{{site.data.alerts.callout_info}}The information_schema views typically represent objects that the current user has privilege to access. To ensure you can view your cluster's entire schema, access it as the root user.{{site.data.alerts.end}}
-
## Objects
diff --git a/v1.1/initialize-a-cluster.md b/v1.1/initialize-a-cluster.md
index 011528b24b4..1c6ee3ea7ef 100644
--- a/v1.1/initialize-a-cluster.md
+++ b/v1.1/initialize-a-cluster.md
@@ -1,14 +1,13 @@
---
title: Initialize a Cluster
summary: Perform a one-time-only initialization of a CockroachDB cluster.
-toc: false
+toc: true
---
New in v1.1: This page explains the `cockroach init` [command](cockroach-commands.html), which you use to perform a one-time initialization of a new multi-node cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials.
{{site.data.alerts.callout_info}}When starting a single-node cluster, you don't need to use the cockroach init command. You can simply run the cockroach start command without the --join flag to start and initialize the single-node cluster.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/insert.md b/v1.1/insert.md
index 9efb60240e5..4d82fd0ba41 100644
--- a/v1.1/insert.md
+++ b/v1.1/insert.md
@@ -1,12 +1,11 @@
---
title: INSERT
summary: The INSERT statement inserts one or more rows into a table.
-toc: false
+toc: true
---
The `INSERT` [statement](sql-statements.html) inserts one or more rows into a table. In cases where inserted values conflict with uniqueness constraints, the `ON CONFLICT` clause can be used to update rather than insert rows.
-
## Performance Best Practices
diff --git a/v1.1/int.md b/v1.1/int.md
index 919868e5cad..bc21c97573d 100644
--- a/v1.1/int.md
+++ b/v1.1/int.md
@@ -1,14 +1,13 @@
---
title: INT
summary: CockroachDB supports various signed integer data types.
-toc: false
+toc: true
---
CockroachDB supports various signed integer [data types](data-types.html).
{{site.data.alerts.callout_info}}To auto-generate globally unique values, use the UUID or SERIAL data type.{{site.data.alerts.end}}
-
## Names and Aliases
diff --git a/v1.1/interleave-in-parent.md b/v1.1/interleave-in-parent.md
index eb262cb14fc..33b64a7a745 100644
--- a/v1.1/interleave-in-parent.md
+++ b/v1.1/interleave-in-parent.md
@@ -1,7 +1,7 @@
---
title: INTERLEAVE IN PARENT
summary: Interleaving tables improves query performance by optimizing the key-value structure of closely related table's data.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ Interleaving tables improves query performance by optimizing the key-value struc
{{site.data.alerts.callout_info}}Interleaving tables does not affect their behavior within SQL.{{site.data.alerts.end}}
-
## How Interleaved Tables Work
diff --git a/v1.1/interval.md b/v1.1/interval.md
index 793c4b5db15..79b31d167ae 100644
--- a/v1.1/interval.md
+++ b/v1.1/interval.md
@@ -1,12 +1,11 @@
---
title: INTERVAL
summary: The INTERVAL data type stores a value that represents a span of time.
-toc: false
+toc: true
---
The `INTERVAL` [data type](data-types.html) stores a value that represents a span of time.
-
## Syntax
diff --git a/v1.1/known-limitations.md b/v1.1/known-limitations.md
index 08b83a28f1c..657ff175e86 100644
--- a/v1.1/known-limitations.md
+++ b/v1.1/known-limitations.md
@@ -1,12 +1,11 @@
---
title: Known Limitations in CockroachDB v1.1
summary: Known limitations in CockroachDB v1.1.
-toc: false
+toc: true
---
This page describes newly identified limitations in the CockroachDB v1.1 release as well as unresolved limitations identified in earlier releases.
-
## New Limitations
diff --git a/v1.1/learn-cockroachdb-sql.md b/v1.1/learn-cockroachdb-sql.md
index 3c05ec0c047..a24967f0639 100644
--- a/v1.1/learn-cockroachdb-sql.md
+++ b/v1.1/learn-cockroachdb-sql.md
@@ -1,14 +1,13 @@
---
title: Learn CockroachDB SQL
summary: Learn some of the most essential CockroachDB SQL statements.
-toc: false
+toc: true
---
This page walks you through some of the most essential CockroachDB SQL statements. For a complete list and related details, see [SQL Statements](sql-statements.html).
{{site.data.alerts.callout_info}}CockroachDB aims to provide standard SQL with extensions, but some standard SQL functionality is not yet available. See our SQL Feature Support page for more details.{{site.data.alerts.end}}
-
## Create a Database
diff --git a/v1.1/manage-long-running-queries.md b/v1.1/manage-long-running-queries.md
index 971aa0f263e..2c3f553882b 100644
--- a/v1.1/manage-long-running-queries.md
+++ b/v1.1/manage-long-running-queries.md
@@ -1,14 +1,13 @@
---
title: Manage Long-Running Queries
summary: Learn how to identify and cancel long-running queries.
-toc: false
+toc: true
---
New in v1.1: This page shows you how to identify and, if necessary, cancel SQL queries that are taking longer than expected to process.
{{site.data.alerts.callout_info}}Schema changes (statements beginning with ALTER) cannot currently be cancelled. However, to monitor the progress of schema changes, you can use SHOW JOBS.{{site.data.alerts.end}}
-
## Identify Long-Running Queries
diff --git a/v1.1/monitor-cockroachdb-with-prometheus.md b/v1.1/monitor-cockroachdb-with-prometheus.md
index 80bd9996fd5..9a62fbe2899 100644
--- a/v1.1/monitor-cockroachdb-with-prometheus.md
+++ b/v1.1/monitor-cockroachdb-with-prometheus.md
@@ -1,14 +1,13 @@
---
title: Monitor CockroachDB with Prometheus
summary: Use Prometheus to monitor CockroachDB.
-toc: false
+toc: true
---
CockroachDB generates detailed time series metrics for each node in a cluster. This page shows you how to pull these metrics into [Prometheus](https://prometheus.io/), an open source tool for storing, aggregating, and querying time series data. It also shows you how to connect [Grafana](https://grafana.com/) and [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) to Prometheus for flexible data visualizations and notifications.
{{site.data.alerts.callout_success}}For details about other monitoring options, see Monitoring and Alerting. {{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/monitoring-and-alerting.md b/v1.1/monitoring-and-alerting.md
index 7f915e028ae..6bba0ba5102 100644
--- a/v1.1/monitoring-and-alerting.md
+++ b/v1.1/monitoring-and-alerting.md
@@ -1,14 +1,13 @@
---
title: Monitoring and Alerting
summary: Monitor the health and performance of a cluster and alert on critical events and metrics.
-toc: false
+toc: true
---
Despite CockroachDB's various [built-in safeguards against failure](high-availability.html), it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention.
This page explains available monitoring tools and critical events and metrics to alert on.
-
## Monitoring Tools
diff --git a/v1.1/multi-active-availability.md b/v1.1/multi-active-availability.md
index d8716ea43ac..4d18cefce2f 100644
--- a/v1.1/multi-active-availability.md
+++ b/v1.1/multi-active-availability.md
@@ -1,12 +1,11 @@
---
title: Multi-Active Availability
summary: Learn about CockroachDB's high availability model, known as Multi-Active Availability.
-toc: false
+toc: true
---
CockroachDB's availability model is described as "Multi-Active Availability." In essence, multi-active availability provides benefits similar to traditional notions of high availability, but also lets you read and write from every node in your cluster without generating any conflicts.
-
## What is High Availability?
diff --git a/v1.1/not-null.md b/v1.1/not-null.md
index c65ce9f276e..9d1c3ce8130 100644
--- a/v1.1/not-null.md
+++ b/v1.1/not-null.md
@@ -1,12 +1,11 @@
---
title: Not Null Constraint
summary: The NOT NULL constraint specifies the column may not contain NULL values.
-toc: false
+toc: true
---
The Not Null [constraint](constraints.html) specifies a column may not contain *NULL* values.
-
## Details
diff --git a/v1.1/null-handling.md b/v1.1/null-handling.md
index 857955ea93a..16e2a814f11 100644
--- a/v1.1/null-handling.md
+++ b/v1.1/null-handling.md
@@ -1,14 +1,13 @@
---
title: NULL Handling
summary: Learn how NULL values are handled in CockroachDB SQL.
-toc: false
+toc: true
---
This page summarizes how `NULL` values are handled in CockroachDB SQL. Each topic is demonstrated via the [built-in SQL client](use-the-built-in-sql-client.html), using the table data in the first section, [NULLs and Logic](#nulls-and-logic).
{{site.data.alerts.callout_info}}When using the built-in client, NULL values are displayed using the word NULL. This distinguishes them from a character field that contains an empty string ("").{{site.data.alerts.end}}
-
## NULLs and Logic
diff --git a/v1.1/operational-faqs.md b/v1.1/operational-faqs.md
index ac26a30a5d9..039cef5a425 100644
--- a/v1.1/operational-faqs.md
+++ b/v1.1/operational-faqs.md
@@ -1,10 +1,9 @@
---
title: Operational FAQs
summary: Get answers to frequently asked questions about operating CockroachDB.
-toc: false
+toc: true
---
-
## Why is my process hanging when I try to start it in the background?
diff --git a/v1.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/v1.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md
index 272c41bba25..27fc7f9d099 100644
--- a/v1.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md
+++ b/v1.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md
@@ -1,7 +1,7 @@
---
title: Automated Operations
summary: Orchestrate the deployment and management of an local cluster using Kubernetes.
-toc: false
+toc: true
---
Other tutorials in this section feature the ways that CockroachDB automates operations for you. On top of this built-in automation, you can use a third-party [orchestration](orchestration.html) system to simplify and automate even more of your operations, from deployment to scaling to overall cluster management.
@@ -10,7 +10,6 @@ This page walks you through a simple demonstration, using the open-source Kubern
{{site.data.alerts.callout_info}}To orchestrate a physically distributed cluster in production, see Orchestrated Deployment.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/orchestrate-cockroachdb-with-docker-swarm-insecure.md b/v1.1/orchestrate-cockroachdb-with-docker-swarm-insecure.md
index ed56f08294c..6812d3d95fb 100644
--- a/v1.1/orchestrate-cockroachdb-with-docker-swarm-insecure.md
+++ b/v1.1/orchestrate-cockroachdb-with-docker-swarm-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Docker Swarm (Insecure)
summary: How to orchestrate the deployment and management of an insecure three-node CockroachDB cluster as a Docker swarm.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ This page shows you how to orchestrate the deployment and management of an insec
If you plan to use CockroachDB in production, we recommend using a secure cluster instead. Select **Secure** above for instructions.
-
## Before You Begin
diff --git a/v1.1/orchestrate-cockroachdb-with-docker-swarm.md b/v1.1/orchestrate-cockroachdb-with-docker-swarm.md
index 2399a3f56ea..f2c7b25b8b9 100644
--- a/v1.1/orchestrate-cockroachdb-with-docker-swarm.md
+++ b/v1.1/orchestrate-cockroachdb-with-docker-swarm.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Docker Swarm
summary: How to orchestrate the deployment and management of a secure three-node CockroachDB cluster as a Docker swarm.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ This page shows you how to orchestrate the deployment and management of a secure
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Before You Begin
diff --git a/v1.1/orchestrate-cockroachdb-with-kubernetes-insecure.md b/v1.1/orchestrate-cockroachdb-with-kubernetes-insecure.md
index 8a58a54e5ab..8f25bd39e45 100644
--- a/v1.1/orchestrate-cockroachdb-with-kubernetes-insecure.md
+++ b/v1.1/orchestrate-cockroachdb-with-kubernetes-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Kubernetes (Insecure)
summary: How to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with Kubernetes.
-toc: false
+toc: true
---
@@ -15,7 +15,6 @@ This page shows you how to orchestrate the deployment and management of an insec
{{site.data.alerts.callout_success}}For details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see CockroachDB Performance on Kubernetes.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/orchestrate-cockroachdb-with-kubernetes.md b/v1.1/orchestrate-cockroachdb-with-kubernetes.md
index 7e2c83d286d..06a5ece10cd 100644
--- a/v1.1/orchestrate-cockroachdb-with-kubernetes.md
+++ b/v1.1/orchestrate-cockroachdb-with-kubernetes.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Kubernetes
summary: How to orchestrate the deployment and management of a secure 3-node CockroachDB cluster with Kubernetes.
-toc: false
+toc: true
secure: true
---
@@ -16,7 +16,6 @@ If you are only testing CockroachDB, or you are not concerned with protecting ne
{{site.data.alerts.callout_success}}For details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see CockroachDB Performance on Kubernetes.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/orchestrate-cockroachdb-with-mesosphere-insecure.md b/v1.1/orchestrate-cockroachdb-with-mesosphere-insecure.md
index e4ec01198e8..90454320e76 100644
--- a/v1.1/orchestrate-cockroachdb-with-mesosphere-insecure.md
+++ b/v1.1/orchestrate-cockroachdb-with-mesosphere-insecure.md
@@ -1,14 +1,13 @@
---
title: Orchestrate CockroachDB with Mesosphere DC/OS (Insecure)
summary: How to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with Mesosphere DC/OS.
-toc: false
+toc: true
---
This page shows you how to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with [Mesosphere DC/OS](https://mesosphere.com/).
{{site.data.alerts.callout_danger}}Deploying an insecure cluster is not recommended for data in production. We'll update this page once it's possible to orchestrate a secure cluster with Mesosphere DC/OS.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/parallel-statement-execution.md b/v1.1/parallel-statement-execution.md
index eb852e54de7..c4e94d1e1b8 100644
--- a/v1.1/parallel-statement-execution.md
+++ b/v1.1/parallel-statement-execution.md
@@ -1,12 +1,11 @@
---
title: Parallel Statement Execution
summary: The parallel statement execution feature allows parallel execution of multiple independent SQL statements within a transaction.
-toc: false
+toc: true
---
CockroachDB supports parallel execution of [independent](parallel-statement-execution.html#when-to-use-parallel-statement-execution) [`INSERT`](insert.html), [`UPDATE`](update.html), [`UPSERT`](upsert.html), and [`DELETE`](delete.html) statements within a single [transaction](transactions.html). Executing statements in parallel helps reduce aggregate latency and improve performance.
-
## Why Use Parallel Statement Execution
diff --git a/v1.1/pause-job.md b/v1.1/pause-job.md
index 0cae8092aad..501e300b858 100644
--- a/v1.1/pause-job.md
+++ b/v1.1/pause-job.md
@@ -1,7 +1,7 @@
---
title: PAUSE JOB
summary: The PAUSE JOB statement lets you temporarily halt the process of potentially long-running jobs, such as schema changes and enterprise backups.
-toc: false
+toc: true
---
New in v1.1: The `PAUSE JOB` [statement](sql-statements.html) lets you pause enterprise [`BACKUP`](backup.html) and [`RESTORE`](restore.html) jobs.
@@ -10,7 +10,6 @@ After pausing jobs, you can resume them with [`RESUME JOB`](resume-job.html).
{{site.data.alerts.callout_info}}As of v1.1, you cannot pause schema changes or enterprise
To upgrade within the v1.0.x series, see the v1.0 version of this page. {{site.data.alerts.end}} - ## Step 1. Prepare to upgrade diff --git a/v1.1/upsert.md b/v1.1/upsert.md index de256d3db71..8d4f4cf84fd 100644 --- a/v1.1/upsert.md +++ b/v1.1/upsert.md @@ -1,12 +1,11 @@ --- title: UPSERT summary: The UPSERT statement inserts rows when values do not violate uniqueness constraints, and it updates rows when values do violate uniqueness constraints. -toc: false +toc: true --- The `UPSERT` [statement](sql-statements.html) is short-hand for [`INSERT ON CONFLICT`](insert.html). It inserts rows in cases where specified values do not violate uniqueness constraints, and it updates rows in cases where values do violate uniqueness constraints. - ## Considerations diff --git a/v1.1/use-the-built-in-sql-client.md b/v1.1/use-the-built-in-sql-client.md index 172259d817e..b60a6d73866 100644 --- a/v1.1/use-the-built-in-sql-client.md +++ b/v1.1/use-the-built-in-sql-client.md @@ -1,14 +1,13 @@ --- title: Use the Built-in SQL Client summary: CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line. -toc: false +toc: true --- CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line. To use this client, run the `cockroach sql` [command](cockroach-commands.html) as described below. To exit the interactive shell, use `\q` or `ctrl-d`. - ## Synopsis diff --git a/v1.1/uuid.md b/v1.1/uuid.md index ae2ac105a4c..673a6a38e1c 100644 --- a/v1.1/uuid.md +++ b/v1.1/uuid.md @@ -1,14 +1,13 @@ --- title: UUID summary: The UUID data type stores 128-bit Universal Unique Identifiers. -toc: false +toc: true --- New in v1.1: The `UUID` (Universally Unique Identifier) [data type](data-types.html) stores a 128-bit value that is [unique across both space and time](https://www.ietf.org/rfc/rfc4122.txt). {{site.data.alerts.callout_success}}To auto-generate unique row IDs, we recommend using
When querying a table, CockroachDB uses the fastest index. For more information about that process, see Index Selection in CockroachDB.{{site.data.alerts.end}} - ## Required Privileges diff --git a/v2.0/create-role.md b/v2.0/create-role.md index 9cf9b75d400..8c09a0ba148 100644 --- a/v2.0/create-role.md +++ b/v2.0/create-role.md @@ -1,14 +1,13 @@ --- title: CREATE ROLE (Enterprise) summary: The CREATE ROLE statement creates SQL roles, which are groups containing any number of roles and users as members. -toc: false +toc: true --- New in v2.0: The `CREATE ROLE` [statement](sql-statements.html) creates SQL [roles](roles.html), which are groups containing any number of roles and users as members. You can assign privileges to roles, and all members of the role (regardless of whether if they are direct or indirect members) will inherit the role's privileges. {{site.data.alerts.callout_info}}
IMPORT jobs.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/performance-best-practices-overview.md b/v1.1/performance-best-practices-overview.md
index adf8d001a27..36de50b5176 100644
--- a/v1.1/performance-best-practices-overview.md
+++ b/v1.1/performance-best-practices-overview.md
@@ -1,12 +1,11 @@
---
title: SQL Performance Best Practices
summary: Best practices for optimizing SQL performance in CockroachDB.
-toc: false
+toc: true
---
This page provides best practices for optimizing SQL performance in CockroachDB.
-
## Multi-Row DML Best Practices
diff --git a/v1.1/porting-postgres.md b/v1.1/porting-postgres.md
index 2455861cdf6..e40c1de502a 100644
--- a/v1.1/porting-postgres.md
+++ b/v1.1/porting-postgres.md
@@ -1,7 +1,7 @@
---
title: Porting from PostgreSQL
summary: Porting an application from PostgreSQL
-toc: false
+toc: true
---
Although CockroachDB supports PostgreSQL syntax and drivers, it does not offer exact compatibility. This page documents the known list of differences between PostgreSQL and CockroachDB for identical input. That is, a SQL statement of the type listed here will behave differently than in PostgreSQL. Porting an existing application to CockroachDB will require changing these expressions.
@@ -10,7 +10,6 @@ Note that some of these differences only apply to rare inputs, and so no change
{{site.data.alerts.callout_info}}This document currently only covers how to rewrite SQL expressions. It does not discuss strategies for porting applications that use SQL features CockroachDB does not currently support, such as the ENUM type.{{site.data.alerts.end}}
-
### Overflow of `float`
diff --git a/v1.1/primary-key.md b/v1.1/primary-key.md
index bfa836fe515..1ea86152be2 100644
--- a/v1.1/primary-key.md
+++ b/v1.1/primary-key.md
@@ -1,7 +1,7 @@
---
title: Primary Key Constraint
summary: The Primary Key constraint specifies that the columns can be used to uniquely identify rows in a table.
-toc: false
+toc: true
---
The Primary Key [constraint](constraints.html) specifies that the constrained columns' values must uniquely identify each row.
@@ -10,7 +10,6 @@ Unlike other constraints which have very specific uses, the Primary Key constrai
{{site.data.alerts.callout_info}}A table's primary key can only be specified in the CREATE TABLE statement. It can't be changed later using ALTER TABLE, though it is possible to go through a process to create a new table with the new primary key you want and then migrate the data.{{site.data.alerts.end}}
-
## Details
diff --git a/v1.1/privileges.md b/v1.1/privileges.md
index 85fa4ed20bd..555e85d75f0 100644
--- a/v1.1/privileges.md
+++ b/v1.1/privileges.md
@@ -1,7 +1,7 @@
---
title: Privileges
summary: Privileges are granted to users at the database and table levels. They are not yet supported for other granularities such as columns or rows.
-toc: false
+toc: true
---
In CockroachDB, privileges are granted to [users](create-and-manage-users.html) at the database and table levels. They are not yet supported for other granularities such as columns or rows.
@@ -10,7 +10,6 @@ When a user connects to a database, either via the [built-in SQL client](use-the
For the privileges required by specific statements, see the documentation for the respective [SQL statement](sql-statements.html).
-
## Supported Privileges
diff --git a/v1.1/query-behavior-troubleshooting.md b/v1.1/query-behavior-troubleshooting.md
index abe84f717c2..e84d636846f 100644
--- a/v1.1/query-behavior-troubleshooting.md
+++ b/v1.1/query-behavior-troubleshooting.md
@@ -1,12 +1,11 @@
---
title: Troubleshoot Query Behavior
summary: Learn how to troubleshoot issues with specific queries with CockroachDB
-toc: false
+toc: true
---
If a query returns an unexpected result or takes longer than expected to process, this page will help you troubleshoot the issue.
-
## Correctness Issues
diff --git a/v1.1/recommended-production-settings.md b/v1.1/recommended-production-settings.md
index 7e8890bf0f4..e96e6a9e0c9 100644
--- a/v1.1/recommended-production-settings.md
+++ b/v1.1/recommended-production-settings.md
@@ -1,13 +1,12 @@
---
title: Production Checklist
summary: Recommended settings for production deployments.
-toc: false
+toc: true
---
This page provides important recommendations for production deployments of CockroachDB.
-
## Cluster Topology
diff --git a/v1.1/release-savepoint.md b/v1.1/release-savepoint.md
index 95e59846e47..5ceb8d388d4 100644
--- a/v1.1/release-savepoint.md
+++ b/v1.1/release-savepoint.md
@@ -1,7 +1,7 @@
---
title: RELEASE SAVEPOINT cockroach_restart
summary: Commit a transaction's changes once there are no retryable errors with the RELEASE SAVEPOINT cockroach_restart statement in CockroachDB.
-toc: false
+toc: true
---
When using [client-side transaction retries](transactions.html#client-side-transaction-retries), the `RELEASE SAVEPOINT cockroach_restart` statement commits the transaction.
@@ -12,7 +12,6 @@ Despite committing the transaction, you must still issue a [`COMMIT`](commit-tra
{{site.data.alerts.callout_danger}}CockroachDB’s SAVEPOINT implementation only supports the cockroach_restart savepoint and does not support all savepoint functionality, such as nested transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/remove-nodes.md b/v1.1/remove-nodes.md
index ebfa8534889..6852c7b94ce 100644
--- a/v1.1/remove-nodes.md
+++ b/v1.1/remove-nodes.md
@@ -1,7 +1,7 @@
---
title: Decommission Nodes
summary: Permanently remove one or more nodes from a cluster.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ toc_not_nested: true
For information about temporarily stopping a node, see [Stop a Node](stop-a-node.html).
-
## Overview
diff --git a/v1.1/rename-column.md b/v1.1/rename-column.md
index 26e48a2680d..3ad1136eccf 100644
--- a/v1.1/rename-column.md
+++ b/v1.1/rename-column.md
@@ -1,14 +1,13 @@
---
title: RENAME COLUMN
summary: The RENAME COLUMN statement changes the name of a column in a table.
-toc: false
+toc: true
---
The `RENAME COLUMN` [statement](sql-statements.html) changes the name of a column in a table.
{{site.data.alerts.callout_info}}It is not possible to rename a column referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/rename-database.md b/v1.1/rename-database.md
index 65bb1009913..5b727274e0f 100644
--- a/v1.1/rename-database.md
+++ b/v1.1/rename-database.md
@@ -1,14 +1,13 @@
---
title: RENAME DATABASE
summary: The RENAME DATABASE statement changes the name of a database.
-toc: false
+toc: true
---
The `RENAME DATABASE` [statement](sql-statements.html) changes the name of a database.
{{site.data.alerts.callout_info}}It is not possible to rename a database referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/rename-index.md b/v1.1/rename-index.md
index b0e3898c82d..395f138ff28 100644
--- a/v1.1/rename-index.md
+++ b/v1.1/rename-index.md
@@ -1,14 +1,13 @@
---
title: RENAME INDEX
summary: The RENAME INDEX statement changes the name of an index for a table.
-toc: false
+toc: true
---
The `RENAME INDEX` [statement](sql-statements.html) changes the name of an index for a table.
{{site.data.alerts.callout_info}}It is not possible to rename an index referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/rename-table.md b/v1.1/rename-table.md
index 68e2830be42..d833b45193f 100644
--- a/v1.1/rename-table.md
+++ b/v1.1/rename-table.md
@@ -1,14 +1,13 @@
---
title: RENAME TABLE
summary: The RENAME TABLE statement changes the name of a table.
-toc: false
+toc: true
---
The `RENAME TABLE` [statement](sql-statements.html) changes the name of a table. It can also be used to move a table from one database to another.
{{site.data.alerts.callout_info}}It is not possible to rename a table referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/reset-cluster-setting.md b/v1.1/reset-cluster-setting.md
index 427a38621b7..ef17fb50af8 100644
--- a/v1.1/reset-cluster-setting.md
+++ b/v1.1/reset-cluster-setting.md
@@ -1,12 +1,11 @@
---
title: RESET CLUSTER SETTING
summary: The RESET CLUSTER SETTING statement resets a cluster setting to its default value for the client session.
-toc: false
+toc: true
---
The `RESET` [statement](sql-statements.html) resets a [cluster setting](set-cluster-setting.html) to its default value for the client session..
-
## Required Privileges
diff --git a/v1.1/reset-vars.md b/v1.1/reset-vars.md
index f10cf471a4a..8524108d2ea 100644
--- a/v1.1/reset-vars.md
+++ b/v1.1/reset-vars.md
@@ -1,12 +1,11 @@
---
title: RESET (session variable)
summary: The SET statement resets a session variable to its default value.
-toc: false
+toc: true
---
The `RESET` [statement](sql-statements.html) resets a [session variable](set-vars.html) to its default value for the client session.
-
## Required Privileges
diff --git a/v1.1/restore.md b/v1.1/restore.md
index 98bc21b4743..f41b1a6882a 100644
--- a/v1.1/restore.md
+++ b/v1.1/restore.md
@@ -1,7 +1,7 @@
---
title: RESTORE
summary: Restore your CockroachDB cluster to a cloud storage services such as AWS S3, Google Cloud Storage, or other NFS.
-toc: false
+toc: true
---
{{site.data.alerts.callout_danger}}The RESTORE feature is only available to enterprise users. For non-enterprise restores, see Restore Data.{{site.data.alerts.end}}
@@ -10,7 +10,6 @@ The `RESTORE` [statement](sql-statements.html) restores your cluster's schemas a
Because CockroachDB is designed with high fault tolerance, restores are designed primarily for disaster recovery, i.e., restarting your cluster if it loses a majority of its nodes. Isolated issues (such as small-scale node outages) do not require any intervention.
-
## Functional Details
diff --git a/v1.1/resume-job.md b/v1.1/resume-job.md
index 0f062235ccc..c94b09e55fe 100644
--- a/v1.1/resume-job.md
+++ b/v1.1/resume-job.md
@@ -1,14 +1,13 @@
---
title: RESUME JOB
summary: The RESUME JOB statement lets you resume jobs that were previously paused with PAUSE JOB.
-toc: false
+toc: true
---
The `PAUSE JOB` [statement](sql-statements.html) lets you resume [paused jobs](pause-job.html), which can be either enterprise `BACKUP` or `RESTORE` jobs.
{{site.data.alerts.callout_info}}As of v1.1, you cannot pause schema changes or IMPORT jobs.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/revoke.md b/v1.1/revoke.md
index a9f9c8e461b..8f5c7478b76 100644
--- a/v1.1/revoke.md
+++ b/v1.1/revoke.md
@@ -1,14 +1,13 @@
---
title: REVOKE
summary: The REVOKE statement revokes privileges from users.
-toc: false
+toc: true
---
The `REVOKE` [statement](sql-statements.html) revokes [privileges](privileges.html) from users.
For the list of privileges that can be granted to and revoked from users, see [`GRANT`](grant.html).
-
## Synopsis
diff --git a/v1.1/rollback-transaction.md b/v1.1/rollback-transaction.md
index 77a690e3022..c604ad6ec84 100644
--- a/v1.1/rollback-transaction.md
+++ b/v1.1/rollback-transaction.md
@@ -1,14 +1,13 @@
---
title: ROLLBACK
summary: Abort the current transaction, discarding all updates made by statements included in the transaction with the ROLLBACK statement in CockroachDB.
-toc: false
+toc: true
---
The `ROLLBACK` [statement](sql-statements.html) aborts the current [transaction](transactions.html), discarding all updates made by statements included in the transaction.
When using [client-side transaction retries](transactions.html#client-side-transaction-retries), use `ROLLBACK TO SAVEPOINT cockroach_restart` to handle a transaction that needs to be retried (identified via the `40001` error code or `retry transaction` string in the error message), and then re-execute the statements you want the transaction to contain.
-
## Synopsis
diff --git a/v1.1/rotate-certificates.md b/v1.1/rotate-certificates.md
index d59010b45b1..4adaff27816 100644
--- a/v1.1/rotate-certificates.md
+++ b/v1.1/rotate-certificates.md
@@ -1,7 +1,7 @@
---
title: Rotate Security Certificates
summary: Rotate the security certificates of a secure CockroachDB cluster by creating and reloading new certificates.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ toc_not_nested: true
{{site.data.alerts.callout_success}}For an introduction to how security certificates work in a secure CockroachDB cluster, see Create Security Certificates.{{site.data.alerts.end}}
-
## When to Rotate Certificates
diff --git a/v1.1/savepoint.md b/v1.1/savepoint.md
index 5b054ed8dcb..fb50dac988d 100644
--- a/v1.1/savepoint.md
+++ b/v1.1/savepoint.md
@@ -1,14 +1,13 @@
---
title: SAVEPOINT
summary: Identify your intent to retry aborted transactions with the SAVEPOINT cockroach_restart statement in CockroachDB.
-toc: false
+toc: true
---
The `SAVEPOINT cockroach_restart` statement defines the intent to retry [transactions](transactions.html) using the CockroachDB-provided function for client-side transaction retries. For more information, see [Transaction Retries](transactions.html#transaction-retries).
{{site.data.alerts.callout_danger}}CockroachDB’s SAVEPOINT implementation only supports the cockroach_restart savepoint and does not support all savepoint functionality, such as nested transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/secure-a-cluster.md b/v1.1/secure-a-cluster.md
index 74dd3201e5d..1561180040f 100644
--- a/v1.1/secure-a-cluster.md
+++ b/v1.1/secure-a-cluster.md
@@ -1,7 +1,7 @@
---
title: Start a Local Cluster (Secure)
summary: Run a secure multi-node CockroachDB cluster locally, using TLS certificates to encrypt network communication.
-toc: false
+toc: true
asciicast: true
---
@@ -14,7 +14,6 @@ Once you’ve [installed CockroachDB](install-cockroachdb.html), it’s simple t
{{site.data.alerts.callout_info}}Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see Manual Deployment or Orchestrated Deployment.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/select.md b/v1.1/select.md
index b5306377de9..1f2fca1c87c 100644
--- a/v1.1/select.md
+++ b/v1.1/select.md
@@ -1,12 +1,11 @@
---
title: SELECT
summary: The SELECT statement retrieves data from a table.
-toc: false
+toc: true
---
The `SELECT` [statement](sql-statements.html) retrieves data from a table. The `SELECT` statement is also a [selection clause](selection-clauses.html).
-
## Synopsis
diff --git a/v1.1/selection-clauses.md b/v1.1/selection-clauses.md
index 316e7c51566..742e0b268bd 100644
--- a/v1.1/selection-clauses.md
+++ b/v1.1/selection-clauses.md
@@ -1,13 +1,12 @@
---
title: SELECT Clauses
summary: SELECT clauses define tabular data.
-toc: false
+toc: true
toc_not_nested: true
---
`SELECT` clauses define tabular data. They can be used either as standalone statements, of which [`SELECT`](select.html) is the most common, or as [subqueries in table expressions](table-expressions.html#subqueries-as-table-expressions).
-
## Overview
diff --git a/v1.1/serial.md b/v1.1/serial.md
index e7dc35fef5d..993750167f2 100644
--- a/v1.1/serial.md
+++ b/v1.1/serial.md
@@ -1,14 +1,13 @@
---
title: SERIAL
summary: The SERIAL data type defaults to a unique 64-bit signed integer that is the combination of the insert timestamp and the ID of the node.
-toc: false
+toc: true
---
The `SERIAL` [data type](data-types.html) is a column data type that, on insert, generates a default integer from the timestamp and ID of the node executing the insert. This combination is likely to be globally unique except in extreme cases (see this [example](create-table.html#create-a-table-with-auto-generated-unique-row-ids) for more details). Also, because value generation does not require talking to other nodes, it is much faster than sequentially auto-incrementing a value, which requires distributed coordination.
{{site.data.alerts.callout_info}}In most cases, we recommend using the UUID data type with the gen_random_uuid() function as the default value, which generates 128-bit values (much larger than SERIAL's 64-bit) and scatters them across all of a table's underlying key-value ranges, ensuring that multiple nodes share in the load. See Create a table with auto-generated unique row IDs for more details.{{site.data.alerts.end}}
-
## Aliases
diff --git a/v1.1/set-cluster-setting.md b/v1.1/set-cluster-setting.md
index e30ce88e7b3..74e4327e35f 100644
--- a/v1.1/set-cluster-setting.md
+++ b/v1.1/set-cluster-setting.md
@@ -1,14 +1,13 @@
---
title: SET CLUSTER SETTING
summary: The SET CLUSTER SETTING statement configures one cluster setting.
-toc: false
+toc: true
---
The `SET CLUSTER SETTING` [statement](sql-statements.html) modifies a [cluster-wide setting](cluster-settings.html).
{{site.data.alerts.callout_danger}}Many cluster settings are intended for tuning CockroachDB internals. Before changing these settings, we strongly encourage you to discuss your goals with CockroachDB; otherwise, you use them at your own risk.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/set-transaction.md b/v1.1/set-transaction.md
index 212a262c765..ce6dc204994 100644
--- a/v1.1/set-transaction.md
+++ b/v1.1/set-transaction.md
@@ -1,14 +1,13 @@
---
title: SET TRANSACTION
summary: The SET TRANSACTION statement sets the transaction isolation level and/or priority for the current session or for an individual transaction.
-toc: false
+toc: true
---
The `SET TRANSACTION` [statement](sql-statements.html) sets the transaction isolation level or priority after you [`BEGIN`](begin-transaction.html) it but before executing the first statement that manipulates a database.
{{site.data.alerts.callout_info}}You can also set the session's default isolation level.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/set-vars.md b/v1.1/set-vars.md
index 4d99cda30ef..1470db505e5 100644
--- a/v1.1/set-vars.md
+++ b/v1.1/set-vars.md
@@ -1,7 +1,7 @@
---
title: SET (session variable)
summary: The SET statement modifies the current configuration variables for the client session.
-toc: false
+toc: true
redirect_from:
- set-application-name.html
- set-database.html
@@ -12,7 +12,6 @@ The `SET` [statement](sql-statements.html) can modify one of the session configu
{{site.data.alerts.callout_danger}}In some cases, client drivers can drop and restart the connection to the server. When this happens, any session configurations made with SET statements are lost. It is therefore more reliable to configure the session in the client's connection string. For examples in different languages, see the Build an App with CockroachDB tutorials.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/show-backup.md b/v1.1/show-backup.md
index 1daaeba713d..0c49560a659 100644
--- a/v1.1/show-backup.md
+++ b/v1.1/show-backup.md
@@ -1,12 +1,11 @@
---
title: SHOW BACKUP
summary: The SHOW BACKUP statement lists the contents of a backup.
-toc: false
+toc: true
---
New in v1.1: The `SHOW BACKUP` [statement](sql-statements.html) lists the contents of an enterprise backup created with the [`BACKUP`](backup.html) statement.
-
## Required Privileges
diff --git a/v1.1/show-cluster-setting.md b/v1.1/show-cluster-setting.md
index 94f6e68cdb3..6c846821f50 100644
--- a/v1.1/show-cluster-setting.md
+++ b/v1.1/show-cluster-setting.md
@@ -1,7 +1,7 @@
---
title: SHOW CLUSTER SETTING
summary: The SHOW CLUSTER SETTING statement displays the current cluster settings.
-toc: false
+toc: true
---
The `SHOW CLUSTER SETTING` [statement](sql-statements.html) can
@@ -9,7 +9,6 @@ display the value of either one or all of the
[cluster settings](cluster-settings.html). These can also be configured
via [`SET CLUSTER SETTING`](set-cluster-setting.html).
-
## Required Privileges
diff --git a/v1.1/show-columns.md b/v1.1/show-columns.md
index 35eee928bb9..ec142909238 100644
--- a/v1.1/show-columns.md
+++ b/v1.1/show-columns.md
@@ -1,12 +1,11 @@
---
title: SHOW COLUMNS
summary: The SHOW COLUMNS statement shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
-toc: false
+toc: true
---
The `SHOW COLUMNS` [statement](sql-statements.html) shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
-
## Required Privileges
diff --git a/v1.1/show-constraints.md b/v1.1/show-constraints.md
index 409694637ae..40e1912bb0a 100644
--- a/v1.1/show-constraints.md
+++ b/v1.1/show-constraints.md
@@ -1,14 +1,13 @@
---
title: SHOW CONSTRAINTS
summary: The SHOW CONSTRAINTS statement lists the constraints on a table.
-toc: false
+toc: true
---
The `SHOW CONSTRAINTS` [statement](sql-statements.html) lists all named [constraints](constraints.html) as well as any unnamed Check constraints on a table.
{{site.data.alerts.callout_danger}}The SHOW CONSTRAINTS statement is under development; the exact output will continue to change.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/show-create-table.md b/v1.1/show-create-table.md
index 9aa38d99368..f3ef906ec1d 100644
--- a/v1.1/show-create-table.md
+++ b/v1.1/show-create-table.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE TABLE
summary: The SHOW CREATE TABLE statement shows the CREATE TABLE statement that would create a carbon copy of the specified table.
-toc: false
+toc: true
---
The `SHOW CREATE TABLE` [statement](sql-statements.html) shows the `CREATE TABLE` statement that would create a carbon copy of the specified table.
-
## Required Privileges
diff --git a/v1.1/show-create-view.md b/v1.1/show-create-view.md
index 05646e189ff..0d233b11667 100644
--- a/v1.1/show-create-view.md
+++ b/v1.1/show-create-view.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE VIEW
summary: The SHOW CREATE VIEW statement shows the CREATE VIEW statement that would create a carbon copy of the specified view.
-toc: false
+toc: true
---
The `SHOW CREATE VIEW` [statement](sql-statements.html) shows the `CREATE VIEW` statement that would create a carbon copy of the specified [view](views.html).
-
## Required Privileges
diff --git a/v1.1/show-databases.md b/v1.1/show-databases.md
index 671d7725b49..0d0b73edff3 100644
--- a/v1.1/show-databases.md
+++ b/v1.1/show-databases.md
@@ -2,12 +2,11 @@
title: SHOW DATABASES
summary: The SHOW DATABASES statement lists all database in the CockroachDB cluster.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW DATABASES` [statement](sql-statements.html) lists all database in the CockroachDB cluster.
-
## Synopsis
diff --git a/v1.1/show-grants.md b/v1.1/show-grants.md
index 30dba32b520..9712944bc1c 100644
--- a/v1.1/show-grants.md
+++ b/v1.1/show-grants.md
@@ -2,12 +2,11 @@
title: SHOW GRANTS
summary: The SHOW GRANTS statement lists the privileges granted to users.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW GRANTS` [statement](sql-statements.html) lists the [privileges](privileges.html) granted to users.
-
## Synopsis
diff --git a/v1.1/show-index.md b/v1.1/show-index.md
index 63870e6d18f..a1078513c72 100644
--- a/v1.1/show-index.md
+++ b/v1.1/show-index.md
@@ -1,12 +1,11 @@
---
title: SHOW INDEX
summary: The SHOW INDEX statement returns index information for a table.
-toc: false
+toc: true
---
The `SHOW INDEX` [statement](sql-statements.html) returns index information for a table.
-
## Required Privileges
diff --git a/v1.1/show-jobs.md b/v1.1/show-jobs.md
index 806995044d2..ada13d97fbe 100644
--- a/v1.1/show-jobs.md
+++ b/v1.1/show-jobs.md
@@ -1,7 +1,7 @@
---
title: SHOW JOBS
summary: The SHOW JOBS statement lists all currently active schema changes and backup/restore jobs.
-toc: false
+toc: true
---
New in v1.1: The `SHOW JOBS` [statement](sql-statements.html) lists all of the types of long-running tasks your cluster has performed, including:
@@ -11,7 +11,6 @@ toc: false
These details can help you understand the status of crucial tasks that can impact the performance of your cluster, as well as help you control them.
-
## Required Privileges
diff --git a/v1.1/show-queries.md b/v1.1/show-queries.md
index 0f4fda3447d..d1f3ad5a030 100644
--- a/v1.1/show-queries.md
+++ b/v1.1/show-queries.md
@@ -1,7 +1,7 @@
---
title: SHOW QUERIES
summary: The SHOW QUERIES statement lists all currently active queries across the cluster or on the local node.
-toc: false
+toc: true
---
New in v1.1: The `SHOW QUERIES` [statement](sql-statements.html) lists details about currently active SQL queries, including:
@@ -16,7 +16,6 @@ These details let you monitor the progress of active queries and, if necessary,
{{site.data.alerts.callout_info}}Schema changes and BACKUP/RESTORE statements are not executed as queries internally and so are not listed by SHOW QUERIES. To monitor such statements, use SHOW JOBS instead.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v1.1/show-sessions.md b/v1.1/show-sessions.md
index b61344659fe..de679a95656 100644
--- a/v1.1/show-sessions.md
+++ b/v1.1/show-sessions.md
@@ -1,7 +1,7 @@
---
title: SHOW SESSIONS
summary: The SHOW SESSIONS statement lists all currently active sessions across the cluster or on the local node.
-toc: false
+toc: true
---
New in v1.1: The `SHOW SESSIONS` [statement](sql-statements.html) lists details about currently active sessions, including:
@@ -14,7 +14,6 @@ toc: false
These details let you monitor the overall state of client connections and identify those that may need further investigation or adjustment.
-
## Required Privileges
diff --git a/v1.1/show-tables.md b/v1.1/show-tables.md
index e99a0ecd30d..7757a675f03 100644
--- a/v1.1/show-tables.md
+++ b/v1.1/show-tables.md
@@ -2,14 +2,13 @@
title: SHOW TABLES
summary: The SHOW TABLES statement lists the tables in a database.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW TABLES` [statement](sql-statements.html) lists the tables in a database. Tables can be standard tables as well as virtual tables representing [views](views.html).
{{site.data.alerts.callout_info}}While a table is being dropped, SHOW TABLES will list the table with a (dropped) suffix.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/show-trace.md b/v1.1/show-trace.md
index 48c293b060e..48da0fbbb3a 100644
--- a/v1.1/show-trace.md
+++ b/v1.1/show-trace.md
@@ -1,14 +1,13 @@
---
title: SHOW TRACE
summary: The SHOW TRACE statement...
-toc: false
+toc: true
---
New in v1.1: The `SHOW TRACE` [statement](sql-statements.html) returns details about how CockroachDB executed a statement or series of statements. These details include messages and timing information from all nodes involved in the execution, providing visibility into the actions taken by CockroachDB across all of its software layers.
You can use `SHOW TRACE` to debug why a query is not performing as expected, to add more information to bug reports, or to generally learn more about how CockroachDB works.
-
## Usage Overview
diff --git a/v1.1/show-users.md b/v1.1/show-users.md
index 9f526ad4d58..c6b3cc40db1 100644
--- a/v1.1/show-users.md
+++ b/v1.1/show-users.md
@@ -1,12 +1,11 @@
---
title: SHOW USERS
summary: The SHOW USERS statement lists the users for all databases.
-toc: false
+toc: true
---
The `SHOW USERS` [statement](sql-statements.html) lists the users for all databases.
-
## Synopsis
diff --git a/v1.1/show-vars.md b/v1.1/show-vars.md
index f5b7079518f..a9b41219e7f 100644
--- a/v1.1/show-vars.md
+++ b/v1.1/show-vars.md
@@ -1,7 +1,7 @@
---
title: SHOW (session settings)
summary: The SHOW statement displays the current settings for the client session.
-toc: false
+toc: true
redirect_from:
- show-all.html
- show-transaction.html
@@ -11,7 +11,6 @@ redirect_from:
The `SHOW` [statement](sql-statements.html) can display the value of either one or all of
the session setting variables. Some of these can also be configured via [`SET`](set-vars.html).
-
## Required Privileges
diff --git a/v1.1/sql-constants.md b/v1.1/sql-constants.md
index fce35cf0c56..9561c904ca0 100644
--- a/v1.1/sql-constants.md
+++ b/v1.1/sql-constants.md
@@ -1,12 +1,11 @@
---
title: Constant Values
summary: SQL Constants represent a simple value that doesn't change.
-toc: false
+toc: true
---
SQL Constants represent a simple value that doesn't change.
-
## Introduction
diff --git a/v1.1/sql-dump.md b/v1.1/sql-dump.md
index 1d5b529c952..8b91e3c7f3c 100644
--- a/v1.1/sql-dump.md
+++ b/v1.1/sql-dump.md
@@ -1,14 +1,13 @@
---
title: SQL Dump (Export)
summary: Learn how to dump schemas and data from a CockroachDB cluster.
-toc: false
+toc: true
---
The `cockroach dump` [command](cockroach-commands.html) outputs the SQL statements required to recreate tables and views. This command can be used to back up or export each database in a cluster. The output should also be suitable for importing into other relational databases, with minimal adjustments.
{{site.data.alerts.callout_success}}CockroachDB enterprise license users can also back up their cluster's data using BACKUP.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v1.1/sql-expressions.md b/v1.1/sql-expressions.md
index dfa970dbd46..3b884269901 100644
--- a/v1.1/sql-expressions.md
+++ b/v1.1/sql-expressions.md
@@ -1,7 +1,7 @@
---
title: Value Expressions
summary: Value expressions allow the computation of new values from basic parts.
-toc: false
+toc: true
---
Most SQL statements can contain *value expressions* that compute new
@@ -16,7 +16,6 @@ structured as a table.
The following sections provide details on each of these options.
-
## Constants
diff --git a/v1.1/sql-faqs.md b/v1.1/sql-faqs.md
index aa33c43e643..0f8a4f1b4b2 100644
--- a/v1.1/sql-faqs.md
+++ b/v1.1/sql-faqs.md
@@ -1,10 +1,9 @@
---
title: SQL FAQs
summary: Get answers to frequently asked questions about CockroachDB SQL.
-toc: false
+toc: true
---
-
## How do I bulk insert data into CockroachDB?
diff --git a/v1.1/sql-feature-support.md b/v1.1/sql-feature-support.md
index 91b25270ee1..1753ffa9024 100644
--- a/v1.1/sql-feature-support.md
+++ b/v1.1/sql-feature-support.md
@@ -3,7 +3,6 @@ title: SQL Feature Support in CockroachDB v1.1
summary: Find CockroachDB's conformance to the SQL standard and which common extensions it supports.
---
-
## Overview
diff --git a/v1.1/sql-name-resolution.md b/v1.1/sql-name-resolution.md
index 886c60c2e2d..7d0c578fe93 100644
--- a/v1.1/sql-name-resolution.md
+++ b/v1.1/sql-name-resolution.md
@@ -1,7 +1,7 @@
---
title: Name Resolution
summary: Table and function names can exist in multiple places. Resolution decides which one to use.
-toc: false
+toc: true
---
A SQL client can have access to multiple databases side-by-side. The
@@ -13,7 +13,6 @@ which `orders` table is being considered?
This page details how CockroachDB performs **name resolution** to answer
this question.
-
## Overview
diff --git a/v1.1/sql-statements.md b/v1.1/sql-statements.md
index 7a4119c609c..3f39afdfbd7 100644
--- a/v1.1/sql-statements.md
+++ b/v1.1/sql-statements.md
@@ -1,14 +1,13 @@
---
title: SQL Statements
summary: SQL statements supported by CockroachDB.
-toc: false
+toc: true
---
CockroachDB supports the following SQL statements. Click a statement for more details.
{{site.data.alerts.callout_success}}In the built-in SQL shell, use \h [statement] to get inline help about a specific statement.{{site.data.alerts.end}}
-
## Data Manipulation Statements
diff --git a/v1.1/start-a-local-cluster.md b/v1.1/start-a-local-cluster.md
index d823d39061c..dd05096b0b5 100644
--- a/v1.1/start-a-local-cluster.md
+++ b/v1.1/start-a-local-cluster.md
@@ -1,7 +1,7 @@
---
title: Start a Local Cluster (Insecure)
summary: Run an insecure multi-node CockroachDB cluster locally with each node listening on a different port.
-toc: false
+toc: true
toc_not_nested: true
asciicast: true
---
@@ -15,7 +15,6 @@ Once you’ve [installed CockroachDB](install-cockroachdb.html), it’s simple t
{{site.data.alerts.callout_info}}Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see Manual Deployment or Orchestrated Deployment.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v1.1/start-a-node.md b/v1.1/start-a-node.md
index 01b0465e4fb..1de4ab00755 100644
--- a/v1.1/start-a-node.md
+++ b/v1.1/start-a-node.md
@@ -1,14 +1,13 @@
---
title: Start a Node
summary: To start a new CockroachDB cluster, or add a node to an existing cluster, run the cockroach start command.
-toc: false
+toc: true
---
This page explains the `cockroach start` [command](cockroach-commands.html), which you use to start nodes as a new cluster or add nodes to an existing cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials.
{{site.data.alerts.callout_info}}Node-level settings are defined by flags passed to the cockroach start command and cannot be changed without stopping and restarting the node. In contrast, some cluster-wide settings are defined via SQL statements and can be updated anytime after a cluster has been started. For more details, see Cluster Settings.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/stop-a-node.md b/v1.1/stop-a-node.md
index 924d2dc867d..a36abb11f13 100644
--- a/v1.1/stop-a-node.md
+++ b/v1.1/stop-a-node.md
@@ -1,14 +1,13 @@
---
title: Stop a Node
summary: Learn how to temporarily stop a CockroachDB node.
-toc: false
+toc: true
---
This page shows you how to use the `cockroach quit` [command](cockroach-commands.html) to temporarily stop a node that you plan to restart, for example, during the process of [upgrading your cluster's version of CockroachDB](upgrade-cockroach-version.html).
For information about permanently removing nodes to downsize a cluster or react to hardware failures, see [Remove Nodes](remove-nodes.html).
-
## Overview
diff --git a/v1.1/string.md b/v1.1/string.md
index 585e0f01fa0..4e570858389 100644
--- a/v1.1/string.md
+++ b/v1.1/string.md
@@ -1,14 +1,13 @@
---
title: STRING
summary: The STRING data type stores a string of Unicode characters.
-toc: false
+toc: true
---
The `STRING` [data type](data-types.html) stores a string of Unicode characters.
-
## Aliases
diff --git a/v1.1/table-expressions.md b/v1.1/table-expressions.md
index 87cf47970fb..b94d996b201 100644
--- a/v1.1/table-expressions.md
+++ b/v1.1/table-expressions.md
@@ -1,7 +1,7 @@
---
title: Table Expressions
summary: Table expressions define a data source in selection clauses.
-toc: false
+toc: true
---
Table expressions define a data source in the `FROM` sub-clause of
@@ -9,7 +9,6 @@ Table expressions define a data source in the `FROM` sub-clause of
TABLE AS`](create-table-as.html), [`INSERT`](insert.html) and
[`UPSERT`](upsert.html) statements.
-
## Introduction
diff --git a/v1.1/timestamp.md b/v1.1/timestamp.md
index 6e20ffd27f9..5b17060e87a 100644
--- a/v1.1/timestamp.md
+++ b/v1.1/timestamp.md
@@ -1,12 +1,11 @@
---
title: TIMESTAMP
summary: The TIMESTAMP data type stores a date and time pair in UTC, whereas TIMESTAMPTZ stores a date and time pair with a time zone offset from UTC.
-toc: false
+toc: true
---
The `TIMESTAMP` [data type](data-types.html) stores a date and time pair in UTC.
-
## Time Zone Details
diff --git a/v1.1/training/backup-and-restore.md b/v1.1/training/backup-and-restore.md
index ce6aa0e9505..83b8837c554 100644
--- a/v1.1/training/backup-and-restore.md
+++ b/v1.1/training/backup-and-restore.md
@@ -1,6 +1,6 @@
---
title: Back and Restore
-toc: false
+toc: true
toc_not_nested: true
block_search: true
sidebar_data: sidebar-data-training.json
@@ -14,7 +14,6 @@ redirect_from: /training/backup-and-restore.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/client-connection-troubleshooting.md b/v1.1/training/client-connection-troubleshooting.md
index 59681937ad7..c8be54217bf 100644
--- a/v1.1/training/client-connection-troubleshooting.md
+++ b/v1.1/training/client-connection-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Client Connection Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
block_search: true
sidebar_data: sidebar-data-training.json
@@ -14,7 +14,6 @@ redirect_from: /training/client-connection-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/cluster-startup-and-scaling.md b/v1.1/training/cluster-startup-and-scaling.md
index 9ca01a8f4f9..bfdc0b41be5 100644
--- a/v1.1/training/cluster-startup-and-scaling.md
+++ b/v1.1/training/cluster-startup-and-scaling.md
@@ -1,6 +1,6 @@
---
title: Cluster Startup and Scaling
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/cluster-startup-and-scaling.html
@@ -13,7 +13,6 @@ redirect_from: /training/cluster-startup-and-scaling.html
content: "Hands-on Lab"
}
-
## Step 1. Create a training directory
diff --git a/v1.1/training/cluster-unavailability-troubleshooting.md b/v1.1/training/cluster-unavailability-troubleshooting.md
index c0fc04be0ae..2d3e376cf93 100644
--- a/v1.1/training/cluster-unavailability-troubleshooting.md
+++ b/v1.1/training/cluster-unavailability-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Cluster Unavailability Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/cluster-unavailability-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/cluster-upgrade.md b/v1.1/training/cluster-upgrade.md
index 4904e089f59..4366ab90056 100644
--- a/v1.1/training/cluster-upgrade.md
+++ b/v1.1/training/cluster-upgrade.md
@@ -1,6 +1,6 @@
---
title: Cluster Upgrade
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/cluster-upgrade.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/data-corruption-troubleshooting.md b/v1.1/training/data-corruption-troubleshooting.md
index 289fb270dd3..eb7aa832506 100644
--- a/v1.1/training/data-corruption-troubleshooting.md
+++ b/v1.1/training/data-corruption-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Data Corruption Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-corruption-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/data-import.md b/v1.1/training/data-import.md
index 67806182021..1c8fe72bad6 100644
--- a/v1.1/training/data-import.md
+++ b/v1.1/training/data-import.md
@@ -1,6 +1,6 @@
---
title: Data Import
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-import.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/data-unavailability-troubleshooting.md b/v1.1/training/data-unavailability-troubleshooting.md
index eaec176a1a5..a5aa6ee9a8f 100644
--- a/v1.1/training/data-unavailability-troubleshooting.md
+++ b/v1.1/training/data-unavailability-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Data Unavailability Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-unavailability-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/fault-tolerance-and-automated-repair.md b/v1.1/training/fault-tolerance-and-automated-repair.md
index 738c7b50b90..af579179147 100644
--- a/v1.1/training/fault-tolerance-and-automated-repair.md
+++ b/v1.1/training/fault-tolerance-and-automated-repair.md
@@ -1,6 +1,6 @@
---
title: Fault Tolerance and Automated Repair
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/fault-tolerance-and-automated-repair.html
@@ -13,7 +13,6 @@ redirect_from: /training/fault-tolerance-and-automated-repair.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/locality-and-replication-zones.md b/v1.1/training/locality-and-replication-zones.md
index 5ccd7dd7f4f..527c112ad90 100644
--- a/v1.1/training/locality-and-replication-zones.md
+++ b/v1.1/training/locality-and-replication-zones.md
@@ -1,6 +1,6 @@
---
title: Locality and Replication Zones
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/locality-and-replication-zones.html
@@ -13,7 +13,6 @@ redirect_from: /training/locality-and-replication-zones.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/network-partition-troubleshooting.md b/v1.1/training/network-partition-troubleshooting.md
index f29225fcf97..b0fa1ec2bd6 100644
--- a/v1.1/training/network-partition-troubleshooting.md
+++ b/v1.1/training/network-partition-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Network Partition Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/network-partition-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/node-decommissioning.md b/v1.1/training/node-decommissioning.md
index 70ebd92cf22..1103429f1ca 100644
--- a/v1.1/training/node-decommissioning.md
+++ b/v1.1/training/node-decommissioning.md
@@ -1,6 +1,6 @@
---
title: Node Decommissioning
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/node-decommissioning.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/node-startup-troubleshooting.md b/v1.1/training/node-startup-troubleshooting.md
index c874af85bfe..cc13a30a4c6 100644
--- a/v1.1/training/node-startup-troubleshooting.md
+++ b/v1.1/training/node-startup-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Node Startup Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/node-startup-troubleshooting.html
content: "Hands-on Lab"
}
-
## Problem 1: SSL required
diff --git a/v1.1/training/planned-maintenance.md b/v1.1/training/planned-maintenance.md
index 1944ee6ccba..6f8343faae0 100644
--- a/v1.1/training/planned-maintenance.md
+++ b/v1.1/training/planned-maintenance.md
@@ -1,6 +1,6 @@
---
title: Planned Maintenance
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/planned-maintenance.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/security.md b/v1.1/training/security.md
index be387b6f2c4..ada3f819456 100644
--- a/v1.1/training/security.md
+++ b/v1.1/training/security.md
@@ -14,7 +14,6 @@ redirect_from: /training/security.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/software-panic-troubleshooting.md b/v1.1/training/software-panic-troubleshooting.md
index e0348f3512e..2c44bb64d09 100644
--- a/v1.1/training/software-panic-troubleshooting.md
+++ b/v1.1/training/software-panic-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Software Panic Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/software-panic-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/under-replication-troubleshooting.md b/v1.1/training/under-replication-troubleshooting.md
index a748e99fc71..405f3fc59d2 100644
--- a/v1.1/training/under-replication-troubleshooting.md
+++ b/v1.1/training/under-replication-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Under-Replication Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/under-replication-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/training/users-and-privileges.md b/v1.1/training/users-and-privileges.md
index 19a9eb36beb..1bc4a15239d 100644
--- a/v1.1/training/users-and-privileges.md
+++ b/v1.1/training/users-and-privileges.md
@@ -1,6 +1,6 @@
---
title: Users and Privileges
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/users-and-privileges.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v1.1/transactions.md b/v1.1/transactions.md
index 2e52bf6fc56..25b79bae89c 100644
--- a/v1.1/transactions.md
+++ b/v1.1/transactions.md
@@ -1,14 +1,13 @@
---
title: Transactions
summary: CockroachDB supports bundling multiple SQL statements into a single all-or-nothing transaction.
-toc: false
+toc: true
---
CockroachDB supports bundling multiple SQL statements into a single all-or-nothing transaction. Each transaction guarantees [ACID semantics](https://en.wikipedia.org/wiki/ACID) spanning arbitrary tables and rows, even when data is distributed. If a transaction succeeds, all mutations are applied together with virtual simultaneity. If any part of a transaction fails, the entire transaction is aborted, and the database is left unchanged. CockroachDB guarantees that while a transaction is pending, it is isolated from other concurrent transactions.
{{site.data.alerts.callout_info}}For a detailed discussion of CockroachDB transaction semantics, see How CockroachDB Does Distributed Atomic Transactions and Serializable, Lockless, Distributed: Isolation in CockroachDB. Note that the explanation of the transaction model described in this blog post is slightly out of date. See the Transaction Retries section for more details.{{site.data.alerts.end}}
-
## SQL Statements
diff --git a/v1.1/truncate.md b/v1.1/truncate.md
index b86140c8606..20a19b2ff11 100644
--- a/v1.1/truncate.md
+++ b/v1.1/truncate.md
@@ -1,14 +1,13 @@
---
title: TRUNCATE
summary: The TRUNCATE statement deletes all rows from specified tables.
-toc: false
+toc: true
---
The `TRUNCATE` [statement](sql-statements.html) deletes all rows from specified tables.
{{site.data.alerts.callout_info}}The TRUNCATE removes all rows from a table by dropping the table and recreating a new table with the same name. For large tables, this is much more performant than deleting each of the rows. However, for smaller tables, it's more performant to use a DELETE statement without a WHERE clause.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v1.1/unique.md b/v1.1/unique.md
index 69f946128e5..05c371025ec 100644
--- a/v1.1/unique.md
+++ b/v1.1/unique.md
@@ -1,12 +1,11 @@
---
title: Unique Constraint
summary: The Unique constraint specifies that each non-NULL value in the constrained column must be unique.
-toc: false
+toc: true
---
The Unique [constraint](constraints.html) specifies that each non-*NULL* value in the constrained column must be unique.
-
## Details
diff --git a/v1.1/update.md b/v1.1/update.md
index 4c9338cc81e..c2a636fd3ac 100644
--- a/v1.1/update.md
+++ b/v1.1/update.md
@@ -1,12 +1,11 @@
---
title: UPDATE
summary: The UPDATE statement updates rows in a table.
-toc: false
+toc: true
---
The `UPDATE` [statement](sql-statements.html) updates rows in a table.
-
## Required Privileges
diff --git a/v1.1/upgrade-cockroach-version.md b/v1.1/upgrade-cockroach-version.md
index a92204b6236..4bfc6f14ae1 100644
--- a/v1.1/upgrade-cockroach-version.md
+++ b/v1.1/upgrade-cockroach-version.md
@@ -1,7 +1,7 @@
---
title: Upgrade to CockroachDB v1.1
summary: Learn how to upgrade your CockroachDB cluster to a new version.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ Because of CockroachDB's [multi-active availability](multi-active-availability.h
{{site.data.alerts.callout_info}} When upgrading, you can skip patch releases, but you cannot skip full releases. Since v1.1 is the second full CockroachDB release, you do not have to go through intermediate releases. You can upgrade to any v1.1.x release from any v1.0.x release, or from any patch release in the v1.1.x series.To upgrade within the v1.0.x series, see the v1.0 version of this page. {{site.data.alerts.end}} - ## Step 1. Prepare to upgrade diff --git a/v1.1/upsert.md b/v1.1/upsert.md index de256d3db71..8d4f4cf84fd 100644 --- a/v1.1/upsert.md +++ b/v1.1/upsert.md @@ -1,12 +1,11 @@ --- title: UPSERT summary: The UPSERT statement inserts rows when values do not violate uniqueness constraints, and it updates rows when values do violate uniqueness constraints. -toc: false +toc: true --- The `UPSERT` [statement](sql-statements.html) is short-hand for [`INSERT ON CONFLICT`](insert.html). It inserts rows in cases where specified values do not violate uniqueness constraints, and it updates rows in cases where values do violate uniqueness constraints. - ## Considerations diff --git a/v1.1/use-the-built-in-sql-client.md b/v1.1/use-the-built-in-sql-client.md index 172259d817e..b60a6d73866 100644 --- a/v1.1/use-the-built-in-sql-client.md +++ b/v1.1/use-the-built-in-sql-client.md @@ -1,14 +1,13 @@ --- title: Use the Built-in SQL Client summary: CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line. -toc: false +toc: true --- CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line. To use this client, run the `cockroach sql` [command](cockroach-commands.html) as described below. To exit the interactive shell, use `\q` or `ctrl-d`. - ## Synopsis diff --git a/v1.1/uuid.md b/v1.1/uuid.md index ae2ac105a4c..673a6a38e1c 100644 --- a/v1.1/uuid.md +++ b/v1.1/uuid.md @@ -1,14 +1,13 @@ --- title: UUID summary: The UUID data type stores 128-bit Universal Unique Identifiers. -toc: false +toc: true --- New in v1.1: The `UUID` (Universally Unique Identifier) [data type](data-types.html) stores a 128-bit value that is [unique across both space and time](https://www.ietf.org/rfc/rfc4122.txt). {{site.data.alerts.callout_success}}To auto-generate unique row IDs, we recommend using
UUID with the gen_random_uuid() function as the default value. See the example below for more details.{{site.data.alerts.end}}
-
## Syntax
A `UUID` value can be expressed using the following formats:
diff --git a/v1.1/validate-constraint.md b/v1.1/validate-constraint.md
index 912e535ac51..065c226bd46 100644
--- a/v1.1/validate-constraint.md
+++ b/v1.1/validate-constraint.md
@@ -1,14 +1,13 @@
---
title: VALIDATE CONSTRAINT
summary: Use the ADD COLUMN statement to add columns to tables.
-toc: false
+toc: true
---
The `VALIDATE CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and checks whether values in a column match a [constraint](constraints.html) on the column.
This statement is especially useful after applying a constraint to an existing column via [`ADD CONSTRAINT`](add-constraint.html). In this case, `VALIDATE CONSTRAINT` can be used to find values already in the column that do not match the constraint.
-
## Required Privileges
diff --git a/v1.1/view-node-details.md b/v1.1/view-node-details.md
index d353aa7ae96..f1b35995929 100644
--- a/v1.1/view-node-details.md
+++ b/v1.1/view-node-details.md
@@ -1,14 +1,13 @@
---
title: View Node Details
summary: To view details for each node in the cluster, use the cockroach node command with the appropriate subcommands and flags.
-toc: false
+toc: true
---
To view details for each node in the cluster, use the `cockroach node` [command](cockroach-commands.html) with the appropriate subcommands and flags.
New in v1.1: The `cockroach node` command is also used in the process of decommissioning nodes for permanent removal. See [Remove Nodes](remove-nodes.html) for more details.
-
## Subcommands
diff --git a/v1.1/views.md b/v1.1/views.md
index fa53598161d..5c611f8e982 100644
--- a/v1.1/views.md
+++ b/v1.1/views.md
@@ -1,12 +1,11 @@
---
title: Views
summary:
-toc: false
+toc: true
---
A view is a stored `SELECT` query represented as a virtual table. Unlike a standard table, a view is not part of the physical schema; instead, it is a virtual table that forms dynamically when requested.
-
## Why Use Views?
diff --git a/v2.0/add-column.md b/v2.0/add-column.md
index fca0ea3e64e..f1125bf9a7f 100644
--- a/v2.0/add-column.md
+++ b/v2.0/add-column.md
@@ -1,12 +1,11 @@
---
title: ADD COLUMN
summary: Use the ADD COLUMN statement to add columns to tables.
-toc: false
+toc: true
---
The `ADD COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and adds columns to tables.
-
## Synopsis
diff --git a/v2.0/add-constraint.md b/v2.0/add-constraint.md
index c8904fbf1b7..dacba9f605c 100644
--- a/v2.0/add-constraint.md
+++ b/v2.0/add-constraint.md
@@ -1,7 +1,7 @@
---
title: ADD CONSTRAINT
summary: Use the ADD CONSTRAINT statement to add constraints to columns.
-toc: false
+toc: true
---
The `ADD CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and can add the following [constraints](constraints.html) to columns:
@@ -13,7 +13,6 @@ The `ADD CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` a
{{site.data.alerts.callout_info}}
The Primary Key and Not Null constraints can only be applied through CREATE TABLE. The Default constraint is managed through ALTER COLUMN.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/admin-ui-access-and-navigate.md b/v2.0/admin-ui-access-and-navigate.md
index d426b54e519..95d80b7a1c8 100644
--- a/v2.0/admin-ui-access-and-navigate.md
+++ b/v2.0/admin-ui-access-and-navigate.md
@@ -1,10 +1,9 @@
---
title: Access and Navigate the CockroachDB Admin UI
summary: Learn how to access and navigate the Admin UI.
-toc: false
+toc: true
---
-
## Access the Admin UI
diff --git a/v2.0/admin-ui-custom-chart-debug-page.md b/v2.0/admin-ui-custom-chart-debug-page.md
index 9108152fe15..c85ae6c443d 100644
--- a/v2.0/admin-ui-custom-chart-debug-page.md
+++ b/v2.0/admin-ui-custom-chart-debug-page.md
@@ -1,13 +1,12 @@
---
title: Custom Chart Debug Page
-toc: false
+toc: true
---
New in v2.0: The **Custom Chart** debug page in the Admin UI can be used to create a custom chart showing any combination of over [200 available metrics](#available-metrics).
The definition of the customized dashboard is encoded in the URL. To share the dashboard with someone, send them the URL. Just like any other URL, it can be bookmarked, sit in a pinned tab in your browser, etc.
-
## Getting There
diff --git a/v2.0/admin-ui-databases-page.md b/v2.0/admin-ui-databases-page.md
index 42d7890ef6a..b8a5453f835 100644
--- a/v2.0/admin-ui-databases-page.md
+++ b/v2.0/admin-ui-databases-page.md
@@ -1,11 +1,10 @@
---
title: Database Page
-toc: false
+toc: true
---
The **Databases** page of the Admin UI provides details of the databases configured, the tables in each database, and the grants assigned to each user. To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then click **Databases** on the left-hand navigation bar.
-
## Tables View
diff --git a/v2.0/admin-ui-jobs-page.md b/v2.0/admin-ui-jobs-page.md
index 076ca088c5b..5d4bc43bd5a 100644
--- a/v2.0/admin-ui-jobs-page.md
+++ b/v2.0/admin-ui-jobs-page.md
@@ -1,11 +1,10 @@
---
title: Jobs Page
-toc: false
+toc: true
---
New in v1.1: The **Jobs** page of the Admin UI provides details about the backup/restore jobs as well as schema changes performed across all nodes in the cluster. To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then click **Jobs** on the left-hand navigation bar.
-
## Job Details
diff --git a/v2.0/admin-ui-overview-dashboard.md b/v2.0/admin-ui-overview-dashboard.md
index 5aa0cc93550..02262d1683a 100644
--- a/v2.0/admin-ui-overview-dashboard.md
+++ b/v2.0/admin-ui-overview-dashboard.md
@@ -1,12 +1,11 @@
---
title: Overview Dashboard
summary: The Overview dashboard lets you monitor important SQL performance, replication, and storage metrics.
-toc: false
+toc: true
---
The **Overview** dashboard lets you monitor important SQL performance, replication, and storage metrics. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and click **Metrics** on the left-hand navigation bar. The **Overview** dashboard is displayed by default.
-
The **Overview** dashboard displays the following time series graphs:
diff --git a/v2.0/admin-ui-replication-dashboard.md b/v2.0/admin-ui-replication-dashboard.md
index fbdfb03b335..06077525c5a 100644
--- a/v2.0/admin-ui-replication-dashboard.md
+++ b/v2.0/admin-ui-replication-dashboard.md
@@ -1,12 +1,11 @@
---
title: Replication Dashboard
summary: The Replication dashboard lets you monitor the replication metrics for your cluster.
-toc: false
+toc: true
---
The **Replication** dashboard in the CockroachDB Admin UI enables you to monitor the replication metrics for your cluster. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **Replication**.
-
## Review of CockroachDB terminology
diff --git a/v2.0/admin-ui-runtime-dashboard.md b/v2.0/admin-ui-runtime-dashboard.md
index dd46e318d95..d93e418894f 100644
--- a/v2.0/admin-ui-runtime-dashboard.md
+++ b/v2.0/admin-ui-runtime-dashboard.md
@@ -1,11 +1,10 @@
---
title: Runtime Dashboard
-toc: false
+toc: true
---
The **Runtime** dashboard in the CockroachDB Admin UI lets you monitor runtime metrics for you cluster, such as node count, memory usage, and CPU time. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **Runtime**.
-
The **Runtime** dashboard displays the following time series graphs:
diff --git a/v2.0/admin-ui-sql-dashboard.md b/v2.0/admin-ui-sql-dashboard.md
index 96f2ac07a84..860b6efde12 100644
--- a/v2.0/admin-ui-sql-dashboard.md
+++ b/v2.0/admin-ui-sql-dashboard.md
@@ -1,12 +1,11 @@
---
title: SQL Dashboard
summary: The SQL dashboard lets you monitor the performance of your SQL queries.
-toc: false
+toc: true
---
The **SQL** dashboard in the CockroachDB Admin UI lets you monitor the performance of your SQL queries. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **SQL**.
-
The **SQL** dashboard displays the following time series graphs:
diff --git a/v2.0/admin-ui-storage-dashboard.md b/v2.0/admin-ui-storage-dashboard.md
index 510e9defb0b..0d8e2bbd282 100644
--- a/v2.0/admin-ui-storage-dashboard.md
+++ b/v2.0/admin-ui-storage-dashboard.md
@@ -1,12 +1,11 @@
---
title: Storage Dashboard
summary: The Storage dashboard lets you monitor the storage utilization for your cluster.
-toc: false
+toc: true
---
The **Storage** dashboard in the CockroachDB Admin UI lets you monitor the storage utilization for your cluster. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **Storage**.
-
The **Storage** dashboard displays the following time series graphs:
diff --git a/v2.0/alter-column.md b/v2.0/alter-column.md
index 9ec3dbe30a1..1f3d5053f83 100644
--- a/v2.0/alter-column.md
+++ b/v2.0/alter-column.md
@@ -1,14 +1,13 @@
---
title: ALTER COLUMN
summary: Use the ALTER COLUMN statement to set, change, or drop a column's Default constraint or to drop the Not Null constraint.
-toc: false
+toc: true
---
The `ALTER COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and sets, changes, or drops a column's [Default constraint](default-value.html) or drops the [Not Null constraint](not-null.html).
{{site.data.alerts.callout_info}}To manage other constraints, see ADD CONSTRAINT and DROP CONSTRAINT{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/alter-sequence.md b/v2.0/alter-sequence.md
index 82cae030741..e2da8e5ce44 100644
--- a/v2.0/alter-sequence.md
+++ b/v2.0/alter-sequence.md
@@ -1,14 +1,13 @@
---
title: ALTER SEQUENCE
summary: Use the ALTER SEQUENCE statement to change the name, increment values, and other settings of a sequence.
-toc: false
+toc: true
---
New in v2.0: The `ALTER SEQUENCE` [statement](sql-statements.html) [changes the name](rename-sequence.html), increment values, and other settings of a sequence.
{{site.data.alerts.callout_info}}To understand how CockroachDB changes schema elements without requiring table locking or other user-visible downtime, see Online Schema Changes in CockroachDB.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/alter-table.md b/v2.0/alter-table.md
index 6cfab406fcd..bf182f698db 100644
--- a/v2.0/alter-table.md
+++ b/v2.0/alter-table.md
@@ -1,14 +1,13 @@
---
title: ALTER TABLE
summary: Use the ALTER TABLE statement to change the schema of a table.
-toc: false
+toc: true
---
The `ALTER TABLE` [statement](sql-statements.html) applies a schema change to a table.
{{site.data.alerts.callout_info}}To understand how CockroachDB changes schema elements without requiring table locking or other user-visible downtime, see Online Schema Changes in CockroachDB.{{site.data.alerts.end}}
-
## Subcommands
diff --git a/v2.0/alter-user.md b/v2.0/alter-user.md
index af4caaba344..bb7dcda941f 100644
--- a/v2.0/alter-user.md
+++ b/v2.0/alter-user.md
@@ -1,14 +1,13 @@
---
title: ALTER USER
summary: The ALTER USER statement can be used to add or change a user's password.
-toc: false
+toc: true
---
New in v2.0: The `ALTER USER` [statement](sql-statements.html) can be used to add or change a [user's](create-and-manage-users.html) password.
{{site.data.alerts.callout_success}}You can also use the cockroach user command to add or change a user's password.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.0/alter-view.md b/v2.0/alter-view.md
index 3439bc825d0..e2594d0e8d7 100644
--- a/v2.0/alter-view.md
+++ b/v2.0/alter-view.md
@@ -1,14 +1,13 @@
---
title: ALTER VIEW
summary: The ALTER VIEW statement changes the name of a view.
-toc: false
+toc: true
---
The `ALTER VIEW` [statement](sql-statements.html) changes the name of a [view](views.html).
{{site.data.alerts.callout_info}}It is not currently possible to change the SELECT statement executed by a view. Instead, you must drop the existing view and create a new view. Also, it is not currently possible to rename a view that other views depend on, but this ability may be added in the future (see this issue).{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/architecture/distribution-layer.md b/v2.0/architecture/distribution-layer.md
index 8df2db35ae6..7f7b84ffdca 100644
--- a/v2.0/architecture/distribution-layer.md
+++ b/v2.0/architecture/distribution-layer.md
@@ -1,14 +1,13 @@
---
title: Distribution Layer
summary:
-toc: false
+toc: true
---
The Distribution Layer of CockroachDB's architecture provides a unified view of your cluster's data.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.0/architecture/overview.md b/v2.0/architecture/overview.md
index 60700dbccb1..4645c9754a7 100644
--- a/v2.0/architecture/overview.md
+++ b/v2.0/architecture/overview.md
@@ -1,7 +1,7 @@
---
title: Architecture Overview
summary:
-toc: false
+toc: true
key: cockroachdb-architecture.html
redirect_from: index.html
---
@@ -10,7 +10,6 @@ CockroachDB was designed to create the open-source database our developers would
However, you definitely do not need to understand the underlying architecture to use CockroachDB. These pages give serious users and database enthusiasts a high-level framework to explain what's happening under the hood.
-
## Using this Guide
diff --git a/v2.0/architecture/replication-layer.md b/v2.0/architecture/replication-layer.md
index 2c60795e5b5..33c0eaa8deb 100644
--- a/v2.0/architecture/replication-layer.md
+++ b/v2.0/architecture/replication-layer.md
@@ -1,14 +1,13 @@
---
title: Replication Layer
summary:
-toc: false
+toc: true
---
The Replication Layer of CockroachDB's architecture copies data between nodes and ensures consistency between these copies by implementing our consensus algorithm.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.0/architecture/sql-layer.md b/v2.0/architecture/sql-layer.md
index 03ca4e9de9d..33399679c1e 100644
--- a/v2.0/architecture/sql-layer.md
+++ b/v2.0/architecture/sql-layer.md
@@ -1,14 +1,13 @@
---
title: SQL Layer
summary:
-toc: false
+toc: true
---
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.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.0/architecture/storage-layer.md b/v2.0/architecture/storage-layer.md
index d0fd16c54d1..5b875a9910c 100644
--- a/v2.0/architecture/storage-layer.md
+++ b/v2.0/architecture/storage-layer.md
@@ -1,14 +1,13 @@
---
title: Storage Layer
summary:
-toc: false
+toc: true
---
The Storage Layer of CockroachDB's architecture reads and writes data to disk.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.0/architecture/transaction-layer.md b/v2.0/architecture/transaction-layer.md
index 4e45882f540..e1546361491 100644
--- a/v2.0/architecture/transaction-layer.md
+++ b/v2.0/architecture/transaction-layer.md
@@ -1,14 +1,13 @@
---
title: Transaction Layer
summary:
-toc: false
+toc: true
---
The Transaction Layer of CockroachDB's architecture implements support for ACID transactions by coordinating concurrent operations.
{{site.data.alerts.callout_info}}If you haven't already, we recommend reading the Architecture Overview.{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.0/array.md b/v2.0/array.md
index e753e9da8a9..fc3676e8756 100644
--- a/v2.0/array.md
+++ b/v2.0/array.md
@@ -1,14 +1,13 @@
---
title: ARRAY
summary: The ARRAY data type stores one-dimensional, 1-indexed, homogenous arrays of any non-array data types.
-toc: false
+toc: true
---
New in v1.1:The `ARRAY` data type stores one-dimensional, 1-indexed, homogenous arrays of any non-array [data type](data-types.html).
The `ARRAY` data type is useful for ensuring compatibility with ORMs and other tools. However, if such compatibility is not a concern, it's more flexible to design your schema with normalized tables.
-
{{site.data.alerts.callout_info}} CockroachDB does not support nested arrays, creating database indexes on arrays, and ordering by arrays.{{site.data.alerts.end}}
diff --git a/v2.0/backup.md b/v2.0/backup.md
index b2301d5544f..0621c1178be 100644
--- a/v2.0/backup.md
+++ b/v2.0/backup.md
@@ -1,7 +1,7 @@
---
title: BACKUP
summary: Back up your CockroachDB cluster to a cloud storage services such as AWS S3, Google Cloud Storage, or other NFS.
-toc: false
+toc: true
---
{{site.data.alerts.callout_danger}}The BACKUP feature is only available to enterprise users. For non-enterprise backups, see cockroach dump.{{site.data.alerts.end}}
@@ -10,7 +10,6 @@ CockroachDB's `BACKUP` [statement](sql-statements.html) allows you to create ful
Because CockroachDB is designed with high fault tolerance, these backups are designed primarily for disaster recovery (i.e., if your cluster loses a majority of its nodes) through [`RESTORE`](restore.html). Isolated issues (such as small-scale node outages) do not require any intervention.
-
## Functional Details
diff --git a/v2.0/begin-transaction.md b/v2.0/begin-transaction.md
index f5d2047c2ce..8aea9be03c8 100644
--- a/v2.0/begin-transaction.md
+++ b/v2.0/begin-transaction.md
@@ -1,14 +1,13 @@
---
title: BEGIN
summary: Initiate a SQL transaction with the BEGIN statement in CockroachDB.
-toc: false
+toc: true
---
The `BEGIN` [statement](sql-statements.html) initiates a [transaction](transactions.html), which either successfully executes all of the statements it contains or none at all.
{{site.data.alerts.callout_danger}}When using transactions, your application should include logic to retry transactions that are aborted to break a dependency cycle between concurrent transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/bool.md b/v2.0/bool.md
index c9bb93d300f..b7bdd457701 100644
--- a/v2.0/bool.md
+++ b/v2.0/bool.md
@@ -1,12 +1,11 @@
---
title: BOOL
summary: The BOOL data type stores Boolean values of false or true.
-toc: false
+toc: true
---
The `BOOL` [data type](data-types.html) stores a Boolean value of `false` or `true`.
-
## Aliases
diff --git a/v2.0/build-a-c++-app-with-cockroachdb.md b/v2.0/build-a-c++-app-with-cockroachdb.md
index 11a753d5371..9bcc68f09a8 100644
--- a/v2.0/build-a-c++-app-with-cockroachdb.md
+++ b/v2.0/build-a-c++-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a C++ App with CockroachDB
summary: Learn how to use CockroachDB from a simple C++ application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple C++ application with CockroachDB usin
We have tested the [C++ libpqxx driver](https://github.com/jtv/libpqxx) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-clojure-app-with-cockroachdb.md b/v2.0/build-a-clojure-app-with-cockroachdb.md
index 1d8c66430e2..49fd6493902 100644
--- a/v2.0/build-a-clojure-app-with-cockroachdb.md
+++ b/v2.0/build-a-clojure-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Clojure App with CockroachDB
summary: Learn how to use CockroachDB from a simple Clojure application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple Clojure application with CockroachDB
We have tested the [Clojure java.jdbc driver](http://clojure-doc.org/articles/ecosystem/java_jdbc/home.html) in conjunction with the [PostgreSQL JDBC driver](https://jdbc.postgresql.org/) enough to claim **beta-level** support, so that combination is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-csharp-app-with-cockroachdb.md b/v2.0/build-a-csharp-app-with-cockroachdb.md
index 1e6957b688d..95142b122d7 100644
--- a/v2.0/build-a-csharp-app-with-cockroachdb.md
+++ b/v2.0/build-a-csharp-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a C# (.NET) App with CockroachDB
summary: Learn how to use CockroachDB from a simple C# (.NET) application with a low-level client driver.
-toc: false
+toc: true
twitter: true
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple C# (.NET) application with CockroachD
We have tested the [.NET Npgsql driver](http://www.npgsql.org/) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-go-app-with-cockroachdb-gorm.md b/v2.0/build-a-go-app-with-cockroachdb-gorm.md
index 2dc9697c69f..394237e5551 100644
--- a/v2.0/build-a-go-app-with-cockroachdb-gorm.md
+++ b/v2.0/build-a-go-app-with-cockroachdb-gorm.md
@@ -1,7 +1,7 @@
---
title: Build a Go App with CockroachDB
summary: Learn how to use CockroachDB from a simple Go application with the GORM ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Go pq driver](https://godoc.org/github.com/lib/pq) and the [
{{site.data.alerts.callout_success}}For a more realistic use of GORM with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/build-a-go-app-with-cockroachdb.md b/v2.0/build-a-go-app-with-cockroachdb.md
index 378c69a891d..e40d2421ec4 100644
--- a/v2.0/build-a-go-app-with-cockroachdb.md
+++ b/v2.0/build-a-go-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Go App with CockroachDB
summary: Learn how to use CockroachDB from a simple Go application with the Go pq driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Go application with CockroachDB using
We have tested the [Go pq driver](https://godoc.org/github.com/lib/pq) and the [GORM ORM](http://jinzhu.me/gorm/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-java-app-with-cockroachdb-hibernate.md b/v2.0/build-a-java-app-with-cockroachdb-hibernate.md
index 8f5774b2c69..b605f97945b 100644
--- a/v2.0/build-a-java-app-with-cockroachdb-hibernate.md
+++ b/v2.0/build-a-java-app-with-cockroachdb-hibernate.md
@@ -1,7 +1,7 @@
---
title: Build a Java App with CockroachDB
summary: Learn how to use CockroachDB from a simple Java application with the Hibernate ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Java jdbc driver](https://jdbc.postgresql.org/) and the [Hib
{{site.data.alerts.callout_success}}For a more realistic use of Hibernate with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/build-a-java-app-with-cockroachdb.md b/v2.0/build-a-java-app-with-cockroachdb.md
index b646d57d96e..cafc75840ff 100644
--- a/v2.0/build-a-java-app-with-cockroachdb.md
+++ b/v2.0/build-a-java-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Java App with CockroachDB
summary: Learn how to use CockroachDB from a simple Java application with the jdbc driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Java application with CockroachDB usi
We have tested the [Java jdbc driver](https://jdbc.postgresql.org/) and the [Hibernate ORM](http://hibernate.org/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-nodejs-app-with-cockroachdb-sequelize.md b/v2.0/build-a-nodejs-app-with-cockroachdb-sequelize.md
index 99b8b87ec4f..7512379e33a 100644
--- a/v2.0/build-a-nodejs-app-with-cockroachdb-sequelize.md
+++ b/v2.0/build-a-nodejs-app-with-cockroachdb-sequelize.md
@@ -1,7 +1,7 @@
---
title: Build a Node.js App with CockroachDB
summary: Learn how to use CockroachDB from a simple Node.js application with the Sequelize ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Node.js pg driver](https://www.npmjs.com/package/pg) and the
{{site.data.alerts.callout_success}}For a more realistic use of Sequelize with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/build-a-nodejs-app-with-cockroachdb.md b/v2.0/build-a-nodejs-app-with-cockroachdb.md
index 9c15f19ea0a..98a09794f11 100644
--- a/v2.0/build-a-nodejs-app-with-cockroachdb.md
+++ b/v2.0/build-a-nodejs-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Node.js App with CockroachDB
summary: Learn how to use CockroachDB from a simple Node.js application with the Node.js pg driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Node.js application with CockroachDB
We have tested the [Node.js pg driver](https://www.npmjs.com/package/pg) and the [Sequelize ORM](https://sequelize.readthedocs.io/en/v3/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-php-app-with-cockroachdb.md b/v2.0/build-a-php-app-with-cockroachdb.md
index 233cdb55968..68060a5a61e 100644
--- a/v2.0/build-a-php-app-with-cockroachdb.md
+++ b/v2.0/build-a-php-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a PHP App with CockroachDB
summary: Learn how to use CockroachDB from a simple PHP application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple PHP application with CockroachDB usin
We have tested the [php-pgsql driver](http://php.net/manual/en/book.pgsql.php) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-python-app-with-cockroachdb-sqlalchemy.md b/v2.0/build-a-python-app-with-cockroachdb-sqlalchemy.md
index a497f97dedc..3bf3e7c60c2 100644
--- a/v2.0/build-a-python-app-with-cockroachdb-sqlalchemy.md
+++ b/v2.0/build-a-python-app-with-cockroachdb-sqlalchemy.md
@@ -1,7 +1,7 @@
---
title: Build a Python App with CockroachDB
summary: Learn how to use CockroachDB from a simple Python application with the SQLAlchemy ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Python psycopg2 driver](http://initd.org/psycopg/docs/) and
{{site.data.alerts.callout_success}}For a more realistic use of SQLAlchemy with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/build-a-python-app-with-cockroachdb.md b/v2.0/build-a-python-app-with-cockroachdb.md
index 0915a3d09c4..1d3820d51be 100644
--- a/v2.0/build-a-python-app-with-cockroachdb.md
+++ b/v2.0/build-a-python-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Python App with CockroachDB
summary: Learn how to use CockroachDB from a simple Python application with the psycopg2 driver.
-toc: false
+toc: true
asciicast: true
twitter: false
---
@@ -15,7 +15,6 @@ This tutorial shows you how build a simple Python application with CockroachDB u
We have tested the [Python psycopg2 driver](http://initd.org/psycopg/docs/) and the [SQLAlchemy ORM](https://docs.sqlalchemy.org/en/latest/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-ruby-app-with-cockroachdb-activerecord.md b/v2.0/build-a-ruby-app-with-cockroachdb-activerecord.md
index 8b5118fafdc..4a392ea91a1 100644
--- a/v2.0/build-a-ruby-app-with-cockroachdb-activerecord.md
+++ b/v2.0/build-a-ruby-app-with-cockroachdb-activerecord.md
@@ -1,7 +1,7 @@
---
title: Build a Ruby App with CockroachDB
summary: Learn how to use CockroachDB from a simple Ruby application with the ActiveRecord ORM.
-toc: false
+toc: true
twitter: false
---
@@ -16,7 +16,6 @@ We have tested the [Ruby pg driver](https://rubygems.org/gems/pg) and the [Activ
{{site.data.alerts.callout_success}}For a more realistic use of ActiveRecord with CockroachDB, see our examples-orms repository.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/build-a-ruby-app-with-cockroachdb.md b/v2.0/build-a-ruby-app-with-cockroachdb.md
index b7b45ac898f..d7bc607ce24 100644
--- a/v2.0/build-a-ruby-app-with-cockroachdb.md
+++ b/v2.0/build-a-ruby-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Ruby App with CockroachDB
summary: Learn how to use CockroachDB from a simple Ruby application with the pg client driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Ruby application with CockroachDB usi
We have tested the [Ruby pg driver](https://rubygems.org/gems/pg) and the [ActiveRecord ORM](http://guides.rubyonrails.org/active_record_basics.html) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/build-a-rust-app-with-cockroachdb.md b/v2.0/build-a-rust-app-with-cockroachdb.md
index 099bdfb24fe..afec3fd4eb5 100644
--- a/v2.0/build-a-rust-app-with-cockroachdb.md
+++ b/v2.0/build-a-rust-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Rust App with CockroachDB
summary: Learn how to use CockroachDB from a simple Rust application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple Rust application with CockroachDB usi
We have tested the Rust postgres driver enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before You Begin
diff --git a/v2.0/bytes.md b/v2.0/bytes.md
index 4f618d5af3c..fff91bfa684 100644
--- a/v2.0/bytes.md
+++ b/v2.0/bytes.md
@@ -1,12 +1,11 @@
---
title: BYTES
summary: The BYTES data type stores binary strings of variable length.
-toc: false
+toc: true
---
The `BYTES` [data type](data-types.html) stores binary strings of variable length.
-
## Aliases
diff --git a/v2.0/cancel-job.md b/v2.0/cancel-job.md
index 9a534ab007a..189fc1e4be1 100644
--- a/v2.0/cancel-job.md
+++ b/v2.0/cancel-job.md
@@ -1,12 +1,11 @@
---
title: CANCEL JOB
summary: The CANCEL JOB statement stops long-running jobs.
-toc: false
+toc: true
---
New in v1.1: The `CANCEL JOB` [statement](sql-statements.html) lets you stop long-running jobs, which include [`IMPORT`](import.html) jobs and enterprise [`BACKUP`](backup.html) and [`RESTORE`](restore.html) tasks.
-
## Limitations
diff --git a/v2.0/cancel-query.md b/v2.0/cancel-query.md
index f44847f3b15..c0d06b34df2 100644
--- a/v2.0/cancel-query.md
+++ b/v2.0/cancel-query.md
@@ -1,12 +1,11 @@
---
title: CANCEL QUERY
summary: The CANCEL QUERY statement cancels a running SQL query.
-toc: false
+toc: true
---
New in v1.1: The `CANCEL QUERY` [statement](sql-statements.html) cancels a running SQL query.
-
## Considerations
diff --git a/v2.0/check.md b/v2.0/check.md
index a69061ccb6d..68e137c75c6 100644
--- a/v2.0/check.md
+++ b/v2.0/check.md
@@ -1,12 +1,11 @@
---
title: CHECK Constraint
summary: The CHECK constraint specifies that values for the column in INSERT or UPDATE statements must satisfy a Boolean expression.
-toc: false
+toc: true
---
The `CHECK` [constraint](constraints.html) specifies that values for the column in [`INSERT`](insert.html) or [`UPDATE`](update.html) statements must return `TRUE` or `NULL` for a Boolean expression. If any values return `FALSE`, the entire statement is rejected.
-
## Details
diff --git a/v2.0/cluster-settings.md b/v2.0/cluster-settings.md
index d11b988c5bd..89521a4b8e4 100644
--- a/v2.0/cluster-settings.md
+++ b/v2.0/cluster-settings.md
@@ -1,14 +1,13 @@
---
title: Cluster Settings
summary: Learn about cluster settings that apply to all nodes of a CockroachDB cluster.
-toc: false
+toc: true
---
This page shows you how to view and change CockroachDB's **cluster-wide settings**.
{{site.data.alerts.callout_info}}In contrast to cluster-wide settings, node-level settings apply to a single node. They are defined by flags passed to the cockroach start command when starting a node and cannot be changed without stopping and restarting the node. For more details, see Start a Node.{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.0/cluster-setup-troubleshooting.md b/v2.0/cluster-setup-troubleshooting.md
index 6f0cba772c3..c68f97dd64f 100644
--- a/v2.0/cluster-setup-troubleshooting.md
+++ b/v2.0/cluster-setup-troubleshooting.md
@@ -1,12 +1,11 @@
---
title: Troubleshoot Cluster Setup
summary: Learn how to troubleshoot issues with starting CockroachDB clusters
-toc: false
+toc: true
---
If you're having trouble starting or scaling your cluster, this page will help you troubleshoot the issue.
-
## Before You Begin
diff --git a/v2.0/cockroach-commands.md b/v2.0/cockroach-commands.md
index e8788a05c86..66129d05d7f 100644
--- a/v2.0/cockroach-commands.md
+++ b/v2.0/cockroach-commands.md
@@ -1,14 +1,13 @@
---
title: Cockroach Commands
summary: Learn the commands for configuring, starting, and managing a CockroachDB cluster.
-toc: false
+toc: true
---
This page introduces the `cockroach` commands for configuring, starting, and managing a CockroachDB cluster, as well as logging flags that can be set on any command and environment variables that can be used in place of certain flags.
You can run `cockroach help` in your shell to get similar guidance.
-
## Commands
diff --git a/v2.0/collate.md b/v2.0/collate.md
index 74017ff1296..232420fcaf6 100644
--- a/v2.0/collate.md
+++ b/v2.0/collate.md
@@ -1,7 +1,7 @@
---
title: COLLATE
summary: The COLLATE feature lets you sort strings according to language- and country-specific rules.
-toc: false
+toc: true
redirect_from: collatedstring.html
---
@@ -9,7 +9,6 @@ The `COLLATE` feature lets you sort [`STRING`](string.html) values according to
Collated strings are important because different languages have [different rules for alphabetic order](https://en.wikipedia.org/wiki/Alphabetical_order#Language-specific_conventions), especially with respect to accented letters. For example, in German accented letters are sorted with their unaccented counterparts, while in Swedish they are placed at the end of the alphabet. A collation is a set of rules used for ordering and usually corresponds to a language, though some languages have multiple collations with different rules for sorting; for example Portuguese has separate collations for Brazilian and European dialects (`pt-BR` and `pt-PT` respectively).
-
## Details
diff --git a/v2.0/column-families.md b/v2.0/column-families.md
index e7911fc00b4..3659971b7eb 100644
--- a/v2.0/column-families.md
+++ b/v2.0/column-families.md
@@ -1,14 +1,13 @@
---
title: Column Families
summary: A column family is a group of columns in a table that are stored as a single key-value pair in the underlying key-value store.
-toc: false
+toc: true
---
A column family is a group of columns in a table that are stored as a single key-value pair in the underlying key-value store. The reduced number of keys results in a smaller storage overhead and, even more significantly, in improved performance during `INSERT`, `UPDATE`, and `DELETE` operations.
This page explains how CockroachDB organizes columns into families as well as cases in which you might want to manually override the default behavior.
-
## Default Behavior
diff --git a/v2.0/commit-transaction.md b/v2.0/commit-transaction.md
index 065aa304626..32d23df6786 100644
--- a/v2.0/commit-transaction.md
+++ b/v2.0/commit-transaction.md
@@ -1,7 +1,7 @@
---
title: COMMIT
summary: Commit a transaction with the COMMIT statement in CockroachDB.
-toc: false
+toc: true
---
The `COMMIT` [statement](sql-statements.html) commits the current [transaction](transactions.html) or, when using [client-side transaction retries](transactions.html#client-side-transaction-retries), clears the connection to allow new transactions to begin.
@@ -10,7 +10,6 @@ When using [client-side transaction retries](transactions.html#client-side-trans
For non-retryable transactions, if statements in the transaction [generated any errors](transactions.html#error-handling), `COMMIT` is equivalent to `ROLLBACK`, which aborts the transaction and discards *all* updates made by its statements.
-
## Synopsis
diff --git a/v2.0/common-table-expressions.md b/v2.0/common-table-expressions.md
index c8c743ac843..489240b7d65 100644
--- a/v2.0/common-table-expressions.md
+++ b/v2.0/common-table-expressions.md
@@ -1,7 +1,7 @@
---
title: Common Table Expressions
summary: Common Table Expressions (CTEs) simplify the definition and use of subqueries
-toc: false
+toc: true
toc_not_nested: true
---
@@ -16,7 +16,6 @@ clauses](select-clause.html) and [`INSERT`](insert.html),
[`DELETE`](delete.html), [`UPDATE`](update.html) and
[`UPSERT`](upsert.html) statements.
-
## Synopsis
diff --git a/v2.0/computed-columns.md b/v2.0/computed-columns.md
index 88810c2433c..da6ae2ae50e 100644
--- a/v2.0/computed-columns.md
+++ b/v2.0/computed-columns.md
@@ -1,12 +1,11 @@
---
title: Computed Columns
summary: A computed column stores data generated by an expression included in the column definition.
-toc: false
+toc: true
---
New in v2.0: A computed column stores data generated from other columns by a [scalar expression](scalar-expressions.html) included in the column definition.
-
## Why use computed columns?
diff --git a/v2.0/configure-replication-zones.md b/v2.0/configure-replication-zones.md
index ceafb848034..563c7b08ce9 100644
--- a/v2.0/configure-replication-zones.md
+++ b/v2.0/configure-replication-zones.md
@@ -2,7 +2,7 @@
title: Configure Replication Zones
summary: In CockroachDB, you use replication zones to control the number and location of replicas for specific sets of data.
keywords: ttl, time to live, availability zone
-toc: false
+toc: true
---
In CockroachDB, you use **replication zones** to control the number and location of replicas for specific sets of data, both when replicas are first added and when they are rebalanced to maintain cluster equilibrium. Initially, there are some special pre-configured replication zones for internal system data along with a default replication zone that applies to the rest of the cluster. You can adjust these pre-configured zones as well as add zones for individual databases, tables, and rows ([enterprise-only](enterprise-licensing.html)) as needed. For example, you might use the default zone to replicate most data in a cluster normally within a single datacenter, while creating a specific zone to more highly replicate a certain database or table across multiple datacenters and geographies.
@@ -11,7 +11,6 @@ This page explains how replication zones work and how to use the `cockroach zone
{{site.data.alerts.callout_info}}Currently, only the root user can configure replication zones.{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.0/connection-parameters.md b/v2.0/connection-parameters.md
index 44d754c7b4f..cdf53138b83 100644
--- a/v2.0/connection-parameters.md
+++ b/v2.0/connection-parameters.md
@@ -1,7 +1,7 @@
---
title: Client Connection Parameters
summary: This page describes the parameters used to establish a client connection.
-toc: false
+toc: true
---
Client applications, including client [`cockroach`
@@ -10,7 +10,6 @@ connection to a CockroachDB cluster. The client connection parameters
determine which CockroachDB cluster they connect to, and how to
establish this network connection.
-
## Supported Connection Parameters
diff --git a/v2.0/constraints.md b/v2.0/constraints.md
index c03fd8eeef0..9a6392d832d 100644
--- a/v2.0/constraints.md
+++ b/v2.0/constraints.md
@@ -1,14 +1,13 @@
---
title: Constraints
summary: Constraints offer additional data integrity by enforcing conditions on the data within a column.
-toc: false
+toc: true
---
Constraints offer additional data integrity by enforcing conditions on the data within a column. Whenever values are manipulated (inserted, deleted, or updated), constraints are checked and modifications that violate constraints are rejected.
For example, the Unique constraint requires that all values in a column be unique from one another (except *NULL* values). If you attempt to write a duplicate value, the constraint rejects the entire statement.
-
## Supported Constraints
diff --git a/v2.0/contribute-to-cockroachdb.md b/v2.0/contribute-to-cockroachdb.md
index 4b76624d5fb..9af5c2c67e5 100644
--- a/v2.0/contribute-to-cockroachdb.md
+++ b/v2.0/contribute-to-cockroachdb.md
@@ -1,12 +1,11 @@
---
title: Contribute to CockroachDB
summary: Contribute to the development of CockroachDB.
-toc: false
+toc: true
---
We made CockroachDB open source to empower developers to fix and extend the product to better meet their needs. Nothing thrills us more than people so passionate about the product that they‘re willing to spend their own time to learn the codebase and give back to the community. We created this doc so we can support contributors in a way that doesn’t sacrifice precious bandwidth that we use to serve our users and otherwise meet our business goals.
-
## Introduction
diff --git a/v2.0/create-a-file-server.md b/v2.0/create-a-file-server.md
index 1a7102950a6..c2ea71cfe7b 100644
--- a/v2.0/create-a-file-server.md
+++ b/v2.0/create-a-file-server.md
@@ -1,7 +1,7 @@
---
title: Create a File Server for Imports and Backups
summary: Learn how to create a simple file server for use with CockroachDB IMPORT and BACKUP
-toc: false
+toc: true
---
If you need a location to store files for the [`IMPORT`](import.html) process or [CockroachDB enterprise backups](backup.html), but don't have access to (or simply can't use) cloud storage providers, you can easily create your own file server. You can then use this file server by leveraging support for our HTTP Export Storage API.
@@ -11,7 +11,6 @@ This is especially useful for:
- Implementing a compatibility layer in front of custom or proprietary storage providers for which CockroachDB does not yet have native support
- Using on-premises storage
-
## HTTP Export Storage API
diff --git a/v2.0/create-and-manage-users.md b/v2.0/create-and-manage-users.md
index 6d8d862a283..cfb69ac8314 100644
--- a/v2.0/create-and-manage-users.md
+++ b/v2.0/create-and-manage-users.md
@@ -1,14 +1,13 @@
---
title: Manage Users
summary: To create and manage your cluster's users (which lets you control SQL-level privileges), use the cockroach user command with appropriate flags.
-toc: false
+toc: true
---
To create, manage, and remove your cluster's users (which lets you control SQL-level [privileges](privileges.html)), use the `cockroach user` [command](cockroach-commands.html) with appropriate flags.
{{site.data.alerts.callout_success}}You can also use the CREATE USER and DROP USER statements to create and remove users.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.0/create-database.md b/v2.0/create-database.md
index 93946cc404b..aae9f6d8855 100644
--- a/v2.0/create-database.md
+++ b/v2.0/create-database.md
@@ -1,12 +1,11 @@
---
title: CREATE DATABASE
summary: The CREATE DATABASE statement creates a new CockroachDB database.
-toc: false
+toc: true
---
The `CREATE DATABASE` [statement](sql-statements.html) creates a new CockroachDB database.
-
## Required Privileges
diff --git a/v2.0/create-index.md b/v2.0/create-index.md
old mode 100755
new mode 100644
index fd3a79afaf2..4f58b36a6c2
--- a/v2.0/create-index.md
+++ b/v2.0/create-index.md
@@ -1,7 +1,7 @@
---
title: CREATE INDEX
summary: The CREATE INDEX statement creates an index for a table. Indexes improve your database's performance by helping SQL quickly locate data.
-toc: false
+toc: true
---
The `CREATE INDEX` [statement](sql-statements.html) creates an index for a table. [Indexes](indexes.html) improve your database's performance by helping SQL locate data without having to look through every row of a table.
@@ -10,7 +10,6 @@ The `CREATE INDEX` [statement](sql-statements.html) creates an index for a table
{{site.data.alerts.callout_info}}Indexes are automatically created for a table's PRIMARY KEY and UNIQUE columns.When querying a table, CockroachDB uses the fastest index. For more information about that process, see Index Selection in CockroachDB.{{site.data.alerts.end}} - ## Required Privileges diff --git a/v2.0/create-role.md b/v2.0/create-role.md index 9cf9b75d400..8c09a0ba148 100644 --- a/v2.0/create-role.md +++ b/v2.0/create-role.md @@ -1,14 +1,13 @@ --- title: CREATE ROLE (Enterprise) summary: The CREATE ROLE statement creates SQL roles, which are groups containing any number of roles and users as members. -toc: false +toc: true --- New in v2.0: The `CREATE ROLE` [statement](sql-statements.html) creates SQL [roles](roles.html), which are groups containing any number of roles and users as members. You can assign privileges to roles, and all members of the role (regardless of whether if they are direct or indirect members) will inherit the role's privileges. {{site.data.alerts.callout_info}}
CREATE ROLE is an enterprise-only feature.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.0/create-security-certificates-openssl.md b/v2.0/create-security-certificates-openssl.md
index 547b6cef8a6..a8f6e53a740 100644
--- a/v2.0/create-security-certificates-openssl.md
+++ b/v2.0/create-security-certificates-openssl.md
@@ -1,7 +1,7 @@
---
title: Create Security Certificates
summary: A secure CockroachDB cluster uses TLS for encrypted inter-node and client-node communication.
-toc: false
+toc: true
---
@@ -11,7 +11,6 @@ toc: false
A secure CockroachDB cluster uses [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) for encrypted inter-node and client-node communication, which requires CA, node, and client certificates and keys. To create these certificates and keys, use the `cockroach cert` [commands](cockroach-commands.html) with the appropriate subcommands and flags, or use [`openssl` commands](https://wiki.openssl.org/index.php/).
-
## Subcommands
diff --git a/v2.0/create-security-certificates.md b/v2.0/create-security-certificates.md
index 97cc855e316..b8c795edc33 100644
--- a/v2.0/create-security-certificates.md
+++ b/v2.0/create-security-certificates.md
@@ -1,7 +1,7 @@
---
title: Create Security Certificates
summary: A secure CockroachDB cluster uses TLS for encrypted inter-node and client-node communication.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ A secure CockroachDB cluster uses [TLS](https://en.wikipedia.org/wiki/Transport_
{{site.data.alerts.callout_success}}For details about when and how to change security certificates without restarting nodes, see Rotate Security Certificates.{{site.data.alerts.end}}
-
## How Security Certificates Work
diff --git a/v2.0/create-sequence.md b/v2.0/create-sequence.md
index f00d196b29f..1f25b0a3800 100644
--- a/v2.0/create-sequence.md
+++ b/v2.0/create-sequence.md
@@ -1,12 +1,11 @@
---
title: CREATE SEQUENCE
summary:
-toc: false
+toc: true
---
New in v2.0: The `CREATE SEQUENCE` [statement](sql-statements.html) creates a new sequence in a database. Use a sequence to auto-increment integers in a table.
-
## Considerations
diff --git a/v2.0/create-table-as.md b/v2.0/create-table-as.md
index 332adf3e7a4..597e6a809b2 100644
--- a/v2.0/create-table-as.md
+++ b/v2.0/create-table-as.md
@@ -1,12 +1,11 @@
---
title: CREATE TABLE AS
summary: The CREATE TABLE AS statement persists the result of a query into the database for later reuse.
-toc: false
+toc: true
---
The `CREATE TABLE ... AS` statement creates a new table from a [selection query](selection-queries.html).
-
## Intended Use
diff --git a/v2.0/create-table.md b/v2.0/create-table.md
index 8946030ab52..81e6588875a 100644
--- a/v2.0/create-table.md
+++ b/v2.0/create-table.md
@@ -1,12 +1,11 @@
---
title: CREATE TABLE
summary: The CREATE TABLE statement creates a new table in a database.
-toc: false
+toc: true
---
The `CREATE TABLE` [statement](sql-statements.html) creates a new table in a database.
-
## Required Privileges
diff --git a/v2.0/create-user.md b/v2.0/create-user.md
index 8b29bb1f7ea..4d5c5055f2c 100644
--- a/v2.0/create-user.md
+++ b/v2.0/create-user.md
@@ -1,14 +1,13 @@
---
title: CREATE USER
summary: The CREATE USER statement creates SQL users, which let you control privileges on your databases and tables.
-toc: false
+toc: true
---
The `CREATE USER` [statement](sql-statements.html) creates SQL users, which let you control [privileges](privileges.html) on your databases and tables.
{{site.data.alerts.callout_success}}You can also use the 
-
## Set Up and Enable the Node Map
diff --git a/v2.0/enterprise-licensing.md b/v2.0/enterprise-licensing.md
index 316e0f8d959..b1bd12c3aef 100644
--- a/v2.0/enterprise-licensing.md
+++ b/v2.0/enterprise-licensing.md
@@ -1,14 +1,13 @@
---
title: Enterprise Licensing
summary: Request and set trial and enterprise license keys for CockroachDB
-toc: false
+toc: true
---
CockroachDB distributes a single binary that contains both core and [enterprise features](https://www.cockroachlabs.com/pricing/). You can use core features without any license key. However, to use the enterprise features, you need either a trial or an enterprise license key.
This page shows you how to obtain and set trial and enterprise license keys for CockroachDB.
-
## Types of Licenses
diff --git a/v2.0/experimental-audit.md b/v2.0/experimental-audit.md
index a4099522a3d..3e2b67aa3fe 100644
--- a/v2.0/experimental-audit.md
+++ b/v2.0/experimental-audit.md
@@ -1,7 +1,7 @@
---
title: EXPERIMENTAL_AUDIT
summary: Use the EXPERIMENTAL_AUDIT subcommand to turn SQL audit logging on or off for a table.
-toc: false
+toc: true
---
`EXPERIMENTAL_AUDIT` is a subcommand of [`ALTER TABLE`](alter-table.html) that is used to turn [SQL audit logging](sql-audit-logging.html) on or off for a table.
@@ -17,7 +17,6 @@ For a detailed description of exactly what is logged, see the [Audit Log File Fo
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Synopsis
diff --git a/v2.0/explain.md b/v2.0/explain.md
index 39d03bc9e8f..1a22a0cce68 100644
--- a/v2.0/explain.md
+++ b/v2.0/explain.md
@@ -1,12 +1,11 @@
---
title: EXPLAIN
summary: The EXPLAIN statement provides information you can use to optimize SQL queries.
-toc: false
+toc: true
---
The `EXPLAIN` [statement](sql-statements.html) returns CockroachDB's query plan for an [explainable statement](#explainable-statements). You can then use this information to optimize the query.
-
## Explainable Statements
diff --git a/v2.0/float.md b/v2.0/float.md
index 9eda22faaad..1734d9a2328 100644
--- a/v2.0/float.md
+++ b/v2.0/float.md
@@ -1,14 +1,13 @@
---
title: FLOAT
summary: The FLOAT data type stores inexact, floating-point numbers with up to 17 digits in total and at least one digit to the right of the decimal point.
-toc: false
+toc: true
---
CockroachDB supports various inexact, floating-point number [data types](data-types.html) with up to 17 digits of decimal precision.
They are handled internally using the [standard double-precision (64-bit binary-encoded) IEEE754 format](https://en.wikipedia.org/wiki/IEEE_floating_point).
-
## Names and Aliases
diff --git a/v2.0/foreign-key.md b/v2.0/foreign-key.md
index 2c37fe51948..8dc895ee74a 100644
--- a/v2.0/foreign-key.md
+++ b/v2.0/foreign-key.md
@@ -1,7 +1,7 @@
---
title: Foreign Key Constraint
summary: The Foreign Key constraint specifies a column can contain only values exactly matching existing values from the column it references.
-toc: false
+toc: true
---
The Foreign Key [constraint](constraints.html) specifies that all of a column's values must exactly match existing values from the column it references, enforcing referential integrity.
@@ -13,7 +13,6 @@ For example, if you create a foreign key on `orders.customer` that references `c
{{site.data.alerts.callout_success}}If you plan to use Foreign Keys in your schema, consider using interleaved tables, which can dramatically improve query performance.{{site.data.alerts.end}}
-
## Details
diff --git a/v2.0/frequently-asked-questions.md b/v2.0/frequently-asked-questions.md
index 31144eac46c..1eda02fcc8b 100644
--- a/v2.0/frequently-asked-questions.md
+++ b/v2.0/frequently-asked-questions.md
@@ -2,10 +2,9 @@
title: Frequently Asked Questions
summary: CockroachDB FAQ - What is CockroachDB? How does it work? What makes it different from other databases?
tags: postgres, cassandra, google cloud spanner
-toc: false
+toc: true
---
-
## What is CockroachDB?
diff --git a/v2.0/functions-and-operators.md b/v2.0/functions-and-operators.md
index 17407928c6d..d2542fda28a 100644
--- a/v2.0/functions-and-operators.md
+++ b/v2.0/functions-and-operators.md
@@ -1,14 +1,13 @@
---
title: Functions and Operators
summary: CockroachDB supports many built-in functions, aggregate functions, and operators.
-toc: false
+toc: true
---
CockroachDB supports the following SQL functions and operators for use in [scalar expressions](scalar-expressions.html).
{{site.data.alerts.callout_success}}In the built-in SQL shell, use statement grants user privileges for interacting with specific databases and tables.
-toc: false
+toc: true
---
New in v2.0: The `GRANT ` [statement](sql-statements.html) lets you add a [role](roles.html) or [user](create-and-manage-users.html) as a member to a role.
{{site.data.alerts.callout_info}}` [statement](sql-statements.html) lets you control each [role](roles.html) or [user's](create-and-manage-users.html) SQL [privileges](privileges.html) for interacting with specific databases and tables.
For privileges required by specific statements, see the documentation for the respective [SQL statement](sql-statements.html).
-
## Synopsis
diff --git a/v2.0/import-data.md b/v2.0/import-data.md
index 28530eb9188..518c272fa18 100644
--- a/v2.0/import-data.md
+++ b/v2.0/import-data.md
@@ -1,14 +1,13 @@
---
title: Import Data
summary: Learn how to import data into a CockroachDB cluster.
-toc: false
+toc: true
---
CockroachDB supports importing data from CSV/TSV or SQL dump files.
{{site.data.alerts.callout_info}}To import/restore data from CockroachDB-generated enterprise license backups, see
cockroach user set command to create and manage users.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.0/create-view.md b/v2.0/create-view.md
index 344b7672a41..dcaf796fdf8 100644
--- a/v2.0/create-view.md
+++ b/v2.0/create-view.md
@@ -1,12 +1,11 @@
---
title: CREATE VIEW
summary: The CREATE VIEW statement creates a .
-toc: false
+toc: true
---
The `CREATE VIEW` statement creates a new [view](views.html), which is a stored query represented as a virtual table.
-
## Required Privileges
diff --git a/v2.0/date.md b/v2.0/date.md
index 0a8e6956907..6a1a38999de 100644
--- a/v2.0/date.md
+++ b/v2.0/date.md
@@ -1,12 +1,11 @@
---
title: DATE
summary: The DATE data type stores a year, month, and day.
-toc: false
+toc: true
---
The `DATE` [data type](data-types.html) stores a year, month, and day.
-
## Syntax
diff --git a/v2.0/debug-and-error-logs.md b/v2.0/debug-and-error-logs.md
index 2f7458d59bf..18fe96a0f17 100644
--- a/v2.0/debug-and-error-logs.md
+++ b/v2.0/debug-and-error-logs.md
@@ -1,7 +1,7 @@
---
title: Understand Debug & Error Logs
summary: Learn how to find and read CockroachDB error logs
-toc: false
+toc: true
---
If you need to [troubleshoot](troubleshooting-overview.html) issues with your cluster, you can check a node's logs, which include details about certain node-level and range-level events, such as errors. For example, if CockroachDB crashes, it normally logs a stack trace to what caused the problem.
@@ -10,7 +10,6 @@ If you need to [troubleshoot](troubleshooting-overview.html) issues with your cl
For detailed information about queries being executed against your system, see [SQL Audit Logging](sql-audit-logging.html).
{{site.data.alerts.end}}
-
## Details
diff --git a/v2.0/debug-zip.md b/v2.0/debug-zip.md
index 058f867f021..6ce7457493a 100644
--- a/v2.0/debug-zip.md
+++ b/v2.0/debug-zip.md
@@ -1,7 +1,7 @@
---
title: Collect Debug Information from Your Cluster
summary: Learn the commands for collecting debug information from all nodes in your cluster.
-toc: false
+toc: true
---
The `debug zip` [command](cockroach-commands.html) connects to your cluster and gathers the following information from each active node into a single file (inactive nodes are not included):
@@ -17,7 +17,6 @@ The `debug zip` [command](cockroach-commands.html) connects to your cluster and
{{site.data.alerts.callout_danger}}The file produced by cockroach debug zip can contain highly sensitive, unanonymized information, such as usernames, passwords, and possibly your table's data. You should share this data only with Cockroach Labs developers and only after determining the most secure method of delivery.{{site.data.alerts.end}}
-
## Details
diff --git a/v2.0/decimal.md b/v2.0/decimal.md
index f72edb9ad00..ec6a5d0eb45 100644
--- a/v2.0/decimal.md
+++ b/v2.0/decimal.md
@@ -1,12 +1,11 @@
---
title: DECIMAL
summary: The DECIMAL data type stores exact, fixed-point numbers.
-toc: false
+toc: true
---
The `DECIMAL` [data type](data-types.html) stores exact, fixed-point numbers. This type is used when it is important to preserve exact precision, for example, with monetary data.
-
## Aliases
diff --git a/v2.0/default-value.md b/v2.0/default-value.md
index 2af0c380da3..c37dd778797 100644
--- a/v2.0/default-value.md
+++ b/v2.0/default-value.md
@@ -1,12 +1,11 @@
---
title: Default Value Constraint
summary: The Default Value constraint specifies a value to populate a column with if none is provided.
-toc: false
+toc: true
---
The Default Value [constraint](constraints.html) specifies a value to write into the constrained column if one is not defined in an `INSERT` statement. The value may be either a hard-coded literal or an expression that is evaluated at the time the row is created.
-
## Details
diff --git a/v2.0/delete.md b/v2.0/delete.md
index d8588869033..b7c914f0b89 100644
--- a/v2.0/delete.md
+++ b/v2.0/delete.md
@@ -1,7 +1,7 @@
---
title: DELETE
summary: The DELETE statement deletes rows from a table.
-toc: false
+toc: true
---
The `DELETE` [statement](sql-statements.html) deletes rows from a table.
@@ -10,7 +10,6 @@ The `DELETE` [statement](sql-statements.html) deletes rows from a table.
{{site.data.alerts.callout_info}}To delete columns, see DROP COLUMN.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/demo-automatic-cloud-migration.md b/v2.0/demo-automatic-cloud-migration.md
index 518dd10c932..a37823d9204 100644
--- a/v2.0/demo-automatic-cloud-migration.md
+++ b/v2.0/demo-automatic-cloud-migration.md
@@ -1,12 +1,11 @@
---
title: Cross-Cloud Migration
summary: Use a local cluster to simulate migrating from one cloud platform to another.
-toc: false
+toc: true
---
CockroachDB's flexible [replication controls](configure-replication-zones.html) make it trivially easy to run a single CockroachDB cluster across cloud platforms and to migrate data from one cloud to another without any service interruption. This page walks you through a local simulation of the process.
-
## Watch a Live Demo
diff --git a/v2.0/demo-automatic-rebalancing.md b/v2.0/demo-automatic-rebalancing.md
index 5449866cdf0..b63cb58b728 100644
--- a/v2.0/demo-automatic-rebalancing.md
+++ b/v2.0/demo-automatic-rebalancing.md
@@ -1,12 +1,11 @@
---
title: Automatic Rebalancing
summary: Use a local cluster to explore how CockroachDB automatically rebalances data as you scale.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB automatically rebalances data as you scale. Starting with a 3-node local cluster, you'll lower the maximum size for a single range, the unit of data that is replicated in CockroachDB. You'll then download and run the `block_writer` example program, which continuously inserts data into your cluster, and watch the replica count quickly increase as ranges split. You'll then add 2 more nodes and watch how CockroachDB automatically rebalances replicas to efficiently use all available capacity.
-
## Before You Begin
diff --git a/v2.0/demo-data-replication.md b/v2.0/demo-data-replication.md
index 4e535c8135a..3d73995e9ee 100644
--- a/v2.0/demo-data-replication.md
+++ b/v2.0/demo-data-replication.md
@@ -1,12 +1,11 @@
---
title: Data Replication
summary: Use a local cluster to explore how CockroachDB replicates and distributes data.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB replicates and distributes data. Starting with a 1-node local cluster, you'll write some data, add 2 nodes, and watch how the data is replicated automatically. You'll then update the cluster to replicate 5 ways, add 2 more nodes, and again watch how all existing replicas are re-replicated to the new nodes.
-
## Before You Begin
diff --git a/v2.0/demo-fault-tolerance-and-recovery.md b/v2.0/demo-fault-tolerance-and-recovery.md
index 7492d511ce8..7f5f919a97b 100644
--- a/v2.0/demo-fault-tolerance-and-recovery.md
+++ b/v2.0/demo-fault-tolerance-and-recovery.md
@@ -1,12 +1,11 @@
---
title: Fault Tolerance & Recovery
summary: Use a local cluster to explore how CockroachDB remains available during, and recovers after, failure.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB remains available during, and recovers after, failure. Starting with a 3-node local cluster, you'll remove a node and see how the cluster continues uninterrupted. You'll then write some data while the node is offline, rejoin the node, and see how it catches up with the rest of the cluster. Finally, you'll add a fourth node, remove a node again, and see how missing replicas eventually re-replicate to the new node.
-
## Before You Begin
diff --git a/v2.0/demo-follow-the-workload.md b/v2.0/demo-follow-the-workload.md
index 11c21f5e7f5..8b14c8e9c5d 100644
--- a/v2.0/demo-follow-the-workload.md
+++ b/v2.0/demo-follow-the-workload.md
@@ -1,12 +1,11 @@
---
title: Follow-the-Workload
summary: CockroachDB can dynamically optimize read latency for the location from which most of the workload is originating.
-toc: false
+toc: true
---
"Follow-the-workload" refers to CockroachDB's ability to dynamically optimize read latency for the location from which most of the workload is originating. This page explains how "follow-the-workload" works and walks you through a simple demonstration using a local cluster.
-
## Overview
diff --git a/v2.0/demo-json-support.md b/v2.0/demo-json-support.md
index bfe531511dd..8a2dd9c53f5 100644
--- a/v2.0/demo-json-support.md
+++ b/v2.0/demo-json-support.md
@@ -1,12 +1,11 @@
---
title: JSON Support
summary: Use a local cluster to explore how CockroachDB can store and query unstructured JSONB data.
-toc: false
+toc: true
---
New in v2.0: This page walks you through a simple demonstration of how CockroachDB can store and query unstructured [`JSONB`](jsonb.html) data from a third-party API, as well as how an [inverted index](inverted-indexes.html) can optimize your queries.
-
## Step 1. Install prerequisites
diff --git a/v2.0/deploy-a-test-cluster.md b/v2.0/deploy-a-test-cluster.md
index 1b352937920..8f657cb61a1 100644
--- a/v2.0/deploy-a-test-cluster.md
+++ b/v2.0/deploy-a-test-cluster.md
@@ -1,14 +1,13 @@
---
title: Deploy a Test Cluster
summary: Use CockroachDB's CloudFormation template to deploy a Kubernetes-orchestrated test cluster on AWS.
-toc: false
+toc: true
---
This page shows you the easiest way to test an insecure, multi-node CockroachDB cluster, using CockroachDB's [AWS CloudFormation](https://aws.amazon.com/cloudformation/) template to simplify setup and [Kubernetes](https://kubernetes.io/) to automate deployment, maintenance, and load balancing of client workloads.
-
## Before You Begin
diff --git a/v2.0/deploy-cockroachdb-on-aws-insecure.md b/v2.0/deploy-cockroachdb-on-aws-insecure.md
index c1583ca827a..29201221afe 100644
--- a/v2.0/deploy-cockroachdb-on-aws-insecure.md
+++ b/v2.0/deploy-cockroachdb-on-aws-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on AWS EC2 (Insecure)
summary: Learn how to deploy CockroachDB on Amazon's AWS EC2 platform.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-aws.md b/v2.0/deploy-cockroachdb-on-aws.md
index 3c65db990f8..37a589be60f 100644
--- a/v2.0/deploy-cockroachdb-on-aws.md
+++ b/v2.0/deploy-cockroachdb-on-aws.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on AWS EC2
summary: Learn how to deploy CockroachDB on Amazon's AWS EC2 platform.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-digital-ocean-insecure.md b/v2.0/deploy-cockroachdb-on-digital-ocean-insecure.md
index a076251c203..e1cd4c1e948 100644
--- a/v2.0/deploy-cockroachdb-on-digital-ocean-insecure.md
+++ b/v2.0/deploy-cockroachdb-on-digital-ocean-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Digital Ocean (Insecure)
summary: Learn how to deploy CockroachDB on Digital Ocean.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-connect-to-your-droplet-with-ssh
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-digital-ocean.md b/v2.0/deploy-cockroachdb-on-digital-ocean.md
index 56628af641b..d45f23585a6 100644
--- a/v2.0/deploy-cockroachdb-on-digital-ocean.md
+++ b/v2.0/deploy-cockroachdb-on-digital-ocean.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Digital Ocean
summary: Learn how to deploy CockroachDB on Digital Ocean.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-connect-to-your-droplet-with-ssh
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-google-cloud-platform-insecure.md b/v2.0/deploy-cockroachdb-on-google-cloud-platform-insecure.md
index 1e3d551998a..322697d3c47 100644
--- a/v2.0/deploy-cockroachdb-on-google-cloud-platform-insecure.md
+++ b/v2.0/deploy-cockroachdb-on-google-cloud-platform-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Google Cloud Platform GCE (Insecure)
summary: Learn how to deploy CockroachDB on Google Cloud Platform's Compute Engine.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://cloud.google.com/compute/docs/instances/connecting-to-instance
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-google-cloud-platform.md b/v2.0/deploy-cockroachdb-on-google-cloud-platform.md
index 6cffc081e84..112a1b0edfb 100644
--- a/v2.0/deploy-cockroachdb-on-google-cloud-platform.md
+++ b/v2.0/deploy-cockroachdb-on-google-cloud-platform.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Google Cloud Platform GCE
summary: Learn how to deploy CockroachDB on Google Cloud Platform's Compute Engine.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://cloud.google.com/compute/docs/instances/connecting-to-instance
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-microsoft-azure-insecure.md b/v2.0/deploy-cockroachdb-on-microsoft-azure-insecure.md
index 44e045d7076..1c5b081a022 100644
--- a/v2.0/deploy-cockroachdb-on-microsoft-azure-insecure.md
+++ b/v2.0/deploy-cockroachdb-on-microsoft-azure-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Microsoft Azure (Insecure)
summary: Learn how to deploy CockroachDB on Microsoft Azure.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-microsoft-azure.md b/v2.0/deploy-cockroachdb-on-microsoft-azure.md
index 6f6f22eca0d..aadd0701001 100644
--- a/v2.0/deploy-cockroachdb-on-microsoft-azure.md
+++ b/v2.0/deploy-cockroachdb-on-microsoft-azure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Microsoft Azure
summary: Learn how to deploy CockroachDB on Microsoft Azure.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-premises-insecure.md b/v2.0/deploy-cockroachdb-on-premises-insecure.md
index a83d04d7c0b..cf454d25331 100644
--- a/v2.0/deploy-cockroachdb-on-premises-insecure.md
+++ b/v2.0/deploy-cockroachdb-on-premises-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB On-Premises (Insecure)
summary: Learn how to manually deploy an insecure, multi-node CockroachDB cluster on multiple machines.
-toc: false
+toc: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys--2
redirect_from: manual-deployment-insecure.html
---
@@ -15,7 +15,6 @@ This tutorial shows you how to manually deploy an insecure multi-node CockroachD
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.0/deploy-cockroachdb-on-premises.md b/v2.0/deploy-cockroachdb-on-premises.md
index 68d9ec8413b..8e8b6bd90fa 100644
--- a/v2.0/deploy-cockroachdb-on-premises.md
+++ b/v2.0/deploy-cockroachdb-on-premises.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB On-Premises
summary: Learn how to manually deploy a secure, multi-node CockroachDB cluster on multiple machines.
-toc: false
+toc: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys--2
---
@@ -14,7 +14,6 @@ This tutorial shows you how to manually deploy a secure multi-node CockroachDB c
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.0/diagnostics-reporting.md b/v2.0/diagnostics-reporting.md
index dae56597b0c..031f1ffd3f0 100644
--- a/v2.0/diagnostics-reporting.md
+++ b/v2.0/diagnostics-reporting.md
@@ -1,7 +1,7 @@
---
title: Diagnostics Reporting
summary: Learn about the diagnostic details that get shared with CockroachDB and how to opt out of sharing.
-toc: false
+toc: true
---
By default, the Admin UI and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
@@ -10,7 +10,6 @@ This page explains the details that get shared and how to opt out of sharing.
{{site.data.alerts.callout_success}}For insights into your cluster's performance and health, use the built-in Admin UI or a third-party monitoring tool like Prometheus.{{site.data.alerts.end}}
-
## What Gets Shared
diff --git a/v2.0/drop-column.md b/v2.0/drop-column.md
index 84dce89dc43..886dada09cc 100644
--- a/v2.0/drop-column.md
+++ b/v2.0/drop-column.md
@@ -1,12 +1,11 @@
---
title: DROP COLUMN
summary: Use the ALTER COLUMN statement to remove columns from tables.
-toc: false
+toc: true
---
The `DROP COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and removes columns from a table.
-
## Synopsis
diff --git a/v2.0/drop-constraint.md b/v2.0/drop-constraint.md
index 01e75bb2f95..a31e329fc71 100644
--- a/v2.0/drop-constraint.md
+++ b/v2.0/drop-constraint.md
@@ -1,14 +1,13 @@
---
title: DROP CONSTRAINT
summary: Use the ALTER CONSTRAINT statement to remove constraints from columns.
-toc: false
+toc: true
---
The `DROP CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and removes Check and Foreign Key constraints from columns.
{{site.data.alerts.callout_info}}For information about removing other constraints, see Constraints: Remove Constraints.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/drop-database.md b/v2.0/drop-database.md
index cca65bb1693..2fb57e28ae8 100644
--- a/v2.0/drop-database.md
+++ b/v2.0/drop-database.md
@@ -1,12 +1,11 @@
---
title: DROP DATABASE
summary: The DROP DATABASE statement removes a database and all its objects from a CockroachDB cluster.
-toc: false
+toc: true
---
The `DROP DATABASE` [statement](sql-statements.html) removes a database and all its objects from a CockroachDB cluster.
-
## Required Privileges
diff --git a/v2.0/drop-index.md b/v2.0/drop-index.md
index 9aee42433f2..6e447129cea 100644
--- a/v2.0/drop-index.md
+++ b/v2.0/drop-index.md
@@ -1,12 +1,11 @@
---
title: DROP INDEX
summary: The DROP INDEX statement removes indexes from tables.
-toc: false
+toc: true
---
The `DROP INDEX` [statement](sql-statements.html) removes indexes from tables.
-
## Synopsis
diff --git a/v2.0/drop-role.md b/v2.0/drop-role.md
index af8ca58c2a6..8f94dd4b84f 100644
--- a/v2.0/drop-role.md
+++ b/v2.0/drop-role.md
@@ -1,14 +1,13 @@
---
title: DROP ROLE (Enterprise)
summary: The DROP ROLE statement removes one or more SQL roles.
-toc: false
+toc: true
---
New in v2.0: The `DROP ROLE` [statement](sql-statements.html) removes one or more SQL roles.
{{site.data.alerts.callout_info}}DROP ROLE is an enterprise-only feature.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.0/drop-sequence.md b/v2.0/drop-sequence.md
index 6e96fbffa56..39a16f8d1da 100644
--- a/v2.0/drop-sequence.md
+++ b/v2.0/drop-sequence.md
@@ -1,12 +1,11 @@
---
title: DROP SEQUENCE
summary:
-toc: false
+toc: true
---
New in v2.0: The `DROP SEQUENCE` [statement](sql-statements.html) removes a sequence from a database.
-
## Required Privileges
diff --git a/v2.0/drop-table.md b/v2.0/drop-table.md
index 07aaa5ace81..7f4105f8048 100644
--- a/v2.0/drop-table.md
+++ b/v2.0/drop-table.md
@@ -1,12 +1,11 @@
---
title: DROP TABLE
summary: The DROP TABLE statement removes a table and all its indexes from a database.
-toc: false
+toc: true
---
The `DROP TABLE` [statement](sql-statements.html) removes a table and all its indexes from a database.
-
## Required Privileges
diff --git a/v2.0/drop-user.md b/v2.0/drop-user.md
index 48d48709bf2..fb5a771fd99 100644
--- a/v2.0/drop-user.md
+++ b/v2.0/drop-user.md
@@ -1,14 +1,13 @@
---
title: DROP USER
summary: The DROP USER statement removes one or more SQL users.
-toc: false
+toc: true
---
New in v1.1: The `DROP USER` [statement](sql-statements.html) removes one or more SQL users.
{{site.data.alerts.callout_success}}You can also use the cockroach user rm command to remove users.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/drop-view.md b/v2.0/drop-view.md
index 943d7d79777..dc209cfc1a9 100644
--- a/v2.0/drop-view.md
+++ b/v2.0/drop-view.md
@@ -1,12 +1,11 @@
---
title: DROP VIEW
summary: The DROP VIEW statement removes a view from a database.
-toc: false
+toc: true
---
The `DROP VIEW` [statement](sql-statements.html) removes a [view](views.html) from a database.
-
## Required Privileges
diff --git a/v2.0/enable-node-map.md b/v2.0/enable-node-map.md
index ccba51ed7b0..1a39aef0a3a 100644
--- a/v2.0/enable-node-map.md
+++ b/v2.0/enable-node-map.md
@@ -1,7 +1,7 @@
---
title: Enable the Node Map
summary: Learn how to enable the node map in the Admin UI.
-toc: false
+toc: true
---
New in v2.0 The **Node Map** visualizes the geographical configuration of a multi-regional cluster by plotting the node localities on a world map. The **Node Map** also provides real-time cluster metrics, with the ability to drill down to individual nodes to monitor and troubleshoot the cluster health and performance.
@@ -12,7 +12,6 @@ This page walks you through the process of setting up and enabling the **Node Ma
-
## Set Up and Enable the Node Map
diff --git a/v2.0/enterprise-licensing.md b/v2.0/enterprise-licensing.md
index 316e0f8d959..b1bd12c3aef 100644
--- a/v2.0/enterprise-licensing.md
+++ b/v2.0/enterprise-licensing.md
@@ -1,14 +1,13 @@
---
title: Enterprise Licensing
summary: Request and set trial and enterprise license keys for CockroachDB
-toc: false
+toc: true
---
CockroachDB distributes a single binary that contains both core and [enterprise features](https://www.cockroachlabs.com/pricing/). You can use core features without any license key. However, to use the enterprise features, you need either a trial or an enterprise license key.
This page shows you how to obtain and set trial and enterprise license keys for CockroachDB.
-
## Types of Licenses
diff --git a/v2.0/experimental-audit.md b/v2.0/experimental-audit.md
index a4099522a3d..3e2b67aa3fe 100644
--- a/v2.0/experimental-audit.md
+++ b/v2.0/experimental-audit.md
@@ -1,7 +1,7 @@
---
title: EXPERIMENTAL_AUDIT
summary: Use the EXPERIMENTAL_AUDIT subcommand to turn SQL audit logging on or off for a table.
-toc: false
+toc: true
---
`EXPERIMENTAL_AUDIT` is a subcommand of [`ALTER TABLE`](alter-table.html) that is used to turn [SQL audit logging](sql-audit-logging.html) on or off for a table.
@@ -17,7 +17,6 @@ For a detailed description of exactly what is logged, see the [Audit Log File Fo
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Synopsis
diff --git a/v2.0/explain.md b/v2.0/explain.md
index 39d03bc9e8f..1a22a0cce68 100644
--- a/v2.0/explain.md
+++ b/v2.0/explain.md
@@ -1,12 +1,11 @@
---
title: EXPLAIN
summary: The EXPLAIN statement provides information you can use to optimize SQL queries.
-toc: false
+toc: true
---
The `EXPLAIN` [statement](sql-statements.html) returns CockroachDB's query plan for an [explainable statement](#explainable-statements). You can then use this information to optimize the query.
-
## Explainable Statements
diff --git a/v2.0/float.md b/v2.0/float.md
index 9eda22faaad..1734d9a2328 100644
--- a/v2.0/float.md
+++ b/v2.0/float.md
@@ -1,14 +1,13 @@
---
title: FLOAT
summary: The FLOAT data type stores inexact, floating-point numbers with up to 17 digits in total and at least one digit to the right of the decimal point.
-toc: false
+toc: true
---
CockroachDB supports various inexact, floating-point number [data types](data-types.html) with up to 17 digits of decimal precision.
They are handled internally using the [standard double-precision (64-bit binary-encoded) IEEE754 format](https://en.wikipedia.org/wiki/IEEE_floating_point).
-
## Names and Aliases
diff --git a/v2.0/foreign-key.md b/v2.0/foreign-key.md
index 2c37fe51948..8dc895ee74a 100644
--- a/v2.0/foreign-key.md
+++ b/v2.0/foreign-key.md
@@ -1,7 +1,7 @@
---
title: Foreign Key Constraint
summary: The Foreign Key constraint specifies a column can contain only values exactly matching existing values from the column it references.
-toc: false
+toc: true
---
The Foreign Key [constraint](constraints.html) specifies that all of a column's values must exactly match existing values from the column it references, enforcing referential integrity.
@@ -13,7 +13,6 @@ For example, if you create a foreign key on `orders.customer` that references `c
{{site.data.alerts.callout_success}}If you plan to use Foreign Keys in your schema, consider using interleaved tables, which can dramatically improve query performance.{{site.data.alerts.end}}
-
## Details
diff --git a/v2.0/frequently-asked-questions.md b/v2.0/frequently-asked-questions.md
index 31144eac46c..1eda02fcc8b 100644
--- a/v2.0/frequently-asked-questions.md
+++ b/v2.0/frequently-asked-questions.md
@@ -2,10 +2,9 @@
title: Frequently Asked Questions
summary: CockroachDB FAQ - What is CockroachDB? How does it work? What makes it different from other databases?
tags: postgres, cassandra, google cloud spanner
-toc: false
+toc: true
---
-
## What is CockroachDB?
diff --git a/v2.0/functions-and-operators.md b/v2.0/functions-and-operators.md
index 17407928c6d..d2542fda28a 100644
--- a/v2.0/functions-and-operators.md
+++ b/v2.0/functions-and-operators.md
@@ -1,14 +1,13 @@
---
title: Functions and Operators
summary: CockroachDB supports many built-in functions, aggregate functions, and operators.
-toc: false
+toc: true
---
CockroachDB supports the following SQL functions and operators for use in [scalar expressions](scalar-expressions.html).
{{site.data.alerts.callout_success}}In the built-in SQL shell, use \hf [function] to get inline help about a specific function.{{site.data.alerts.end}}
-
## Special Syntax Forms
diff --git a/v2.0/generate-cockroachdb-resources.md b/v2.0/generate-cockroachdb-resources.md
index 59a2c7f9e8e..ddf31b0d92b 100644
--- a/v2.0/generate-cockroachdb-resources.md
+++ b/v2.0/generate-cockroachdb-resources.md
@@ -1,12 +1,11 @@
---
title: Generate CockroachDB Resources
summary: Use cockroach gen to generate command-line interface utlities, such as man pages, and example data.
-toc: false
+toc: true
---
The `cockroach gen` command can generate command-line interface (CLI) utilities ([`man` pages](https://en.wikipedia.org/wiki/Man_page) and a`bash` autocompletion script), example SQL data suitable to populate test databases, and an HAProxy configuration file for load balancing a running cluster.
-
## Subcommands
diff --git a/v2.0/grant-roles.md b/v2.0/grant-roles.md
index 1f690e117c5..d6851224bcd 100644
--- a/v2.0/grant-roles.md
+++ b/v2.0/grant-roles.md
@@ -1,14 +1,13 @@
---
title: GRANT <roles>
summary: The GRANT GRANT <roles> is an enterprise-only feature.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/grant.md b/v2.0/grant.md
index 36d66bbc50b..47ccf9c5903 100644
--- a/v2.0/grant.md
+++ b/v2.0/grant.md
@@ -1,14 +1,13 @@
---
title: GRANT <privileges>
summary: The GRANT statement grants user privileges for interacting with specific databases and tables.
-toc: false
+toc: true
---
The `GRANT RESTORE.{{site.data.alerts.end}}
-
## Import from Tabular Data (CSV)
diff --git a/v2.0/import.md b/v2.0/import.md
index d225c0a1792..8fdf7f4b690 100644
--- a/v2.0/import.md
+++ b/v2.0/import.md
@@ -1,14 +1,13 @@
---
title: IMPORT
summary: Import CSV data into your CockroachDB cluster.
-toc: false
+toc: true
---
The `IMPORT` [statement](sql-statements.html) imports tabular data (e.g. CSVs) into a single table.
{{site.data.alerts.callout_info}}For details about importing SQL dumps, see Import Data.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.0/indexes.md b/v2.0/indexes.md
old mode 100755
new mode 100644
index e590aa87348..f94c4728e58
--- a/v2.0/indexes.md
+++ b/v2.0/indexes.md
@@ -1,13 +1,12 @@
---
title: Indexes
summary: Indexes improve your database's performance by helping SQL locate data without having to look through every row of a table.
-toc: false
+toc: true
toc_not_nested: true
---
Indexes improve your database's performance by helping SQL locate data without having to look through every row of a table.
-
## How Do Indexes Work?
diff --git a/v2.0/inet.md b/v2.0/inet.md
index fcddb70db9e..bdf367f76b0 100644
--- a/v2.0/inet.md
+++ b/v2.0/inet.md
@@ -1,11 +1,10 @@
---
title: INET
summary: The INET data type stores an IPv4 or IPv6 address.
-toc: false
+toc: true
---
New in v2.0: The `INET` [data type](data-types.html) stores an IPv4 or IPv6 address.
-
## Syntax
diff --git a/v2.0/information-schema.md b/v2.0/information-schema.md
index 0c302d50eaa..576bc670066 100644
--- a/v2.0/information-schema.md
+++ b/v2.0/information-schema.md
@@ -1,7 +1,7 @@
---
title: Information Schema
summary: The information_schema database contains read-only views that you can use for introspection into your database's tables, columns, indexes, and views.
-toc: false
+toc: true
---
CockroachDB provides a virtual schema called `information_schema` that contains information about your database's tables, columns, indexes, and views. This information can be used for introspection and reflection.
@@ -10,7 +10,6 @@ The definition of `information_schema` is part of the SQL standard and can there
{{site.data.alerts.callout_info}}The information_schema views typically represent objects that the current user has privilege to access. To ensure you can view all the objects in a database, access it as the root user.{{site.data.alerts.end}}
-
## Data Exposed by information_schema
diff --git a/v2.0/initialize-a-cluster.md b/v2.0/initialize-a-cluster.md
index 011528b24b4..1c6ee3ea7ef 100644
--- a/v2.0/initialize-a-cluster.md
+++ b/v2.0/initialize-a-cluster.md
@@ -1,14 +1,13 @@
---
title: Initialize a Cluster
summary: Perform a one-time-only initialization of a CockroachDB cluster.
-toc: false
+toc: true
---
New in v1.1: This page explains the `cockroach init` [command](cockroach-commands.html), which you use to perform a one-time initialization of a new multi-node cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials.
{{site.data.alerts.callout_info}}When starting a single-node cluster, you don't need to use the cockroach init command. You can simply run the cockroach start command without the --join flag to start and initialize the single-node cluster.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/insert.md b/v2.0/insert.md
index a94bf449142..e35d4097a11 100644
--- a/v2.0/insert.md
+++ b/v2.0/insert.md
@@ -1,12 +1,11 @@
---
title: INSERT
summary: The INSERT statement inserts one or more rows into a table.
-toc: false
+toc: true
---
The `INSERT` [statement](sql-statements.html) inserts one or more rows into a table. In cases where inserted values conflict with uniqueness constraints, the `ON CONFLICT` clause can be used to update rather than insert rows.
-
## Performance Best Practices
diff --git a/v2.0/int.md b/v2.0/int.md
index 919868e5cad..bc21c97573d 100644
--- a/v2.0/int.md
+++ b/v2.0/int.md
@@ -1,14 +1,13 @@
---
title: INT
summary: CockroachDB supports various signed integer data types.
-toc: false
+toc: true
---
CockroachDB supports various signed integer [data types](data-types.html).
{{site.data.alerts.callout_info}}To auto-generate globally unique values, use the UUID or SERIAL data type.{{site.data.alerts.end}}
-
## Names and Aliases
diff --git a/v2.0/interleave-in-parent.md b/v2.0/interleave-in-parent.md
index 853edc8f6c2..ee201ca423a 100644
--- a/v2.0/interleave-in-parent.md
+++ b/v2.0/interleave-in-parent.md
@@ -1,7 +1,7 @@
---
title: INTERLEAVE IN PARENT
summary: Interleaving tables improves query performance by optimizing the key-value structure of closely related table's data.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ Interleaving tables improves query performance by optimizing the key-value struc
{{site.data.alerts.callout_info}}Interleaving tables does not affect their behavior within SQL.{{site.data.alerts.end}}
-
## How Interleaved Tables Work
diff --git a/v2.0/interval.md b/v2.0/interval.md
index 26d93a7ca52..7f57dd36317 100644
--- a/v2.0/interval.md
+++ b/v2.0/interval.md
@@ -1,12 +1,11 @@
---
title: INTERVAL
summary: The INTERVAL data type stores a value that represents a span of time.
-toc: false
+toc: true
---
The `INTERVAL` [data type](data-types.html) stores a value that represents a span of time.
-
## Syntax
diff --git a/v2.0/inverted-indexes.md b/v2.0/inverted-indexes.md
index e9256a3e0e7..cc3150176ae 100644
--- a/v2.0/inverted-indexes.md
+++ b/v2.0/inverted-indexes.md
@@ -1,14 +1,13 @@
---
title: Inverted Indexes
summary: Inverted indexes improve your database's performance and usefulness by helping SQL locate schemaless data in a JSONB column.
-toc: false
+toc: true
---
New in v2.0: Inverted indexes improve your database's performance by helping SQL locate the schemaless data in a [`JSONB`](jsonb.html) column.
{{site.data.alerts.callout_success}}For a hands-on demonstration of using an inverted index to improve query performance on a JSONB column, see the JSON tutorial.{{site.data.alerts.end}}
-
## How Do Inverted Indexes Work?
diff --git a/v2.0/joins.md b/v2.0/joins.md
index b4eba70a041..9a333708397 100644
--- a/v2.0/joins.md
+++ b/v2.0/joins.md
@@ -1,7 +1,7 @@
---
title: Join Expressions
summary: Join expressions combine data from two or more table expressions.
-toc: false
+toc: true
---
Join expressions, also called "joins", combine the results of two or
@@ -9,7 +9,6 @@ more table expressions based on conditions on the values of particular columns.
Join expressions define a data source in the `FROM` sub-clause of [simple `SELECT` clauses](select-clause.html), or as parameter to [`TABLE`](selection-queries.html#table-clause). Joins are a particular kind of [table expression](table-expressions.html).
-
## Synopsis
diff --git a/v2.0/jsonb.md b/v2.0/jsonb.md
index 4c645deb230..f3d798145d0 100644
--- a/v2.0/jsonb.md
+++ b/v2.0/jsonb.md
@@ -1,14 +1,13 @@
---
title: JSONB
summary: The JSONB data type stores JSON (JavaScript Object Notation) data.
-toc: false
+toc: true
---
New in v2.0: The `JSONB` [data type](data-types.html) stores JSON (JavaScript Object Notation) data as a binary representation of the `JSONB` value, which eliminates whitespace, duplicate keys, and key ordering. `JSONB` supports [inverted indexes](inverted-indexes.html).
{{site.data.alerts.callout_success}}For a hands-on demonstration of storing and querying JSON data from a third-party API, see the JSON tutorial.{{site.data.alerts.end}}
-
## Alias
diff --git a/v2.0/known-limitations.md b/v2.0/known-limitations.md
index 0261a4b4626..c444652da22 100644
--- a/v2.0/known-limitations.md
+++ b/v2.0/known-limitations.md
@@ -1,12 +1,11 @@
---
title: Known Limitations in CockroachDB v2.0
summary: Known limitations in CockroachDB v2.0.
-toc: false
+toc: true
---
This page describes newly identified limitations in the CockroachDB v2.0 release as well as unresolved limitations identified in earlier releases.
-
## New Limitations
diff --git a/v2.0/learn-cockroachdb-sql.md b/v2.0/learn-cockroachdb-sql.md
index 89a98505111..5e7e8a92960 100644
--- a/v2.0/learn-cockroachdb-sql.md
+++ b/v2.0/learn-cockroachdb-sql.md
@@ -1,14 +1,13 @@
---
title: Learn CockroachDB SQL
summary: Learn some of the most essential CockroachDB SQL statements.
-toc: false
+toc: true
---
This page walks you through some of the most essential CockroachDB SQL statements. For a complete list and related details, see [SQL Statements](sql-statements.html).
{{site.data.alerts.callout_info}}CockroachDB aims to provide standard SQL with extensions, but some standard SQL functionality is not yet available. See our SQL Feature Support page for more details.{{site.data.alerts.end}}
-
## Create a Database
diff --git a/v2.0/limit-offset.md b/v2.0/limit-offset.md
index 47ddf32d186..a4a6432cce9 100644
--- a/v2.0/limit-offset.md
+++ b/v2.0/limit-offset.md
@@ -1,7 +1,7 @@
---
title: Limiting Query Results
summary: LIMIT and OFFSET restrict an operation to a few row.
-toc: false
+toc: true
---
The `LIMIT` and `OFFSET` clauses restrict the operation of:
@@ -10,7 +10,6 @@ The `LIMIT` and `OFFSET` clauses restrict the operation of:
as part of [`INSERT`](insert.html) or [`UPSERT`](upsert.html).
- [`UPDATE`](update.html) and [`DELETE`](delete.html) statements.
-
## Synopsis
diff --git a/v2.0/manage-long-running-queries.md b/v2.0/manage-long-running-queries.md
index cfed13cec23..66048ea1d5a 100644
--- a/v2.0/manage-long-running-queries.md
+++ b/v2.0/manage-long-running-queries.md
@@ -1,14 +1,13 @@
---
title: Manage Long-Running Queries
summary: Learn how to identify and cancel long-running queries.
-toc: false
+toc: true
---
This page shows you how to identify and, if necessary, cancel SQL queries that are taking longer than expected to process.
{{site.data.alerts.callout_info}}Schema changes (statements beginning with ALTER) cannot currently be cancelled. However, to monitor the progress of schema changes, you can use SHOW JOBS.{{site.data.alerts.end}}
-
## Identify Long-Running Queries
diff --git a/v2.0/monitor-cockroachdb-with-prometheus.md b/v2.0/monitor-cockroachdb-with-prometheus.md
index 640ccd3700c..9f1f3b74c72 100644
--- a/v2.0/monitor-cockroachdb-with-prometheus.md
+++ b/v2.0/monitor-cockroachdb-with-prometheus.md
@@ -1,14 +1,13 @@
---
title: Monitor CockroachDB with Prometheus
summary: Use Prometheus to monitor CockroachDB.
-toc: false
+toc: true
---
CockroachDB generates detailed time series metrics for each node in a cluster. This page shows you how to pull these metrics into [Prometheus](https://prometheus.io/), an open source tool for storing, aggregating, and querying time series data. It also shows you how to connect [Grafana](https://grafana.com/) and [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) to Prometheus for flexible data visualizations and notifications.
{{site.data.alerts.callout_success}}For details about other monitoring options, see Monitoring and Alerting. {{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/monitoring-and-alerting.md b/v2.0/monitoring-and-alerting.md
index 8da8f50e036..bdf3c0d6421 100644
--- a/v2.0/monitoring-and-alerting.md
+++ b/v2.0/monitoring-and-alerting.md
@@ -1,14 +1,13 @@
---
title: Monitoring and Alerting
summary: Monitor the health and performance of a cluster and alert on critical events and metrics.
-toc: false
+toc: true
---
Despite CockroachDB's various [built-in safeguards against failure](high-availability.html), it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention.
This page explains available monitoring tools and critical events and metrics to alert on.
-
## Monitoring Tools
diff --git a/v2.0/multi-active-availability.md b/v2.0/multi-active-availability.md
index d8716ea43ac..4d18cefce2f 100644
--- a/v2.0/multi-active-availability.md
+++ b/v2.0/multi-active-availability.md
@@ -1,12 +1,11 @@
---
title: Multi-Active Availability
summary: Learn about CockroachDB's high availability model, known as Multi-Active Availability.
-toc: false
+toc: true
---
CockroachDB's availability model is described as "Multi-Active Availability." In essence, multi-active availability provides benefits similar to traditional notions of high availability, but also lets you read and write from every node in your cluster without generating any conflicts.
-
## What is High Availability?
diff --git a/v2.0/not-null.md b/v2.0/not-null.md
index db851e83339..8ebd13239ed 100644
--- a/v2.0/not-null.md
+++ b/v2.0/not-null.md
@@ -1,12 +1,11 @@
---
title: Not Null Constraint
summary: The NOT NULL constraint specifies the column may not contain NULL values.
-toc: false
+toc: true
---
The Not Null [constraint](constraints.html) specifies a column may not contain *NULL* values.
-
## Details
diff --git a/v2.0/null-handling.md b/v2.0/null-handling.md
index 20c7cb82840..14d12dc2140 100644
--- a/v2.0/null-handling.md
+++ b/v2.0/null-handling.md
@@ -1,7 +1,7 @@
---
title: NULL Handling
summary: Learn how NULL values are handled in CockroachDB SQL.
-toc: false
+toc: true
---
This page summarizes how `NULL` values are handled in CockroachDB
@@ -10,7 +10,6 @@ client](use-the-built-in-sql-client.html).
{{site.data.alerts.callout_info}}When using the built-in client, NULL values are displayed using the word NULL. This distinguishes them from a character field that contains an empty string ("").{{site.data.alerts.end}}
-
## NULLs and Simple Comparisons
diff --git a/v2.0/operational-faqs.md b/v2.0/operational-faqs.md
index 822bb8a5b7b..063bb30f146 100644
--- a/v2.0/operational-faqs.md
+++ b/v2.0/operational-faqs.md
@@ -1,11 +1,10 @@
---
title: Operational FAQs
summary: Get answers to frequently asked questions about operating CockroachDB.
-toc: false
+toc: true
toc_not_nested: true
---
-
## Why is my process hanging when I try to start it in the background?
diff --git a/v2.0/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/v2.0/orchestrate-a-local-cluster-with-kubernetes-insecure.md
index 383c28950da..5403a588a1a 100644
--- a/v2.0/orchestrate-a-local-cluster-with-kubernetes-insecure.md
+++ b/v2.0/orchestrate-a-local-cluster-with-kubernetes-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestration
summary: Orchestrate the deployment and management of an local cluster using Kubernetes.
-toc: false
+toc: true
---
Other tutorials in this section feature the ways that CockroachDB automates operations for you. On top of this built-in automation, you can use a third-party [orchestration](orchestration.html) system to simplify and automate even more of your operations, from deployment to scaling to overall cluster management.
@@ -10,7 +10,6 @@ This page walks you through a simple demonstration, using the open-source Kubern
{{site.data.alerts.callout_info}}To orchestrate a physically distributed cluster in production, see Orchestrated Deployment.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/orchestrate-cockroachdb-with-docker-swarm-insecure.md b/v2.0/orchestrate-cockroachdb-with-docker-swarm-insecure.md
index 4ecc1dc6db5..4cd662a94a4 100644
--- a/v2.0/orchestrate-cockroachdb-with-docker-swarm-insecure.md
+++ b/v2.0/orchestrate-cockroachdb-with-docker-swarm-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Docker Swarm
summary: How to orchestrate the deployment and management of an insecure three-node CockroachDB cluster as a Docker swarm.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ This page shows you how to orchestrate the deployment and management of an insec
If you plan to use CockroachDB in production, we recommend using a secure cluster instead. Select **Secure** above for instructions.
-
## Before You Begin
diff --git a/v2.0/orchestrate-cockroachdb-with-docker-swarm.md b/v2.0/orchestrate-cockroachdb-with-docker-swarm.md
index feefbe832e3..4f175496db7 100644
--- a/v2.0/orchestrate-cockroachdb-with-docker-swarm.md
+++ b/v2.0/orchestrate-cockroachdb-with-docker-swarm.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Docker Swarm
summary: How to orchestrate the deployment and management of a secure three-node CockroachDB cluster as a Docker swarm.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ This page shows you how to orchestrate the deployment and management of a secure
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Before You Begin
diff --git a/v2.0/orchestrate-cockroachdb-with-kubernetes-insecure.md b/v2.0/orchestrate-cockroachdb-with-kubernetes-insecure.md
index cdce048fbce..9671af57783 100644
--- a/v2.0/orchestrate-cockroachdb-with-kubernetes-insecure.md
+++ b/v2.0/orchestrate-cockroachdb-with-kubernetes-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Kubernetes (Insecure)
summary: How to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with Kubernetes.
-toc: false
+toc: true
---
@@ -15,7 +15,6 @@ This page shows you how to orchestrate the deployment and management of an insec
{{site.data.alerts.callout_success}}For details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see CockroachDB Performance on Kubernetes.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/orchestrate-cockroachdb-with-kubernetes.md b/v2.0/orchestrate-cockroachdb-with-kubernetes.md
index b92af61b365..814cb813950 100644
--- a/v2.0/orchestrate-cockroachdb-with-kubernetes.md
+++ b/v2.0/orchestrate-cockroachdb-with-kubernetes.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Kubernetes
summary: How to orchestrate the deployment and management of a secure 3-node CockroachDB cluster with Kubernetes.
-toc: false
+toc: true
secure: true
---
@@ -16,7 +16,6 @@ If you are only testing CockroachDB, or you are not concerned with protecting ne
{{site.data.alerts.callout_success}}For details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see CockroachDB Performance on Kubernetes.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/orchestrate-cockroachdb-with-mesosphere-insecure.md b/v2.0/orchestrate-cockroachdb-with-mesosphere-insecure.md
index 3f656489299..f632ec224e9 100644
--- a/v2.0/orchestrate-cockroachdb-with-mesosphere-insecure.md
+++ b/v2.0/orchestrate-cockroachdb-with-mesosphere-insecure.md
@@ -1,14 +1,13 @@
---
title: Orchestrate CockroachDB with Mesosphere DC/OS (Insecure)
summary: How to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with Mesosphere DC/OS.
-toc: false
+toc: true
---
This page shows you how to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with [Mesosphere DC/OS](https://mesosphere.com/).
{{site.data.alerts.callout_danger}}Deploying an insecure cluster is not recommended for data in production. We'll update this page once it's possible to orchestrate a secure cluster with Mesosphere DC/OS.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/parallel-statement-execution.md b/v2.0/parallel-statement-execution.md
index a164e4bb235..299b97259e5 100644
--- a/v2.0/parallel-statement-execution.md
+++ b/v2.0/parallel-statement-execution.md
@@ -1,12 +1,11 @@
---
title: Parallel Statement Execution
summary: The parallel statement execution feature allows parallel execution of multiple independent SQL statements within a transaction.
-toc: false
+toc: true
---
CockroachDB supports parallel execution of [independent](parallel-statement-execution.html#when-to-use-parallel-statement-execution) [`INSERT`](insert.html), [`UPDATE`](update.html), [`UPSERT`](upsert.html), and [`DELETE`](delete.html) statements within a single [transaction](transactions.html). Executing statements in parallel helps reduce aggregate latency and improve performance.
-
## Why Use Parallel Statement Execution
diff --git a/v2.0/partition-by.md b/v2.0/partition-by.md
index ee067c2da55..9cc29ac7663 100644
--- a/v2.0/partition-by.md
+++ b/v2.0/partition-by.md
@@ -1,14 +1,13 @@
---
title: PARTITION BY
summary: Use the ALTER TABLE statement to define partitions and subpartitions, repartition, or unpartition a table.
-toc: false
+toc: true
---
New in v2.0 `PARTITION BY` is a subcommand of [`ALTER TABLE`](alter-table.html) that is used to define partitions and subpartitions on a table, and repartition or unpartition a table.
{{site.data.alerts.callout_info}}Defining table partitions is an enterprise-only feature.{{site.data.alerts.end}}
-
## Primary Key Requirements
diff --git a/v2.0/partitioning.md b/v2.0/partitioning.md
index b516e29106c..e0ba12f1077 100644
--- a/v2.0/partitioning.md
+++ b/v2.0/partitioning.md
@@ -1,14 +1,13 @@
---
title: Define Table Partitions
summary: Partitioning is an enterprise feature that gives you row-level control of how and where your data is stored.
-toc: false
+toc: true
---
New in v2.0 CockroachDB allows you to define table partitions, thus giving you row-level control of how and where your data is stored. Partitioning enables you to reduce latencies and costs and can assist in meeting regulatory requirements for your data.
{{site.data.alerts.callout_info}}Table partitioning is an enterprise-only feature.{{site.data.alerts.end}}
-
## Why Use Table Partitioning
diff --git a/v2.0/pause-job.md b/v2.0/pause-job.md
index c80bd3938aa..9a2c2a960aa 100644
--- a/v2.0/pause-job.md
+++ b/v2.0/pause-job.md
@@ -1,7 +1,7 @@
---
title: PAUSE JOB
summary: The PAUSE JOB statement lets you temporarily halt the process of potentially long-running jobs.
-toc: false
+toc: true
---
New in v1.1: The `PAUSE JOB` [statement](sql-statements.html) lets you pause [`BACKUP`](backup.html), [`RESTORE`](restore.html), and [`IMPORT`](import.html) jobs.
@@ -10,7 +10,6 @@ After pausing jobs, you can resume them with [`RESUME JOB`](resume-job.html).
{{site.data.alerts.callout_info}}You cannot pause schema changes.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/performance-benchmarking-with-tpc-c.md b/v2.0/performance-benchmarking-with-tpc-c.md
index 95106d201f8..408cac23678 100644
--- a/v2.0/performance-benchmarking-with-tpc-c.md
+++ b/v2.0/performance-benchmarking-with-tpc-c.md
@@ -1,7 +1,7 @@
---
title: Performance Benchmarking with TPC-C
summary: Learn how to benchmark CockroachDB against TPC-C.
-toc: false
+toc: true
---
This page walks you through [TPC-C](http://www.tpc.org/tpcc/) performance benchmarking on CockroachDB. It measures `tpmC` (new order transactions/minute) on two TPC-C datasets:
@@ -13,7 +13,6 @@ These two points on the spectrum show how CockroachDB scales from modest-sized p
-
## Benchmark a small cluster
diff --git a/v2.0/performance-best-practices-overview.md b/v2.0/performance-best-practices-overview.md
index 3cdb3d3dca6..9158972f755 100644
--- a/v2.0/performance-best-practices-overview.md
+++ b/v2.0/performance-best-practices-overview.md
@@ -1,12 +1,11 @@
---
title: SQL Performance Best Practices
summary: Best practices for optimizing SQL performance in CockroachDB.
-toc: false
+toc: true
---
This page provides best practices for optimizing SQL performance in CockroachDB.
-
## Multi-Row DML Best Practices
diff --git a/v2.0/porting-postgres.md b/v2.0/porting-postgres.md
index 2455861cdf6..e40c1de502a 100644
--- a/v2.0/porting-postgres.md
+++ b/v2.0/porting-postgres.md
@@ -1,7 +1,7 @@
---
title: Porting from PostgreSQL
summary: Porting an application from PostgreSQL
-toc: false
+toc: true
---
Although CockroachDB supports PostgreSQL syntax and drivers, it does not offer exact compatibility. This page documents the known list of differences between PostgreSQL and CockroachDB for identical input. That is, a SQL statement of the type listed here will behave differently than in PostgreSQL. Porting an existing application to CockroachDB will require changing these expressions.
@@ -10,7 +10,6 @@ Note that some of these differences only apply to rare inputs, and so no change
{{site.data.alerts.callout_info}}This document currently only covers how to rewrite SQL expressions. It does not discuss strategies for porting applications that use SQL features CockroachDB does not currently support, such as the statement revokes privileges from users and/or roles.
-toc: false
+toc: true
---
New in v2.0: The `REVOKE ` [statement](sql-statements.html) lets you revoke a [role](roles.html) or [user's](create-and-manage-users.html) membership to a role.
{{site.data.alerts.callout_info}}` [statement](sql-statements.html) revokes [privileges](privileges.html) from [users](create-and-manage-users.html) and/or [roles](roles.html).
For the list of privileges that can be granted to and revoked from users and roles, see [`GRANT`](grant.html).
-
## Synopsis
diff --git a/v2.0/roles.md b/v2.0/roles.md
index 3f6c512c0fd..249ea760a56 100644
--- a/v2.0/roles.md
+++ b/v2.0/roles.md
@@ -1,7 +1,7 @@
---
title: Manage Roles
summary: Roles are SQL groups that contain any number of users and roles as members.
-toc: false
+toc: true
---
New in v2.0: Roles are SQL groups that contain any number of users and roles as members. To create and manage your cluster's roles, use the following statements:
@@ -15,7 +15,6 @@ toc: false
- [`SHOW ROLES`](show-roles.html)
- [`SHOW GRANTS`](show-grants.html)
-
## Terminology
diff --git a/v2.0/rollback-transaction.md b/v2.0/rollback-transaction.md
index bdc231308fd..fe650d36ca3 100644
--- a/v2.0/rollback-transaction.md
+++ b/v2.0/rollback-transaction.md
@@ -1,14 +1,13 @@
---
title: ROLLBACK
summary: Abort the current transaction, discarding all updates made by statements included in the transaction with the ROLLBACK statement in CockroachDB.
-toc: false
+toc: true
---
The `ROLLBACK` [statement](sql-statements.html) aborts the current [transaction](transactions.html), discarding all updates made by statements included in the transaction.
When using [client-side transaction retries](transactions.html#client-side-transaction-retries), use `ROLLBACK TO SAVEPOINT cockroach_restart` to handle a transaction that needs to be retried (identified via the `40001` error code or `retry transaction` string in the error message), and then re-execute the statements you want the transaction to contain.
-
## Synopsis
diff --git a/v2.0/rotate-certificates.md b/v2.0/rotate-certificates.md
index d59010b45b1..4adaff27816 100644
--- a/v2.0/rotate-certificates.md
+++ b/v2.0/rotate-certificates.md
@@ -1,7 +1,7 @@
---
title: Rotate Security Certificates
summary: Rotate the security certificates of a secure CockroachDB cluster by creating and reloading new certificates.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ toc_not_nested: true
{{site.data.alerts.callout_success}}For an introduction to how security certificates work in a secure CockroachDB cluster, see Create Security Certificates.{{site.data.alerts.end}}
-
## When to Rotate Certificates
diff --git a/v2.0/savepoint.md b/v2.0/savepoint.md
index b6fc57bdaf2..02d8ef33685 100644
--- a/v2.0/savepoint.md
+++ b/v2.0/savepoint.md
@@ -1,14 +1,13 @@
---
title: SAVEPOINT
summary: Identify your intent to retry aborted transactions with the SAVEPOINT cockroach_restart statement in CockroachDB.
-toc: false
+toc: true
---
The `SAVEPOINT cockroach_restart` statement defines the intent to retry [transactions](transactions.html) using the CockroachDB-provided function for client-side transaction retries. For more information, see [Transaction Retries](transactions.html#transaction-retries).
{{site.data.alerts.callout_danger}}CockroachDB’s
When querying a table, CockroachDB uses the fastest index. For more information about that process, see Index Selection in CockroachDB.{{site.data.alerts.end}} - ## Required privileges diff --git a/v2.1/create-role.md b/v2.1/create-role.md index 9a1a0a8f29e..9666703a660 100644 --- a/v2.1/create-role.md +++ b/v2.1/create-role.md @@ -1,14 +1,13 @@ --- title: CREATE ROLE (Enterprise) summary: The CREATE ROLE statement creates SQL roles, which are groups containing any number of roles and users as members. -toc: false +toc: true --- The `CREATE ROLE` [statement](sql-statements.html) creates SQL [roles](roles.html), which are groups containing any number of roles and users as members. You can assign privileges to roles, and all members of the role (regardless of whether if they are direct or indirect members) will inherit the role's privileges. {{site.data.alerts.callout_info}}
ENUM type.{{site.data.alerts.end}}
-
### Overflow of `float`
diff --git a/v2.0/primary-key.md b/v2.0/primary-key.md
index dba07fb60ee..48d0515ea53 100644
--- a/v2.0/primary-key.md
+++ b/v2.0/primary-key.md
@@ -1,7 +1,7 @@
---
title: Primary Key Constraint
summary: The Primary Key constraint specifies that the columns can be used to uniquely identify rows in a table.
-toc: false
+toc: true
---
The Primary Key [constraint](constraints.html) specifies that the constrained columns' values must uniquely identify each row.
@@ -10,7 +10,6 @@ Unlike other constraints which have very specific uses, the Primary Key constrai
{{site.data.alerts.callout_info}}A table's primary key can only be specified in the CREATE TABLE statement. It can't be changed later using ALTER TABLE, though it is possible to go through a process to create a new table with the new primary key you want and then migrate the data.{{site.data.alerts.end}}
-
## Details
diff --git a/v2.0/privileges.md b/v2.0/privileges.md
index f26f4958750..da492db05ca 100644
--- a/v2.0/privileges.md
+++ b/v2.0/privileges.md
@@ -1,7 +1,7 @@
---
title: Privileges
summary: Privileges are granted to roles and users at the database and table levels. They are not yet supported for other granularities such as columns or rows.
-toc: false
+toc: true
---
In CockroachDB, privileges are granted to [roles](roles.html) and [users](create-and-manage-users.html) at the database and table levels. They are not yet supported for other granularities such as columns or rows.
@@ -10,7 +10,6 @@ When a user connects to a database, either via the [built-in SQL client](use-the
For the privileges required by specific statements, see the documentation for the respective [SQL statement](sql-statements.html).
-
## Supported Privileges
diff --git a/v2.0/query-behavior-troubleshooting.md b/v2.0/query-behavior-troubleshooting.md
index b76c4bce64e..4004a968b93 100644
--- a/v2.0/query-behavior-troubleshooting.md
+++ b/v2.0/query-behavior-troubleshooting.md
@@ -1,12 +1,11 @@
---
title: Troubleshoot Query Behavior
summary: Learn how to troubleshoot issues with specific queries with CockroachDB
-toc: false
+toc: true
---
If a query returns an unexpected result or takes longer than expected to process, this page will help you troubleshoot the issue.
-
## Correctness Issues
diff --git a/v2.0/query-order.md b/v2.0/query-order.md
index ab539469543..709fa017382 100644
--- a/v2.0/query-order.md
+++ b/v2.0/query-order.md
@@ -1,7 +1,7 @@
---
title: Ordering Query Results
summary: The ORDER BY clause controls the order of rows.
-toc: false
+toc: true
---
The `ORDER BY` clause controls the order in which rows are returned or
@@ -11,7 +11,6 @@ as operand of [`INSERT`](insert.html) or [`UPSERT`](upsert.html), as
well as with [`DELETE`](delete.html) and [`UPDATE`](update.html)
statements.
-
## Synopsis
diff --git a/v2.0/recommended-production-settings.md b/v2.0/recommended-production-settings.md
index 57c77ab486a..8f49aaca36f 100644
--- a/v2.0/recommended-production-settings.md
+++ b/v2.0/recommended-production-settings.md
@@ -1,12 +1,11 @@
---
title: Production Checklist
summary: Recommended settings for production deployments.
-toc: false
+toc: true
---
This page provides important recommendations for production deployments of CockroachDB.
-
## Cluster Topology
diff --git a/v2.0/release-savepoint.md b/v2.0/release-savepoint.md
index cf40e422ca4..5f990f95bd8 100644
--- a/v2.0/release-savepoint.md
+++ b/v2.0/release-savepoint.md
@@ -1,7 +1,7 @@
---
title: RELEASE SAVEPOINT cockroach_restart
summary: Commit a transaction's changes once there are no retryable errors with the RELEASE SAVEPOINT cockroach_restart statement in CockroachDB.
-toc: false
+toc: true
---
When using [client-side transaction retries](transactions.html#client-side-transaction-retries), the `RELEASE SAVEPOINT cockroach_restart` statement commits the transaction.
@@ -12,7 +12,6 @@ Despite committing the transaction, you must still issue a [`COMMIT`](commit-tra
{{site.data.alerts.callout_danger}}CockroachDB’s SAVEPOINT implementation only supports the cockroach_restart savepoint and does not support all savepoint functionality, such as nested transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/remove-nodes.md b/v2.0/remove-nodes.md
index 8f5d556c86f..45680258991 100644
--- a/v2.0/remove-nodes.md
+++ b/v2.0/remove-nodes.md
@@ -1,7 +1,7 @@
---
title: Decommission Nodes
summary: Permanently remove one or more nodes from a cluster.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ This page shows you how to decommission and permanently remove one or more nodes
For information about temporarily stopping a node (e.g., for planned maintenance), see [Stop a Node](stop-a-node.html).
-
## Overview
diff --git a/v2.0/rename-column.md b/v2.0/rename-column.md
index 9c4d6b96970..bd401970432 100644
--- a/v2.0/rename-column.md
+++ b/v2.0/rename-column.md
@@ -1,14 +1,13 @@
---
title: RENAME COLUMN
summary: The RENAME COLUMN statement changes the name of a column in a table.
-toc: false
+toc: true
---
The `RENAME COLUMN` [statement](sql-statements.html) changes the name of a column in a table.
{{site.data.alerts.callout_info}}It is not possible to rename a column referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/rename-database.md b/v2.0/rename-database.md
index a96800949b9..0c43dfd44ca 100644
--- a/v2.0/rename-database.md
+++ b/v2.0/rename-database.md
@@ -1,14 +1,13 @@
---
title: RENAME DATABASE
summary: The RENAME DATABASE statement changes the name of a database.
-toc: false
+toc: true
---
The `RENAME DATABASE` [statement](sql-statements.html) changes the name of a database.
{{site.data.alerts.callout_info}}It is not possible to rename a database referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/rename-index.md b/v2.0/rename-index.md
index 0e6e7f83056..92085cd8b49 100644
--- a/v2.0/rename-index.md
+++ b/v2.0/rename-index.md
@@ -1,14 +1,13 @@
---
title: RENAME INDEX
summary: The RENAME INDEX statement changes the name of an index for a table.
-toc: false
+toc: true
---
The `RENAME INDEX` [statement](sql-statements.html) changes the name of an index for a table.
{{site.data.alerts.callout_info}}It is not possible to rename an index referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/rename-sequence.md b/v2.0/rename-sequence.md
index 531f16f31dd..2e98bb4051b 100644
--- a/v2.0/rename-sequence.md
+++ b/v2.0/rename-sequence.md
@@ -1,7 +1,7 @@
---
title: RENAME SEQUENCE
summary: The RENAME SEQUENCE statement changes the name of a sequence.
-toc: false
+toc: true
---
New in v2.0: The `RENAME TO` [statement](sql-statements.html) is part of [`ALTER SEQUENCE`](alter-sequence.html), and changes the name of a sequence.
@@ -10,7 +10,6 @@ toc: false
{{site.data.alerts.callout_info}}To understand how CockroachDB changes schema elements without requiring table locking or other user-visible downtime, see Online Schema Changes in CockroachDB.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/rename-table.md b/v2.0/rename-table.md
index 5ef8b57fed0..67e0886399a 100644
--- a/v2.0/rename-table.md
+++ b/v2.0/rename-table.md
@@ -1,14 +1,13 @@
---
title: RENAME TABLE
summary: The RENAME TABLE statement changes the name of a table.
-toc: false
+toc: true
---
The `RENAME TABLE` [statement](sql-statements.html) changes the name of a table. It can also be used to move a table from one database to another.
{{site.data.alerts.callout_info}}It is not possible to rename a table referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/reset-cluster-setting.md b/v2.0/reset-cluster-setting.md
index 6cc43e70a6b..677e60ca157 100644
--- a/v2.0/reset-cluster-setting.md
+++ b/v2.0/reset-cluster-setting.md
@@ -1,12 +1,11 @@
---
title: RESET CLUSTER SETTING
summary: The RESET CLUSTER SETTING statement resets a cluster setting to its default value for the client session.
-toc: false
+toc: true
---
The `RESET` [statement](sql-statements.html) resets a [cluster setting](set-cluster-setting.html) to its default value for the client session..
-
## Required Privileges
diff --git a/v2.0/reset-vars.md b/v2.0/reset-vars.md
index f10cf471a4a..8524108d2ea 100644
--- a/v2.0/reset-vars.md
+++ b/v2.0/reset-vars.md
@@ -1,12 +1,11 @@
---
title: RESET (session variable)
summary: The SET statement resets a session variable to its default value.
-toc: false
+toc: true
---
The `RESET` [statement](sql-statements.html) resets a [session variable](set-vars.html) to its default value for the client session.
-
## Required Privileges
diff --git a/v2.0/restore.md b/v2.0/restore.md
index 3f95554f570..7f2825ffaa9 100644
--- a/v2.0/restore.md
+++ b/v2.0/restore.md
@@ -1,7 +1,7 @@
---
title: RESTORE
summary: Restore your CockroachDB cluster to a cloud storage services such as AWS S3, Google Cloud Storage, or other NFS.
-toc: false
+toc: true
---
{{site.data.alerts.callout_danger}}The RESTORE feature is only available to enterprise users. For non-enterprise restores, see Restore Data.{{site.data.alerts.end}}
@@ -10,7 +10,6 @@ The `RESTORE` [statement](sql-statements.html) restores your cluster's schemas a
Because CockroachDB is designed with high fault tolerance, restores are designed primarily for disaster recovery, i.e., restarting your cluster if it loses a majority of its nodes. Isolated issues (such as small-scale node outages) do not require any intervention.
-
## Functional Details
diff --git a/v2.0/resume-job.md b/v2.0/resume-job.md
index 84cbc0ffeff..377cda88de1 100644
--- a/v2.0/resume-job.md
+++ b/v2.0/resume-job.md
@@ -1,14 +1,13 @@
---
title: RESUME JOB
summary: The RESUME JOB statement lets you resume jobs that were previously paused with PAUSE JOB.
-toc: false
+toc: true
---
The `RESUME JOB` [statement](sql-statements.html) lets you resume [paused](pause-job.html) [`BACKUP`](backup.html), [`RESTORE`](restore.html), and [`IMPORT`](import.html) jobs.
{{site.data.alerts.callout_info}}You cannot pause schema changes.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/revoke-roles.md b/v2.0/revoke-roles.md
index 5faba75c1f1..377a5f5734e 100644
--- a/v2.0/revoke-roles.md
+++ b/v2.0/revoke-roles.md
@@ -1,14 +1,13 @@
---
title: REVOKE <roles>
summary: The REVOKE REVOKE <roles> is an enterprise-only feature.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/revoke.md b/v2.0/revoke.md
index 6fa1b1242b1..421abd010ed 100644
--- a/v2.0/revoke.md
+++ b/v2.0/revoke.md
@@ -1,14 +1,13 @@
---
title: REVOKE <privileges>
summary: The REVOKE statement revokes privileges from users and/or roles.
-toc: false
+toc: true
---
The `REVOKE SAVEPOINT implementation only supports the cockroach_restart savepoint and does not support all savepoint functionality, such as nested transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/scalar-expressions.md b/v2.0/scalar-expressions.md
index bc6e68f6ca7..bdbfa5dbba3 100644
--- a/v2.0/scalar-expressions.md
+++ b/v2.0/scalar-expressions.md
@@ -1,7 +1,7 @@
---
title: Scalar Expressions
summary: Scalar expressions allow the computation of new values from basic parts.
-toc: false
+toc: true
redirect_from: sql-expressions.html
key: sql-expressions.html
---
@@ -18,7 +18,6 @@ structured as a table.
The following sections provide details on each of these options.
-
## Constants
diff --git a/v2.0/secure-a-cluster.md b/v2.0/secure-a-cluster.md
index f2457e7612f..dc1d86be138 100644
--- a/v2.0/secure-a-cluster.md
+++ b/v2.0/secure-a-cluster.md
@@ -1,7 +1,7 @@
---
title: Start a Local Cluster (Secure)
summary: Run a secure multi-node CockroachDB cluster locally, using TLS certificates to encrypt network communication.
-toc: false
+toc: true
asciicast: true
---
@@ -14,7 +14,6 @@ Once you’ve [installed CockroachDB](install-cockroachdb.html), it’s simple t
{{site.data.alerts.callout_info}}Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see Manual Deployment or Orchestrated Deployment.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/select-clause.md b/v2.0/select-clause.md
index f12ee0a6129..5e512df71d5 100644
--- a/v2.0/select-clause.md
+++ b/v2.0/select-clause.md
@@ -1,7 +1,7 @@
---
title: Simple SELECT Clause
summary: The Simple SELECT clause loads or computes data from various sources.
-toc: false
+toc: true
redirect_from: select.html
key: select.html
---
@@ -14,7 +14,6 @@ also called "the `SELECT` statement". However, it is also a
[selection clause](selection-queries.html#selection-clauses) that can be combined
with other constructs to form more complex [selection queries](selection-queries.html).
-
## Synopsis
diff --git a/v2.0/selection-queries.md b/v2.0/selection-queries.md
index fa001bad608..3cd078bb468 100644
--- a/v2.0/selection-queries.md
+++ b/v2.0/selection-queries.md
@@ -1,7 +1,7 @@
---
title: Selection Queries
summary: Selection Queries can read and process data.
-toc: false
+toc: true
redirect_from: selection-clauses.html
key: selection-clauses.html
---
@@ -18,7 +18,6 @@ Selection queries can occur:
- Between parentheses as a [subquery](table-expressions.html#subqueries-as-table-expressions).
- As [operand to other statements](#using-selection-queries-with-other-statements) that take tabular data as input, for example [`INSERT`](insert.html), [`UPSERT`](upsert.html), [`CREATE TABLE AS`](create-table-as.html) or [`ALTER ... SPLIT AT`](split-at.html).
-
## Synopsis
diff --git a/v2.0/serial.md b/v2.0/serial.md
index acb0a4bb5c6..539cc7473af 100644
--- a/v2.0/serial.md
+++ b/v2.0/serial.md
@@ -1,14 +1,13 @@
---
title: SERIAL
summary: The SERIAL data type defaults to a unique 64-bit integer that is the combination of the insert timestamp and the ID of the node.
-toc: false
+toc: true
---
The `SERIAL` [data type](data-types.html) is a column data type that, on insert, generates a 64-bit integer from the timestamp and ID of the node executing the insert. This combination is likely to be globally unique except in extreme cases (see this [example](create-table.html#create-a-table-with-auto-generated-unique-row-ids) for more details). Also, because value generation does not require talking to other nodes, it is much faster than sequentially auto-incrementing a value, which requires distributed coordination.
{{site.data.alerts.callout_info}}In most cases, we recommend using the UUID data type with the gen_random_uuid() function as the default value, which generates 128-bit values (much larger than SERIAL's 64-bit) and scatters them across all of a table's underlying key-value ranges, ensuring that multiple nodes share in the load. See Create a table with auto-generated unique row IDs for more details.{{site.data.alerts.end}}
-
## Aliases
diff --git a/v2.0/set-cluster-setting.md b/v2.0/set-cluster-setting.md
index c9888e41b8c..6cb738ba126 100644
--- a/v2.0/set-cluster-setting.md
+++ b/v2.0/set-cluster-setting.md
@@ -1,14 +1,13 @@
---
title: SET CLUSTER SETTING
summary: The SET CLUSTER SETTING statement configures one cluster setting.
-toc: false
+toc: true
---
The `SET CLUSTER SETTING` [statement](sql-statements.html) modifies a [cluster-wide setting](cluster-settings.html).
{{site.data.alerts.callout_danger}}Many cluster settings are intended for tuning CockroachDB internals. Before changing these settings, we strongly encourage you to discuss your goals with CockroachDB; otherwise, you use them at your own risk.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/set-transaction.md b/v2.0/set-transaction.md
index a98ffc44c02..57508e4ef67 100644
--- a/v2.0/set-transaction.md
+++ b/v2.0/set-transaction.md
@@ -1,14 +1,13 @@
---
title: SET TRANSACTION
summary: The SET TRANSACTION statement sets the transaction isolation level and/or priority for the current session or for an individual transaction.
-toc: false
+toc: true
---
The `SET TRANSACTION` [statement](sql-statements.html) sets the transaction isolation level or priority after you [`BEGIN`](begin-transaction.html) it but before executing the first statement that manipulates a database.
{{site.data.alerts.callout_info}}You can also set the session's default isolation level.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/set-vars.md b/v2.0/set-vars.md
index 8a9b88ee11c..17e20c2e371 100644
--- a/v2.0/set-vars.md
+++ b/v2.0/set-vars.md
@@ -1,7 +1,7 @@
---
title: SET (session variable)
summary: The SET statement modifies the current configuration variables for the client session.
-toc: false
+toc: true
redirect_from:
- set-application-name.html
- set-database.html
@@ -12,7 +12,6 @@ The `SET` [statement](sql-statements.html) can modify one of the session configu
{{site.data.alerts.callout_danger}}In some cases, client drivers can drop and restart the connection to the server. When this happens, any session configurations made with SET statements are lost. It is therefore more reliable to configure the session in the client's connection string. For examples in different languages, see the Build an App with CockroachDB tutorials.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/show-backup.md b/v2.0/show-backup.md
index 7fb441682b2..71834afab7f 100644
--- a/v2.0/show-backup.md
+++ b/v2.0/show-backup.md
@@ -1,12 +1,11 @@
---
title: SHOW BACKUP
summary: The SHOW BACKUP statement lists the contents of a backup.
-toc: false
+toc: true
---
New in v1.1: The `SHOW BACKUP` [statement](sql-statements.html) lists the contents of an enterprise backup created with the [`BACKUP`](backup.html) statement.
-
## Required Privileges
diff --git a/v2.0/show-cluster-setting.md b/v2.0/show-cluster-setting.md
index 04cd82535af..34e1aed7a62 100644
--- a/v2.0/show-cluster-setting.md
+++ b/v2.0/show-cluster-setting.md
@@ -1,7 +1,7 @@
---
title: SHOW CLUSTER SETTING
summary: The SHOW CLUSTER SETTING statement displays the current cluster settings.
-toc: false
+toc: true
---
The `SHOW CLUSTER SETTING` [statement](sql-statements.html) can
@@ -9,7 +9,6 @@ display the value of either one or all of the
[cluster settings](cluster-settings.html). These can also be configured
via [`SET CLUSTER SETTING`](set-cluster-setting.html).
-
## Required Privileges Changed in v2.0
diff --git a/v2.0/show-columns.md b/v2.0/show-columns.md
index 19ee5e92405..90be1ba8cf9 100644
--- a/v2.0/show-columns.md
+++ b/v2.0/show-columns.md
@@ -1,12 +1,11 @@
---
title: SHOW COLUMNS
summary: The SHOW COLUMNS statement shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
-toc: false
+toc: true
---
The `SHOW COLUMNS` [statement](sql-statements.html) shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
-
## Required Privileges
diff --git a/v2.0/show-constraints.md b/v2.0/show-constraints.md
index eed2d7474ee..f807bec1e70 100644
--- a/v2.0/show-constraints.md
+++ b/v2.0/show-constraints.md
@@ -1,14 +1,13 @@
---
title: SHOW CONSTRAINTS
summary: The SHOW CONSTRAINTS statement lists the constraints on a table.
-toc: false
+toc: true
---
The `SHOW CONSTRAINTS` [statement](sql-statements.html) lists all named [constraints](constraints.html) as well as any unnamed Check constraints on a table.
{{site.data.alerts.callout_danger}}The SHOW CONSTRAINTS statement is under development; the exact output will continue to change.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/show-create-sequence.md b/v2.0/show-create-sequence.md
index a4d1393d9c1..f532cf449f0 100644
--- a/v2.0/show-create-sequence.md
+++ b/v2.0/show-create-sequence.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE SEQUENCE
summary: The SHOW CREATE SEQUENCE statement shows the CREATE SEQUENCE statement that would create a copy of the specified sequence.
-toc: false
+toc: true
---
New in v2.0: The `SHOW CREATE SEQUENCE` [statement](sql-statements.html) shows the `CREATE SEQUENCE` statement that would create a copy of the specified sequence.
-
## Required Privileges
diff --git a/v2.0/show-create-table.md b/v2.0/show-create-table.md
index 917a530ab3e..7386c0735bb 100644
--- a/v2.0/show-create-table.md
+++ b/v2.0/show-create-table.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE TABLE
summary: The SHOW CREATE TABLE statement shows the CREATE TABLE statement that would create a copy of the specified table.
-toc: false
+toc: true
---
The `SHOW CREATE TABLE` [statement](sql-statements.html) shows the `CREATE TABLE` statement that would create a copy of the specified table.
-
## Required Privileges
diff --git a/v2.0/show-create-view.md b/v2.0/show-create-view.md
index e63a690910c..fe5b2a782c0 100644
--- a/v2.0/show-create-view.md
+++ b/v2.0/show-create-view.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE VIEW
summary: The SHOW CREATE VIEW statement shows the CREATE VIEW statement that would create a copy of the specified view.
-toc: false
+toc: true
---
The `SHOW CREATE VIEW` [statement](sql-statements.html) shows the `CREATE VIEW` statement that would create a copy of the specified [view](views.html).
-
## Required Privileges
diff --git a/v2.0/show-databases.md b/v2.0/show-databases.md
index 744e6fae526..1b778f31779 100644
--- a/v2.0/show-databases.md
+++ b/v2.0/show-databases.md
@@ -2,12 +2,11 @@
title: SHOW DATABASES
summary: The SHOW DATABASES statement lists all database in the CockroachDB cluster.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW DATABASES` [statement](sql-statements.html) lists all database in the CockroachDB cluster.
-
## Synopsis
diff --git a/v2.0/show-experimental-ranges.md b/v2.0/show-experimental-ranges.md
index 6dce6459df1..56471c3d33d 100644
--- a/v2.0/show-experimental-ranges.md
+++ b/v2.0/show-experimental-ranges.md
@@ -1,7 +1,7 @@
---
title: SHOW EXPERIMENTAL_RANGES
summary: The SHOW EXPERIMENTAL_RANGES shows information about the ranges that make up a specific table's data.
-toc: false
+toc: true
redirect_from: show-testing-ranges.html
---
@@ -19,7 +19,6 @@ This information is useful for verifying that:
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Synopsis
diff --git a/v2.0/show-grants.md b/v2.0/show-grants.md
index b5345577342..0134fc36abe 100644
--- a/v2.0/show-grants.md
+++ b/v2.0/show-grants.md
@@ -2,12 +2,11 @@
title: SHOW GRANTS
summary: The SHOW GRANTS statement lists the privileges granted to users.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW GRANTS` [statement](sql-statements.html) lists the [privileges](privileges.html) granted to users.
-
## Synopsis
diff --git a/v2.0/show-index.md b/v2.0/show-index.md
index b096f821697..f923a619e52 100644
--- a/v2.0/show-index.md
+++ b/v2.0/show-index.md
@@ -1,12 +1,11 @@
---
title: SHOW INDEX
summary: The SHOW INDEX statement returns index information for a table.
-toc: false
+toc: true
---
The `SHOW INDEX` [statement](sql-statements.html) returns index information for a table.
-
## Required Privileges
diff --git a/v2.0/show-jobs.md b/v2.0/show-jobs.md
index 75259a6f9b0..f88c0923387 100644
--- a/v2.0/show-jobs.md
+++ b/v2.0/show-jobs.md
@@ -1,7 +1,7 @@
---
title: SHOW JOBS
summary: The SHOW JOBS statement lists all currently active schema changes and backup/restore jobs.
-toc: false
+toc: true
---
New in v1.1: The `SHOW JOBS` [statement](sql-statements.html) lists all of the types of long-running tasks your cluster has performed, including:
@@ -13,7 +13,6 @@ These details can help you understand the status of crucial tasks that can impac
{{site.data.alerts.callout_info}} The SHOW JOBS statement shows only long-running tasks. For an exhaustive list of jobs running in the cluster, use the SQL Audit Logging (Experimental) feature.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/show-queries.md b/v2.0/show-queries.md
index 8fc9a8499e7..4e154bcee6e 100644
--- a/v2.0/show-queries.md
+++ b/v2.0/show-queries.md
@@ -1,7 +1,7 @@
---
title: SHOW QUERIES
summary: The SHOW QUERIES statement lists all currently active queries across the cluster or on the local node.
-toc: false
+toc: true
---
New in v1.1: The `SHOW QUERIES` [statement](sql-statements.html) lists details about currently active SQL queries, including:
@@ -16,7 +16,6 @@ These details let you monitor the progress of active queries and, if necessary,
{{site.data.alerts.callout_info}}Schema changes and BACKUP/RESTORE statements are not executed as queries internally and so are not listed by SHOW QUERIES. To monitor such statements, use SHOW JOBS instead.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/show-roles.md b/v2.0/show-roles.md
index 3256fbaffb3..f86dbeb80b5 100644
--- a/v2.0/show-roles.md
+++ b/v2.0/show-roles.md
@@ -1,12 +1,11 @@
---
title: SHOW ROLES
summary: The SHOW ROLES statement lists the roles for all databases.
-toc: false
+toc: true
---
New in v2.0: The `SHOW ROLES` [statement](sql-statements.html) lists the roles for all databases.
-
## Synopsis
diff --git a/v2.0/show-schemas.md b/v2.0/show-schemas.md
index 9211bb88bdf..7f7231ac549 100644
--- a/v2.0/show-schemas.md
+++ b/v2.0/show-schemas.md
@@ -1,12 +1,11 @@
---
title: SHOW SCHEMAS
summary: The SHOW SCHEMAS statement lists the schemas in a database.
-toc: false
+toc: true
---
New in v2.0: The `SHOW SCHEMAS` [statement](sql-statements.html) lists all [schemas](sql-name-resolution.html#logical-schemas-and-namespaces) in a database.
-
## Required Privileges
diff --git a/v2.0/show-sessions.md b/v2.0/show-sessions.md
index 34d4566dca3..f12e4588a1f 100644
--- a/v2.0/show-sessions.md
+++ b/v2.0/show-sessions.md
@@ -1,7 +1,7 @@
---
title: SHOW SESSIONS
summary: The SHOW SESSIONS statement lists all currently active sessions across the cluster or on the local node.
-toc: false
+toc: true
---
New in v1.1: The `SHOW SESSIONS` [statement](sql-statements.html) lists details about currently active sessions, including:
@@ -14,7 +14,6 @@ toc: false
These details let you monitor the overall state of client connections and identify those that may need further investigation or adjustment.
-
## Required Privileges
diff --git a/v2.0/show-tables.md b/v2.0/show-tables.md
index 73fdea4652d..4b54c9eabb9 100644
--- a/v2.0/show-tables.md
+++ b/v2.0/show-tables.md
@@ -2,14 +2,13 @@
title: SHOW TABLES
summary: The SHOW TABLES statement lists the tables in a schema or database.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW TABLES` [statement](sql-statements.html) lists the tables or [views](views.html) in a schema or database.
{{site.data.alerts.callout_info}}While a table or view is being dropped, SHOW TABLES will list the object with a (dropped) suffix.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/show-trace.md b/v2.0/show-trace.md
index 27fce023e0a..100e3c51a9a 100644
--- a/v2.0/show-trace.md
+++ b/v2.0/show-trace.md
@@ -1,14 +1,13 @@
---
title: SHOW TRACE
summary: The SHOW TRACE statement returns details about how CockroachDB executed a statement or series of statements.
-toc: false
+toc: true
---
The `SHOW TRACE` [statement](sql-statements.html) returns details about how CockroachDB executed a statement or series of statements. These details include messages and timing information from all nodes involved in the execution, providing visibility into the actions taken by CockroachDB across all of its software layers.
You can use `SHOW TRACE` to debug why a query is not performing as expected, to add more information to bug reports, or to generally learn more about how CockroachDB works.
-
## Usage Overview
diff --git a/v2.0/show-users.md b/v2.0/show-users.md
index 8377f8c114c..6ecb9c8696a 100644
--- a/v2.0/show-users.md
+++ b/v2.0/show-users.md
@@ -1,12 +1,11 @@
---
title: SHOW USERS
summary: The SHOW USERS statement lists the users for all databases.
-toc: false
+toc: true
---
The `SHOW USERS` [statement](sql-statements.html) lists the users for all databases.
-
## Synopsis
diff --git a/v2.0/show-vars.md b/v2.0/show-vars.md
index e8fadbd817a..ba48cc0fa7b 100644
--- a/v2.0/show-vars.md
+++ b/v2.0/show-vars.md
@@ -1,7 +1,7 @@
---
title: SHOW (session settings)
summary: The SHOW statement displays the current settings for the client session.
-toc: false
+toc: true
redirect_from:
- show-all.html
- show-transaction.html
@@ -11,7 +11,6 @@ redirect_from:
The `SHOW` [statement](sql-statements.html) can display the value of either one or all of
the session setting variables. Some of these can also be configured via [`SET`](set-vars.html).
-
## Required Privileges
diff --git a/v2.0/split-at.md b/v2.0/split-at.md
index a7a8b5fb35f..894e3af2092 100644
--- a/v2.0/split-at.md
+++ b/v2.0/split-at.md
@@ -1,12 +1,11 @@
---
title: SPLIT AT
summary: The SPLIT AT statement forces a key-value layer range split at the specified row in a table or index.
-toc: false
+toc: true
---
The `SPLIT AT` [statement](sql-statements.html) forces a key-value layer range split at the specified row in a table or index.
-
## Synopsis
diff --git a/v2.0/sql-audit-logging.md b/v2.0/sql-audit-logging.md
index 354d87fd62f..dd7f3c2b14f 100644
--- a/v2.0/sql-audit-logging.md
+++ b/v2.0/sql-audit-logging.md
@@ -1,7 +1,7 @@
---
title: SQL Audit Logging
summary: Use the EXPERIMENTAL_AUDIT setting to turn SQL audit logging on or off for a table.
-toc: false
+toc: true
---
SQL audit logging gives you detailed information about queries being executed against your system. This feature is especially useful when you want to log all queries that are run against a table containing personally identifiable information (PII).
@@ -16,7 +16,6 @@ For reference material, including a detailed description of the audit log file f
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Step 1. Create sample tables
diff --git a/v2.0/sql-constants.md b/v2.0/sql-constants.md
index 3d8635f802d..3d1d4a33f57 100644
--- a/v2.0/sql-constants.md
+++ b/v2.0/sql-constants.md
@@ -1,12 +1,11 @@
---
title: Constant Values
summary: SQL Constants represent a simple value that doesn't change.
-toc: false
+toc: true
---
SQL Constants represent a simple value that doesn't change.
-
## Introduction
diff --git a/v2.0/sql-dump.md b/v2.0/sql-dump.md
index e3e53afcd85..49a3d110845 100644
--- a/v2.0/sql-dump.md
+++ b/v2.0/sql-dump.md
@@ -1,14 +1,13 @@
---
title: SQL Dump (Export)
summary: Learn how to dump schemas and data from a CockroachDB cluster.
-toc: false
+toc: true
---
The `cockroach dump` [command](cockroach-commands.html) outputs the SQL statements required to recreate tables, views, and sequences. This command can be used to back up or export each database in a cluster. The output should also be suitable for importing into other relational databases, with minimal adjustments.
{{site.data.alerts.callout_success}}CockroachDB enterprise license users can also back up their cluster's data using BACKUP.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.0/sql-faqs.md b/v2.0/sql-faqs.md
index 01266f0ebbb..f80d2b4ccd7 100644
--- a/v2.0/sql-faqs.md
+++ b/v2.0/sql-faqs.md
@@ -1,11 +1,10 @@
---
title: SQL FAQs
summary: Get answers to frequently asked questions about CockroachDB SQL.
-toc: false
+toc: true
toc_not_nested: true
---
-
## How do I bulk insert data into CockroachDB?
diff --git a/v2.0/sql-feature-support.md b/v2.0/sql-feature-support.md
index 72025fceebf..391dba1b239 100644
--- a/v2.0/sql-feature-support.md
+++ b/v2.0/sql-feature-support.md
@@ -3,7 +3,6 @@ title: SQL Feature Support in CockroachDB v2.0
summary: Summary of CockroachDB's conformance to the SQL standard and which common extensions it supports.
---
-
## Overview
diff --git a/v2.0/sql-name-resolution.md b/v2.0/sql-name-resolution.md
index 0bda530c0c1..030a46bcf98 100644
--- a/v2.0/sql-name-resolution.md
+++ b/v2.0/sql-name-resolution.md
@@ -1,14 +1,13 @@
---
title: Name Resolution
summary: Table and function names can exist in multiple places. Resolution decides which one to use.
-toc: false
+toc: true
---
Changed in v2.0: A query can specify a table name without a database or schema name (e.g., `SELECT * FROM orders`). How does CockroachDB know which `orders` table is being considered and in which schema?
This page details how CockroachDB performs **name resolution** to answer this question.
-
## Logical Schemas And Namespaces
diff --git a/v2.0/sql-statements.md b/v2.0/sql-statements.md
index e7816260316..b056e211549 100644
--- a/v2.0/sql-statements.md
+++ b/v2.0/sql-statements.md
@@ -1,14 +1,13 @@
---
title: SQL Statements
summary: SQL statements supported by CockroachDB.
-toc: false
+toc: true
---
CockroachDB supports the following SQL statements. Click a statement for more details.
{{site.data.alerts.callout_success}}In the built-in SQL shell, use \h [statement] to get inline help about a specific statement.{{site.data.alerts.end}}
-
## Data Manipulation Statements
diff --git a/v2.0/start-a-local-cluster.md b/v2.0/start-a-local-cluster.md
index 946b41ff771..a3d8c699660 100644
--- a/v2.0/start-a-local-cluster.md
+++ b/v2.0/start-a-local-cluster.md
@@ -1,7 +1,7 @@
---
title: Start a Local Cluster (Insecure)
summary: Run an insecure multi-node CockroachDB cluster locally with each node listening on a different port.
-toc: false
+toc: true
toc_not_nested: true
asciicast: true
---
@@ -15,7 +15,6 @@ Once you’ve [installed CockroachDB](install-cockroachdb.html), it’s simple t
{{site.data.alerts.callout_info}}Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see Manual Deployment or Orchestrated Deployment.{{site.data.alerts.end}}
-
## Before You Begin
diff --git a/v2.0/start-a-node.md b/v2.0/start-a-node.md
index c6938a0e9bb..1297f719320 100644
--- a/v2.0/start-a-node.md
+++ b/v2.0/start-a-node.md
@@ -1,14 +1,13 @@
---
title: Start a Node
summary: To start a new CockroachDB cluster, or add a node to an existing cluster, run the cockroach start command.
-toc: false
+toc: true
---
This page explains the `cockroach start` [command](cockroach-commands.html), which you use to start nodes as a new cluster or add nodes to an existing cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials.
{{site.data.alerts.callout_info}}Node-level settings are defined by flags passed to the cockroach start command and cannot be changed without stopping and restarting the node. In contrast, some cluster-wide settings are defined via SQL statements and can be updated anytime after a cluster has been started. For more details, see Cluster Settings.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/stop-a-node.md b/v2.0/stop-a-node.md
index b539d671e67..db3a86e7636 100644
--- a/v2.0/stop-a-node.md
+++ b/v2.0/stop-a-node.md
@@ -1,14 +1,13 @@
---
title: Stop a Node
summary: Learn how to temporarily stop a CockroachDB node.
-toc: false
+toc: true
---
This page shows you how to use the `cockroach quit` [command](cockroach-commands.html) to temporarily stop a node that you plan to restart, for example, during the process of [upgrading your cluster's version of CockroachDB](upgrade-cockroach-version.html) or to perform planned maintenance (e.g., upgrading system software).
For information about permanently removing nodes to downsize a cluster or react to hardware failures, see [Remove Nodes](remove-nodes.html).
-
## Overview
diff --git a/v2.0/string.md b/v2.0/string.md
index 841debeb711..877dec7b534 100644
--- a/v2.0/string.md
+++ b/v2.0/string.md
@@ -1,14 +1,13 @@
---
title: STRING
summary: The STRING data type stores a string of Unicode characters.
-toc: false
+toc: true
---
The `STRING` [data type](data-types.html) stores a string of Unicode characters.
-
## Aliases
diff --git a/v2.0/table-expressions.md b/v2.0/table-expressions.md
index 1206c0615ff..eb09ff65d92 100644
--- a/v2.0/table-expressions.md
+++ b/v2.0/table-expressions.md
@@ -1,7 +1,7 @@
---
title: Table Expressions
summary: Table expressions define a data source in selection clauses.
-toc: false
+toc: true
---
Table expressions define a data source in the `FROM` sub-clause of
@@ -11,7 +11,6 @@ Table expressions define a data source in the `FROM` sub-clause of
[SQL Joins](joins.html) are a particular kind of table
expression.
-
## Synopsis
diff --git a/v2.0/time.md b/v2.0/time.md
index 0e2d577d379..b6388f9101f 100644
--- a/v2.0/time.md
+++ b/v2.0/time.md
@@ -1,11 +1,10 @@
---
title: TIME
summary: The TIME data type stores a time of day without a time zone.
-toc: false
+toc: true
---
New in v2.0: The `TIME` [data type](data-types.html) stores the time of day without a time zone.
-
## Aliases
diff --git a/v2.0/timestamp.md b/v2.0/timestamp.md
index 05a82b7f362..aaebd4afe3b 100644
--- a/v2.0/timestamp.md
+++ b/v2.0/timestamp.md
@@ -1,12 +1,11 @@
---
title: TIMESTAMP
summary: The TIMESTAMP data type stores a date and time pair in UTC, whereas TIMESTAMPTZ stores a date and time pair with a time zone offset from UTC.
-toc: false
+toc: true
---
The `TIMESTAMP` [data type](data-types.html) stores a date and time pair in UTC.
-
## Time Zone Details
diff --git a/v2.0/training/backup-and-restore.md b/v2.0/training/backup-and-restore.md
index 8afc3a3061a..89caf8958dd 100644
--- a/v2.0/training/backup-and-restore.md
+++ b/v2.0/training/backup-and-restore.md
@@ -1,6 +1,6 @@
---
title: Back and Restore
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/backup-and-restore.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/client-connection-troubleshooting.md b/v2.0/training/client-connection-troubleshooting.md
index 2fdc187fcf2..d7e24d06678 100644
--- a/v2.0/training/client-connection-troubleshooting.md
+++ b/v2.0/training/client-connection-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Client Connection Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/client-connection-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/cluster-startup-and-scaling.md b/v2.0/training/cluster-startup-and-scaling.md
index 347f4674b6e..0aa54721a4d 100644
--- a/v2.0/training/cluster-startup-and-scaling.md
+++ b/v2.0/training/cluster-startup-and-scaling.md
@@ -1,6 +1,6 @@
---
title: Cluster Startup and Scaling
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/cluster-startup-and-scaling.html
@@ -13,7 +13,6 @@ redirect_from: /training/cluster-startup-and-scaling.html
content: "Hands-on Lab"
}
-
## Step 1. Create a training directory
diff --git a/v2.0/training/cluster-unavailability-troubleshooting.md b/v2.0/training/cluster-unavailability-troubleshooting.md
index fc60ee5d77c..f127b63269f 100644
--- a/v2.0/training/cluster-unavailability-troubleshooting.md
+++ b/v2.0/training/cluster-unavailability-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Cluster Unavailability Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/cluster-unavailability-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/cluster-upgrade.md b/v2.0/training/cluster-upgrade.md
index 21bdc20f729..eddba5f0702 100644
--- a/v2.0/training/cluster-upgrade.md
+++ b/v2.0/training/cluster-upgrade.md
@@ -1,6 +1,6 @@
---
title: Cluster Upgrade
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/cluster-upgrade.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/data-corruption-troubleshooting.md b/v2.0/training/data-corruption-troubleshooting.md
index 4c4f28469b3..bc83b56f154 100644
--- a/v2.0/training/data-corruption-troubleshooting.md
+++ b/v2.0/training/data-corruption-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Data Corruption Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-corruption-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/data-import.md b/v2.0/training/data-import.md
index 0bfa4c0368f..01c04beff12 100644
--- a/v2.0/training/data-import.md
+++ b/v2.0/training/data-import.md
@@ -1,6 +1,6 @@
---
title: Data Import
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-import.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/data-unavailability-troubleshooting.md b/v2.0/training/data-unavailability-troubleshooting.md
index 530b606d072..65637c4a4c8 100644
--- a/v2.0/training/data-unavailability-troubleshooting.md
+++ b/v2.0/training/data-unavailability-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Data Unavailability Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-unavailability-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/fault-tolerance-and-automated-repair.md b/v2.0/training/fault-tolerance-and-automated-repair.md
index d696706bad0..0fae6325950 100644
--- a/v2.0/training/fault-tolerance-and-automated-repair.md
+++ b/v2.0/training/fault-tolerance-and-automated-repair.md
@@ -1,6 +1,6 @@
---
title: Fault Tolerance and Automated Repair
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/fault-tolerance-and-automated-repair.html
@@ -13,7 +13,6 @@ redirect_from: /training/fault-tolerance-and-automated-repair.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/locality-and-replication-zones.md b/v2.0/training/locality-and-replication-zones.md
index 102f3000bd6..3f68add52e2 100644
--- a/v2.0/training/locality-and-replication-zones.md
+++ b/v2.0/training/locality-and-replication-zones.md
@@ -1,6 +1,6 @@
---
title: Locality and Replication Zones
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/locality-and-replication-zones.html
@@ -13,7 +13,6 @@ redirect_from: /training/locality-and-replication-zones.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/network-partition-troubleshooting.md b/v2.0/training/network-partition-troubleshooting.md
index 380155a7d37..611326a003c 100644
--- a/v2.0/training/network-partition-troubleshooting.md
+++ b/v2.0/training/network-partition-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Network Partition Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/network-partition-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/node-decommissioning.md b/v2.0/training/node-decommissioning.md
index 14bdc1adbf5..db7998a567b 100644
--- a/v2.0/training/node-decommissioning.md
+++ b/v2.0/training/node-decommissioning.md
@@ -1,6 +1,6 @@
---
title: Node Decommissioning
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/node-decommissioning.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/node-startup-troubleshooting.md b/v2.0/training/node-startup-troubleshooting.md
index 78a71ad2235..36ce98f0e4b 100644
--- a/v2.0/training/node-startup-troubleshooting.md
+++ b/v2.0/training/node-startup-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Node Startup Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/node-startup-troubleshooting.html
content: "Hands-on Lab"
}
-
## Problem 1: SSL required
diff --git a/v2.0/training/planned-maintenance.md b/v2.0/training/planned-maintenance.md
index 1944ee6ccba..6f8343faae0 100644
--- a/v2.0/training/planned-maintenance.md
+++ b/v2.0/training/planned-maintenance.md
@@ -1,6 +1,6 @@
---
title: Planned Maintenance
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/planned-maintenance.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/security.md b/v2.0/training/security.md
index be387b6f2c4..ada3f819456 100644
--- a/v2.0/training/security.md
+++ b/v2.0/training/security.md
@@ -14,7 +14,6 @@ redirect_from: /training/security.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/software-panic-troubleshooting.md b/v2.0/training/software-panic-troubleshooting.md
index e0348f3512e..2c44bb64d09 100644
--- a/v2.0/training/software-panic-troubleshooting.md
+++ b/v2.0/training/software-panic-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Software Panic Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/software-panic-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/under-replication-troubleshooting.md b/v2.0/training/under-replication-troubleshooting.md
index 966c0dbe7e5..39b5874e00a 100644
--- a/v2.0/training/under-replication-troubleshooting.md
+++ b/v2.0/training/under-replication-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Under-Replication Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/under-replication-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/training/users-and-privileges.md b/v2.0/training/users-and-privileges.md
index c0216c29745..ffae1d860fc 100644
--- a/v2.0/training/users-and-privileges.md
+++ b/v2.0/training/users-and-privileges.md
@@ -1,6 +1,6 @@
---
title: Users and Privileges
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/users-and-privileges.html
content: "Hands-on Lab"
}
-
## Before You Begin
diff --git a/v2.0/transactions.md b/v2.0/transactions.md
index f626b57192b..44aa6365999 100644
--- a/v2.0/transactions.md
+++ b/v2.0/transactions.md
@@ -1,14 +1,13 @@
---
title: Transactions
summary: CockroachDB supports bundling multiple SQL statements into a single all-or-nothing transaction.
-toc: false
+toc: true
---
CockroachDB supports bundling multiple SQL statements into a single all-or-nothing transaction. Each transaction guarantees [ACID semantics](https://en.wikipedia.org/wiki/ACID) spanning arbitrary tables and rows, even when data is distributed. If a transaction succeeds, all mutations are applied together with virtual simultaneity. If any part of a transaction fails, the entire transaction is aborted, and the database is left unchanged. CockroachDB guarantees that while a transaction is pending, it is isolated from other concurrent transactions with serializable [isolation](#isolation-levels).
{{site.data.alerts.callout_info}}For a detailed discussion of CockroachDB transaction semantics, see How CockroachDB Does Distributed Atomic Transactions and Serializable, Lockless, Distributed: Isolation in CockroachDB. Note that the explanation of the transaction model described in this blog post is slightly out of date. See the Transaction Retries section for more details.{{site.data.alerts.end}}
-
## SQL Statements
diff --git a/v2.0/truncate.md b/v2.0/truncate.md
index afa4fdc42b1..f4bd7864992 100644
--- a/v2.0/truncate.md
+++ b/v2.0/truncate.md
@@ -1,14 +1,13 @@
---
title: TRUNCATE
summary: The TRUNCATE statement deletes all rows from specified tables.
-toc: false
+toc: true
---
The `TRUNCATE` [statement](sql-statements.html) deletes all rows from specified tables.
{{site.data.alerts.callout_info}}The TRUNCATE removes all rows from a table by dropping the table and recreating a new table with the same name. For large tables, this is much more performant than deleting each of the rows. However, for smaller tables, it's more performant to use a DELETE statement without a WHERE clause.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.0/unique.md b/v2.0/unique.md
index 29308bf6ca0..1ca7de4b3dd 100644
--- a/v2.0/unique.md
+++ b/v2.0/unique.md
@@ -1,12 +1,11 @@
---
title: Unique Constraint
summary: The Unique constraint specifies that each non-NULL value in the constrained column must be unique.
-toc: false
+toc: true
---
The Unique [constraint](constraints.html) specifies that each non-*NULL* value in the constrained column must be unique.
-
## Details
diff --git a/v2.0/update.md b/v2.0/update.md
index 86f147858f6..2504dab41f9 100644
--- a/v2.0/update.md
+++ b/v2.0/update.md
@@ -1,14 +1,13 @@
---
title: UPDATE
summary: The UPDATE statement updates rows in a table.
-toc: false
+toc: true
---
The `UPDATE` [statement](sql-statements.html) updates rows in a table.
{{site.data.alerts.callout_danger}}If you update a row that contains a column referenced by a foreign key constraint and has an ON UPDATE action, all of the dependent rows will also be updated.{{site.data.alerts.end}}
-
## Required Privileges
diff --git a/v2.0/upgrade-cockroach-version.md b/v2.0/upgrade-cockroach-version.md
index 1e5d535087d..27ace0b181c 100644
--- a/v2.0/upgrade-cockroach-version.md
+++ b/v2.0/upgrade-cockroach-version.md
@@ -1,7 +1,7 @@
---
title: Upgrade to CockroachDB v2.0.3
summary: Learn how to upgrade your CockroachDB cluster to a new version.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ Because of CockroachDB's [multi-active availability](multi-active-availability.h
{{site.data.alerts.callout_info}}This page shows you how to upgrade to v2.0.3 from v1.1.x, or from any patch release in the v2.0.x series. To upgrade within the v1.1.x series, see the v1.1 version of this page.{{site.data.alerts.end}}
-
## Step 1. Verify that you can upgrade
diff --git a/v2.0/upsert.md b/v2.0/upsert.md
index 824686cda24..8483e3219a7 100644
--- a/v2.0/upsert.md
+++ b/v2.0/upsert.md
@@ -1,12 +1,11 @@
---
title: UPSERT
summary: The UPSERT statement inserts rows when values do not violate uniqueness constraints, and it updates rows when values do violate uniqueness constraints.
-toc: false
+toc: true
---
The `UPSERT` [statement](sql-statements.html) is short-hand for [`INSERT ON CONFLICT`](insert.html#on-conflict-clause). It inserts rows in cases where specified values do not violate uniqueness constraints, and it updates rows in cases where values do violate uniqueness constraints.
-
## Considerations
diff --git a/v2.0/use-the-built-in-sql-client.md b/v2.0/use-the-built-in-sql-client.md
index a9dc197e55c..f701a389e92 100644
--- a/v2.0/use-the-built-in-sql-client.md
+++ b/v2.0/use-the-built-in-sql-client.md
@@ -1,14 +1,13 @@
---
title: Use the Built-in SQL Client
summary: CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line.
-toc: false
+toc: true
---
CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line. To use this client, run the `cockroach sql` [command](cockroach-commands.html) as described below.
To exit the interactive shell, use `\q` or `ctrl-d`.
-
## Synopsis
diff --git a/v2.0/uuid.md b/v2.0/uuid.md
index a882081285e..37e6be3218c 100644
--- a/v2.0/uuid.md
+++ b/v2.0/uuid.md
@@ -1,14 +1,13 @@
---
title: UUID
summary: The UUID data type stores 128-bit Universal Unique Identifiers.
-toc: false
+toc: true
---
New in v1.1: The `UUID` (Universally Unique Identifier) [data type](data-types.html) stores a 128-bit value that is [unique across both space and time](https://www.ietf.org/rfc/rfc4122.txt).
{{site.data.alerts.callout_success}}To auto-generate unique row IDs, we recommend using UUID with the gen_random_uuid() function as the default value. See the example below for more details.{{site.data.alerts.end}}
-
## Syntax
A `UUID` value can be expressed using the following formats:
diff --git a/v2.0/validate-constraint.md b/v2.0/validate-constraint.md
index d9f910e07a9..70b29e1f856 100644
--- a/v2.0/validate-constraint.md
+++ b/v2.0/validate-constraint.md
@@ -1,14 +1,13 @@
---
title: VALIDATE CONSTRAINT
summary: Use the ADD COLUMN statement to add columns to tables.
-toc: false
+toc: true
---
The `VALIDATE CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and checks whether values in a column match a [constraint](constraints.html) on the column.
This statement is especially useful after applying a constraint to an existing column via [`ADD CONSTRAINT`](add-constraint.html). In this case, `VALIDATE CONSTRAINT` can be used to find values already in the column that do not match the constraint.
-
## Required Privileges
diff --git a/v2.0/view-node-details.md b/v2.0/view-node-details.md
index e86e100ae39..caca2a48e1e 100644
--- a/v2.0/view-node-details.md
+++ b/v2.0/view-node-details.md
@@ -1,14 +1,13 @@
---
title: View Node Details
summary: To view details for each node in the cluster, use the cockroach node command with the appropriate subcommands and flags.
-toc: false
+toc: true
---
To view details for each node in the cluster, use the `cockroach node` [command](cockroach-commands.html) with the appropriate subcommands and flags.
New in v1.1: The `cockroach node` command is also used in the process of decommissioning nodes for permanent removal. See [Remove Nodes](remove-nodes.html) for more details.
-
## Subcommands
diff --git a/v2.0/views.md b/v2.0/views.md
index f5b14e54e48..7e7316c82ec 100644
--- a/v2.0/views.md
+++ b/v2.0/views.md
@@ -1,12 +1,11 @@
---
title: Views
summary:
-toc: false
+toc: true
---
A view is a stored [selection query](selection-queries.html) and provides a shorthand name for it. CockroachDB's views are **dematerialized**: they do not store the results of the underlying queries. Instead, the underlying query is executed anew every time the view is used.
-
## Why Use Views?
diff --git a/v2.1/add-column.md b/v2.1/add-column.md
index fc201daa9f6..ad368f155c9 100644
--- a/v2.1/add-column.md
+++ b/v2.1/add-column.md
@@ -1,12 +1,11 @@
---
title: ADD COLUMN
summary: Use the ADD COLUMN statement to add columns to tables.
-toc: false
+toc: true
---
The `ADD COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and adds columns to tables.
-
## Synopsis
diff --git a/v2.1/add-constraint.md b/v2.1/add-constraint.md
index 12b7700b0f0..e269f2460f4 100644
--- a/v2.1/add-constraint.md
+++ b/v2.1/add-constraint.md
@@ -1,7 +1,7 @@
---
title: ADD CONSTRAINT
summary: Use the ADD CONSTRAINT statement to add constraints to columns.
-toc: false
+toc: true
---
The `ADD CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and can add the following [constraints](constraints.html) to columns:
@@ -14,7 +14,6 @@ The `ADD CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` a
The [`PRIMARY KEY`](primary-key.html) and [`NOT NULL`](not-null.html) constraints can only be applied through [`CREATE TABLE`](create-table.html). The [`DEFAULT`](default-value.html) constraint is managed through [`ALTER COLUMN`](alter-column.html).
{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/admin-ui-access-and-navigate.md b/v2.1/admin-ui-access-and-navigate.md
index 19d1491b5db..04005175906 100644
--- a/v2.1/admin-ui-access-and-navigate.md
+++ b/v2.1/admin-ui-access-and-navigate.md
@@ -1,12 +1,11 @@
---
title: Use the CockroachDB Admin UI
summary: Learn how to access and navigate the Admin UI.
-toc: false
+toc: true
---
The built-in Admin UI gives you essential metrics about a cluster's health, such as the number of live, dead, and suspect nodes, the number of unavailable ranges, and the queries per second and service latency across the cluster.
-
## Access the Admin UI
diff --git a/v2.1/admin-ui-custom-chart-debug-page.md b/v2.1/admin-ui-custom-chart-debug-page.md
index 5a16a51741e..b7cd7ba9098 100644
--- a/v2.1/admin-ui-custom-chart-debug-page.md
+++ b/v2.1/admin-ui-custom-chart-debug-page.md
@@ -1,13 +1,12 @@
---
title: Custom Chart Debug Page
-toc: false
+toc: true
---
The **Custom Chart** debug page in the Admin UI can be used to create a custom chart showing any combination of over [200 available metrics](#available-metrics).
The definition of the customized dashboard is encoded in the URL. To share the dashboard with someone, send them the URL. Like any other URL, it can be bookmarked, sit in a pinned tab in your browser, etc.
-
## Getting there
diff --git a/v2.1/admin-ui-databases-page.md b/v2.1/admin-ui-databases-page.md
index e6a5be93094..ab0f5b59d04 100644
--- a/v2.1/admin-ui-databases-page.md
+++ b/v2.1/admin-ui-databases-page.md
@@ -1,11 +1,10 @@
---
title: Database Page
-toc: false
+toc: true
---
The **Databases** page of the Admin UI provides details of the databases configured, the tables in each database, and the grants assigned to each user. To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then click **Databases** on the left-hand navigation bar.
-
## Tables view
diff --git a/v2.1/admin-ui-jobs-page.md b/v2.1/admin-ui-jobs-page.md
index 7d303d16d92..e13bd2bf898 100644
--- a/v2.1/admin-ui-jobs-page.md
+++ b/v2.1/admin-ui-jobs-page.md
@@ -1,11 +1,10 @@
---
title: Jobs Page
-toc: false
+toc: true
---
The **Jobs** page of the Admin UI provides details about the backup/restore jobs as well as schema changes performed across all nodes in the cluster. To view these details, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and then click **Jobs** on the left-hand navigation bar.
-
## Job details
diff --git a/v2.1/admin-ui-overview-dashboard.md b/v2.1/admin-ui-overview-dashboard.md
index 599661bb785..8b13379815c 100644
--- a/v2.1/admin-ui-overview-dashboard.md
+++ b/v2.1/admin-ui-overview-dashboard.md
@@ -1,12 +1,11 @@
---
title: Overview Dashboard
summary: The Overview dashboard lets you monitor important SQL performance, replication, and storage metrics.
-toc: false
+toc: true
---
The **Overview** dashboard lets you monitor important SQL performance, replication, and storage metrics. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui) and click **Metrics** on the left-hand navigation bar. The **Overview** dashboard is displayed by default.
-
The **Overview** dashboard displays the following time series graphs:
diff --git a/v2.1/admin-ui-replication-dashboard.md b/v2.1/admin-ui-replication-dashboard.md
index b47ee0c3862..4c35f6053f8 100644
--- a/v2.1/admin-ui-replication-dashboard.md
+++ b/v2.1/admin-ui-replication-dashboard.md
@@ -1,12 +1,11 @@
---
title: Replication Dashboard
summary: The Replication dashboard lets you monitor the replication metrics for your cluster.
-toc: false
+toc: true
---
The **Replication** dashboard in the CockroachDB Admin UI enables you to monitor the replication metrics for your cluster. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **Replication**.
-
## Review of CockroachDB terminology
diff --git a/v2.1/admin-ui-runtime-dashboard.md b/v2.1/admin-ui-runtime-dashboard.md
index 685e44d7f3a..8ba830fe43d 100644
--- a/v2.1/admin-ui-runtime-dashboard.md
+++ b/v2.1/admin-ui-runtime-dashboard.md
@@ -1,11 +1,10 @@
---
title: Runtime Dashboard
-toc: false
+toc: true
---
The **Runtime** dashboard in the CockroachDB Admin UI lets you monitor runtime metrics for you cluster, such as node count, memory usage, and CPU time. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **Runtime**.
-
The **Runtime** dashboard displays the following time series graphs:
diff --git a/v2.1/admin-ui-sql-dashboard.md b/v2.1/admin-ui-sql-dashboard.md
index 51c6ade626b..d9cb08aa9f9 100644
--- a/v2.1/admin-ui-sql-dashboard.md
+++ b/v2.1/admin-ui-sql-dashboard.md
@@ -1,12 +1,11 @@
---
title: SQL Dashboard
summary: The SQL dashboard lets you monitor the performance of your SQL queries.
-toc: false
+toc: true
---
The **SQL** dashboard in the CockroachDB Admin UI lets you monitor the performance of your SQL queries. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **SQL**.
-
The **SQL** dashboard displays the following time series graphs:
diff --git a/v2.1/admin-ui-statements-page.md b/v2.1/admin-ui-statements-page.md
index fc3be82c8e8..05316ad765d 100644
--- a/v2.1/admin-ui-statements-page.md
+++ b/v2.1/admin-ui-statements-page.md
@@ -1,13 +1,12 @@
---
title: Statements Page
-toc: false
+toc: true
---
The **Statements** page helps you identify the frequently executed or high latency [SQL statements](sql-statements.html). The **Statements** page also allows you to view the details of an individual SQL statement by clicking on the statement to view the **Statement Details** page.
To view the **Statements** page, open [http://localhost:8080/#/statements](http://localhost:8080/#/statements) in your browser (replacing `localhost` and `8080` with your node's host and port).
-
{{site.data.alerts.callout_danger}}
**This feature is a work in progress**. It will change leading up to the v2.1 release.
diff --git a/v2.1/admin-ui-storage-dashboard.md b/v2.1/admin-ui-storage-dashboard.md
index 6cc10f9200b..ab1ebac2e47 100644
--- a/v2.1/admin-ui-storage-dashboard.md
+++ b/v2.1/admin-ui-storage-dashboard.md
@@ -1,12 +1,11 @@
---
title: Storage Dashboard
summary: The Storage dashboard lets you monitor the storage utilization for your cluster.
-toc: false
+toc: true
---
The **Storage** dashboard in the CockroachDB Admin UI lets you monitor the storage utilization for your cluster. To view this dashboard, [access the Admin UI](admin-ui-access-and-navigate.html#access-the-admin-ui), click **Metrics** on the left-hand navigation bar, and then select **Dashboard** > **Storage**.
-
The **Storage** dashboard displays the following time series graphs:
diff --git a/v2.1/alter-column.md b/v2.1/alter-column.md
index 17a26f059bb..4295e590f68 100644
--- a/v2.1/alter-column.md
+++ b/v2.1/alter-column.md
@@ -1,7 +1,7 @@
---
title: ALTER COLUMN
summary: Use the ALTER COLUMN statement to set, change, or drop a column's Default constraint or to drop the Not Null constraint.
-toc: false
+toc: true
---
The `ALTER COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and sets, changes, or drops a column's [Default constraint](default-value.html) or drops the [Not Null constraint](not-null.html).
@@ -10,7 +10,6 @@ The `ALTER COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and
To manage other constraints, see [`ADD CONSTRAINT`](add-constraint.html) and [`DROP CONSTRAINT`](drop-constraint.html).
{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/alter-sequence.md b/v2.1/alter-sequence.md
index 9f6993f6a3f..cb2828ab1c8 100644
--- a/v2.1/alter-sequence.md
+++ b/v2.1/alter-sequence.md
@@ -1,7 +1,7 @@
---
title: ALTER SEQUENCE
summary: Use the ALTER SEQUENCE statement to change the name, increment values, and other settings of a sequence.
-toc: false
+toc: true
---
The `ALTER SEQUENCE` [statement](sql-statements.html) [changes the name](rename-sequence.html), increment values, and other settings of a sequence.
@@ -10,7 +10,6 @@ The `ALTER SEQUENCE` [statement](sql-statements.html) [changes the name](rename-
To understand how CockroachDB changes schema elements without requiring table locking or other user-visible downtime, see [Online Schema Changes in CockroachDB](https://www.cockroachlabs.com/blog/how-online-schema-changes-are-possible-in-cockroachdb/).
{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/alter-table.md b/v2.1/alter-table.md
index aa5f0f21f75..83f65c35cc7 100644
--- a/v2.1/alter-table.md
+++ b/v2.1/alter-table.md
@@ -1,7 +1,7 @@
---
title: ALTER TABLE
summary: Use the ALTER TABLE statement to change the schema of a table.
-toc: false
+toc: true
---
The `ALTER TABLE` [statement](sql-statements.html) applies a schema change to a table.
@@ -10,7 +10,6 @@ The `ALTER TABLE` [statement](sql-statements.html) applies a schema change to a
To understand how CockroachDB changes schema elements without requiring table locking or other user-visible downtime, see [Online Schema Changes in CockroachDB](https://www.cockroachlabs.com/blog/how-online-schema-changes-are-possible-in-cockroachdb/).
{{site.data.alerts.end}}
-
## Subcommands
diff --git a/v2.1/alter-user.md b/v2.1/alter-user.md
index 2d39aee9a3d..ad700bff41e 100644
--- a/v2.1/alter-user.md
+++ b/v2.1/alter-user.md
@@ -1,7 +1,7 @@
---
title: ALTER USER
summary: The ALTER USER statement can be used to add or change a user's password.
-toc: false
+toc: true
---
The `ALTER USER` [statement](sql-statements.html) can be used to add or change a [user's](create-and-manage-users.html) password.
@@ -10,7 +10,6 @@ The `ALTER USER` [statement](sql-statements.html) can be used to add or change a
You can also use the [`cockroach user`](create-and-manage-users.html#update-a-users-password) command to add or change a user's password.
{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.1/alter-view.md b/v2.1/alter-view.md
index 7a61f07e350..894c91cb9e0 100644
--- a/v2.1/alter-view.md
+++ b/v2.1/alter-view.md
@@ -1,7 +1,7 @@
---
title: ALTER VIEW
summary: The ALTER VIEW statement changes the name of a view.
-toc: false
+toc: true
---
The `ALTER VIEW` [statement](sql-statements.html) changes the name of a [view](views.html).
@@ -10,7 +10,6 @@ The `ALTER VIEW` [statement](sql-statements.html) changes the name of a [view](v
It is not currently possible to change the `SELECT` statement executed by a view. Instead, you must drop the existing view and create a new view. Also, it is not currently possible to rename a view that other views depend on, but this ability may be added in the future (see [this issue](https://github.com/cockroachdb/cockroach/issues/10083)).
{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/architecture/distribution-layer.md b/v2.1/architecture/distribution-layer.md
index c3c471e230e..f35c98611bf 100644
--- a/v2.1/architecture/distribution-layer.md
+++ b/v2.1/architecture/distribution-layer.md
@@ -1,7 +1,7 @@
---
title: Distribution Layer
summary:
-toc: false
+toc: true
---
The distribution layer of CockroachDB's architecture provides a unified view of your cluster's data.
@@ -10,7 +10,6 @@ The distribution layer of CockroachDB's architecture provides a unified view of
If you haven't already, we recommend reading the [Architecture Overview](overview.html).
{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.1/architecture/overview.md b/v2.1/architecture/overview.md
index 05cace14f01..e86f9bb3b26 100644
--- a/v2.1/architecture/overview.md
+++ b/v2.1/architecture/overview.md
@@ -1,7 +1,7 @@
---
title: Architecture Overview
summary:
-toc: false
+toc: true
key: cockroachdb-architecture.html
redirect_from: index.html
---
@@ -10,7 +10,6 @@ CockroachDB was designed to create the open-source database our developers would
However, you definitely do not need to understand the underlying architecture to use CockroachDB. These pages give serious users and database enthusiasts a high-level framework to explain what's happening under the hood.
-
## Using this guide
diff --git a/v2.1/architecture/replication-layer.md b/v2.1/architecture/replication-layer.md
index 69a845da10c..fee0272bcdc 100644
--- a/v2.1/architecture/replication-layer.md
+++ b/v2.1/architecture/replication-layer.md
@@ -1,7 +1,7 @@
---
title: Replication Layer
summary:
-toc: false
+toc: true
---
The replication layer of CockroachDB's architecture copies data between nodes and ensures consistency between these copies by implementing our consensus algorithm.
@@ -10,7 +10,6 @@ The replication layer of CockroachDB's architecture copies data between nodes an
If you haven't already, we recommend reading the [Architecture Overview](overview.html).
{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.1/architecture/sql-layer.md b/v2.1/architecture/sql-layer.md
index 34270aec839..42e9feea3b9 100644
--- a/v2.1/architecture/sql-layer.md
+++ b/v2.1/architecture/sql-layer.md
@@ -1,7 +1,7 @@
---
title: SQL Layer
summary:
-toc: false
+toc: true
---
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.
@@ -10,7 +10,6 @@ The SQL layer of CockroachDB's architecture exposes its SQL API to developers, a
If you haven't already, we recommend reading the [Architecture Overview](overview.html).
{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.1/architecture/storage-layer.md b/v2.1/architecture/storage-layer.md
index 542323640c6..838e9429f0b 100644
--- a/v2.1/architecture/storage-layer.md
+++ b/v2.1/architecture/storage-layer.md
@@ -1,7 +1,7 @@
---
title: Storage Layer
summary:
-toc: false
+toc: true
---
The storage layer of CockroachDB's architecture reads and writes data to disk.
@@ -10,7 +10,6 @@ The storage layer of CockroachDB's architecture reads and writes data to disk.
If you haven't already, we recommend reading the [Architecture Overview](overview.html).
{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.1/architecture/transaction-layer.md b/v2.1/architecture/transaction-layer.md
index c126f1e0a5d..510431fdafb 100644
--- a/v2.1/architecture/transaction-layer.md
+++ b/v2.1/architecture/transaction-layer.md
@@ -1,7 +1,7 @@
---
title: Transaction Layer
summary:
-toc: false
+toc: true
---
The transaction layer of CockroachDB's architecture implements support for ACID transactions by coordinating concurrent operations.
@@ -10,7 +10,6 @@ The transaction layer of CockroachDB's architecture implements support for ACID
If you haven't already, we recommend reading the [Architecture Overview](overview.html).
{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.1/array.md b/v2.1/array.md
index b6485b1ad28..a007e0a5ea5 100644
--- a/v2.1/array.md
+++ b/v2.1/array.md
@@ -1,14 +1,13 @@
---
title: ARRAY
summary: The ARRAY data type stores one-dimensional, 1-indexed, homogenous arrays of any non-array data types.
-toc: false
+toc: true
---
The `ARRAY` data type stores one-dimensional, 1-indexed, homogenous arrays of any non-array [data type](data-types.html).
The `ARRAY` data type is useful for ensuring compatibility with ORMs and other tools. However, if such compatibility is not a concern, it's more flexible to design your schema with normalized tables.
-
{{site.data.alerts.callout_info}}
CockroachDB does not support nested arrays, creating database indexes on arrays, and ordering by arrays.
diff --git a/v2.1/backup.md b/v2.1/backup.md
index 63957fc34c3..d1576a40c64 100644
--- a/v2.1/backup.md
+++ b/v2.1/backup.md
@@ -1,7 +1,7 @@
---
title: BACKUP
summary: Back up your CockroachDB cluster to a cloud storage services such as AWS S3, Google Cloud Storage, or other NFS.
-toc: false
+toc: true
---
{{site.data.alerts.callout_danger}}
@@ -12,7 +12,6 @@ CockroachDB's `BACKUP` [statement](sql-statements.html) allows you to create ful
Because CockroachDB is designed with high fault tolerance, these backups are designed primarily for disaster recovery (i.e., if your cluster loses a majority of its nodes) through [`RESTORE`](restore.html). Isolated issues (such as small-scale node outages) do not require any intervention.
-
## Functional details
diff --git a/v2.1/begin-transaction.md b/v2.1/begin-transaction.md
index a0cab3a5c76..64c78f4fa33 100644
--- a/v2.1/begin-transaction.md
+++ b/v2.1/begin-transaction.md
@@ -1,7 +1,7 @@
---
title: BEGIN
summary: Initiate a SQL transaction with the BEGIN statement in CockroachDB.
-toc: false
+toc: true
---
The `BEGIN` [statement](sql-statements.html) initiates a [transaction](transactions.html), which either successfully executes all of the statements it contains or none at all.
@@ -10,7 +10,6 @@ The `BEGIN` [statement](sql-statements.html) initiates a [transaction](transacti
When using transactions, your application should include logic to [retry transactions](transactions.html#transaction-retries) that are aborted to break a dependency cycle between concurrent transactions.
{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/bool.md b/v2.1/bool.md
index a15602a3c91..73bc8f17300 100644
--- a/v2.1/bool.md
+++ b/v2.1/bool.md
@@ -1,12 +1,11 @@
---
title: BOOL
summary: The BOOL data type stores Boolean values of false or true.
-toc: false
+toc: true
---
The `BOOL` [data type](data-types.html) stores a Boolean value of `false` or `true`.
-
## Aliases
diff --git a/v2.1/build-a-c++-app-with-cockroachdb.md b/v2.1/build-a-c++-app-with-cockroachdb.md
index 504f64f3a45..05f5993c9f8 100644
--- a/v2.1/build-a-c++-app-with-cockroachdb.md
+++ b/v2.1/build-a-c++-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a C++ App with CockroachDB
summary: Learn how to use CockroachDB from a simple C++ application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple C++ application with CockroachDB usin
We have tested the [C++ libpqxx driver](https://github.com/jtv/libpqxx) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-clojure-app-with-cockroachdb.md b/v2.1/build-a-clojure-app-with-cockroachdb.md
index 6f986396ff1..aa08301ebe9 100644
--- a/v2.1/build-a-clojure-app-with-cockroachdb.md
+++ b/v2.1/build-a-clojure-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Clojure App with CockroachDB
summary: Learn how to use CockroachDB from a simple Clojure application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple Clojure application with CockroachDB
We have tested the [Clojure java.jdbc driver](http://clojure-doc.org/articles/ecosystem/java_jdbc/home.html) in conjunction with the [PostgreSQL JDBC driver](https://jdbc.postgresql.org/) enough to claim **beta-level** support, so that combination is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-csharp-app-with-cockroachdb.md b/v2.1/build-a-csharp-app-with-cockroachdb.md
index 00a9ca7e661..0e2dfeb861d 100644
--- a/v2.1/build-a-csharp-app-with-cockroachdb.md
+++ b/v2.1/build-a-csharp-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a C# (.NET) App with CockroachDB
summary: Learn how to use CockroachDB from a simple C# (.NET) application with a low-level client driver.
-toc: false
+toc: true
twitter: true
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple C# (.NET) application with CockroachD
We have tested the [.NET Npgsql driver](http://www.npgsql.org/) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-go-app-with-cockroachdb-gorm.md b/v2.1/build-a-go-app-with-cockroachdb-gorm.md
index 4d84ebc610d..6d03d9c2c70 100644
--- a/v2.1/build-a-go-app-with-cockroachdb-gorm.md
+++ b/v2.1/build-a-go-app-with-cockroachdb-gorm.md
@@ -1,7 +1,7 @@
---
title: Build a Go App with CockroachDB
summary: Learn how to use CockroachDB from a simple Go application with the GORM ORM.
-toc: false
+toc: true
twitter: false
---
@@ -18,7 +18,6 @@ We have tested the [Go pq driver](https://godoc.org/github.com/lib/pq) and the [
For a more realistic use of GORM with CockroachDB, see our [`examples-orms`](https://github.com/cockroachdb/examples-orms) repository.
{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/build-a-go-app-with-cockroachdb.md b/v2.1/build-a-go-app-with-cockroachdb.md
index 2a544466879..89075bd74e7 100644
--- a/v2.1/build-a-go-app-with-cockroachdb.md
+++ b/v2.1/build-a-go-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Go App with CockroachDB
summary: Learn how to use CockroachDB from a simple Go application with the Go pq driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Go application with CockroachDB using
We have tested the [Go pq driver](https://godoc.org/github.com/lib/pq) and the [GORM ORM](http://jinzhu.me/gorm/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-java-app-with-cockroachdb-hibernate.md b/v2.1/build-a-java-app-with-cockroachdb-hibernate.md
index 28a108b49a5..ba80e9a9895 100644
--- a/v2.1/build-a-java-app-with-cockroachdb-hibernate.md
+++ b/v2.1/build-a-java-app-with-cockroachdb-hibernate.md
@@ -1,7 +1,7 @@
---
title: Build a Java App with CockroachDB
summary: Learn how to use CockroachDB from a simple Java application with the Hibernate ORM.
-toc: false
+toc: true
twitter: false
---
@@ -18,7 +18,6 @@ We have tested the [Java jdbc driver](https://jdbc.postgresql.org/) and the [Hib
For a more realistic use of Hibernate with CockroachDB, see our [`examples-orms`](https://github.com/cockroachdb/examples-orms) repository.
{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/build-a-java-app-with-cockroachdb.md b/v2.1/build-a-java-app-with-cockroachdb.md
index b720e11f81b..8ee2ed6cd26 100644
--- a/v2.1/build-a-java-app-with-cockroachdb.md
+++ b/v2.1/build-a-java-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Java App with CockroachDB
summary: Learn how to use CockroachDB from a simple Java application with the jdbc driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Java application with CockroachDB usi
We have tested the [Java jdbc driver](https://jdbc.postgresql.org/) and the [Hibernate ORM](http://hibernate.org/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-nodejs-app-with-cockroachdb-sequelize.md b/v2.1/build-a-nodejs-app-with-cockroachdb-sequelize.md
index a02dd107261..bbbf680d5e4 100644
--- a/v2.1/build-a-nodejs-app-with-cockroachdb-sequelize.md
+++ b/v2.1/build-a-nodejs-app-with-cockroachdb-sequelize.md
@@ -1,7 +1,7 @@
---
title: Build a Node.js App with CockroachDB
summary: Learn how to use CockroachDB from a simple Node.js application with the Sequelize ORM.
-toc: false
+toc: true
twitter: false
---
@@ -18,7 +18,6 @@ We have tested the [Node.js pg driver](https://www.npmjs.com/package/pg) and the
For a more realistic use of Sequelize with CockroachDB, see our [`examples-orms`](https://github.com/cockroachdb/examples-orms)repository.
{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/build-a-nodejs-app-with-cockroachdb.md b/v2.1/build-a-nodejs-app-with-cockroachdb.md
index 2035b3a8684..3b423a10ec1 100644
--- a/v2.1/build-a-nodejs-app-with-cockroachdb.md
+++ b/v2.1/build-a-nodejs-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Node.js App with CockroachDB
summary: Learn how to use CockroachDB from a simple Node.js application with the Node.js pg driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Node.js application with CockroachDB
We have tested the [Node.js pg driver](https://www.npmjs.com/package/pg) and the [Sequelize ORM](https://sequelize.readthedocs.io/en/v3/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-php-app-with-cockroachdb.md b/v2.1/build-a-php-app-with-cockroachdb.md
index 2db53ef578d..edf6a19959a 100644
--- a/v2.1/build-a-php-app-with-cockroachdb.md
+++ b/v2.1/build-a-php-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a PHP App with CockroachDB
summary: Learn how to use CockroachDB from a simple PHP application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple PHP application with CockroachDB usin
We have tested the [php-pgsql driver](http://php.net/manual/en/book.pgsql.php) enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-python-app-with-cockroachdb-sqlalchemy.md b/v2.1/build-a-python-app-with-cockroachdb-sqlalchemy.md
index c92b1ebbe10..cb8ed9a444a 100644
--- a/v2.1/build-a-python-app-with-cockroachdb-sqlalchemy.md
+++ b/v2.1/build-a-python-app-with-cockroachdb-sqlalchemy.md
@@ -1,7 +1,7 @@
---
title: Build a Python App with CockroachDB
summary: Learn how to use CockroachDB from a simple Python application with the SQLAlchemy ORM.
-toc: false
+toc: true
twitter: false
---
@@ -18,7 +18,6 @@ We have tested the [Python psycopg2 driver](http://initd.org/psycopg/docs/) and
For a more realistic use of SQLAlchemy with CockroachDB, see our [`examples-orms`](https://github.com/cockroachdb/examples-orms) repository.
{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/build-a-python-app-with-cockroachdb.md b/v2.1/build-a-python-app-with-cockroachdb.md
index c710b793d8b..4459f0ff429 100644
--- a/v2.1/build-a-python-app-with-cockroachdb.md
+++ b/v2.1/build-a-python-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Python App with CockroachDB
summary: Learn how to use CockroachDB from a simple Python application with the psycopg2 driver.
-toc: false
+toc: true
asciicast: true
twitter: false
---
@@ -15,7 +15,6 @@ This tutorial shows you how build a simple Python application with CockroachDB u
We have tested the [Python psycopg2 driver](http://initd.org/psycopg/docs/) and the [SQLAlchemy ORM](https://docs.sqlalchemy.org/en/latest/) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-ruby-app-with-cockroachdb-activerecord.md b/v2.1/build-a-ruby-app-with-cockroachdb-activerecord.md
index d809c92ede0..bf6d4c5c0b5 100644
--- a/v2.1/build-a-ruby-app-with-cockroachdb-activerecord.md
+++ b/v2.1/build-a-ruby-app-with-cockroachdb-activerecord.md
@@ -1,7 +1,7 @@
---
title: Build a Ruby App with CockroachDB
summary: Learn how to use CockroachDB from a simple Ruby application with the ActiveRecord ORM.
-toc: false
+toc: true
twitter: false
---
@@ -18,7 +18,6 @@ We have tested the [Ruby pg driver](https://rubygems.org/gems/pg) and the [Activ
For a more realistic use of ActiveRecord with CockroachDB, see our [`examples-orms`](https://github.com/cockroachdb/examples-orms) repository.
{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/build-a-ruby-app-with-cockroachdb.md b/v2.1/build-a-ruby-app-with-cockroachdb.md
index 36b118733c7..d8e7c3022d8 100644
--- a/v2.1/build-a-ruby-app-with-cockroachdb.md
+++ b/v2.1/build-a-ruby-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Ruby App with CockroachDB
summary: Learn how to use CockroachDB from a simple Ruby application with the pg client driver.
-toc: false
+toc: true
twitter: false
---
@@ -14,7 +14,6 @@ This tutorial shows you how build a simple Ruby application with CockroachDB usi
We have tested the [Ruby pg driver](https://rubygems.org/gems/pg) and the [ActiveRecord ORM](http://guides.rubyonrails.org/active_record_basics.html) enough to claim **beta-level** support, so those are featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/build-a-rust-app-with-cockroachdb.md b/v2.1/build-a-rust-app-with-cockroachdb.md
index 9a36398a0a9..b1f5844e97f 100644
--- a/v2.1/build-a-rust-app-with-cockroachdb.md
+++ b/v2.1/build-a-rust-app-with-cockroachdb.md
@@ -1,7 +1,7 @@
---
title: Build a Rust App with CockroachDB
summary: Learn how to use CockroachDB from a simple Rust application with a low-level client driver.
-toc: false
+toc: true
twitter: false
---
@@ -9,7 +9,6 @@ This tutorial shows you how build a simple Rust application with CockroachDB usi
We have tested the Rust postgres driver enough to claim **beta-level** support, so that driver is featured here. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support.
-
## Before you begin
diff --git a/v2.1/bytes.md b/v2.1/bytes.md
index d1bec261815..c23d77eaf47 100644
--- a/v2.1/bytes.md
+++ b/v2.1/bytes.md
@@ -1,12 +1,11 @@
---
title: BYTES
summary: The BYTES data type stores binary strings of variable length.
-toc: false
+toc: true
---
The `BYTES` [data type](data-types.html) stores binary strings of variable length.
-
## Aliases
diff --git a/v2.1/cancel-job.md b/v2.1/cancel-job.md
index 9881d1d9408..04b5a2b6aff 100644
--- a/v2.1/cancel-job.md
+++ b/v2.1/cancel-job.md
@@ -1,12 +1,11 @@
---
title: CANCEL JOB
summary: The CANCEL JOB statement stops long-running jobs.
-toc: false
+toc: true
---
The `CANCEL JOB` [statement](sql-statements.html) lets you stop long-running jobs, which include [`IMPORT`](import.html) jobs, enterprise [`BACKUP`](backup.html) and [`RESTORE`](restore.html) jobs, and as of v2.1, schema changes.
-
## Limitations
diff --git a/v2.1/cancel-query.md b/v2.1/cancel-query.md
index 35c83df1efd..9964e5230f1 100644
--- a/v2.1/cancel-query.md
+++ b/v2.1/cancel-query.md
@@ -1,12 +1,11 @@
---
title: CANCEL QUERY
summary: The CANCEL QUERY statement cancels a running SQL query.
-toc: false
+toc: true
---
The `CANCEL QUERY` [statement](sql-statements.html) cancels a running SQL query.
-
## Considerations
diff --git a/v2.1/cancel-session.md b/v2.1/cancel-session.md
index 1795793a89d..33527ebc456 100644
--- a/v2.1/cancel-session.md
+++ b/v2.1/cancel-session.md
@@ -1,12 +1,11 @@
---
title: CANCEL SESSION
summary: The CANCEL SESSION statement stops long-running sessions.
-toc: false
+toc: true
---
New in v2.1: The `CANCEL SESSION` [statement](sql-statements.html) lets you stop long-running sessions. `CANCEL SESSION` will attempt to cancel the currently active query and end the session.
-
## Required privileges
diff --git a/v2.1/change-data-capture.md b/v2.1/change-data-capture.md
index ba5da691fef..029a346878d 100644
--- a/v2.1/change-data-capture.md
+++ b/v2.1/change-data-capture.md
@@ -1,7 +1,7 @@
---
title: Change Data Capture (CDC)
summary: Change data capture (CDC) provides efficient, distributed, row-level change subscriptions.
-toc: false
+toc: true
---
New in v2.1: Change data capture (CDC) provides efficient, distributed, row-level change feeds into Apache Kafka for downstream processing such as reporting, caching, or full-text indexing.
@@ -12,7 +12,6 @@ toc: false
In v2.1, CDC will be an enterprise feature and will have a core version.
{{site.data.alerts.end}}
-
## What is change data capture?
diff --git a/v2.1/check.md b/v2.1/check.md
index 129f26974a1..21bd0acbb9b 100644
--- a/v2.1/check.md
+++ b/v2.1/check.md
@@ -1,12 +1,11 @@
---
title: CHECK Constraint
summary: The CHECK constraint specifies that values for the column in INSERT or UPDATE statements must satisfy a Boolean expression.
-toc: false
+toc: true
---
The `CHECK` [constraint](constraints.html) specifies that values for the column in [`INSERT`](insert.html) or [`UPDATE`](update.html) statements must return `TRUE` or `NULL` for a Boolean expression. If any values return `FALSE`, the entire statement is rejected.
-
## Details
diff --git a/v2.1/cluster-settings.md b/v2.1/cluster-settings.md
index ed3e9cd00c7..f08f59287fa 100644
--- a/v2.1/cluster-settings.md
+++ b/v2.1/cluster-settings.md
@@ -1,7 +1,7 @@
---
title: Cluster Settings
summary: Learn about cluster settings that apply to all nodes of a CockroachDB cluster.
-toc: false
+toc: true
---
Cluster settings apply to all nodes of a CockroachDB cluster and control, for example, whether or not to share diagnostic details with Cockroach Labs as well as advanced options for debugging and cluster tuning.
@@ -10,7 +10,6 @@ They can be updated anytime after a cluster has been started, but only by the `r
{{site.data.alerts.callout_info}}In contrast to cluster-wide settings, node-level settings apply to a single node. They are defined by flags passed to the cockroach start command when starting a node and cannot be changed without stopping and restarting the node. For more details, see Start a Node.{{site.data.alerts.end}}
-
## Settings
diff --git a/v2.1/cluster-setup-troubleshooting.md b/v2.1/cluster-setup-troubleshooting.md
index 9730350bb40..19078c5aab6 100644
--- a/v2.1/cluster-setup-troubleshooting.md
+++ b/v2.1/cluster-setup-troubleshooting.md
@@ -1,12 +1,11 @@
---
title: Troubleshoot Cluster Setup
summary: Learn how to troubleshoot issues with starting CockroachDB clusters
-toc: false
+toc: true
---
If you're having trouble starting or scaling your cluster, this page will help you troubleshoot the issue.
-
## Before you begin
diff --git a/v2.1/cockroach-commands.md b/v2.1/cockroach-commands.md
index 2cee7f6bd91..aaaa304b42b 100644
--- a/v2.1/cockroach-commands.md
+++ b/v2.1/cockroach-commands.md
@@ -1,14 +1,13 @@
---
title: Cockroach Commands
summary: Learn the commands for configuring, starting, and managing a CockroachDB cluster.
-toc: false
+toc: true
---
This page introduces the `cockroach` commands for configuring, starting, and managing a CockroachDB cluster, as well as environment variables that can be used in place of certain flags.
You can run `cockroach help` in your shell to get similar guidance.
-
## Commands
diff --git a/v2.1/collate.md b/v2.1/collate.md
index 1692460fa20..fc7a502004a 100644
--- a/v2.1/collate.md
+++ b/v2.1/collate.md
@@ -1,7 +1,7 @@
---
title: COLLATE
summary: The COLLATE feature lets you sort strings according to language- and country-specific rules.
-toc: false
+toc: true
redirect_from: collatedstring.html
---
@@ -9,7 +9,6 @@ The `COLLATE` feature lets you sort [`STRING`](string.html) values according to
Collated strings are important because different languages have [different rules for alphabetic order](https://en.wikipedia.org/wiki/Alphabetical_order#Language-specific_conventions), especially with respect to accented letters. For example, in German accented letters are sorted with their unaccented counterparts, while in Swedish they are placed at the end of the alphabet. A collation is a set of rules used for ordering and usually corresponds to a language, though some languages have multiple collations with different rules for sorting; for example Portuguese has separate collations for Brazilian and European dialects (`pt-BR` and `pt-PT` respectively).
-
## Details
diff --git a/v2.1/column-families.md b/v2.1/column-families.md
index a4b2795c3e5..f776a3ef815 100644
--- a/v2.1/column-families.md
+++ b/v2.1/column-families.md
@@ -1,14 +1,13 @@
---
title: Column Families
summary: A column family is a group of columns in a table that are stored as a single key-value pair in the underlying key-value store.
-toc: false
+toc: true
---
A column family is a group of columns in a table that are stored as a single key-value pair in the underlying key-value store. The reduced number of keys results in a smaller storage overhead and, even more significantly, in improved performance during `INSERT`, `UPDATE`, and `DELETE` operations.
This page explains how CockroachDB organizes columns into families as well as cases in which you might want to manually override the default behavior.
-
## Default behavior
diff --git a/v2.1/commit-transaction.md b/v2.1/commit-transaction.md
index fe3b7fe2697..0a0674f6cdd 100644
--- a/v2.1/commit-transaction.md
+++ b/v2.1/commit-transaction.md
@@ -1,7 +1,7 @@
---
title: COMMIT
summary: Commit a transaction with the COMMIT statement in CockroachDB.
-toc: false
+toc: true
---
The `COMMIT` [statement](sql-statements.html) commits the current [transaction](transactions.html) or, when using [client-side transaction retries](transactions.html#client-side-transaction-retries), clears the connection to allow new transactions to begin.
@@ -10,7 +10,6 @@ When using [client-side transaction retries](transactions.html#client-side-trans
For non-retryable transactions, if statements in the transaction [generated any errors](transactions.html#error-handling), `COMMIT` is equivalent to `ROLLBACK`, which aborts the transaction and discards *all* updates made by its statements.
-
## Synopsis
diff --git a/v2.1/common-table-expressions.md b/v2.1/common-table-expressions.md
index 69276468ef6..83177ea584e 100644
--- a/v2.1/common-table-expressions.md
+++ b/v2.1/common-table-expressions.md
@@ -1,7 +1,7 @@
---
title: Common Table Expressions
summary: Common Table Expressions (CTEs) simplify the definition and use of subqueries
-toc: false
+toc: true
toc_not_nested: true
---
@@ -14,7 +14,6 @@ clauses](select-clause.html) and [`INSERT`](insert.html),
[`DELETE`](delete.html), [`UPDATE`](update.html) and
[`UPSERT`](upsert.html) statements.
-
## Synopsis
diff --git a/v2.1/computed-columns.md b/v2.1/computed-columns.md
index 5cb9fd480fe..b4a495ab3ec 100644
--- a/v2.1/computed-columns.md
+++ b/v2.1/computed-columns.md
@@ -1,12 +1,11 @@
---
title: Computed Columns
summary: A computed column stores data generated by an expression included in the column definition.
-toc: false
+toc: true
---
A computed column stores data generated from other columns by a [scalar expression](scalar-expressions.html) included in the column definition.
-
## Why use computed columns?
diff --git a/v2.1/configure-replication-zones.md b/v2.1/configure-replication-zones.md
index 2cc450af927..65a0ab3445f 100644
--- a/v2.1/configure-replication-zones.md
+++ b/v2.1/configure-replication-zones.md
@@ -2,7 +2,7 @@
title: Configure Replication Zones
summary: In CockroachDB, you use replication zones to control the number and location of replicas for specific sets of data.
keywords: ttl, time to live, availability zone
-toc: false
+toc: true
---
In CockroachDB, you use **replication zones** to control the number and location of replicas for specific sets of data, both when replicas are first added and when they are rebalanced to maintain cluster equilibrium. Initially, there are some special pre-configured replication zones for internal system data along with a default replication zone that applies to the rest of the cluster. You can adjust these pre-configured zones as well as add zones for individual databases, tables, and rows ([enterprise-only](enterprise-licensing.html)) as needed. For example, you might use the default zone to replicate most data in a cluster normally within a single datacenter, while creating a specific zone to more highly replicate a certain database or table across multiple datacenters and geographies.
@@ -11,7 +11,6 @@ This page explains how replication zones work and how to use the `cockroach zone
{{site.data.alerts.callout_info}}Currently, only the root user can configure replication zones.{{site.data.alerts.end}}
-
## Overview
diff --git a/v2.1/connection-parameters.md b/v2.1/connection-parameters.md
index b79af8d18bc..602dd4afb5d 100644
--- a/v2.1/connection-parameters.md
+++ b/v2.1/connection-parameters.md
@@ -1,7 +1,7 @@
---
title: Client Connection Parameters
summary: This page describes the parameters used to establish a client connection.
-toc: false
+toc: true
---
Client applications, including client [`cockroach`
@@ -10,7 +10,6 @@ connection to a CockroachDB cluster. The client connection parameters
determine which CockroachDB cluster they connect to, and how to
establish this network connection.
-
## Supported connection parameters
diff --git a/v2.1/constraints.md b/v2.1/constraints.md
index 3dc58d63306..3e0c96fbaf8 100644
--- a/v2.1/constraints.md
+++ b/v2.1/constraints.md
@@ -1,14 +1,13 @@
---
title: Constraints
summary: Constraints offer additional data integrity by enforcing conditions on the data within a column.
-toc: false
+toc: true
---
Constraints offer additional data integrity by enforcing conditions on the data within a column. Whenever values are manipulated (inserted, deleted, or updated), constraints are checked and modifications that violate constraints are rejected.
For example, the Unique constraint requires that all values in a column be unique from one another (except *NULL* values). If you attempt to write a duplicate value, the constraint rejects the entire statement.
-
## Supported constraints
diff --git a/v2.1/contribute-to-cockroachdb.md b/v2.1/contribute-to-cockroachdb.md
index ab81db06c54..10a7cadfbf1 100644
--- a/v2.1/contribute-to-cockroachdb.md
+++ b/v2.1/contribute-to-cockroachdb.md
@@ -1,12 +1,11 @@
---
title: Contribute to CockroachDB
summary: Contribute to the development of CockroachDB.
-toc: false
+toc: true
---
We made CockroachDB open source to empower developers to fix and extend the product to better meet their needs. Nothing thrills us more than people so passionate about the product that they‘re willing to spend their own time to learn the codebase and give back to the community. We created this doc so we can support contributors in a way that doesn’t sacrifice precious bandwidth that we use to serve our users and otherwise meet our business goals.
-
## Introduction
diff --git a/v2.1/create-a-file-server.md b/v2.1/create-a-file-server.md
index 4e6596b0d31..e7db5559b4c 100644
--- a/v2.1/create-a-file-server.md
+++ b/v2.1/create-a-file-server.md
@@ -1,7 +1,7 @@
---
title: Create a File Server for Imports and Backups
summary: Learn how to create a simple file server for use with CockroachDB IMPORT and BACKUP
-toc: false
+toc: true
---
If you need a location to store files for the [`IMPORT`](import.html) process or [CockroachDB enterprise backups](backup.html), but do not have access to (or simply cannot use) cloud storage providers, you can easily create your own file server. You can then use this file server by leveraging support for our HTTP Export Storage API.
@@ -11,7 +11,6 @@ This is especially useful for:
- Implementing a compatibility layer in front of custom or proprietary storage providers for which CockroachDB does not yet have native support
- Using on-premises storage
-
## HTTP export storage API
diff --git a/v2.1/create-and-manage-users.md b/v2.1/create-and-manage-users.md
index 2f93b61593b..16f7e944896 100644
--- a/v2.1/create-and-manage-users.md
+++ b/v2.1/create-and-manage-users.md
@@ -1,14 +1,13 @@
---
title: Manage Users
summary: To create and manage your cluster's users (which lets you control SQL-level privileges), use the cockroach user command with appropriate flags.
-toc: false
+toc: true
---
To create, manage, and remove your cluster's users (which lets you control SQL-level [privileges](privileges.html)), use the `cockroach user` [command](cockroach-commands.html) with appropriate flags.
{{site.data.alerts.callout_success}}You can also use the CREATE USER and DROP USER statements to create and remove users.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.1/create-changefeed.md b/v2.1/create-changefeed.md
index 9e2eca4b1ee..79f4aa4eaa7 100644
--- a/v2.1/create-changefeed.md
+++ b/v2.1/create-changefeed.md
@@ -1,7 +1,7 @@
---
title: CREATE CHANGEFEED
summary: The CREATE CHANGEFEED statement creates a new changefeed, which provides row-level change subscriptions.
-toc: false
+toc: true
---
New in v2.1: The `CREATE CHANGEFEED` [statement](sql-statements.html) creates a new changefeed, which provides row-level change subscriptions.
@@ -16,7 +16,6 @@ For more information, see [Change Data Capture](change-data-capture.html).
In v2.1, CDC will be an enterprise feature and will have a core version.
{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/create-database.md b/v2.1/create-database.md
index 718f2346d40..b9c3184c441 100644
--- a/v2.1/create-database.md
+++ b/v2.1/create-database.md
@@ -1,12 +1,11 @@
---
title: CREATE DATABASE
summary: The CREATE DATABASE statement creates a new CockroachDB database.
-toc: false
+toc: true
---
The `CREATE DATABASE` [statement](sql-statements.html) creates a new CockroachDB database.
-
## Required privileges
diff --git a/v2.1/create-index.md b/v2.1/create-index.md
old mode 100755
new mode 100644
index 3503c5843c3..13dec5f72d0
--- a/v2.1/create-index.md
+++ b/v2.1/create-index.md
@@ -1,7 +1,7 @@
---
title: CREATE INDEX
summary: The CREATE INDEX statement creates an index for a table. Indexes improve your database's performance by helping SQL quickly locate data.
-toc: false
+toc: true
---
The `CREATE INDEX` [statement](sql-statements.html) creates an index for a table. [Indexes](indexes.html) improve your database's performance by helping SQL locate data without having to look through every row of a table.
@@ -10,7 +10,6 @@ To create an index on the schemaless data in a [`JSONB`](jsonb.html) column, use
{{site.data.alerts.callout_info}}Indexes are automatically created for a table's PRIMARY KEY and UNIQUE columns.When querying a table, CockroachDB uses the fastest index. For more information about that process, see Index Selection in CockroachDB.{{site.data.alerts.end}} - ## Required privileges diff --git a/v2.1/create-role.md b/v2.1/create-role.md index 9a1a0a8f29e..9666703a660 100644 --- a/v2.1/create-role.md +++ b/v2.1/create-role.md @@ -1,14 +1,13 @@ --- title: CREATE ROLE (Enterprise) summary: The CREATE ROLE statement creates SQL roles, which are groups containing any number of roles and users as members. -toc: false +toc: true --- The `CREATE ROLE` [statement](sql-statements.html) creates SQL [roles](roles.html), which are groups containing any number of roles and users as members. You can assign privileges to roles, and all members of the role (regardless of whether if they are direct or indirect members) will inherit the role's privileges. {{site.data.alerts.callout_info}}
CREATE ROLE is an enterprise-only feature.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.1/create-security-certificates-openssl.md b/v2.1/create-security-certificates-openssl.md
index 36f30449a53..1f854e739de 100644
--- a/v2.1/create-security-certificates-openssl.md
+++ b/v2.1/create-security-certificates-openssl.md
@@ -1,7 +1,7 @@
---
title: Create Security Certificates
summary: A secure CockroachDB cluster uses TLS for encrypted inter-node and client-node communication.
-toc: false
+toc: true
---
@@ -11,7 +11,6 @@ toc: false
A secure CockroachDB cluster uses [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) for encrypted inter-node and client-node communication, which requires CA, node, and client certificates and keys. To create these certificates and keys, use the `cockroach cert` [commands](cockroach-commands.html) with the appropriate subcommands and flags, or use [`openssl` commands](https://wiki.openssl.org/index.php/).
-
## Subcommands
diff --git a/v2.1/create-security-certificates.md b/v2.1/create-security-certificates.md
index 1498a73fc6b..22ccc3a4116 100644
--- a/v2.1/create-security-certificates.md
+++ b/v2.1/create-security-certificates.md
@@ -1,7 +1,7 @@
---
title: Create Security Certificates
summary: A secure CockroachDB cluster uses TLS for encrypted inter-node and client-node communication.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ A secure CockroachDB cluster uses [TLS](https://en.wikipedia.org/wiki/Transport_
{{site.data.alerts.callout_success}}For details about when and how to change security certificates without restarting nodes, see Rotate Security Certificates.{{site.data.alerts.end}}
-
## How security certificates work
diff --git a/v2.1/create-sequence.md b/v2.1/create-sequence.md
index 459da37e983..9676fbdc82c 100644
--- a/v2.1/create-sequence.md
+++ b/v2.1/create-sequence.md
@@ -1,12 +1,11 @@
---
title: CREATE SEQUENCE
summary:
-toc: false
+toc: true
---
The `CREATE SEQUENCE` [statement](sql-statements.html) creates a new sequence in a database. Use a sequence to auto-increment integers in a table.
-
## Considerations
diff --git a/v2.1/create-table-as.md b/v2.1/create-table-as.md
index fb54f1f9cae..179a7a5fdea 100644
--- a/v2.1/create-table-as.md
+++ b/v2.1/create-table-as.md
@@ -1,12 +1,11 @@
---
title: CREATE TABLE AS
summary: The CREATE TABLE AS statement persists the result of a query into the database for later reuse.
-toc: false
+toc: true
---
The `CREATE TABLE ... AS` statement creates a new table from a [selection query](selection-queries.html).
-
## Intended use
diff --git a/v2.1/create-table.md b/v2.1/create-table.md
index 0ebb689b686..108d4445a8e 100644
--- a/v2.1/create-table.md
+++ b/v2.1/create-table.md
@@ -1,12 +1,11 @@
---
title: CREATE TABLE
summary: The CREATE TABLE statement creates a new table in a database.
-toc: false
+toc: true
---
The `CREATE TABLE` [statement](sql-statements.html) creates a new table in a database.
-
## Required privileges
diff --git a/v2.1/create-user.md b/v2.1/create-user.md
index 0276e6afd0a..f3de914f133 100644
--- a/v2.1/create-user.md
+++ b/v2.1/create-user.md
@@ -1,14 +1,13 @@
---
title: CREATE USER
summary: The CREATE USER statement creates SQL users, which let you control privileges on your databases and tables.
-toc: false
+toc: true
---
The `CREATE USER` [statement](sql-statements.html) creates SQL users, which let you control [privileges](privileges.html) on your databases and tables.
{{site.data.alerts.callout_success}}You can also use the 
-
## Set up and enable the Node Map
diff --git a/v2.1/encryption.md b/v2.1/encryption.md
index 0c50bce21fa..723b20e8005 100644
--- a/v2.1/encryption.md
+++ b/v2.1/encryption.md
@@ -1,7 +1,7 @@
---
title: Encryption At Rest
summary: Encryption At Rest encrypts node data on local disk transparently.
-toc: false
+toc: true
---
New in v2.1:
@@ -9,7 +9,6 @@ Encryption At Rest provides transparent encryption for node data on local disk.
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Overview
diff --git a/v2.1/enterprise-licensing.md b/v2.1/enterprise-licensing.md
index ba113d9cd18..a64bd31e8c4 100644
--- a/v2.1/enterprise-licensing.md
+++ b/v2.1/enterprise-licensing.md
@@ -1,14 +1,13 @@
---
title: Enterprise Licensing
summary: Request and set trial and enterprise license keys for CockroachDB
-toc: false
+toc: true
---
CockroachDB distributes a single binary that contains both core and [enterprise features](https://www.cockroachlabs.com/pricing/). You can use core features without any license key. However, to use the enterprise features, you need either a trial or an enterprise license key.
This page shows you how to obtain and set trial and enterprise license keys for CockroachDB.
-
## Types of licenses
diff --git a/v2.1/experimental-audit.md b/v2.1/experimental-audit.md
index 9cc4a50ca2f..661927c9b5a 100644
--- a/v2.1/experimental-audit.md
+++ b/v2.1/experimental-audit.md
@@ -1,7 +1,7 @@
---
title: EXPERIMENTAL_AUDIT
summary: Use the EXPERIMENTAL_AUDIT subcommand to turn SQL audit logging on or off for a table.
-toc: false
+toc: true
---
`EXPERIMENTAL_AUDIT` is a subcommand of [`ALTER TABLE`](alter-table.html) that is used to turn [SQL audit logging](sql-audit-logging.html) on or off for a table.
@@ -17,7 +17,6 @@ For a detailed description of exactly what is logged, see the [Audit Log File Fo
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Synopsis
diff --git a/v2.1/explain.md b/v2.1/explain.md
index 65c78679bae..d3a73da5179 100644
--- a/v2.1/explain.md
+++ b/v2.1/explain.md
@@ -1,12 +1,11 @@
---
title: EXPLAIN
summary: The EXPLAIN statement provides information you can use to optimize SQL queries.
-toc: false
+toc: true
---
The `EXPLAIN` [statement](sql-statements.html) returns CockroachDB's query plan for an [explainable statement](#explainable-statements). You can then use this information to optimize the query.
-
## Explainable statements
diff --git a/v2.1/export.md b/v2.1/export.md
index 88d8b9473e6..b10683dd8c4 100644
--- a/v2.1/export.md
+++ b/v2.1/export.md
@@ -1,7 +1,7 @@
---
title: EXPORT
summary: Export tabular data from a CockroachDB cluster in CSV format.
-toc: false
+toc: true
---
New in v2.1: The `EXPORT` [statement](sql-statements.html) exports tabular data or the results of arbitrary `SELECT` statements to CSV files.
@@ -10,7 +10,6 @@ Using the [CockroachDB distributed execution engine](https://www.cockroachlabs.c
{{site.data.alerts.callout_danger}}The statement grants user privileges for interacting with specific databases and tables.
-toc: false
+toc: true
---
The `GRANT ` [statement](sql-statements.html) lets you add a [role](roles.html) or [user](create-and-manage-users.html) as a member to a role.
{{site.data.alerts.callout_info}}` [statement](sql-statements.html) lets you control each [role](roles.html) or [user's](create-and-manage-users.html) SQL [privileges](privileges.html) for interacting with specific databases and tables.
For privileges required by specific statements, see the documentation for the respective [SQL statement](sql-statements.html).
-
## Synopsis
diff --git a/v2.1/import-data.md b/v2.1/import-data.md
index 7756af54e29..6ba53743916 100644
--- a/v2.1/import-data.md
+++ b/v2.1/import-data.md
@@ -1,14 +1,13 @@
---
title: Import Data
summary: Learn how to import data into a CockroachDB cluster.
-toc: false
+toc: true
---
CockroachDB supports importing data from CSV/TSV or SQL dump files.
{{site.data.alerts.callout_info}}To import/restore data from CockroachDB-generated enterprise license backups, see
cockroach user set command to create and manage users.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.1/create-view.md b/v2.1/create-view.md
index c6a67c85eb1..ceaaabd14ed 100644
--- a/v2.1/create-view.md
+++ b/v2.1/create-view.md
@@ -1,12 +1,11 @@
---
title: CREATE VIEW
summary: The CREATE VIEW statement creates a .
-toc: false
+toc: true
---
The `CREATE VIEW` statement creates a new [view](views.html), which is a stored query represented as a virtual table.
-
## Required privileges
diff --git a/v2.1/date.md b/v2.1/date.md
index eaa177ea9d6..ecbdb2c2b14 100644
--- a/v2.1/date.md
+++ b/v2.1/date.md
@@ -1,12 +1,11 @@
---
title: DATE
summary: The DATE data type stores a year, month, and day.
-toc: false
+toc: true
---
The `DATE` [data type](data-types.html) stores a year, month, and day.
-
## Syntax
diff --git a/v2.1/debug-and-error-logs.md b/v2.1/debug-and-error-logs.md
index 54df7b579b2..be2e9bb61e3 100644
--- a/v2.1/debug-and-error-logs.md
+++ b/v2.1/debug-and-error-logs.md
@@ -1,7 +1,7 @@
---
title: Understand Debug & Error Logs
summary: Learn how to find and read CockroachDB error logs
-toc: false
+toc: true
---
If you need to [troubleshoot](troubleshooting-overview.html) issues with your cluster, you can check a node's logs, which include details about certain node-level and range-level events, such as errors. For example, if CockroachDB crashes, it normally logs a stack trace to what caused the problem.
@@ -10,7 +10,6 @@ If you need to [troubleshoot](troubleshooting-overview.html) issues with your cl
For detailed information about queries being executed against your system, see [SQL Audit Logging](sql-audit-logging.html).
{{site.data.alerts.end}}
-
## Details
diff --git a/v2.1/debug-zip.md b/v2.1/debug-zip.md
index b7109faa204..bc630eb3933 100644
--- a/v2.1/debug-zip.md
+++ b/v2.1/debug-zip.md
@@ -1,7 +1,7 @@
---
title: Collect Debug Information from Your Cluster
summary: Learn the commands for collecting debug information from all nodes in your cluster.
-toc: false
+toc: true
---
The `debug zip` [command](cockroach-commands.html) connects to your cluster and gathers the following information from each active node into a single file (inactive nodes are not included):
@@ -17,7 +17,6 @@ The `debug zip` [command](cockroach-commands.html) connects to your cluster and
{{site.data.alerts.callout_danger}}The file produced by cockroach debug zip can contain highly sensitive, unanonymized information, such as usernames, passwords, and possibly your table's data. You should share this data only with Cockroach Labs developers and only after determining the most secure method of delivery.{{site.data.alerts.end}}
-
## Details
diff --git a/v2.1/decimal.md b/v2.1/decimal.md
index 95949662f93..1d900ec49ae 100644
--- a/v2.1/decimal.md
+++ b/v2.1/decimal.md
@@ -1,12 +1,11 @@
---
title: DECIMAL
summary: The DECIMAL data type stores exact, fixed-point numbers.
-toc: false
+toc: true
---
The `DECIMAL` [data type](data-types.html) stores exact, fixed-point numbers. This type is used when it is important to preserve exact precision, for example, with monetary data.
-
## Aliases
diff --git a/v2.1/default-value.md b/v2.1/default-value.md
index f0b66f60da7..71143afe8ef 100644
--- a/v2.1/default-value.md
+++ b/v2.1/default-value.md
@@ -1,12 +1,11 @@
---
title: Default Value Constraint
summary: The Default Value constraint specifies a value to populate a column with if none is provided.
-toc: false
+toc: true
---
The Default Value [constraint](constraints.html) specifies a value to write into the constrained column if one is not defined in an `INSERT` statement. The value may be either a hard-coded literal or an expression that is evaluated at the time the row is created.
-
## Details
diff --git a/v2.1/delete.md b/v2.1/delete.md
index f63ce0fcb68..0acc6911922 100644
--- a/v2.1/delete.md
+++ b/v2.1/delete.md
@@ -1,7 +1,7 @@
---
title: DELETE
summary: The DELETE statement deletes rows from a table.
-toc: false
+toc: true
---
The `DELETE` [statement](sql-statements.html) deletes rows from a table.
@@ -10,7 +10,6 @@ The `DELETE` [statement](sql-statements.html) deletes rows from a table.
{{site.data.alerts.callout_info}}To delete columns, see DROP COLUMN.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/demo-automatic-cloud-migration.md b/v2.1/demo-automatic-cloud-migration.md
index 2f479dc70de..0987e878e53 100644
--- a/v2.1/demo-automatic-cloud-migration.md
+++ b/v2.1/demo-automatic-cloud-migration.md
@@ -1,12 +1,11 @@
---
title: Cross-Cloud Migration
summary: Use a local cluster to simulate migrating from one cloud platform to another.
-toc: false
+toc: true
---
CockroachDB's flexible [replication controls](configure-replication-zones.html) make it trivially easy to run a single CockroachDB cluster across cloud platforms and to migrate data from one cloud to another without any service interruption. This page walks you through a local simulation of the process.
-
## Watch the demo
diff --git a/v2.1/demo-automatic-rebalancing.md b/v2.1/demo-automatic-rebalancing.md
index 0db4689f4e6..279f5cabc3f 100644
--- a/v2.1/demo-automatic-rebalancing.md
+++ b/v2.1/demo-automatic-rebalancing.md
@@ -1,12 +1,11 @@
---
title: Automatic Rebalancing
summary: Use a local cluster to explore how CockroachDB automatically rebalances data as you scale.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB automatically rebalances data as you scale. Starting with a 3-node local cluster, you'll lower the maximum size for a single range, the unit of data that is replicated in CockroachDB. You'll then download and run the `block_writer` example program, which continuously inserts data into your cluster, and watch the replica count quickly increase as ranges split. You'll then add 2 more nodes and watch how CockroachDB automatically rebalances replicas to efficiently use all available capacity.
-
## Before you begin
diff --git a/v2.1/demo-data-replication.md b/v2.1/demo-data-replication.md
index f3af961eb85..9fb145ff973 100644
--- a/v2.1/demo-data-replication.md
+++ b/v2.1/demo-data-replication.md
@@ -1,12 +1,11 @@
---
title: Data Replication
summary: Use a local cluster to explore how CockroachDB replicates and distributes data.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB replicates and distributes data. Starting with a 1-node local cluster, you'll write some data, add 2 nodes, and watch how the data is replicated automatically. You'll then update the cluster to replicate 5 ways, add 2 more nodes, and again watch how all existing replicas are re-replicated to the new nodes.
-
## Before you begin
diff --git a/v2.1/demo-fault-tolerance-and-recovery.md b/v2.1/demo-fault-tolerance-and-recovery.md
index 3d02dadd369..8be5836bef8 100644
--- a/v2.1/demo-fault-tolerance-and-recovery.md
+++ b/v2.1/demo-fault-tolerance-and-recovery.md
@@ -1,12 +1,11 @@
---
title: Fault Tolerance & Recovery
summary: Use a local cluster to explore how CockroachDB remains available during, and recovers after, failure.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB remains available during, and recovers after, failure. Starting with a 3-node local cluster, you'll remove a node and see how the cluster continues uninterrupted. You'll then write some data while the node is offline, rejoin the node, and see how it catches up with the rest of the cluster. Finally, you'll add a fourth node, remove a node again, and see how missing replicas eventually re-replicate to the new node.
-
## Before you begin
diff --git a/v2.1/demo-follow-the-workload.md b/v2.1/demo-follow-the-workload.md
index 79229bdb6ea..e9b19c2a65a 100644
--- a/v2.1/demo-follow-the-workload.md
+++ b/v2.1/demo-follow-the-workload.md
@@ -1,12 +1,11 @@
---
title: Follow-the-Workload
summary: CockroachDB can dynamically optimize read latency for the location from which most of the workload is originating.
-toc: false
+toc: true
---
"Follow-the-workload" refers to CockroachDB's ability to dynamically optimize read latency for the location from which most of the workload is originating. This page explains how "follow-the-workload" works and walks you through a simple demonstration using a local cluster.
-
## Overview
diff --git a/v2.1/demo-json-support.md b/v2.1/demo-json-support.md
index 65234f4503c..fce3d1ea8e9 100644
--- a/v2.1/demo-json-support.md
+++ b/v2.1/demo-json-support.md
@@ -1,12 +1,11 @@
---
title: JSON Support
summary: Use a local cluster to explore how CockroachDB can store and query unstructured JSONB data.
-toc: false
+toc: true
---
This page walks you through a simple demonstration of how CockroachDB can store and query unstructured [`JSONB`](jsonb.html) data from a third-party API, as well as how an [inverted index](inverted-indexes.html) can optimize your queries.
-
## Step 1. Install prerequisites
diff --git a/v2.1/deploy-a-test-cluster.md b/v2.1/deploy-a-test-cluster.md
index 0ee0abae945..ca852def3ca 100644
--- a/v2.1/deploy-a-test-cluster.md
+++ b/v2.1/deploy-a-test-cluster.md
@@ -1,14 +1,13 @@
---
title: Deploy a Test Cluster
summary: Use CockroachDB's CloudFormation template to deploy a Kubernetes-orchestrated test cluster on AWS.
-toc: false
+toc: true
---
This page shows you the easiest way to test an insecure, multi-node CockroachDB cluster, using CockroachDB's [AWS CloudFormation](https://aws.amazon.com/cloudformation/) template to simplify setup and [Kubernetes](https://kubernetes.io/) to automate deployment, maintenance, and load balancing of client workloads.
-
## Before you begin
diff --git a/v2.1/deploy-cockroachdb-on-aws-insecure.md b/v2.1/deploy-cockroachdb-on-aws-insecure.md
index 5ad6326c42e..86b9f84b56e 100644
--- a/v2.1/deploy-cockroachdb-on-aws-insecure.md
+++ b/v2.1/deploy-cockroachdb-on-aws-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on AWS EC2 (Insecure)
summary: Learn how to deploy CockroachDB on Amazon's AWS EC2 platform.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-aws.md b/v2.1/deploy-cockroachdb-on-aws.md
index bc1a7d964e2..4850a501f2c 100644
--- a/v2.1/deploy-cockroachdb-on-aws.md
+++ b/v2.1/deploy-cockroachdb-on-aws.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on AWS EC2
summary: Learn how to deploy CockroachDB on Amazon's AWS EC2 platform.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-digital-ocean-insecure.md b/v2.1/deploy-cockroachdb-on-digital-ocean-insecure.md
index 2fb60650768..7761223b026 100644
--- a/v2.1/deploy-cockroachdb-on-digital-ocean-insecure.md
+++ b/v2.1/deploy-cockroachdb-on-digital-ocean-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Digital Ocean (Insecure)
summary: Learn how to deploy CockroachDB on Digital Ocean.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-connect-to-your-droplet-with-ssh
---
@@ -15,7 +15,6 @@ This page shows you how to deploy an insecure multi-node CockroachDB cluster on
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-digital-ocean.md b/v2.1/deploy-cockroachdb-on-digital-ocean.md
index 889e97b47f1..8ada258d28f 100644
--- a/v2.1/deploy-cockroachdb-on-digital-ocean.md
+++ b/v2.1/deploy-cockroachdb-on-digital-ocean.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Digital Ocean
summary: Learn how to deploy CockroachDB on Digital Ocean.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-connect-to-your-droplet-with-ssh
---
@@ -15,7 +15,6 @@ This page shows you how to deploy a secure multi-node CockroachDB cluster on Dig
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-google-cloud-platform-insecure.md b/v2.1/deploy-cockroachdb-on-google-cloud-platform-insecure.md
index 03f25ad5e91..d55ac38c1d1 100644
--- a/v2.1/deploy-cockroachdb-on-google-cloud-platform-insecure.md
+++ b/v2.1/deploy-cockroachdb-on-google-cloud-platform-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Google Cloud Platform GCE (Insecure)
summary: Learn how to deploy CockroachDB on Google Cloud Platform's Compute Engine.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://cloud.google.com/compute/docs/instances/connecting-to-instance
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-google-cloud-platform.md b/v2.1/deploy-cockroachdb-on-google-cloud-platform.md
index b6f8a449197..88166d145d7 100644
--- a/v2.1/deploy-cockroachdb-on-google-cloud-platform.md
+++ b/v2.1/deploy-cockroachdb-on-google-cloud-platform.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Google Cloud Platform GCE
summary: Learn how to deploy CockroachDB on Google Cloud Platform's Compute Engine.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://cloud.google.com/compute/docs/instances/connecting-to-instance
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-microsoft-azure-insecure.md b/v2.1/deploy-cockroachdb-on-microsoft-azure-insecure.md
index d29bdd780c2..f537d68743c 100644
--- a/v2.1/deploy-cockroachdb-on-microsoft-azure-insecure.md
+++ b/v2.1/deploy-cockroachdb-on-microsoft-azure-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Microsoft Azure (Insecure)
summary: Learn how to deploy CockroachDB on Microsoft Azure.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy an insecure multi-node CockroachDB cl
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-microsoft-azure.md b/v2.1/deploy-cockroachdb-on-microsoft-azure.md
index d4d80c18529..e5d298d97b3 100644
--- a/v2.1/deploy-cockroachdb-on-microsoft-azure.md
+++ b/v2.1/deploy-cockroachdb-on-microsoft-azure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB on Microsoft Azure
summary: Learn how to deploy CockroachDB on Microsoft Azure.
-toc: false
+toc: true
toc_not_nested: true
ssh-link: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys
---
@@ -15,7 +15,6 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-premises-insecure.md b/v2.1/deploy-cockroachdb-on-premises-insecure.md
index 0d551bf897b..40334e75cd5 100644
--- a/v2.1/deploy-cockroachdb-on-premises-insecure.md
+++ b/v2.1/deploy-cockroachdb-on-premises-insecure.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB On-Premises (Insecure)
summary: Learn how to manually deploy an insecure, multi-node CockroachDB cluster on multiple machines.
-toc: false
+toc: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys--2
redirect_from: manual-deployment-insecure.html
---
@@ -15,7 +15,6 @@ This tutorial shows you how to manually deploy an insecure multi-node CockroachD
{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select Secure above for instructions.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.1/deploy-cockroachdb-on-premises.md b/v2.1/deploy-cockroachdb-on-premises.md
index cbdcccac4fd..68d2de743a7 100644
--- a/v2.1/deploy-cockroachdb-on-premises.md
+++ b/v2.1/deploy-cockroachdb-on-premises.md
@@ -1,7 +1,7 @@
---
title: Deploy CockroachDB On-Premises
summary: Learn how to manually deploy a secure, multi-node CockroachDB cluster on multiple machines.
-toc: false
+toc: true
ssh-link: https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys--2
---
@@ -14,7 +14,6 @@ This tutorial shows you how to manually deploy a secure multi-node CockroachDB c
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Requirements
diff --git a/v2.1/diagnostics-reporting.md b/v2.1/diagnostics-reporting.md
index a1667514c9c..16ff7be96bf 100644
--- a/v2.1/diagnostics-reporting.md
+++ b/v2.1/diagnostics-reporting.md
@@ -1,7 +1,7 @@
---
title: Diagnostics Reporting
summary: Learn about the diagnostic details that get shared with CockroachDB and how to opt out of sharing.
-toc: false
+toc: true
---
By default, the Admin UI and each node of a CockroachDB cluster share anonymous usage details with Cockroach Labs. These details, which are completely scrubbed of identifiable information, greatly help us understand and improve how the system behaves in real-world scenarios.
@@ -10,7 +10,6 @@ This page explains the details that get shared and how to opt out of sharing.
{{site.data.alerts.callout_success}}For insights into your cluster's performance and health, use the built-in Admin UI or a third-party monitoring tool like Prometheus.{{site.data.alerts.end}}
-
## What gets shared
diff --git a/v2.1/drop-column.md b/v2.1/drop-column.md
index 2b7eb880382..853c87dcfef 100644
--- a/v2.1/drop-column.md
+++ b/v2.1/drop-column.md
@@ -1,12 +1,11 @@
---
title: DROP COLUMN
summary: Use the ALTER COLUMN statement to remove columns from tables.
-toc: false
+toc: true
---
The `DROP COLUMN` [statement](sql-statements.html) is part of `ALTER TABLE` and removes columns from a table.
-
## Synopsis
diff --git a/v2.1/drop-constraint.md b/v2.1/drop-constraint.md
index 3b2ebb5eec4..49cb4336613 100644
--- a/v2.1/drop-constraint.md
+++ b/v2.1/drop-constraint.md
@@ -1,14 +1,13 @@
---
title: DROP CONSTRAINT
summary: Use the ALTER CONSTRAINT statement to remove constraints from columns.
-toc: false
+toc: true
---
The `DROP CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and removes Check and Foreign Key constraints from columns.
{{site.data.alerts.callout_info}}For information about removing other constraints, see Constraints: Remove Constraints.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/drop-database.md b/v2.1/drop-database.md
index 2f4a6bf018f..071d0023a29 100644
--- a/v2.1/drop-database.md
+++ b/v2.1/drop-database.md
@@ -1,12 +1,11 @@
---
title: DROP DATABASE
summary: The DROP DATABASE statement removes a database and all its objects from a CockroachDB cluster.
-toc: false
+toc: true
---
The `DROP DATABASE` [statement](sql-statements.html) removes a database and all its objects from a CockroachDB cluster.
-
## Required privileges
diff --git a/v2.1/drop-index.md b/v2.1/drop-index.md
index 114f1b21f1e..b17106b7890 100644
--- a/v2.1/drop-index.md
+++ b/v2.1/drop-index.md
@@ -1,12 +1,11 @@
---
title: DROP INDEX
summary: The DROP INDEX statement removes indexes from tables.
-toc: false
+toc: true
---
The `DROP INDEX` [statement](sql-statements.html) removes indexes from tables.
-
## Synopsis
diff --git a/v2.1/drop-role.md b/v2.1/drop-role.md
index 25215f25936..02e388a8276 100644
--- a/v2.1/drop-role.md
+++ b/v2.1/drop-role.md
@@ -1,14 +1,13 @@
---
title: DROP ROLE (Enterprise)
summary: The DROP ROLE statement removes one or more SQL roles.
-toc: false
+toc: true
---
The `DROP ROLE` [statement](sql-statements.html) removes one or more SQL roles.
{{site.data.alerts.callout_info}}DROP ROLE is an enterprise-only feature.{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.1/drop-sequence.md b/v2.1/drop-sequence.md
index 992ebbfc690..8064547a662 100644
--- a/v2.1/drop-sequence.md
+++ b/v2.1/drop-sequence.md
@@ -1,12 +1,11 @@
---
title: DROP SEQUENCE
summary:
-toc: false
+toc: true
---
The `DROP SEQUENCE` [statement](sql-statements.html) removes a sequence from a database.
-
## Required privileges
diff --git a/v2.1/drop-table.md b/v2.1/drop-table.md
index 7cc84ae63e4..58825c14d26 100644
--- a/v2.1/drop-table.md
+++ b/v2.1/drop-table.md
@@ -1,12 +1,11 @@
---
title: DROP TABLE
summary: The DROP TABLE statement removes a table and all its indexes from a database.
-toc: false
+toc: true
---
The `DROP TABLE` [statement](sql-statements.html) removes a table and all its indexes from a database.
-
## Required privileges
diff --git a/v2.1/drop-user.md b/v2.1/drop-user.md
index c61c56a9bdb..3202b8b467a 100644
--- a/v2.1/drop-user.md
+++ b/v2.1/drop-user.md
@@ -1,14 +1,13 @@
---
title: DROP USER
summary: The DROP USER statement removes one or more SQL users.
-toc: false
+toc: true
---
The `DROP USER` [statement](sql-statements.html) removes one or more SQL users.
{{site.data.alerts.callout_success}}You can also use the cockroach user rm command to remove users.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/drop-view.md b/v2.1/drop-view.md
index 10404a8bf97..b6aea837d9c 100644
--- a/v2.1/drop-view.md
+++ b/v2.1/drop-view.md
@@ -1,12 +1,11 @@
---
title: DROP VIEW
summary: The DROP VIEW statement removes a view from a database.
-toc: false
+toc: true
---
The `DROP VIEW` [statement](sql-statements.html) removes a [view](views.html) from a database.
-
## Required privileges
diff --git a/v2.1/enable-node-map.md b/v2.1/enable-node-map.md
index 43dc815b048..41f4b9b2c37 100644
--- a/v2.1/enable-node-map.md
+++ b/v2.1/enable-node-map.md
@@ -1,7 +1,7 @@
---
title: Enable the Node Map
summary: Learn how to enable the node map in the Admin UI.
-toc: false
+toc: true
---
The **Node Map** visualizes the geographical configuration of a multi-regional cluster by plotting the node localities on a world map. The **Node Map** also provides real-time cluster metrics, with the ability to drill down to individual nodes to monitor and troubleshoot the cluster health and performance.
@@ -12,7 +12,6 @@ This page walks you through the process of setting up and enabling the **Node Ma
-
## Set up and enable the Node Map
diff --git a/v2.1/encryption.md b/v2.1/encryption.md
index 0c50bce21fa..723b20e8005 100644
--- a/v2.1/encryption.md
+++ b/v2.1/encryption.md
@@ -1,7 +1,7 @@
---
title: Encryption At Rest
summary: Encryption At Rest encrypts node data on local disk transparently.
-toc: false
+toc: true
---
New in v2.1:
@@ -9,7 +9,6 @@ Encryption At Rest provides transparent encryption for node data on local disk.
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Overview
diff --git a/v2.1/enterprise-licensing.md b/v2.1/enterprise-licensing.md
index ba113d9cd18..a64bd31e8c4 100644
--- a/v2.1/enterprise-licensing.md
+++ b/v2.1/enterprise-licensing.md
@@ -1,14 +1,13 @@
---
title: Enterprise Licensing
summary: Request and set trial and enterprise license keys for CockroachDB
-toc: false
+toc: true
---
CockroachDB distributes a single binary that contains both core and [enterprise features](https://www.cockroachlabs.com/pricing/). You can use core features without any license key. However, to use the enterprise features, you need either a trial or an enterprise license key.
This page shows you how to obtain and set trial and enterprise license keys for CockroachDB.
-
## Types of licenses
diff --git a/v2.1/experimental-audit.md b/v2.1/experimental-audit.md
index 9cc4a50ca2f..661927c9b5a 100644
--- a/v2.1/experimental-audit.md
+++ b/v2.1/experimental-audit.md
@@ -1,7 +1,7 @@
---
title: EXPERIMENTAL_AUDIT
summary: Use the EXPERIMENTAL_AUDIT subcommand to turn SQL audit logging on or off for a table.
-toc: false
+toc: true
---
`EXPERIMENTAL_AUDIT` is a subcommand of [`ALTER TABLE`](alter-table.html) that is used to turn [SQL audit logging](sql-audit-logging.html) on or off for a table.
@@ -17,7 +17,6 @@ For a detailed description of exactly what is logged, see the [Audit Log File Fo
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Synopsis
diff --git a/v2.1/explain.md b/v2.1/explain.md
index 65c78679bae..d3a73da5179 100644
--- a/v2.1/explain.md
+++ b/v2.1/explain.md
@@ -1,12 +1,11 @@
---
title: EXPLAIN
summary: The EXPLAIN statement provides information you can use to optimize SQL queries.
-toc: false
+toc: true
---
The `EXPLAIN` [statement](sql-statements.html) returns CockroachDB's query plan for an [explainable statement](#explainable-statements). You can then use this information to optimize the query.
-
## Explainable statements
diff --git a/v2.1/export.md b/v2.1/export.md
index 88d8b9473e6..b10683dd8c4 100644
--- a/v2.1/export.md
+++ b/v2.1/export.md
@@ -1,7 +1,7 @@
---
title: EXPORT
summary: Export tabular data from a CockroachDB cluster in CSV format.
-toc: false
+toc: true
---
New in v2.1: The `EXPORT` [statement](sql-statements.html) exports tabular data or the results of arbitrary `SELECT` statements to CSV files.
@@ -10,7 +10,6 @@ Using the [CockroachDB distributed execution engine](https://www.cockroachlabs.c
{{site.data.alerts.callout_danger}}The EXPORT feature is only available to enterprise users. Also note that this feature is currently under development and is slated for full release in CockroachDB 2.1. The feature flags and behavior are subject to change. {{site.data.alerts.end}}
-
## Export file location
diff --git a/v2.1/float.md b/v2.1/float.md
index e1c20089390..dc915daab94 100644
--- a/v2.1/float.md
+++ b/v2.1/float.md
@@ -1,14 +1,13 @@
---
title: FLOAT
summary: The FLOAT data type stores inexact, floating-point numbers with up to 17 digits in total and at least one digit to the right of the decimal point.
-toc: false
+toc: true
---
CockroachDB supports various inexact, floating-point number [data types](data-types.html) with up to 17 digits of decimal precision.
They are handled internally using the [standard double-precision (64-bit binary-encoded) IEEE754 format](https://en.wikipedia.org/wiki/IEEE_floating_point).
-
## Names and Aliases
diff --git a/v2.1/foreign-key.md b/v2.1/foreign-key.md
index 1d8ef24fd0f..96af3c20352 100644
--- a/v2.1/foreign-key.md
+++ b/v2.1/foreign-key.md
@@ -1,7 +1,7 @@
---
title: Foreign Key Constraint
summary: The Foreign Key constraint specifies a column can contain only values exactly matching existing values from the column it references.
-toc: false
+toc: true
---
The Foreign Key [constraint](constraints.html) specifies that all of a column's values must exactly match existing values from the column it references, enforcing referential integrity.
@@ -13,7 +13,6 @@ For example, if you create a foreign key on `orders.customer` that references `c
{{site.data.alerts.callout_success}}If you plan to use Foreign Keys in your schema, consider using interleaved tables, which can dramatically improve query performance.{{site.data.alerts.end}}
-
## Details
diff --git a/v2.1/frequently-asked-questions.md b/v2.1/frequently-asked-questions.md
index 5e2666efc1e..932a9cc7ae9 100644
--- a/v2.1/frequently-asked-questions.md
+++ b/v2.1/frequently-asked-questions.md
@@ -2,10 +2,9 @@
title: Frequently Asked Questions
summary: CockroachDB FAQ - What is CockroachDB? How does it work? What makes it different from other databases?
tags: postgres, cassandra, google cloud spanner
-toc: false
+toc: true
---
-
## What is CockroachDB?
diff --git a/v2.1/functions-and-operators.md b/v2.1/functions-and-operators.md
index 892249a735f..fe31f70daf8 100644
--- a/v2.1/functions-and-operators.md
+++ b/v2.1/functions-and-operators.md
@@ -1,14 +1,13 @@
---
title: Functions and Operators
summary: CockroachDB supports many built-in functions, aggregate functions, and operators.
-toc: false
+toc: true
---
CockroachDB supports the following SQL functions and operators for use in [scalar expressions](scalar-expressions.html).
{{site.data.alerts.callout_success}}In the built-in SQL shell, use \hf [function] to get inline help about a specific function.{{site.data.alerts.end}}
-
## Special syntax forms
diff --git a/v2.1/generate-cockroachdb-resources.md b/v2.1/generate-cockroachdb-resources.md
index aa52ab7fcf0..2543d32c526 100644
--- a/v2.1/generate-cockroachdb-resources.md
+++ b/v2.1/generate-cockroachdb-resources.md
@@ -1,12 +1,11 @@
---
title: Generate CockroachDB Resources
summary: Use cockroach gen to generate command-line interface utlities, such as man pages, and example data.
-toc: false
+toc: true
---
The `cockroach gen` command can generate command-line interface (CLI) utilities ([`man` pages](https://en.wikipedia.org/wiki/Man_page) and a`bash` autocompletion script), example SQL data suitable to populate test databases, and an HAProxy configuration file for load balancing a running cluster.
-
## Subcommands
diff --git a/v2.1/grant-roles.md b/v2.1/grant-roles.md
index 4cb09cc2844..f01d664d6ab 100644
--- a/v2.1/grant-roles.md
+++ b/v2.1/grant-roles.md
@@ -1,14 +1,13 @@
---
title: GRANT <roles>
summary: The GRANT GRANT <roles> is an enterprise-only feature.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/grant.md b/v2.1/grant.md
index 4728686971e..a251c57027d 100644
--- a/v2.1/grant.md
+++ b/v2.1/grant.md
@@ -1,14 +1,13 @@
---
title: GRANT <privileges>
summary: The GRANT statement grants user privileges for interacting with specific databases and tables.
-toc: false
+toc: true
---
The `GRANT RESTORE.{{site.data.alerts.end}}
-
## Import from tabular data (CSV)
diff --git a/v2.1/import.md b/v2.1/import.md
index 5c3d401f557..7a1041d747b 100644
--- a/v2.1/import.md
+++ b/v2.1/import.md
@@ -1,14 +1,13 @@
---
title: IMPORT
summary: Import CSV data into your CockroachDB cluster.
-toc: false
+toc: true
---
The `IMPORT` [statement](sql-statements.html) imports tabular data (e.g., CSVs) into a single table.
{{site.data.alerts.callout_info}}For details about importing SQL dumps, see Import Data.{{site.data.alerts.end}}
-
## Requirements
diff --git a/v2.1/indexes.md b/v2.1/indexes.md
old mode 100755
new mode 100644
index 99dc06d4f9b..cbb38e9abad
--- a/v2.1/indexes.md
+++ b/v2.1/indexes.md
@@ -1,13 +1,12 @@
---
title: Indexes
summary: Indexes improve your database's performance by helping SQL locate data without having to look through every row of a table.
-toc: false
+toc: true
toc_not_nested: true
---
Indexes improve your database's performance by helping SQL locate data without having to look through every row of a table.
-
## How do indexes work?
diff --git a/v2.1/inet.md b/v2.1/inet.md
index dd74b7d30fd..f5c1f0966ef 100644
--- a/v2.1/inet.md
+++ b/v2.1/inet.md
@@ -1,11 +1,10 @@
---
title: INET
summary: The INET data type stores an IPv4 or IPv6 address.
-toc: false
+toc: true
---
The `INET` [data type](data-types.html) stores an IPv4 or IPv6 address.
-
## Syntax
diff --git a/v2.1/information-schema.md b/v2.1/information-schema.md
index 38b958892bd..9b71d5b964b 100644
--- a/v2.1/information-schema.md
+++ b/v2.1/information-schema.md
@@ -1,7 +1,7 @@
---
title: Information Schema
summary: The information_schema database contains read-only views that you can use for introspection into your database's tables, columns, indexes, and views.
-toc: false
+toc: true
---
CockroachDB provides a virtual schema called `information_schema` that contains information about your database's tables, columns, indexes, and views. This information can be used for introspection and reflection.
@@ -10,7 +10,6 @@ The definition of `information_schema` is part of the SQL standard and can there
{{site.data.alerts.callout_info}}The information_schema views typically represent objects that the current user has privilege to access. To ensure you can view all the objects in a database, access it as the root user.{{site.data.alerts.end}}
-
## Data exposed by information_schema
diff --git a/v2.1/initialize-a-cluster.md b/v2.1/initialize-a-cluster.md
index 79ced911b65..a155cb70244 100644
--- a/v2.1/initialize-a-cluster.md
+++ b/v2.1/initialize-a-cluster.md
@@ -1,14 +1,13 @@
---
title: Initialize a Cluster
summary: Perform a one-time-only initialization of a CockroachDB cluster.
-toc: false
+toc: true
---
This page explains the `cockroach init` [command](cockroach-commands.html), which you use to perform a one-time initialization of a new multi-node cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials.
{{site.data.alerts.callout_info}}When starting a single-node cluster, you do not need to use the cockroach init command. You can simply run the cockroach start command without the --join flag to start and initialize the single-node cluster.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/insert.md b/v2.1/insert.md
index 5daaebb4a51..c4602d0d576 100644
--- a/v2.1/insert.md
+++ b/v2.1/insert.md
@@ -1,12 +1,11 @@
---
title: INSERT
summary: The INSERT statement inserts one or more rows into a table.
-toc: false
+toc: true
---
The `INSERT` [statement](sql-statements.html) inserts one or more rows into a table. In cases where inserted values conflict with uniqueness constraints, the `ON CONFLICT` clause can be used to update rather than insert rows.
-
## Performance best practices
diff --git a/v2.1/int.md b/v2.1/int.md
index 7dd4e86b0b7..7667338ba67 100644
--- a/v2.1/int.md
+++ b/v2.1/int.md
@@ -1,14 +1,13 @@
---
title: INT
summary: CockroachDB supports various signed integer data types.
-toc: false
+toc: true
---
CockroachDB supports various signed integer [data types](data-types.html).
{{site.data.alerts.callout_info}}To auto-generate globally unique values, use the UUID or SERIAL data type.{{site.data.alerts.end}}
-
## Names and Aliases
diff --git a/v2.1/interleave-in-parent.md b/v2.1/interleave-in-parent.md
index 328280b97c5..fb84be71e53 100644
--- a/v2.1/interleave-in-parent.md
+++ b/v2.1/interleave-in-parent.md
@@ -1,7 +1,7 @@
---
title: INTERLEAVE IN PARENT
summary: Interleaving tables improves query performance by optimizing the key-value structure of closely related table's data.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ Interleaving tables improves query performance by optimizing the key-value struc
{{site.data.alerts.callout_info}}Interleaving tables does not affect their behavior within SQL.{{site.data.alerts.end}}
-
## How interleaved tables work
diff --git a/v2.1/interval.md b/v2.1/interval.md
index 4f3fc701dba..978e87418ed 100644
--- a/v2.1/interval.md
+++ b/v2.1/interval.md
@@ -1,12 +1,11 @@
---
title: INTERVAL
summary: The INTERVAL data type stores a value that represents a span of time.
-toc: false
+toc: true
---
The `INTERVAL` [data type](data-types.html) stores a value that represents a span of time.
-
## Syntax
diff --git a/v2.1/inverted-indexes.md b/v2.1/inverted-indexes.md
index 576e8283843..ff79f77be10 100644
--- a/v2.1/inverted-indexes.md
+++ b/v2.1/inverted-indexes.md
@@ -1,14 +1,13 @@
---
title: Inverted Indexes
summary: Inverted indexes improve your database's performance and usefulness by helping SQL locate schemaless data in a JSONB column.
-toc: false
+toc: true
---
Inverted indexes improve your database's performance by helping SQL locate the schemaless data in a [`JSONB`](jsonb.html) column.
{{site.data.alerts.callout_success}}For a hands-on demonstration of using an inverted index to improve query performance on a JSONB column, see the JSON tutorial.{{site.data.alerts.end}}
-
## How do inverted indexes work?
diff --git a/v2.1/joins.md b/v2.1/joins.md
index c999cdd274d..4fe4557434b 100644
--- a/v2.1/joins.md
+++ b/v2.1/joins.md
@@ -1,14 +1,13 @@
---
title: Join Expressions
summary: Join expressions combine data from two or more table expressions.
-toc: false
+toc: true
---
Join expressions, also called "joins", combine the results of two or more table expressions based on conditions on the values of particular columns (i.e., equality columns).
Join expressions define a data source in the `FROM` sub-clause of [simple `SELECT` clauses](select-clause.html), or as parameter to [`TABLE`](selection-queries.html#table-clause). Joins are a particular kind of [table expression](table-expressions.html).
-
## Synopsis
diff --git a/v2.1/jsonb.md b/v2.1/jsonb.md
index 68efb52fe2e..46bf4441d7e 100644
--- a/v2.1/jsonb.md
+++ b/v2.1/jsonb.md
@@ -1,14 +1,13 @@
---
title: JSONB
summary: The JSONB data type stores JSON (JavaScript Object Notation) data.
-toc: false
+toc: true
---
The `JSONB` [data type](data-types.html) stores JSON (JavaScript Object Notation) data as a binary representation of the `JSONB` value, which eliminates whitespace, duplicate keys, and key ordering. `JSONB` supports [inverted indexes](inverted-indexes.html).
{{site.data.alerts.callout_success}}For a hands-on demonstration of storing and querying JSON data from a third-party API, see the JSON tutorial.{{site.data.alerts.end}}
-
## Alias
diff --git a/v2.1/known-limitations.md b/v2.1/known-limitations.md
index a544e930a8f..d5e3e805de6 100644
--- a/v2.1/known-limitations.md
+++ b/v2.1/known-limitations.md
@@ -1,12 +1,11 @@
---
title: Known Limitations in CockroachDB v2.1
summary: Known limitations in CockroachDB v2.1.
-toc: false
+toc: true
---
This page describes newly identified limitations in the CockroachDB v2.1 release as well as unresolved limitations identified in earlier releases.
-
## New limitations
diff --git a/v2.1/learn-cockroachdb-sql.md b/v2.1/learn-cockroachdb-sql.md
index dee52ec110a..6264d84538b 100644
--- a/v2.1/learn-cockroachdb-sql.md
+++ b/v2.1/learn-cockroachdb-sql.md
@@ -1,7 +1,7 @@
---
title: Learn CockroachDB SQL
summary: Learn some of the most essential CockroachDB SQL statements.
-toc: false
+toc: true
---
This page walks you through some of the most essential CockroachDB SQL statements. For a complete list and related details, see [SQL Statements](sql-statements.html).
@@ -10,7 +10,6 @@ This page walks you through some of the most essential CockroachDB SQL statement
{{site.data.alerts.callout_info}}CockroachDB aims to provide standard SQL with extensions, but some standard SQL functionality is not yet available. See our SQL Feature Support page for more details.{{site.data.alerts.end}}
-
## Create a Database
diff --git a/v2.1/limit-offset.md b/v2.1/limit-offset.md
index ebf378ec0dd..d05256c5a27 100644
--- a/v2.1/limit-offset.md
+++ b/v2.1/limit-offset.md
@@ -1,7 +1,7 @@
---
title: Limiting Query Results
summary: LIMIT and OFFSET restrict an operation to a few row.
-toc: false
+toc: true
---
The `LIMIT` and `OFFSET` clauses restrict the operation of:
@@ -10,7 +10,6 @@ The `LIMIT` and `OFFSET` clauses restrict the operation of:
as part of [`INSERT`](insert.html) or [`UPSERT`](upsert.html).
- [`UPDATE`](update.html) and [`DELETE`](delete.html) statements.
-
## Synopsis
diff --git a/v2.1/manage-long-running-queries.md b/v2.1/manage-long-running-queries.md
index 9fea14a5a45..027726e2dae 100644
--- a/v2.1/manage-long-running-queries.md
+++ b/v2.1/manage-long-running-queries.md
@@ -1,14 +1,13 @@
---
title: Manage Long-Running Queries
summary: Learn how to identify and cancel long-running queries.
-toc: false
+toc: true
---
This page shows you how to identify and, if necessary, cancel SQL queries that are taking longer than expected to process.
{{site.data.alerts.callout_success}} Schema changes are treated differently than other SQL queries. You can use SHOW JOBS to monitor the progress of schema changes, and as of v2.1, use CANCEL JOB to cancel schema changes that are taking longer than expected. {{site.data.alerts.end}}
-
## Identify long-running queries
diff --git a/v2.1/monitor-cockroachdb-with-prometheus.md b/v2.1/monitor-cockroachdb-with-prometheus.md
index 2f1203996dc..53133b78ad5 100644
--- a/v2.1/monitor-cockroachdb-with-prometheus.md
+++ b/v2.1/monitor-cockroachdb-with-prometheus.md
@@ -1,14 +1,13 @@
---
title: Monitor CockroachDB with Prometheus
summary: Use Prometheus to monitor CockroachDB.
-toc: false
+toc: true
---
CockroachDB generates detailed time series metrics for each node in a cluster. This page shows you how to pull these metrics into [Prometheus](https://prometheus.io/), an open source tool for storing, aggregating, and querying time series data. It also shows you how to connect [Grafana](https://grafana.com/) and [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) to Prometheus for flexible data visualizations and notifications.
{{site.data.alerts.callout_success}}For details about other monitoring options, see Monitoring and Alerting. {{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/monitoring-and-alerting.md b/v2.1/monitoring-and-alerting.md
index ecb03ab1118..6f99f8151f5 100644
--- a/v2.1/monitoring-and-alerting.md
+++ b/v2.1/monitoring-and-alerting.md
@@ -1,14 +1,13 @@
---
title: Monitoring and Alerting
summary: Monitor the health and performance of a cluster and alert on critical events and metrics.
-toc: false
+toc: true
---
Despite CockroachDB's various [built-in safeguards against failure](high-availability.html), it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention.
This page explains available monitoring tools and critical events and metrics to alert on.
-
## Monitoring tools
diff --git a/v2.1/multi-active-availability.md b/v2.1/multi-active-availability.md
index 054643f9af6..daa4fc44a3d 100644
--- a/v2.1/multi-active-availability.md
+++ b/v2.1/multi-active-availability.md
@@ -1,12 +1,11 @@
---
title: Multi-Active Availability
summary: Learn about CockroachDB's high availability model, known as Multi-Active Availability.
-toc: false
+toc: true
---
CockroachDB's availability model is described as "Multi-Active Availability." In essence, multi-active availability provides benefits similar to traditional notions of high availability, but also lets you read and write from every node in your cluster without generating any conflicts.
-
## What is high availability?
diff --git a/v2.1/not-null.md b/v2.1/not-null.md
index 5858a1665f2..badde49c289 100644
--- a/v2.1/not-null.md
+++ b/v2.1/not-null.md
@@ -1,12 +1,11 @@
---
title: Not Null Constraint
summary: The NOT NULL constraint specifies the column may not contain NULL values.
-toc: false
+toc: true
---
The Not Null [constraint](constraints.html) specifies a column may not contain *NULL* values.
-
## Details
diff --git a/v2.1/null-handling.md b/v2.1/null-handling.md
index 8b3c0a7cd70..958b754a929 100644
--- a/v2.1/null-handling.md
+++ b/v2.1/null-handling.md
@@ -1,7 +1,7 @@
---
title: NULL Handling
summary: Learn how NULL values are handled in CockroachDB SQL.
-toc: false
+toc: true
---
This page summarizes how `NULL` values are handled in CockroachDB
@@ -10,7 +10,6 @@ client](use-the-built-in-sql-client.html).
{{site.data.alerts.callout_info}}When using the built-in client, NULL values are displayed using the word NULL. This distinguishes them from a character field that contains an empty string ("").{{site.data.alerts.end}}
-
## NULLs and simple comparisons
diff --git a/v2.1/operational-faqs.md b/v2.1/operational-faqs.md
index b4c15e45293..4d5d694d8d6 100644
--- a/v2.1/operational-faqs.md
+++ b/v2.1/operational-faqs.md
@@ -1,11 +1,10 @@
---
title: Operational FAQs
summary: Get answers to frequently asked questions about operating CockroachDB.
-toc: false
+toc: true
toc_not_nested: true
---
-
## Why is my process hanging when I try to start it in the background?
diff --git a/v2.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/v2.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md
index 3a660acb887..190e09a3d95 100644
--- a/v2.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md
+++ b/v2.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestration
summary: Orchestrate the deployment and management of an local cluster using Kubernetes.
-toc: false
+toc: true
---
Other tutorials in this section feature the ways that CockroachDB automates operations for you. On top of this built-in automation, you can use a third-party [orchestration](orchestration.html) system to simplify and automate even more of your operations, from deployment to scaling to overall cluster management.
@@ -10,7 +10,6 @@ This page walks you through a simple demonstration, using the open-source Kubern
{{site.data.alerts.callout_info}}To orchestrate a physically distributed cluster in production, see Orchestrated Deployment.{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/orchestrate-cockroachdb-with-docker-swarm-insecure.md b/v2.1/orchestrate-cockroachdb-with-docker-swarm-insecure.md
index 38d4974b175..1cd4531b10c 100644
--- a/v2.1/orchestrate-cockroachdb-with-docker-swarm-insecure.md
+++ b/v2.1/orchestrate-cockroachdb-with-docker-swarm-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Docker Swarm
summary: How to orchestrate the deployment and management of an insecure three-node CockroachDB cluster as a Docker swarm.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ This page shows you how to orchestrate the deployment and management of an insec
If you plan to use CockroachDB in production, we recommend using a secure cluster instead. Select **Secure** above for instructions.
-
## Before you begin
diff --git a/v2.1/orchestrate-cockroachdb-with-docker-swarm.md b/v2.1/orchestrate-cockroachdb-with-docker-swarm.md
index f5e6e24c296..b6ba7939f29 100644
--- a/v2.1/orchestrate-cockroachdb-with-docker-swarm.md
+++ b/v2.1/orchestrate-cockroachdb-with-docker-swarm.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Docker Swarm
summary: How to orchestrate the deployment and management of a secure three-node CockroachDB cluster as a Docker swarm.
-toc: false
+toc: true
---
@@ -13,7 +13,6 @@ This page shows you how to orchestrate the deployment and management of a secure
If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.
-
## Before you begin
diff --git a/v2.1/orchestrate-cockroachdb-with-kubernetes-insecure.md b/v2.1/orchestrate-cockroachdb-with-kubernetes-insecure.md
index cc64433e376..86d3ba760d7 100644
--- a/v2.1/orchestrate-cockroachdb-with-kubernetes-insecure.md
+++ b/v2.1/orchestrate-cockroachdb-with-kubernetes-insecure.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Kubernetes (Insecure)
summary: How to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with Kubernetes.
-toc: false
+toc: true
---
@@ -15,7 +15,6 @@ This page shows you how to orchestrate the deployment and management of an insec
{{site.data.alerts.callout_success}}For details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see CockroachDB Performance on Kubernetes.{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/orchestrate-cockroachdb-with-kubernetes.md b/v2.1/orchestrate-cockroachdb-with-kubernetes.md
index 2243aa37d75..98d8143bb3c 100644
--- a/v2.1/orchestrate-cockroachdb-with-kubernetes.md
+++ b/v2.1/orchestrate-cockroachdb-with-kubernetes.md
@@ -1,7 +1,7 @@
---
title: Orchestrate CockroachDB with Kubernetes
summary: How to orchestrate the deployment and management of a secure 3-node CockroachDB cluster with Kubernetes.
-toc: false
+toc: true
secure: true
---
@@ -16,7 +16,6 @@ If you are only testing CockroachDB, or you are not concerned with protecting ne
{{site.data.alerts.callout_success}}For details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see CockroachDB Performance on Kubernetes.{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/orchestrate-cockroachdb-with-mesosphere-insecure.md b/v2.1/orchestrate-cockroachdb-with-mesosphere-insecure.md
index 0b833075771..7d74574155c 100644
--- a/v2.1/orchestrate-cockroachdb-with-mesosphere-insecure.md
+++ b/v2.1/orchestrate-cockroachdb-with-mesosphere-insecure.md
@@ -1,14 +1,13 @@
---
title: Orchestrate CockroachDB with Mesosphere DC/OS (Insecure)
summary: How to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with Mesosphere DC/OS.
-toc: false
+toc: true
---
This page shows you how to orchestrate the deployment and management of an insecure 3-node CockroachDB cluster with [Mesosphere DC/OS](https://mesosphere.com/).
{{site.data.alerts.callout_danger}}Deploying an insecure cluster is not recommended for data in production. We'll update this page once it's possible to orchestrate a secure cluster with Mesosphere DC/OS.{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/parallel-statement-execution.md b/v2.1/parallel-statement-execution.md
index b7dfe83e7cd..7050202e72c 100644
--- a/v2.1/parallel-statement-execution.md
+++ b/v2.1/parallel-statement-execution.md
@@ -1,12 +1,11 @@
---
title: Parallel Statement Execution
summary: The parallel statement execution feature allows parallel execution of multiple independent SQL statements within a transaction.
-toc: false
+toc: true
---
CockroachDB supports parallel execution of [independent](parallel-statement-execution.html#when-to-use-parallel-statement-execution) [`INSERT`](insert.html), [`UPDATE`](update.html), [`UPSERT`](upsert.html), and [`DELETE`](delete.html) statements within a single [transaction](transactions.html). Executing statements in parallel helps reduce aggregate latency and improve performance.
-
## Why use parallel statement execution
diff --git a/v2.1/partition-by.md b/v2.1/partition-by.md
index 345e1b3c9f6..f67b18a2108 100644
--- a/v2.1/partition-by.md
+++ b/v2.1/partition-by.md
@@ -1,14 +1,13 @@
---
title: PARTITION BY
summary: Use the ALTER TABLE statement to define partitions and subpartitions, repartition, or unpartition a table.
-toc: false
+toc: true
---
`PARTITION BY` is a subcommand of [`ALTER TABLE`](alter-table.html) that is used to define partitions and subpartitions on a table, and repartition or unpartition a table.
{{site.data.alerts.callout_info}}Defining table partitions is an enterprise-only feature.{{site.data.alerts.end}}
-
## Primary key requirements
diff --git a/v2.1/partitioning.md b/v2.1/partitioning.md
index e1bda25021e..81fce68e4b1 100644
--- a/v2.1/partitioning.md
+++ b/v2.1/partitioning.md
@@ -1,14 +1,13 @@
---
title: Define Table Partitions
summary: Partitioning is an enterprise feature that gives you row-level control of how and where your data is stored.
-toc: false
+toc: true
---
CockroachDB allows you to define table partitions, thus giving you row-level control of how and where your data is stored. Partitioning enables you to reduce latencies and costs and can assist in meeting regulatory requirements for your data.
{{site.data.alerts.callout_info}}Table partitioning is an enterprise-only feature.{{site.data.alerts.end}}
-
## Why use table partitioning
diff --git a/v2.1/pause-job.md b/v2.1/pause-job.md
index 0558e19301b..1bb77624f6e 100644
--- a/v2.1/pause-job.md
+++ b/v2.1/pause-job.md
@@ -1,7 +1,7 @@
---
title: PAUSE JOB
summary: The PAUSE JOB statement lets you temporarily halt the process of potentially long-running jobs.
-toc: false
+toc: true
---
The `PAUSE JOB` [statement](sql-statements.html) lets you pause [`BACKUP`](backup.html), [`RESTORE`](restore.html), and [`IMPORT`](import.html) jobs.
@@ -10,7 +10,6 @@ After pausing jobs, you can resume them with [`RESUME JOB`](resume-job.html).
{{site.data.alerts.callout_info}}You cannot pause schema changes.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/performance-benchmarking-with-tpc-c.md b/v2.1/performance-benchmarking-with-tpc-c.md
index b827e9c1c96..166281d9089 100644
--- a/v2.1/performance-benchmarking-with-tpc-c.md
+++ b/v2.1/performance-benchmarking-with-tpc-c.md
@@ -1,7 +1,7 @@
---
title: Performance Benchmarking with TPC-C
summary: Learn how to benchmark CockroachDB against TPC-C.
-toc: false
+toc: true
---
This page walks you through [TPC-C](http://www.tpc.org/tpcc/) performance benchmarking on CockroachDB. It measures `tpmC` (new order transactions/minute) on two TPC-C datasets:
@@ -13,7 +13,6 @@ These two points on the spectrum show how CockroachDB scales from modest-sized p
-
## Benchmark a small cluster
diff --git a/v2.1/performance-best-practices-overview.md b/v2.1/performance-best-practices-overview.md
index c7aa96bbc3d..b6fc017b784 100644
--- a/v2.1/performance-best-practices-overview.md
+++ b/v2.1/performance-best-practices-overview.md
@@ -1,12 +1,11 @@
---
title: SQL Performance Best Practices
summary: Best practices for optimizing SQL performance in CockroachDB.
-toc: false
+toc: true
---
This page provides best practices for optimizing SQL performance in CockroachDB.
-
## Multi-row DML best practices
diff --git a/v2.1/porting-postgres.md b/v2.1/porting-postgres.md
index 6ba9de44cba..2b52345871d 100644
--- a/v2.1/porting-postgres.md
+++ b/v2.1/porting-postgres.md
@@ -1,7 +1,7 @@
---
title: Porting from PostgreSQL
summary: Porting an application from PostgreSQL
-toc: false
+toc: true
---
Although CockroachDB supports PostgreSQL syntax and drivers, it does not offer exact compatibility. This page documents the known list of differences between PostgreSQL and CockroachDB for identical input. That is, a SQL statement of the type listed here will behave differently than in PostgreSQL. Porting an existing application to CockroachDB will require changing these expressions.
@@ -10,7 +10,6 @@ Note that some of these differences only apply to rare inputs, and so no change
{{site.data.alerts.callout_info}}This document currently only covers how to rewrite SQL expressions. It does not discuss strategies for porting applications that use SQL features CockroachDB does not currently support, such as the statement revokes privileges from users and/or roles.
-toc: false
+toc: true
---
The `REVOKE ` [statement](sql-statements.html) lets you revoke a [role](roles.html) or [user's](create-and-manage-users.html) membership to a role.
{{site.data.alerts.callout_info}}` [statement](sql-statements.html) revokes [privileges](privileges.html) from [users](create-and-manage-users.html) and/or [roles](roles.html).
For the list of privileges that can be granted to and revoked from users and roles, see [`GRANT`](grant.html).
-
## Synopsis
diff --git a/v2.1/roles.md b/v2.1/roles.md
index 4a4ae317969..2bd7e8e28af 100644
--- a/v2.1/roles.md
+++ b/v2.1/roles.md
@@ -1,7 +1,7 @@
---
title: Manage Roles
summary: Roles are SQL groups that contain any number of users and roles as members.
-toc: false
+toc: true
---
Roles are SQL groups that contain any number of users and roles as members. To create and manage your cluster's roles, use the following statements:
@@ -15,7 +15,6 @@ Roles are SQL groups that contain any number of users and roles as members. To c
- [`SHOW ROLES`](show-roles.html)
- [`SHOW GRANTS`](show-grants.html)
-
## Terminology
diff --git a/v2.1/rollback-transaction.md b/v2.1/rollback-transaction.md
index 7f813b28d1c..1479bf5896d 100644
--- a/v2.1/rollback-transaction.md
+++ b/v2.1/rollback-transaction.md
@@ -1,14 +1,13 @@
---
title: ROLLBACK
summary: Abort the current transaction, discarding all updates made by statements included in the transaction with the ROLLBACK statement in CockroachDB.
-toc: false
+toc: true
---
The `ROLLBACK` [statement](sql-statements.html) aborts the current [transaction](transactions.html), discarding all updates made by statements included in the transaction.
When using [client-side transaction retries](transactions.html#client-side-transaction-retries), use `ROLLBACK TO SAVEPOINT cockroach_restart` to handle a transaction that needs to be retried (identified via the `40001` error code or `retry transaction` string in the error message), and then re-execute the statements you want the transaction to contain.
-
## Synopsis
diff --git a/v2.1/rotate-certificates.md b/v2.1/rotate-certificates.md
index e6019347fe6..8060e497b57 100644
--- a/v2.1/rotate-certificates.md
+++ b/v2.1/rotate-certificates.md
@@ -1,14 +1,13 @@
---
title: Rotate Security Certificates
summary: Rotate the security certificates of a secure CockroachDB cluster by creating and reloading new certificates.
-toc: false
+toc: true
---
CockroachDB allows you to rotate security certificates without restarting nodes.
{{site.data.alerts.callout_success}}For an introduction to how security certificates work in a secure CockroachDB cluster, see Create Security Certificates.{{site.data.alerts.end}}
-
## When to rotate certificates
diff --git a/v2.1/savepoint.md b/v2.1/savepoint.md
index b4517956f5d..87005c80463 100644
--- a/v2.1/savepoint.md
+++ b/v2.1/savepoint.md
@@ -1,14 +1,13 @@
---
title: SAVEPOINT
summary: Identify your intent to retry aborted transactions with the SAVEPOINT cockroach_restart statement in CockroachDB.
-toc: false
+toc: true
---
The `SAVEPOINT cockroach_restart` statement defines the intent to retry [transactions](transactions.html) using the CockroachDB-provided function for client-side transaction retries. For more information, see [Transaction Retries](transactions.html#transaction-retries).
{{site.data.alerts.callout_danger}}CockroachDB’s
ENUM type.{{site.data.alerts.end}}
-
### Overflow of `float`
diff --git a/v2.1/primary-key.md b/v2.1/primary-key.md
index 57f9af90f0a..154b4f2ecd2 100644
--- a/v2.1/primary-key.md
+++ b/v2.1/primary-key.md
@@ -1,7 +1,7 @@
---
title: Primary Key Constraint
summary: The Primary Key constraint specifies that the columns can be used to uniquely identify rows in a table.
-toc: false
+toc: true
---
The Primary Key [constraint](constraints.html) specifies that the constrained columns' values must uniquely identify each row.
@@ -10,7 +10,6 @@ Unlike other constraints which have very specific uses, the Primary Key constrai
{{site.data.alerts.callout_info}}A table's primary key can only be specified in the CREATE TABLE statement. It cannot be changed later using ALTER TABLE, though it is possible to go through a process to create a new table with the new primary key you want and then migrate the data.{{site.data.alerts.end}}
-
## Details
diff --git a/v2.1/privileges.md b/v2.1/privileges.md
index 67ea077ce0b..1ed50091ba4 100644
--- a/v2.1/privileges.md
+++ b/v2.1/privileges.md
@@ -1,7 +1,7 @@
---
title: Privileges
summary: Privileges are granted to roles and users at the database and table levels. They are not yet supported for other granularities such as columns or rows.
-toc: false
+toc: true
---
In CockroachDB, privileges are granted to [roles](roles.html) and [users](create-and-manage-users.html) at the database and table levels. They are not yet supported for other granularities such as columns or rows.
@@ -10,7 +10,6 @@ When a user connects to a database, either via the [built-in SQL client](use-the
For the privileges required by specific statements, see the documentation for the respective [SQL statement](sql-statements.html).
-
## Supported privileges
diff --git a/v2.1/query-behavior-troubleshooting.md b/v2.1/query-behavior-troubleshooting.md
index a675497585a..5f75b648ce4 100644
--- a/v2.1/query-behavior-troubleshooting.md
+++ b/v2.1/query-behavior-troubleshooting.md
@@ -1,12 +1,11 @@
---
title: Troubleshoot Query Behavior
summary: Learn how to troubleshoot issues with specific queries with CockroachDB
-toc: false
+toc: true
---
If a query returns an unexpected result or takes longer than expected to process, this page will help you troubleshoot the issue.
-
## Correctness issues
diff --git a/v2.1/query-order.md b/v2.1/query-order.md
index 4daf2de9510..ffb80842250 100644
--- a/v2.1/query-order.md
+++ b/v2.1/query-order.md
@@ -1,7 +1,7 @@
---
title: Ordering Query Results
summary: The ORDER BY clause controls the order of rows.
-toc: false
+toc: true
---
The `ORDER BY` clause controls the order in which rows are returned or
@@ -11,7 +11,6 @@ as operand of [`INSERT`](insert.html) or [`UPSERT`](upsert.html), as
well as with [`DELETE`](delete.html) and [`UPDATE`](update.html)
statements.
-
## Synopsis
diff --git a/v2.1/recommended-production-settings.md b/v2.1/recommended-production-settings.md
index 92fdfe7583d..d1d58238d4c 100644
--- a/v2.1/recommended-production-settings.md
+++ b/v2.1/recommended-production-settings.md
@@ -1,12 +1,11 @@
---
title: Production Checklist
summary: Recommended settings for production deployments.
-toc: false
+toc: true
---
This page provides important recommendations for production deployments of CockroachDB.
-
## Cluster topology
diff --git a/v2.1/release-savepoint.md b/v2.1/release-savepoint.md
index 6742fb6e1de..e507f655fc8 100644
--- a/v2.1/release-savepoint.md
+++ b/v2.1/release-savepoint.md
@@ -1,7 +1,7 @@
---
title: RELEASE SAVEPOINT cockroach_restart
summary: Commit a transaction's changes once there are no retryable errors with the RELEASE SAVEPOINT cockroach_restart statement in CockroachDB.
-toc: false
+toc: true
---
When using [client-side transaction retries](transactions.html#client-side-transaction-retries), the `RELEASE SAVEPOINT cockroach_restart` statement commits the transaction.
@@ -12,7 +12,6 @@ Despite committing the transaction, you must still issue a [`COMMIT`](commit-tra
{{site.data.alerts.callout_danger}}CockroachDB’s SAVEPOINT implementation only supports the cockroach_restart savepoint and does not support all savepoint functionality, such as nested transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/remove-nodes.md b/v2.1/remove-nodes.md
index 04257419cca..fbd025fabe0 100644
--- a/v2.1/remove-nodes.md
+++ b/v2.1/remove-nodes.md
@@ -1,7 +1,7 @@
---
title: Decommission Nodes
summary: Permanently remove one or more nodes from a cluster.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -9,7 +9,6 @@ This page shows you how to decommission and permanently remove one or more nodes
For information about temporarily stopping a node (e.g., for planned maintenance), see [Stop a Node](stop-a-node.html).
-
## Overview
diff --git a/v2.1/rename-column.md b/v2.1/rename-column.md
index a61f1386a80..95d67c48b33 100644
--- a/v2.1/rename-column.md
+++ b/v2.1/rename-column.md
@@ -1,14 +1,13 @@
---
title: RENAME COLUMN
summary: The RENAME COLUMN statement changes the name of a column in a table.
-toc: false
+toc: true
---
The `RENAME COLUMN` [statement](sql-statements.html) changes the name of a column in a table.
{{site.data.alerts.callout_info}}It is not possible to rename a column referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/rename-database.md b/v2.1/rename-database.md
index 6427543d7dd..4886ef913bf 100644
--- a/v2.1/rename-database.md
+++ b/v2.1/rename-database.md
@@ -1,14 +1,13 @@
---
title: RENAME DATABASE
summary: The RENAME DATABASE statement changes the name of a database.
-toc: false
+toc: true
---
The `RENAME DATABASE` [statement](sql-statements.html) changes the name of a database.
{{site.data.alerts.callout_info}}It is not possible to rename a database referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/rename-index.md b/v2.1/rename-index.md
index bea7feefa50..29d4563f826 100644
--- a/v2.1/rename-index.md
+++ b/v2.1/rename-index.md
@@ -1,14 +1,13 @@
---
title: RENAME INDEX
summary: The RENAME INDEX statement changes the name of an index for a table.
-toc: false
+toc: true
---
The `RENAME INDEX` [statement](sql-statements.html) changes the name of an index for a table.
{{site.data.alerts.callout_info}}It is not possible to rename an index referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/rename-sequence.md b/v2.1/rename-sequence.md
index d0cdc51ae4b..1e34c9bd074 100644
--- a/v2.1/rename-sequence.md
+++ b/v2.1/rename-sequence.md
@@ -1,7 +1,7 @@
---
title: RENAME SEQUENCE
summary: The RENAME SEQUENCE statement changes the name of a sequence.
-toc: false
+toc: true
---
The `RENAME TO` [statement](sql-statements.html) is part of [`ALTER SEQUENCE`](alter-sequence.html), and changes the name of a sequence.
@@ -10,7 +10,6 @@ The `RENAME TO` [statement](sql-statements.html) is part of [`ALTER SEQUENCE`](a
{{site.data.alerts.callout_info}}To understand how CockroachDB changes schema elements without requiring table locking or other user-visible downtime, see Online Schema Changes in CockroachDB.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/rename-table.md b/v2.1/rename-table.md
index 878005ac730..478ae8e6ca8 100644
--- a/v2.1/rename-table.md
+++ b/v2.1/rename-table.md
@@ -1,14 +1,13 @@
---
title: RENAME TABLE
summary: The RENAME TABLE statement changes the name of a table.
-toc: false
+toc: true
---
The `RENAME TABLE` [statement](sql-statements.html) changes the name of a table. It can also be used to move a table from one database to another.
{{site.data.alerts.callout_info}}It is not possible to rename a table referenced by a view. For more details, see View Dependencies.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/reset-cluster-setting.md b/v2.1/reset-cluster-setting.md
index b7dcd35ca5e..67bd1a44be8 100644
--- a/v2.1/reset-cluster-setting.md
+++ b/v2.1/reset-cluster-setting.md
@@ -1,12 +1,11 @@
---
title: RESET CLUSTER SETTING
summary: The RESET CLUSTER SETTING statement resets a cluster setting to its default value for the client session.
-toc: false
+toc: true
---
The `RESET` [statement](sql-statements.html) resets a [cluster setting](set-cluster-setting.html) to its default value for the client session..
-
## Required privileges
diff --git a/v2.1/reset-vars.md b/v2.1/reset-vars.md
index cf75aba6fc4..1acaec0ad66 100644
--- a/v2.1/reset-vars.md
+++ b/v2.1/reset-vars.md
@@ -1,12 +1,11 @@
---
title: RESET (session variable)
summary: The SET statement resets a session variable to its default value.
-toc: false
+toc: true
---
The `RESET` [statement](sql-statements.html) resets a [session variable](set-vars.html) to its default value for the client session.
-
## Required privileges
diff --git a/v2.1/restore.md b/v2.1/restore.md
index 93d764978e2..f24f8b9ecb8 100644
--- a/v2.1/restore.md
+++ b/v2.1/restore.md
@@ -1,7 +1,7 @@
---
title: RESTORE
summary: Restore your CockroachDB cluster to a cloud storage services such as AWS S3, Google Cloud Storage, or other NFS.
-toc: false
+toc: true
---
{{site.data.alerts.callout_danger}}The RESTORE feature is only available to enterprise users. For non-enterprise restores, see Restore Data.{{site.data.alerts.end}}
@@ -10,7 +10,6 @@ The `RESTORE` [statement](sql-statements.html) restores your cluster's schemas a
Because CockroachDB is designed with high fault tolerance, restores are designed primarily for disaster recovery, i.e., restarting your cluster if it loses a majority of its nodes. Isolated issues (such as small-scale node outages) do not require any intervention.
-
## Functional details
diff --git a/v2.1/resume-job.md b/v2.1/resume-job.md
index 86ad1d573d1..231538b663a 100644
--- a/v2.1/resume-job.md
+++ b/v2.1/resume-job.md
@@ -1,14 +1,13 @@
---
title: RESUME JOB
summary: The RESUME JOB statement lets you resume jobs that were previously paused with PAUSE JOB.
-toc: false
+toc: true
---
The `RESUME JOB` [statement](sql-statements.html) lets you resume [paused](pause-job.html) [`BACKUP`](backup.html), [`RESTORE`](restore.html), and [`IMPORT`](import.html) jobs.
{{site.data.alerts.callout_info}}You cannot pause schema changes.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/revoke-roles.md b/v2.1/revoke-roles.md
index 45a57655284..499a8493fc8 100644
--- a/v2.1/revoke-roles.md
+++ b/v2.1/revoke-roles.md
@@ -1,14 +1,13 @@
---
title: REVOKE <roles>
summary: The REVOKE REVOKE <roles> is an enterprise-only feature.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/revoke.md b/v2.1/revoke.md
index 373fc5bf776..22419610d5e 100644
--- a/v2.1/revoke.md
+++ b/v2.1/revoke.md
@@ -1,14 +1,13 @@
---
title: REVOKE <privileges>
summary: The REVOKE statement revokes privileges from users and/or roles.
-toc: false
+toc: true
---
The `REVOKE SAVEPOINT implementation only supports the cockroach_restart savepoint and does not support all savepoint functionality, such as nested transactions.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/scalar-expressions.md b/v2.1/scalar-expressions.md
index 473267cfaaf..8ec4db07450 100644
--- a/v2.1/scalar-expressions.md
+++ b/v2.1/scalar-expressions.md
@@ -1,7 +1,7 @@
---
title: Scalar Expressions
summary: Scalar expressions allow the computation of new values from basic parts.
-toc: false
+toc: true
redirect_from: sql-expressions.html
key: sql-expressions.html
---
@@ -18,7 +18,6 @@ structured as a table.
The following sections provide details on each of these options.
-
## Constants
diff --git a/v2.1/secure-a-cluster.md b/v2.1/secure-a-cluster.md
index 298e71cd6ff..dc999f54c11 100644
--- a/v2.1/secure-a-cluster.md
+++ b/v2.1/secure-a-cluster.md
@@ -1,7 +1,7 @@
---
title: Start a Local Cluster (Secure)
summary: Run a secure multi-node CockroachDB cluster locally, using TLS certificates to encrypt network communication.
-toc: false
+toc: true
asciicast: true
---
@@ -16,7 +16,6 @@ Once you’ve [installed CockroachDB](install-cockroachdb.html), it’s simple t
Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html).
{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/select-clause.md b/v2.1/select-clause.md
index ffec6c30285..d21e2a24fa3 100644
--- a/v2.1/select-clause.md
+++ b/v2.1/select-clause.md
@@ -1,7 +1,7 @@
---
title: Simple SELECT Clause
summary: The Simple SELECT clause loads or computes data from various sources.
-toc: false
+toc: true
redirect_from: select.html
key: select.html
---
@@ -14,7 +14,6 @@ also called "the `SELECT` statement". However, it is also a
[selection clause](selection-queries.html#selection-clauses) that can be combined
with other constructs to form more complex [selection queries](selection-queries.html).
-
## Synopsis
diff --git a/v2.1/selection-queries.md b/v2.1/selection-queries.md
index d66b9dfb7f1..e86e69e7888 100644
--- a/v2.1/selection-queries.md
+++ b/v2.1/selection-queries.md
@@ -1,7 +1,7 @@
---
title: Selection Queries
summary: Selection Queries can read and process data.
-toc: false
+toc: true
redirect_from: selection-clauses.html
key: selection-clauses.html
---
@@ -18,7 +18,6 @@ Selection queries can occur:
- Between parentheses as a [subquery](table-expressions.html#subqueries-as-table-expressions).
- As [operand to other statements](#using-selection-queries-with-other-statements) that take tabular data as input, for example [`INSERT`](insert.html), [`UPSERT`](upsert.html), [`CREATE TABLE AS`](create-table-as.html) or [`ALTER ... SPLIT AT`](split-at.html).
-
## Synopsis
diff --git a/v2.1/serial.md b/v2.1/serial.md
index cc56c42f372..390f8de0461 100644
--- a/v2.1/serial.md
+++ b/v2.1/serial.md
@@ -1,7 +1,7 @@
---
title: SERIAL
summary: The SERIAL data type defaults to a unique 64-bit integer that is the combination of the insert timestamp and the ID of the node.
-toc: false
+toc: true
---
The `SERIAL` [data type](data-types.html) is a column data type that, on insert, generates a 64-bit integer from the timestamp and ID of the node executing the insert. This combination is likely to be globally unique except in extreme cases (see this [example](create-table.html#create-a-table-with-auto-generated-unique-row-ids) for more details). Also, because value generation does not require talking to other nodes, it is much faster than sequentially auto-incrementing a value, which requires distributed coordination.
@@ -10,7 +10,6 @@ The `SERIAL` [data type](data-types.html) is a column data type that, on insert,
In most cases, we recommend using the [`UUID`](uuid.html) data type with the `gen_random_uuid()` function as the default value, which generates 128-bit values (much larger than `SERIAL`'s 64-bit) and scatters them across all of a table's underlying key-value ranges, ensuring that multiple nodes share in the load. See [Create a table with auto-generated unique row IDs](uuid.html#create-a-table-with-auto-generated-unique-row-ids) for more details.
{{site.data.alerts.end}}
-
## Aliases
diff --git a/v2.1/set-cluster-setting.md b/v2.1/set-cluster-setting.md
index 64e869075b9..48f92218634 100644
--- a/v2.1/set-cluster-setting.md
+++ b/v2.1/set-cluster-setting.md
@@ -1,14 +1,13 @@
---
title: SET CLUSTER SETTING
summary: The SET CLUSTER SETTING statement configures one cluster setting.
-toc: false
+toc: true
---
The `SET CLUSTER SETTING` [statement](sql-statements.html) modifies a [cluster-wide setting](cluster-settings.html).
{{site.data.alerts.callout_danger}}Many cluster settings are intended for tuning CockroachDB internals. Before changing these settings, we strongly encourage you to discuss your goals with CockroachDB; otherwise, you use them at your own risk.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/set-transaction.md b/v2.1/set-transaction.md
index c497602deae..858b9455253 100644
--- a/v2.1/set-transaction.md
+++ b/v2.1/set-transaction.md
@@ -1,14 +1,13 @@
---
title: SET TRANSACTION
summary: The SET TRANSACTION statement sets the transaction isolation level and/or priority for the current session or for an individual transaction.
-toc: false
+toc: true
---
The `SET TRANSACTION` [statement](sql-statements.html) sets the transaction isolation level or priority after you [`BEGIN`](begin-transaction.html) it but before executing the first statement that manipulates a database.
{{site.data.alerts.callout_info}}You can also set the session's default isolation level.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/set-vars.md b/v2.1/set-vars.md
index 42983d01019..7bfaf064d89 100644
--- a/v2.1/set-vars.md
+++ b/v2.1/set-vars.md
@@ -1,7 +1,7 @@
---
title: SET (session variable)
summary: The SET statement modifies the current configuration variables for the client session.
-toc: false
+toc: true
redirect_from:
- set-application-name.html
- set-database.html
@@ -12,7 +12,6 @@ The `SET` [statement](sql-statements.html) can modify one of the session configu
{{site.data.alerts.callout_danger}}In some cases, client drivers can drop and restart the connection to the server. When this happens, any session configurations made with SET statements are lost. It is therefore more reliable to configure the session in the client's connection string. For examples in different languages, see the Build an App with CockroachDB tutorials.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/show-backup.md b/v2.1/show-backup.md
index d24ca4f861e..76ff8af056c 100644
--- a/v2.1/show-backup.md
+++ b/v2.1/show-backup.md
@@ -1,12 +1,11 @@
---
title: SHOW BACKUP
summary: The SHOW BACKUP statement lists the contents of a backup.
-toc: false
+toc: true
---
The `SHOW BACKUP` [statement](sql-statements.html) lists the contents of an enterprise backup created with the [`BACKUP`](backup.html) statement.
-
## Required privileges
diff --git a/v2.1/show-cluster-setting.md b/v2.1/show-cluster-setting.md
index 57de0f2a09b..9a0d1818551 100644
--- a/v2.1/show-cluster-setting.md
+++ b/v2.1/show-cluster-setting.md
@@ -1,7 +1,7 @@
---
title: SHOW CLUSTER SETTING
summary: The SHOW CLUSTER SETTING statement displays the current cluster settings.
-toc: false
+toc: true
---
The `SHOW CLUSTER SETTING` [statement](sql-statements.html) can
@@ -9,7 +9,6 @@ display the value of either one or all of the
[cluster settings](cluster-settings.html). These can also be configured
via [`SET CLUSTER SETTING`](set-cluster-setting.html).
-
## Required privileges
diff --git a/v2.1/show-columns.md b/v2.1/show-columns.md
index d6c9ce66ce1..ea97621ab03 100644
--- a/v2.1/show-columns.md
+++ b/v2.1/show-columns.md
@@ -1,12 +1,11 @@
---
title: SHOW COLUMNS
summary: The SHOW COLUMNS statement shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
-toc: false
+toc: true
---
The `SHOW COLUMNS` [statement](sql-statements.html) shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
-
## Required privileges
diff --git a/v2.1/show-constraints.md b/v2.1/show-constraints.md
index a65c3767303..6494cd60a2e 100644
--- a/v2.1/show-constraints.md
+++ b/v2.1/show-constraints.md
@@ -1,7 +1,7 @@
---
title: SHOW CONSTRAINTS
summary: The SHOW CONSTRAINTS statement lists the constraints on a table.
-toc: false
+toc: true
---
The `SHOW CONSTRAINTS` [statement](sql-statements.html) lists all named [constraints](constraints.html) as well as any unnamed Check constraints on a table.
@@ -10,7 +10,6 @@ The `SHOW CONSTRAINTS` [statement](sql-statements.html) lists all named [constra
The `SHOW CONSTRAINTS` statement is under development; the exact output will continue to change.
{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/show-create-sequence.md b/v2.1/show-create-sequence.md
index f08717189a3..b1c8f85a370 100644
--- a/v2.1/show-create-sequence.md
+++ b/v2.1/show-create-sequence.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE SEQUENCE
summary: The SHOW CREATE SEQUENCE statement shows the CREATE SEQUENCE statement that would create a copy of the specified sequence.
-toc: false
+toc: true
---
The `SHOW CREATE SEQUENCE` [statement](sql-statements.html) shows the `CREATE SEQUENCE` statement that would create a copy of the specified sequence.
-
## Required privileges
diff --git a/v2.1/show-create-table.md b/v2.1/show-create-table.md
index 3717205178f..e48cbe6a5d0 100644
--- a/v2.1/show-create-table.md
+++ b/v2.1/show-create-table.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE TABLE
summary: The SHOW CREATE TABLE statement shows the CREATE TABLE statement that would create a copy of the specified table.
-toc: false
+toc: true
---
The `SHOW CREATE TABLE` [statement](sql-statements.html) shows the `CREATE TABLE` statement that would create a copy of the specified table.
-
## Required privileges
diff --git a/v2.1/show-create-view.md b/v2.1/show-create-view.md
index e885a2b3933..2b9cb81827c 100644
--- a/v2.1/show-create-view.md
+++ b/v2.1/show-create-view.md
@@ -1,12 +1,11 @@
---
title: SHOW CREATE VIEW
summary: The SHOW CREATE VIEW statement shows the CREATE VIEW statement that would create a copy of the specified view.
-toc: false
+toc: true
---
The `SHOW CREATE VIEW` [statement](sql-statements.html) shows the `CREATE VIEW` statement that would create a copy of the specified [view](views.html).
-
## Required privileges
diff --git a/v2.1/show-databases.md b/v2.1/show-databases.md
index 866ef5595cc..9e95f953362 100644
--- a/v2.1/show-databases.md
+++ b/v2.1/show-databases.md
@@ -2,12 +2,11 @@
title: SHOW DATABASES
summary: The SHOW DATABASES statement lists all database in the CockroachDB cluster.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW DATABASES` [statement](sql-statements.html) lists all database in the CockroachDB cluster.
-
## Synopsis
diff --git a/v2.1/show-experimental-ranges.md b/v2.1/show-experimental-ranges.md
index 32540d7f6ac..75c87201693 100644
--- a/v2.1/show-experimental-ranges.md
+++ b/v2.1/show-experimental-ranges.md
@@ -1,7 +1,7 @@
---
title: SHOW EXPERIMENTAL_RANGES
summary: The SHOW EXPERIMENTAL_RANGES shows information about the ranges that make up a specific table's data.
-toc: false
+toc: true
redirect_from: show-testing-ranges.html
---
@@ -19,7 +19,6 @@ This information is useful for verifying that:
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Synopsis
diff --git a/v2.1/show-grants.md b/v2.1/show-grants.md
index bde5c8ed305..6180bf9daf8 100644
--- a/v2.1/show-grants.md
+++ b/v2.1/show-grants.md
@@ -2,12 +2,11 @@
title: SHOW GRANTS
summary: The SHOW GRANTS statement lists the privileges granted to users.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW GRANTS` [statement](sql-statements.html) lists the [privileges](privileges.html) granted to users.
-
## Synopsis
diff --git a/v2.1/show-index.md b/v2.1/show-index.md
index 76f4c2cbb8e..a99c8369728 100644
--- a/v2.1/show-index.md
+++ b/v2.1/show-index.md
@@ -1,12 +1,11 @@
---
title: SHOW INDEX
summary: The SHOW INDEX statement returns index information for a table.
-toc: false
+toc: true
---
The `SHOW INDEX` [statement](sql-statements.html) returns index information for a table.
-
## Required privileges
diff --git a/v2.1/show-jobs.md b/v2.1/show-jobs.md
index acb44b5b25e..1242a354258 100644
--- a/v2.1/show-jobs.md
+++ b/v2.1/show-jobs.md
@@ -1,7 +1,7 @@
---
title: SHOW JOBS
summary: The SHOW JOBS statement lists all currently active schema changes and backup/restore jobs.
-toc: false
+toc: true
---
The `SHOW JOBS` [statement](sql-statements.html) lists all of the types of long-running tasks your cluster has performed, including:
@@ -13,7 +13,6 @@ These details can help you understand the status of crucial tasks that can impac
{{site.data.alerts.callout_info}} The SHOW JOBS statement shows only long-running tasks. For an exhaustive list of jobs running in the cluster, use the SQL Audit Logging (Experimental) feature.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/show-queries.md b/v2.1/show-queries.md
index 52063f5b6b2..09669d59236 100644
--- a/v2.1/show-queries.md
+++ b/v2.1/show-queries.md
@@ -1,7 +1,7 @@
---
title: SHOW QUERIES
summary: The SHOW QUERIES statement lists all currently active queries across the cluster or on the local node.
-toc: false
+toc: true
---
The `SHOW QUERIES` [statement](sql-statements.html) lists details about currently active SQL queries, including:
@@ -16,7 +16,6 @@ These details let you monitor the progress of active queries and, if necessary,
{{site.data.alerts.callout_info}}Schema changes and BACKUP/RESTORE statements are not executed as queries internally and so are not listed by SHOW QUERIES. To monitor such statements, use SHOW JOBS instead.{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/show-roles.md b/v2.1/show-roles.md
index 52bf543de25..b0e8b724dfd 100644
--- a/v2.1/show-roles.md
+++ b/v2.1/show-roles.md
@@ -1,12 +1,11 @@
---
title: SHOW ROLES
summary: The SHOW ROLES statement lists the roles for all databases.
-toc: false
+toc: true
---
The `SHOW ROLES` [statement](sql-statements.html) lists the roles for all databases.
-
## Synopsis
diff --git a/v2.1/show-schemas.md b/v2.1/show-schemas.md
index 32b03eff892..d45164178f8 100644
--- a/v2.1/show-schemas.md
+++ b/v2.1/show-schemas.md
@@ -1,12 +1,11 @@
---
title: SHOW SCHEMAS
summary: The SHOW SCHEMAS statement lists the schemas in a database.
-toc: false
+toc: true
---
The `SHOW SCHEMAS` [statement](sql-statements.html) lists all [schemas](sql-name-resolution.html#logical-schemas-and-namespaces) in a database.
-
## Required privileges
diff --git a/v2.1/show-sessions.md b/v2.1/show-sessions.md
index bcbaefb54e5..39af96cda67 100644
--- a/v2.1/show-sessions.md
+++ b/v2.1/show-sessions.md
@@ -1,7 +1,7 @@
---
title: SHOW SESSIONS
summary: The SHOW SESSIONS statement lists all currently active sessions across the cluster or on the local node.
-toc: false
+toc: true
---
The `SHOW SESSIONS` [statement](sql-statements.html) lists details about currently active sessions, including:
@@ -14,7 +14,6 @@ The `SHOW SESSIONS` [statement](sql-statements.html) lists details about current
These details let you monitor the overall state of client connections and identify those that may need further investigation or adjustment.
-
## Required privileges
diff --git a/v2.1/show-tables.md b/v2.1/show-tables.md
index 11f9bb664cc..d22aab6229b 100644
--- a/v2.1/show-tables.md
+++ b/v2.1/show-tables.md
@@ -2,14 +2,13 @@
title: SHOW TABLES
summary: The SHOW TABLES statement lists the tables in a schema or database.
keywords: reflection
-toc: false
+toc: true
---
The `SHOW TABLES` [statement](sql-statements.html) lists the tables or [views](views.html) in a schema or database.
{{site.data.alerts.callout_info}}While a table or view is being dropped, SHOW TABLES will list the object with a (dropped) suffix.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/show-trace.md b/v2.1/show-trace.md
index 52e49c75a62..6a24ce655c2 100644
--- a/v2.1/show-trace.md
+++ b/v2.1/show-trace.md
@@ -1,14 +1,13 @@
---
title: SHOW TRACE
summary: The SHOW TRACE statement returns details about how CockroachDB executed a statement or series of statements.
-toc: false
+toc: true
---
The `SHOW TRACE` [statement](sql-statements.html) returns details about how CockroachDB executed a statement or series of statements. These details include messages and timing information from all nodes involved in the execution, providing visibility into the actions taken by CockroachDB across all of its software layers.
You can use `SHOW TRACE` to debug why a query is not performing as expected, to add more information to bug reports, or to generally learn more about how CockroachDB works.
-
## Usage overview
diff --git a/v2.1/show-users.md b/v2.1/show-users.md
index a95ef75337a..5b8f67bdc0d 100644
--- a/v2.1/show-users.md
+++ b/v2.1/show-users.md
@@ -1,12 +1,11 @@
---
title: SHOW USERS
summary: The SHOW USERS statement lists the users for all databases.
-toc: false
+toc: true
---
The `SHOW USERS` [statement](sql-statements.html) lists the users for all databases.
-
## Synopsis
diff --git a/v2.1/show-vars.md b/v2.1/show-vars.md
index 955322337c7..ddee91eeca9 100644
--- a/v2.1/show-vars.md
+++ b/v2.1/show-vars.md
@@ -1,7 +1,7 @@
---
title: SHOW (session settings)
summary: The SHOW statement displays the current settings for the client session.
-toc: false
+toc: true
redirect_from:
- show-all.html
- show-transaction.html
@@ -11,7 +11,6 @@ redirect_from:
The `SHOW` [statement](sql-statements.html) can display the value of either one or all of
the session setting variables. Some of these can also be configured via [`SET`](set-vars.html).
-
## Required privileges
diff --git a/v2.1/split-at.md b/v2.1/split-at.md
index 2eea3d826fe..af5c87e1440 100644
--- a/v2.1/split-at.md
+++ b/v2.1/split-at.md
@@ -1,12 +1,11 @@
---
title: SPLIT AT
summary: The SPLIT AT statement forces a key-value layer range split at the specified row in a table or index.
-toc: false
+toc: true
---
The `SPLIT AT` [statement](sql-statements.html) forces a key-value layer range split at the specified row in a table or index.
-
## Synopsis
diff --git a/v2.1/sql-audit-logging.md b/v2.1/sql-audit-logging.md
index d3fbeab8dc8..0244c8bb0df 100644
--- a/v2.1/sql-audit-logging.md
+++ b/v2.1/sql-audit-logging.md
@@ -1,7 +1,7 @@
---
title: SQL Audit Logging
summary: Use the EXPERIMENTAL_AUDIT setting to turn SQL audit logging on or off for a table.
-toc: false
+toc: true
---
SQL audit logging gives you detailed information about queries being executed against your system. This feature is especially useful when you want to log all queries that are run against a table containing personally identifiable information (PII).
@@ -16,7 +16,6 @@ For reference material, including a detailed description of the audit log file f
{% include {{ page.version.version }}/misc/experimental-warning.md %}
-
## Step 1. Create sample tables
diff --git a/v2.1/sql-constants.md b/v2.1/sql-constants.md
index 0112438b738..a5153b401cd 100644
--- a/v2.1/sql-constants.md
+++ b/v2.1/sql-constants.md
@@ -1,12 +1,11 @@
---
title: Constant Values
summary: SQL Constants represent a simple value that doesn't change.
-toc: false
+toc: true
---
SQL Constants represent a simple value that doesn't change.
-
## Introduction
diff --git a/v2.1/sql-dump.md b/v2.1/sql-dump.md
index dde98e5e485..bf746ef676f 100644
--- a/v2.1/sql-dump.md
+++ b/v2.1/sql-dump.md
@@ -1,7 +1,7 @@
---
title: SQL Dump (Export)
summary: Learn how to dump schemas and data from a CockroachDB cluster.
-toc: false
+toc: true
---
The `cockroach dump` [command](cockroach-commands.html) outputs the SQL statements required to recreate tables, views, and sequences. This command can be used to back up or export each database in a cluster. The output should also be suitable for importing into other relational databases, with minimal adjustments.
@@ -10,7 +10,6 @@ The `cockroach dump` [command](cockroach-commands.html) outputs the SQL statemen
CockroachDB [enterprise license](https://www.cockroachlabs.com/pricing/) users can also back up their cluster's data using [`BACKUP`](backup.html).
{{site.data.alerts.end}}
-
## Considerations
diff --git a/v2.1/sql-faqs.md b/v2.1/sql-faqs.md
index 5088429f6e1..063d67329f9 100644
--- a/v2.1/sql-faqs.md
+++ b/v2.1/sql-faqs.md
@@ -1,11 +1,10 @@
---
title: SQL FAQs
summary: Get answers to frequently asked questions about CockroachDB SQL.
-toc: false
+toc: true
toc_not_nested: true
---
-
## How do I bulk insert data into CockroachDB?
diff --git a/v2.1/sql-feature-support.md b/v2.1/sql-feature-support.md
index 97c6a04527d..2aa498d1517 100644
--- a/v2.1/sql-feature-support.md
+++ b/v2.1/sql-feature-support.md
@@ -3,7 +3,6 @@ title: SQL Feature Support in CockroachDB v2.1
summary: Summary of CockroachDB's conformance to the SQL standard and which common extensions it supports.
---
-
## Overview
diff --git a/v2.1/sql-name-resolution.md b/v2.1/sql-name-resolution.md
index e4a6116b925..e6566a5259c 100644
--- a/v2.1/sql-name-resolution.md
+++ b/v2.1/sql-name-resolution.md
@@ -1,14 +1,13 @@
---
title: Name Resolution
summary: Table and function names can exist in multiple places. Resolution decides which one to use.
-toc: false
+toc: true
---
A query can specify a table name without a database or schema name (e.g., `SELECT * FROM orders`). How does CockroachDB know which `orders` table is being considered and in which schema?
This page details how CockroachDB performs **name resolution** to answer this question.
-
## Logical schemas and namespaces
diff --git a/v2.1/sql-statements.md b/v2.1/sql-statements.md
index dd83684d857..9cfde73d8d1 100644
--- a/v2.1/sql-statements.md
+++ b/v2.1/sql-statements.md
@@ -1,7 +1,7 @@
---
title: SQL Statements
summary: SQL statements supported by CockroachDB.
-toc: false
+toc: true
---
CockroachDB supports the following SQL statements. Click a statement for more details.
@@ -10,7 +10,6 @@ CockroachDB supports the following SQL statements. Click a statement for more de
In the [built-in SQL shell](use-the-built-in-sql-client.html#sql-shell-help), use `\h [statement]` to get inline help about a specific statement.
{{site.data.alerts.end}}
-
## Data manipulation statements
diff --git a/v2.1/start-a-local-cluster.md b/v2.1/start-a-local-cluster.md
index 4881b565f7a..c833924943a 100644
--- a/v2.1/start-a-local-cluster.md
+++ b/v2.1/start-a-local-cluster.md
@@ -1,7 +1,7 @@
---
title: Start a Local Cluster (Insecure)
summary: Run an insecure multi-node CockroachDB cluster locally with each node listening on a different port.
-toc: false
+toc: true
toc_not_nested: true
asciicast: true
---
@@ -17,7 +17,6 @@ Once you’ve [installed CockroachDB](install-cockroachdb.html), it’s simple t
Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see [Manual Deployment](manual-deployment.html) or [Orchestrated Deployment](orchestration.html).
{{site.data.alerts.end}}
-
## Before you begin
diff --git a/v2.1/start-a-node.md b/v2.1/start-a-node.md
index 8bed404bcfd..2c95cdad0c6 100644
--- a/v2.1/start-a-node.md
+++ b/v2.1/start-a-node.md
@@ -1,14 +1,13 @@
---
title: Start a Node
summary: To start a new CockroachDB cluster, or add a node to an existing cluster, run the cockroach start command.
-toc: false
+toc: true
---
This page explains the `cockroach start` [command](cockroach-commands.html), which you use to start nodes as a new cluster or add nodes to an existing cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials.
{{site.data.alerts.callout_info}}Node-level settings are defined by flags passed to the cockroach start command and cannot be changed without stopping and restarting the node. In contrast, some cluster-wide settings are defined via SQL statements and can be updated anytime after a cluster has been started. For more details, see Cluster Settings.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/stop-a-node.md b/v2.1/stop-a-node.md
index 14623514009..7e8ff8e4752 100644
--- a/v2.1/stop-a-node.md
+++ b/v2.1/stop-a-node.md
@@ -1,14 +1,13 @@
---
title: Stop a Node
summary: Learn how to temporarily stop a CockroachDB node.
-toc: false
+toc: true
---
This page shows you how to use the `cockroach quit` [command](cockroach-commands.html) to temporarily stop a node that you plan to restart, for example, during the process of [upgrading your cluster's version of CockroachDB](upgrade-cockroach-version.html) or to perform planned maintenance (e.g., upgrading system software).
For information about permanently removing nodes to downsize a cluster or react to hardware failures, see [Remove Nodes](remove-nodes.html).
-
## Overview
diff --git a/v2.1/string.md b/v2.1/string.md
index fa8fbcb6d3f..a81ce3f0893 100644
--- a/v2.1/string.md
+++ b/v2.1/string.md
@@ -1,14 +1,13 @@
---
title: STRING
summary: The STRING data type stores a string of Unicode characters.
-toc: false
+toc: true
---
The `STRING` [data type](data-types.html) stores a string of Unicode characters.
-
## Aliases
diff --git a/v2.1/subqueries.md b/v2.1/subqueries.md
index 7e57d2e7570..e9797d6ac8c 100644
--- a/v2.1/subqueries.md
+++ b/v2.1/subqueries.md
@@ -1,12 +1,11 @@
---
title: Subqueries
summary: Subqueries enable the use of the results from a query within another query.
-toc: false
+toc: true
---
SQL subqueries enable reuse of the results from a [selection query](selection-queries.html) within another query.
-
## Overview
diff --git a/v2.1/table-expressions.md b/v2.1/table-expressions.md
index 43a0a3a403f..ce94c7806ae 100644
--- a/v2.1/table-expressions.md
+++ b/v2.1/table-expressions.md
@@ -1,7 +1,7 @@
---
title: Table Expressions
summary: Table expressions define a data source in selection clauses.
-toc: false
+toc: true
---
Table expressions define a data source in the `FROM` sub-clause of
@@ -11,7 +11,6 @@ Table expressions define a data source in the `FROM` sub-clause of
[SQL Joins](joins.html) are a particular kind of table
expression.
-
## Synopsis
diff --git a/v2.1/time.md b/v2.1/time.md
index d4591021c67..6b7ac1d6a1b 100644
--- a/v2.1/time.md
+++ b/v2.1/time.md
@@ -1,11 +1,10 @@
---
title: TIME
summary: The TIME data type stores a time of day in UTC, whereas TIMETZ stores a time of day with a time zone offset from UTC.
-toc: false
+toc: true
---
The `TIME` [data type](data-types.html) stores the time of day in UTC, whereas `TIMETZ` stores a time of day with a time zone offset from UTC.
-
## Variants
diff --git a/v2.1/timestamp.md b/v2.1/timestamp.md
index 594732e9cc0..d6af8848d11 100644
--- a/v2.1/timestamp.md
+++ b/v2.1/timestamp.md
@@ -1,12 +1,11 @@
---
title: TIMESTAMP
summary: The TIMESTAMP data type stores a date and time pair in UTC, whereas TIMESTAMPTZ stores a date and time pair with a time zone offset from UTC.
-toc: false
+toc: true
---
The `TIMESTAMP` [data type](data-types.html) stores a date and time pair in UTC, whereas `TIMESTAMPTZ` stores a date and time pair with a time zone offset from UTC.
-
## Variants
diff --git a/v2.1/training/backup-and-restore.md b/v2.1/training/backup-and-restore.md
index 9f3d29aa0ce..08d9bf98e1f 100644
--- a/v2.1/training/backup-and-restore.md
+++ b/v2.1/training/backup-and-restore.md
@@ -1,6 +1,6 @@
---
title: Back and Restore
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/backup-and-restore.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/client-connection-troubleshooting.md b/v2.1/training/client-connection-troubleshooting.md
index 9b0e46b951e..91d6fde4536 100644
--- a/v2.1/training/client-connection-troubleshooting.md
+++ b/v2.1/training/client-connection-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Client Connection Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/client-connection-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/cluster-startup-and-scaling.md b/v2.1/training/cluster-startup-and-scaling.md
index 0dc89a88554..64a9bfa8ebd 100644
--- a/v2.1/training/cluster-startup-and-scaling.md
+++ b/v2.1/training/cluster-startup-and-scaling.md
@@ -1,6 +1,6 @@
---
title: Cluster Startup and Scaling
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/cluster-startup-and-scaling.html
@@ -13,7 +13,6 @@ redirect_from: /training/cluster-startup-and-scaling.html
content: "Hands-on Lab"
}
-
## Step 1. Create a training directory
diff --git a/v2.1/training/cluster-unavailability-troubleshooting.md b/v2.1/training/cluster-unavailability-troubleshooting.md
index 444c10fc0be..5a31de439db 100644
--- a/v2.1/training/cluster-unavailability-troubleshooting.md
+++ b/v2.1/training/cluster-unavailability-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Cluster Unavailability Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/cluster-unavailability-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/cluster-upgrade.md b/v2.1/training/cluster-upgrade.md
index 527959fc66b..be64ec8f85d 100644
--- a/v2.1/training/cluster-upgrade.md
+++ b/v2.1/training/cluster-upgrade.md
@@ -1,6 +1,6 @@
---
title: Cluster Upgrade
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/cluster-upgrade.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/data-corruption-troubleshooting.md b/v2.1/training/data-corruption-troubleshooting.md
index e5fa633aff3..e3d9509b914 100644
--- a/v2.1/training/data-corruption-troubleshooting.md
+++ b/v2.1/training/data-corruption-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Data Corruption Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-corruption-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/data-import.md b/v2.1/training/data-import.md
index a696cbf2ee5..0b2fc555da5 100644
--- a/v2.1/training/data-import.md
+++ b/v2.1/training/data-import.md
@@ -1,6 +1,6 @@
---
title: Data Import
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-import.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/data-unavailability-troubleshooting.md b/v2.1/training/data-unavailability-troubleshooting.md
index 60c7f29b1bc..61c235761aa 100644
--- a/v2.1/training/data-unavailability-troubleshooting.md
+++ b/v2.1/training/data-unavailability-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Data Unavailability Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/data-unavailability-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/fault-tolerance-and-automated-repair.md b/v2.1/training/fault-tolerance-and-automated-repair.md
index 7710f060e67..4cf150eebb6 100644
--- a/v2.1/training/fault-tolerance-and-automated-repair.md
+++ b/v2.1/training/fault-tolerance-and-automated-repair.md
@@ -1,6 +1,6 @@
---
title: Fault Tolerance and Automated Repair
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/fault-tolerance-and-automated-repair.html
@@ -13,7 +13,6 @@ redirect_from: /training/fault-tolerance-and-automated-repair.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/locality-and-replication-zones.md b/v2.1/training/locality-and-replication-zones.md
index abf2f37df14..bcbad2193f8 100644
--- a/v2.1/training/locality-and-replication-zones.md
+++ b/v2.1/training/locality-and-replication-zones.md
@@ -1,6 +1,6 @@
---
title: Locality and Replication Zones
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
redirect_from: /training/locality-and-replication-zones.html
@@ -13,7 +13,6 @@ redirect_from: /training/locality-and-replication-zones.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/network-partition-troubleshooting.md b/v2.1/training/network-partition-troubleshooting.md
index c9294cdd5e8..2b53662ec66 100644
--- a/v2.1/training/network-partition-troubleshooting.md
+++ b/v2.1/training/network-partition-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Network Partition Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/network-partition-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/node-decommissioning.md b/v2.1/training/node-decommissioning.md
index 0e1761d3428..9e007234905 100644
--- a/v2.1/training/node-decommissioning.md
+++ b/v2.1/training/node-decommissioning.md
@@ -1,6 +1,6 @@
---
title: Node Decommissioning
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/node-decommissioning.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/node-startup-troubleshooting.md b/v2.1/training/node-startup-troubleshooting.md
index 1be24cb0bcf..4297ae0af52 100644
--- a/v2.1/training/node-startup-troubleshooting.md
+++ b/v2.1/training/node-startup-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Node Startup Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/node-startup-troubleshooting.html
content: "Hands-on Lab"
}
-
## Problem 1: SSL required
diff --git a/v2.1/training/planned-maintenance.md b/v2.1/training/planned-maintenance.md
index b65a42c2b5a..1e26287247d 100644
--- a/v2.1/training/planned-maintenance.md
+++ b/v2.1/training/planned-maintenance.md
@@ -1,6 +1,6 @@
---
title: Planned Maintenance
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/planned-maintenance.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/security.md b/v2.1/training/security.md
index d8984b1814a..4a88d7cde0b 100644
--- a/v2.1/training/security.md
+++ b/v2.1/training/security.md
@@ -14,7 +14,6 @@ redirect_from: /training/security.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/software-panic-troubleshooting.md b/v2.1/training/software-panic-troubleshooting.md
index 1d92e63e7ac..f386ccd4f4a 100644
--- a/v2.1/training/software-panic-troubleshooting.md
+++ b/v2.1/training/software-panic-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Software Panic Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/software-panic-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/under-replication-troubleshooting.md b/v2.1/training/under-replication-troubleshooting.md
index 3dd21555ec0..f299fa11ff8 100644
--- a/v2.1/training/under-replication-troubleshooting.md
+++ b/v2.1/training/under-replication-troubleshooting.md
@@ -1,6 +1,6 @@
---
title: Under-Replication Troubleshooting
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/under-replication-troubleshooting.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/training/users-and-privileges.md b/v2.1/training/users-and-privileges.md
index 82ba8a0bed9..59504514075 100644
--- a/v2.1/training/users-and-privileges.md
+++ b/v2.1/training/users-and-privileges.md
@@ -1,6 +1,6 @@
---
title: Users and Privileges
-toc: false
+toc: true
toc_not_nested: true
sidebar_data: sidebar-data-training.json
block_search: true
@@ -14,7 +14,6 @@ redirect_from: /training/users-and-privileges.html
content: "Hands-on Lab"
}
-
## Before you begin
diff --git a/v2.1/transactions.md b/v2.1/transactions.md
index 44803628f0a..dd79d820353 100644
--- a/v2.1/transactions.md
+++ b/v2.1/transactions.md
@@ -1,7 +1,7 @@
---
title: Transactions
summary: CockroachDB supports bundling multiple SQL statements into a single all-or-nothing transaction.
-toc: false
+toc: true
---
CockroachDB supports bundling multiple SQL statements into a single all-or-nothing transaction. Each transaction guarantees [ACID semantics](https://en.wikipedia.org/wiki/ACID) spanning arbitrary tables and rows, even when data is distributed. If a transaction succeeds, all mutations are applied together with virtual simultaneity. If any part of a transaction fails, the entire transaction is aborted, and the database is left unchanged. CockroachDB guarantees that while a transaction is pending, it is isolated from other concurrent transactions with serializable [isolation](#isolation-levels).
@@ -10,7 +10,6 @@ CockroachDB supports bundling multiple SQL statements into a single all-or-nothi
For a detailed discussion of CockroachDB transaction semantics, see [How CockroachDB Does Distributed Atomic Transactions](https://www.cockroachlabs.com/blog/how-cockroachdb-distributes-atomic-transactions/) and [Serializable, Lockless, Distributed: Isolation in CockroachDB](https://www.cockroachlabs.com/blog/serializable-lockless-distributed-isolation-cockroachdb/). Note that the explanation of the transaction model described in this blog post is slightly out of date. See the [Transaction Retries](#transaction-retries) section for more details.
{{site.data.alerts.end}}
-
## SQL statements
diff --git a/v2.1/truncate.md b/v2.1/truncate.md
index 10b70f4f566..8ea76f18603 100644
--- a/v2.1/truncate.md
+++ b/v2.1/truncate.md
@@ -1,14 +1,13 @@
---
title: TRUNCATE
summary: The TRUNCATE statement deletes all rows from specified tables.
-toc: false
+toc: true
---
The `TRUNCATE` [statement](sql-statements.html) deletes all rows from specified tables.
{{site.data.alerts.callout_info}}The TRUNCATE removes all rows from a table by dropping the table and recreating a new table with the same name. For large tables, this is much more performant than deleting each of the rows. However, for smaller tables, it's more performant to use a DELETE statement without a WHERE clause.{{site.data.alerts.end}}
-
## Synopsis
diff --git a/v2.1/unique.md b/v2.1/unique.md
index 116e33238f4..fbd3084cee1 100644
--- a/v2.1/unique.md
+++ b/v2.1/unique.md
@@ -1,12 +1,11 @@
---
title: Unique Constraint
summary: The UNIQUE constraint specifies that each non-NULL value in the constrained column must be unique.
-toc: false
+toc: true
---
The `UNIQUE` [constraint](constraints.html) specifies that each non-`NULL` value in the constrained column must be unique.
-
## Details
diff --git a/v2.1/update.md b/v2.1/update.md
index 9c89f28b6f8..5bac08c4484 100644
--- a/v2.1/update.md
+++ b/v2.1/update.md
@@ -1,7 +1,7 @@
---
title: UPDATE
summary: The UPDATE statement updates rows in a table.
-toc: false
+toc: true
---
The `UPDATE` [statement](sql-statements.html) updates rows in a table.
@@ -10,7 +10,6 @@ The `UPDATE` [statement](sql-statements.html) updates rows in a table.
If you update a row that contains a column referenced by a [foreign key constraint](foreign-key.html) and has an [`ON UPDATE` action](foreign-key.html#foreign-key-actions), all of the dependent rows will also be updated.
{{site.data.alerts.end}}
-
## Required privileges
diff --git a/v2.1/upgrade-cockroach-version.md b/v2.1/upgrade-cockroach-version.md
index b1c6aa22a36..18ba7ecbfdd 100644
--- a/v2.1/upgrade-cockroach-version.md
+++ b/v2.1/upgrade-cockroach-version.md
@@ -1,7 +1,7 @@
---
title: Upgrade to CockroachDB v2.1
summary: Learn how to upgrade your CockroachDB cluster to a new version.
-toc: false
+toc: true
toc_not_nested: true
---
@@ -11,7 +11,6 @@ Because of CockroachDB's [multi-active availability](multi-active-availability.h
This page shows you how to upgrade to v2.1 from v2.0.x, or from any patch release in the v2.1.x series. To upgrade within the v2.0.x series, see [the v2.0 version of this page](https://www.cockroachlabs.com/docs/v2.0/upgrade-cockroach-version.html).
{{site.data.alerts.end}}
-
## Step 1. Verify that you can upgrade
diff --git a/v2.1/upsert.md b/v2.1/upsert.md
index 80a8a10ef5a..05aaeff00f8 100644
--- a/v2.1/upsert.md
+++ b/v2.1/upsert.md
@@ -1,12 +1,11 @@
---
title: UPSERT
summary: The UPSERT statement inserts rows when values do not violate uniqueness constraints, and it updates rows when values do violate uniqueness constraints.
-toc: false
+toc: true
---
The `UPSERT` [statement](sql-statements.html) is short-hand for [`INSERT ON CONFLICT`](insert.html#on-conflict-clause). It inserts rows in cases where specified values do not violate uniqueness constraints, and it updates rows in cases where values do violate uniqueness constraints.
-
## Considerations
diff --git a/v2.1/use-the-built-in-sql-client.md b/v2.1/use-the-built-in-sql-client.md
index 7f2c0c2f3a6..2a96c306678 100644
--- a/v2.1/use-the-built-in-sql-client.md
+++ b/v2.1/use-the-built-in-sql-client.md
@@ -1,14 +1,13 @@
---
title: Use the Built-in SQL Client
summary: CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line.
-toc: false
+toc: true
---
CockroachDB comes with a built-in client for executing SQL statements from an interactive shell or directly from the command line. To use this client, run the `cockroach sql` [command](cockroach-commands.html) as described below.
To exit the interactive shell, use `\q` or `ctrl-d`.
-
## Synopsis
diff --git a/v2.1/uuid.md b/v2.1/uuid.md
index c7b9748dc31..72d4e317847 100644
--- a/v2.1/uuid.md
+++ b/v2.1/uuid.md
@@ -1,7 +1,7 @@
---
title: UUID
summary: The UUID data type stores 128-bit Universal Unique Identifiers.
-toc: false
+toc: true
---
The `UUID` (Universally Unique Identifier) [data type](data-types.html) stores a 128-bit value that is [unique across both space and time](https://www.ietf.org/rfc/rfc4122.txt).
@@ -10,7 +10,6 @@ The `UUID` (Universally Unique Identifier) [data type](data-types.html) stores a
To auto-generate unique row IDs, we recommend using [`UUID`](uuid.html) with the `gen_random_uuid()` function as the default value. See the [example](#create-a-table-with-auto-generated-unique-row-ids) below for more details.
{{site.data.alerts.end}}
-
## Syntax
A `UUID` value can be expressed using the following formats:
diff --git a/v2.1/validate-constraint.md b/v2.1/validate-constraint.md
index fc1db36c7a8..7114fc3dfe0 100644
--- a/v2.1/validate-constraint.md
+++ b/v2.1/validate-constraint.md
@@ -1,14 +1,13 @@
---
title: VALIDATE CONSTRAINT
summary: Use the ADD COLUMN statement to add columns to tables.
-toc: false
+toc: true
---
The `VALIDATE CONSTRAINT` [statement](sql-statements.html) is part of `ALTER TABLE` and checks whether values in a column match a [constraint](constraints.html) on the column.
This statement is especially useful after applying a constraint to an existing column via [`ADD CONSTRAINT`](add-constraint.html). In this case, `VALIDATE CONSTRAINT` can be used to find values already in the column that do not match the constraint.
-
## Required privileges
diff --git a/v2.1/view-node-details.md b/v2.1/view-node-details.md
index 001f10118c1..7d2eec4d96e 100644
--- a/v2.1/view-node-details.md
+++ b/v2.1/view-node-details.md
@@ -1,14 +1,13 @@
---
title: View Node Details
summary: To view details for each node in the cluster, use the cockroach node command with the appropriate subcommands and flags.
-toc: false
+toc: true
---
To view details for each node in the cluster, use the `cockroach node` [command](cockroach-commands.html) with the appropriate subcommands and flags.
The `cockroach node` command is also used in the process of decommissioning nodes for permanent removal. See [Remove Nodes](remove-nodes.html) for more details.
-
## Subcommands
diff --git a/v2.1/views.md b/v2.1/views.md
index 8810bf51e88..148fad5dff9 100644
--- a/v2.1/views.md
+++ b/v2.1/views.md
@@ -1,12 +1,11 @@
---
title: Views
summary:
-toc: false
+toc: true
---
A view is a stored [selection query](selection-queries.html) and provides a shorthand name for it. CockroachDB's views are **dematerialized**: they do not store the results of the underlying queries. Instead, the underlying query is executed anew every time the view is used.
-
## Why use views?