SQL language changes
- -- To perform [`REASSIGN OWNED BY`](https://www.cockroachlabs.com/docs/v21.2/reassign-owned), the current user running the command must now be a member of both the old and new [roles](https://www.cockroachlabs.com/docs/v21.2/security-reference/authorization#roles). Previously the new owner would need: to be a member of the `CREATEDB` role if the object being changed was a database, [`CREATE` privileges](https://www.cockroachlabs.com/docs/v21.2/grant#supported-privileges) for the database if the object being changed was a schema, or `CREATE` privileges for the schema if object being changed was a table or type. [#69382][#69382] -- The [SQL stats compaction job](https://www.cockroachlabs.com/docs/v21.2/cost-based-optimizer#table-statistics) now only shows up in the output of [`SHOW AUTOMATIC JOBS`](https://www.cockroachlabs.com/docs/v21.2/show-jobs). [#69641][#69641] -- `DROP`s, `RENAME`s, and other light schema changes are no longer user cancelable to avoid scenarios that do not properly rollback. [#69328][#69328] -- Users can now opt to disable auto-rehoming for a session by setting `on_update_rehome_row_enabled = false`. This can be permanently unset by default using the [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `sql.defaults.on_update_rehome_row.enabled`. [#69626][#69626] -- It is now possible to alter the owner of the [`crdb_internal_region` type](https://www.cockroachlabs.com/docs/v21.2/set-locality#crdb_region), which is created by initiating a [multi-region database](https://www.cockroachlabs.com/docs/v21.2/multiregion-overview). [#69722][#69722] -- Added more detail to the error message users receive when they call [`SHOW BACKUP`](https://www.cockroachlabs.com/docs/v21.2/show-backup) with a path pointing to the root of the collection, rather than a specific [backup](https://www.cockroachlabs.com/docs/v21.2/backup) in the collection. [#69638][#69638] -- Introduced a new cluster setting `sql.stats.persisted_rows.max` and increased its default value to `1000000` (1,000,000 rows). [#69667][#69667] -- Previously, users had no way of determining which objects in their database utilized deprecated features like interleaved indexes/tables or cross-database references. Added crdb_internal tables `cross_db_references`, `interleaved_indexes`, and `interleaved_tables` for detecting these deprecated features within a given database. [#61629][#61629] -- The `sql.defaults.vectorize_row_count_threshold` [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings), as well as the corresponding `vectorize_row_count_threshold` session variable, have been removed. From now on, CockroachDB will behave exactly as if these were set to `0` (last default value). [#62164][#62164] -- Updated `crdb_internal.interleaved` to add the `parent_table_name` column replacing the `parent_index_name` column. [#62076][#62076] -- CockroachDB now references sequences used in views by their IDs to allow these sequences to be renamed. [#61439][#61439] -- Added `SQLType` to classify `DDL`, `DML`, `DCL`, or `TCL` statement types. [#62989][#62989] -- Implemented the geometry-based [built-in](https://www.cockroachlabs.com/docs/v21.2/functions-and-operators#built-in-functions) `ST_IsValidTrajectory`. [#63072][#63072] -- CockroachDB now accepts UUID inputs that have a hyphen after any group of four digits. This aligns with the UUID format used by PostgreSQL. For example, `a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11` is now considered a valid UUID. [#63137][#63137] -- The `gen_ulid` and `uuid_ulid_to_string` [built-ins](https://www.cockroachlabs.com/docs/v21.2/functions-and-operators#built-in-functions) are now available for use. [#62440][#62440] -- Single-key spans in [`EXPLAIN`](https://www.cockroachlabs.com/docs/v21.2/explain) and `EXPLAIN (DISTSQL)` are now shown without a misleading dash after them. [#61583][#61583] -- Enabled locality-optimized search in the row execution engine. [#63384][#63384] -- CockroachDB now should be more stable when executing queries with subqueries producing many rows (previously it could OOM crash; it wil now use the temporary disk storage). [#63900][#63900] -- Correlated common table expressions (CTEs) can now be used. [#63956][#63956] -- Introduced a new session variable `distsql_workmem` that determines how much RAM a single operation of a single query can take before the operation must spill to disk. This is identical to the `sql.distsql.temp_storage.workmem` [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) but has the session-level scope. [#63959][#63959] -- `crdb_internal.node_statement_statistics` now stores `statement_id`. [#64076][#64076] -- Added line to the [`EXPLAIN ANALYZE`](https://www.cockroachlabs.com/docs/v21.2/explain-analyze) output to show disk spill usage to make it clear when disk spilling occurs executing a query. This output is only shown when the disk usage is greater than zero. The verbiage in the DistSQL `EXPLAIN` diagrams changed from `max scratch disk allocated` to `max sql temp disk usage` for consistency and to match the way we talk about SQL spill disk usage elsewhere. [#64137][#64137] -- Previously, committing a transaction when a portal was suspended would cause a "multiple active portals not supported" error. Now, the portal is automatically destroyed. [#63677][#63677] -- Bulk IO operations are no longer included in service latency metrics. [#64442][#64442] -- Collated strings may now have a locale that is a language tag, followed by a `-u-` suffix, followed by anything else. For example, any locale with a prefix of `en-US-u-` is now considered valid. [#64695][#64695] -- Added new tables to `pg_catalog`: `pg_partitioned_table`, `pg_replication_origin_status`, `pg_init_privs`, `pg_replication_slots`, `pg_policy`, `pg_sequences`, `pg_subscription_rel`, `pg_largeobject_metadata`. [#64035][#64035] -- Added new columns to `pg_catalog` tables: `pg_class` (`relminmxid`), `pg_constraint` (`conparentid`). [#64035][#64035] -- Using the table name as a projection now works, e.g., `SELECT table_name FROM table_name` or `SELECT row_to_json(table_name) FROM table_name`. [#64748][#64748] -- Added `generate_series` for `TIMESTAMPTZ` values. [#64887][#64887] -- Added the `sql.defaults.require_explicit_primary_keys.enabled` [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) for requiring explicit primary keys in [`CREATE TABLE`](https://www.cockroachlabs.com/docs/v21.2/create-table) statements. [#64951][#64951] -- SQL service latency now only includes metrics from DML statements. [#64893][#64893] -- Added support for using `OPERATOR(operator)` for binary expressions. This only works for in-built CockroachDB operators. [#64701][#64701] -- Introduced the `OPERATOR` syntax for unary operators. This only works for unary operators usable in CockroachDB. [#64701][#64701] -- Implemented the geometry [built-in](https://www.cockroachlabs.com/docs/v21.2/functions-and-operators#built-in-functions) function `ST_LineCrossingDirection`. [#64997][#64997] -- Added the `pg_relation_is_updatable` and `pg_column_is_updatable` [built-in](https://www.cockroachlabs.com/docs/v21.2/functions-and-operators#built-in-functions) functions [#64788][#64788] -- `information_schema.columns.data_type` now returns "`USER-DEFINED`" when the column is a user-defined type (e.g., [`ENUM`](https://www.cockroachlabs.com/docs/v21.2/enum)) [#65154][#65154] -- CockroachDB now supports the scalar functions `get_byte()` and `set_byte()` as in PostgreSQL. [#65189][#65189] -- CockroachDB now supports converting strings of hexadecimal digits prefixed by `x` or `X` to a BIT value, in the same way as PostgreSQL. Note that only the conversion via casts is supported (e.g., `'XAB'::BIT(8)`); PostgreSQL's literal constant syntax (e.g., `X'AB'::BIT(8)`) continues to have different meaning in CockroachDB (byte array) due to historical reasons. [#65188][#65188] -- [`SHOW JOBS`](https://www.cockroachlabs.com/docs/v21.2/show-jobs) now shows the `trace_id` of the trace that is associated with the current execution of the job. This allows pulling inflight traces for a job for debugging purposes. [#65322][#65322] -- The [vectorized execution engine](https://www.cockroachlabs.com/docs/v21.2/vectorized-execution) now supports the ntile window function. [#64977][#64977] -- Pg_sequences table was implemented on pg_catalog [#65420][#65420] -- A constant can now be cast to regclass without first converting the constant to an OID. E.g., 52::regclass can now be done instead of 52::oid::regclass. [#65432][#65432] -- References to WITH expressions from correlated subqueries are now always supported. [#65550][#65550] -- Added new [`SHOW CHANGEFEED JOBS`](https://www.cockroachlabs.com/docs/v21.2/show-jobs) command with additional information about changefeeds for improved user visibility. [#64956][#64956] -- This is strictly a change for docgen and sql grammar. Now all sql.y statements (excluding those that are unimplemented or specified to be skipped) will have automatically have a stmtSpec defined for them and thus will have a bnf and svg file automatically generated in cockroachdb/generated-diagrams. [#65278][#65278] -- The [vectorized execution engine](https://www.cockroachlabs.com/docs/v21.2/vectorized-execution) now supports the `lag` and `lead` window functions. [#65634][#65634] -- The total number of statement/transaction fingerprints stored in-memory can now be limited using the [cluster settings](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `sql.metrics.max_mem_stmt_fingerprints` and `sql.metrics.max_mem_txn_fingerprints`. [#65902][#65902] -- Previously, SQL commands that were sent during the PostgreSQL extended protocol that were too big would error opaquely. This is now resolved by returning a friendlier error message. [#57590][#57590] -- Namespace entries may no longer be queried via `system.namespace2`. [#65340][#65340] -- [`EXPLAIN ANALYZE`](https://www.cockroachlabs.com/docs/v21.2/explain-analyze) output now includes, for each plan step, the total time spent waiting for KV requests as well as the total time those KV requests spent contending with other transactions. [#66157][#66157] -- Added the [`SHOW CREATE DATABASE`](https://www.cockroachlabs.com/docs/v21.2/show-create) command to get database metadata. [#66033][#66033] -- Added `sample_plan`, `database_name`, and `exec_node_ids` columns to the `crdb_internal.node_statement_statistics` table. This allows for third-party and partner consumption of this data. [#65782][#65782] -- Implemented `pg_rewrite` for table-view dependencies. Table-view dependencies are no longer stored directly in `pg_depend`. [#65495][#65495] -- Added some virtual tables `crdb_internal.(node|cluster)_distsql_flows` that expose the information about the flows of the DistSQL execution scheduled on remote nodes. These tables do not include information about the non-distributed queries or about local flows (from the perspective of the gateway node of the query). [#65727][#65727] -- The use order of columns in a foreign key no longer needs to match the order the columns were defined for the reference table's unique constraint. [#65209][#65209] -- Previously, in some special cases ([`UPSERT`](https://www.cockroachlabs.com/docs/v21.2/upsert)s, as documented in [this issue](https://github.com/cockroachdb/docs/issues/9922)), the support of the distinct operations was missing in the [vectorized execution engine](https://www.cockroachlabs.com/docs/v21.2/vectorized-execution). This has been added, and such operations will be able to spill to disk if necessary. However, in case the distinct operator does, in fact, spill to disk, there is a slight complication. The order in which rows are inserted can be non-deterministic: for example, for a query such as `INSERT INTO t VALUES (1, 1), (1, 2), (1, 3) ON CONFLICT DO NOTHING`, with `t` having the schema `a INT PRIMARY KEY, b INT`, it is possible that any of the three rows are actually inserted. PostgreSQL appears to have the same behavior. [#61582][#61582] -- Added three new views to the `crdb_internal schema` to support developers investigating contention events: `cluster_contended_{tables, indexes, keys}`. [#66370][#66370] -- Implemented `similar_escape` and made `similar_to_escape` compatible with PostgreSQL. [#66578][#66578] -- The `"char"` column type will now truncate long values, in line with PostgreSQL. [#66422][#66422] -- The contents of the statistics table in the information schema have changed; therefore, so have the results of [`SHOW INDEX`](https://www.cockroachlabs.com/docs/v21.2/show-index) and [`SHOW COLUMNS`](https://www.cockroachlabs.com/docs/v21.2/show-columns). A column that is not in the primary key will now be listed as belonging to the primary index as a stored column. Previously, it was simply not listed as belonging to the primary index. [#66599][#66599] -- Adding empty missing tables on `information_schema` for compatibility: `attributes`, `check_constraint_routine_usage`, `column_column_usage`, `column_domain_usage`, `column_options`, `constraint_table_usage`, `data_type_privileges`, `domain_constraints`, `domain_udt_usage`, `domains`, `element_types`, `foreign_data_wrapper_options`, `foreign_data_wrappers`, `foreign_server_options`, `foreign_servers`, `foreign_table_options`, `foreign_tables`, `information_schema_catalog_name`, `role_column_grants`, `role_routine_grants`, `role_udt_grants`, `role_usage_grants`, `routine_privileges`, `sql_features`, `sql_implementation_info`, `sql_parts`, `sql_sizing`, `transforms`, `triggered_update_columns`, `triggers`, `udt_privileges`, `usage_privileges`, `user_defined_types`, `user_mapping_options`, `user_mappings`, `view_column_usage`, `view_routine_usage`, `view_table_usage`. [#65854][#65854] -- The [`SHOW QUERIES`](https://www.cockroachlabs.com/docs/v21.2/show-statements) command was extended for prepared statements to show the actual values in use at query time, rather than the previous `$1`, `$2`, etc. placeholders. We expect showing these values will greatly improve the experience of debugging slow queries. [#66689][#66689] -- Populated the `pg_type` table with entries for each table. Also populated `pg_class.reltypid` with the corresponding `oid` in the `pg_type` table. [#66815][#66815] -- Added a virtual table `crdb_internal.cluster_inflight_traces` which surfaces cluster-wide inflight traces for the `trace_id` specified via an index constraint. The output of this table is not appropriate to consume over a SQL connection; follow-up changes will add CLI wrappers to make the interaction more user-friendly. [#66679][#66679] -- Added support for `iso_8601` and `sql_standard` as usable session variables in `IntervalStyle`. Also added a `sql.defaults.intervalstyle` [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) to be used as the default interval style. [#67000][#67000] -- Added a [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `sql.defaults.primary_region`, which assigns a `PRIMARY REGION` to a database by default. [#67168][#67168] -- Introduced a [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `sql.allow_drop_final_region.enabled` which disallows dropping of a `PRIMARY REGION` (the final region of a database). [#67168][#67168] -- [`IMPORT TABLE`](https://www.cockroachlabs.com/docs/v21.2/import) will be deprecated in v21.2 and removed in a future release. Users should create a table using [`CREATE TABLE`](https://www.cockroachlabs.com/docs/v21.2/create-table) and then [`IMPORT INTO`](https://www.cockroachlabs.com/docs/v21.2/import-into) the newly created table. [#67275][#67275] -- CockroachDB now uses `JSONB` instead of `BYTES` to store statement plans in `system.statement_statistics`. [#67331][#67331] -- Reduced instantaneous memory usage during scans by up to 2x. [#66376][#66376] -- Added the session variable `backslash_quote` for PostgreSQL compatibility. Setting this does a no-op, and only `safe_encoding` is supported. [#67343][#67343] -- Introduced a `crdb_internal.regions` table which contains data on all regions in the cluster. [#67098][#67098] -- When parsing intervals, `IntervalStyle` is now taken into account. In particular, `IntervalStyle = 'sql_standard'` will make all interval fields negative if there is a negative symbol at the front, e.g., `-3 years 1 day` would be `-(3 years 1 day)` in `sql_standard` and `-3 days, 1 day` in PostgreSQL `DateStyle`. [#67210][#67210] -- `ROLLBACK TO SAVEPOINT` can now be used to recover from `LockNotAvailable` errors (`pgcode` `55P03`), which are returned when performing a [`FOR UPDATE SELECT`](https://www.cockroachlabs.com/docs/v21.2/select-for-update) with a `NOWAIT` wait policy. [#67514][#67514] -- Added tables to `information_schema` that are present on MySQL. The tables are not populated and are entirely empty. `column_statistics`, `columns_extensions`, `engines`, `events`, `files`, `keywords`, `optimizer_trace`, `partitions`, `plugins`, `processlist`, `profiling`, `resource_groups`, `schemata_extensions`, `st_geometry_columns`, `st_spatial_reference_systems`, `st_units_of_measure`, `table_constraints_extensions`, `tables_extensions`, `tablespaces`, `tablespaces_extensions`, `user_attributes`. [#66795][#66795] -- Added new [built-ins](https://www.cockroachlabs.com/docs/v21.2/functions-and-operators#built-in-functions) `compress(data, codec)` and `decompress(data, codec)` which can compress and decompress bytes with the specified codec. `Gzip` is the only currently supported codec. [#67426][#67426] -- The column types of the results of `SHOW LAST QUERY STATISTICS` (an undocumented statement meant mostly for internal use by CockroachDB's SQL shell) has been changed from `INTERVAL` to `STRING`. They are populated by the durations of the various phases of executions as if the duration, as an `INTERVAL`, was converted to `STRING` using the '`postgres`' `IntervalStyle`. This ensures that the server-side execution timings are always available regardless of the value of the `IntervalStyle` session variable. [#67654][#67654] -- Changed `information_schema.routines` data types at columns `interval_precision`, `result_cast_char_octet_length` and `result_cast_datetime_precision` to `INT`. [#67641][#67641] -- Added syntax for granting and revoking privileges for all the tables in the specified schemas. New supported syntax: [`GRANT {privileges...} ON ALL TABLES IN SCHEMA {schema_names...} TO {roles...}`](https://www.cockroachlabs.com/docs/v21.2/grant); [`REVOKE {privileges...} ON ALL TABLES IN SCHEMA {schema_names...} TO {roles...}`](https://www.cockroachlabs.com/docs/v21.2/revoke). This command is added for PostgreSQL compatibility. [#67509][#67509] -- Added `pg_stat_database` and `pg_stat_database_conflicts` to `pg_catalog`. [#66687][#66687] -- A database that is restored with the [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `sql.defaults.primary_region` will now have the `PRIMARY REGION` from the cluster setting assigned to the database. [#67581][#67581] -- The [vectorized execution engine](https://www.cockroachlabs.com/docs/v21.2/vectorized-execution) now supports `CASE` expressions that output `BYTES`-like types. [#66399][#66399] -- Introduced the `with_min_timestamp` and `with_max_staleness` [built-in](https://www.cockroachlabs.com/docs/v21.2/functions-and-operators#built-in-functions) functions. In a `SELECT` clause, they return the same timestamp and `(now() - interval)`, but are intended for use in `AS OF SYSTEM TIME`, which will appear in an upcoming update. [#67697][#67697] -- `first_value`, `last_value`, and `nth_value` window functions can now be executed in the [vectorized execution engine](https://www.cockroachlabs.com/docs/v21.2/vectorized-execution). This allows for faster execution time, and also removes the need for conversions to and from row format. [#67764][#67764] -- Improved performance of lookup joins in some cases. If join inequality conditions can be matched to index columns, CockroachDB now includes the conditions in the index lookup spans and removes them from the runtime filters. [#66002][#66002] -- Added support for `ALTER DEFAULT PRIVILEGES` and default [privileges](https://www.cockroachlabs.com/docs/v21.2/security-reference/authorization#privileges) stored on databases. All objects created in a database will have the privilege set defined by the default privileges for that type of object on the database. The types of objects are `TABLES`, `SEQUENCES`, `SCHEMAS`, `TYPES`. Example: `ALTER DEFAULT PRIVILEGES GRANT SELECT ON TABLES TO foo` makes it such that all tables created by the user that executed the `ALTER DEFAULT PRIVILEGES` command will have [`SELECT` privilege](https://www.cockroachlabs.com/docs/v21.2/security-reference/authorization#privileges) on the table for user `foo`. Additionally, one can specify a [role](https://www.cockroachlabs.com/docs/v21.2/security-reference/authorization#roles). Example: `ALTER DEFAULT PRIVILEGES FOR ROLE bar GRANT SELECT ON TABLES TO foo`. All tables created by bar will have [`SELECT` privilege](https://www.cockroachlabs.com/docs/v21.2/security-reference/authorization#privileges) for `foo`. If a role is not specified, it uses the current user. For further context, see the [PostgreSQL documentation](https://www.postgresql.org/docs/current/sql-alterdefaultprivileges.html). Currently, default privileges are not supported on the schema. Specifying a schema like `ALTER DEFAULT PRIVILEGES IN SCHEMA s` will error. `WITH GRANT OPTION` is ignored. `GRANT OPTION FOR` is also ignored. [#66785][#66785] -- Introduced a `nearest_only` argument for `with_min_timestamp`/`with_max_staleness`, which enforces that bounded staleness reads only talk to the nearest replica. [#67837][#67837] -- [`CREATE TABLE LIKE`](https://www.cockroachlabs.com/docs/v21.2/create-table) now copies hidden columns over. [#67799][#67799] -- Populated `pg_catalog.pg_default_acl`. This is important for tracking which default [privileges](https://www.cockroachlabs.com/docs/v21.2/security-reference/authorization#privileges) are defined in the database. `pg_catalog.pg_default_acl` has 5 columns:- `oid` (`oid`): row identifier
- `defaclrole` (`oid`): `oid` of the role the default privileges are defined for
- `defaclnamespace` (`oid`): `oid` of the schema the default privileges are defined in
- `defaclobjtype` (`char`): `r` = relation (`table`, `view`), `S` = sequence, `f` = function, `T` = type, `n` = schema
- `defaclacl` (`aclitem[]`): string representation of default privileges, following the format "`$1`=`$2`/`$3`" where `$1` is the grantee's username, `$2` is a list of characters representing the privileges, and `$3` is the grantor (which is currently always an empty string in CockroachDB).
- `CREATE` = '`C`'
- `SELECT` = '`r`'
- `INSERT` = '`a`'
- `DELETE` = '`d`'
- `UPDATE` = '`w`'
- `USAGE` = '`U`'
- `CONNECT` = '`c`'
- By default, this knob is false and applications cannot customize `IntervalStyle`. Interval to string conversions that are already stored in the schema are unaffected and continue to produce results as per the default style `postgres`.
- When the knob is true, these things happen:
- Apps can start customizing `IntervalStyle` in SQL sessions.
- A SQL session that has a custom `IntervalStyle` will start observing *incoherent results* when accessing tables that already contain a conversion from interval to string.
- Settings specified in the connection URL as a query parameter
- Per-role and per-database settings configured by `ALTER ROLE`
- Per-role and all-database settings configured by `ALTER ROLE`
- All-role and per-database settings configured by `ALTER ROLE`
- All-role and all-database settings configured by `ALTER ROLE`
- By default, this knob is false and applications cannot customize `DateStyle`. Invalid conversions that are already stored in the schema are unaffected and continue to produce results as per the default style `postgres`.
- When the knob is true, these things happen:
- Apps can start customizing `DateStyle` in SQL sessions.
- A SQL session that has a custom `DateStyle` will start observing *incoherent results* when accessing tables that already contain the aforementioned casts.
- New schemas cannot have the above casts.
Operational changes
- -- [New session variable](https://www.cockroachlabs.com/docs/v21.2/set-vars#supported-variables) `large_full_scan_rows`, as well as the corresponding cluster setting `sql.defaults.large_full_scan_rows`, are now available. This setting determines which tables are considered "large" for the purposes of enabling `disallow_full_table_scans` feature to reject full table/index scans only of "large" table. The default value for the new setting is `1000`, and in order to reject all full table/index scans (the previous behavior) one can set the new setting to `0`. Internally issued queries aren't affected, and the new setting has no impact when `disallow_full_table_scans` feature is not enabled. [#69371][#69371] -- Introduced new metric called `txn.restarts.commitdeadlineexceeded` that tracks the number of transactions that were forced to restart because their commit deadline was exceeded (`COMMIT_DEADLINE_EXCEEDED`). [#69671][#69671] -- The default value of the `storage.transaction.separated_intents.enabled` [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) was changed to `true`. [#64831][#64831] -- Node-level admission control that considers the CPU resource was introduced for KV request processing, and response processing (in SQL) for KV responses. This admission control can be enabled using `admission.kv.enabled` and `admission.sql_kv_response.enabled`. [#65614][#65614] -- The new [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `bulkio.backup.merge_file_size` allows [`BACKUP`](https://www.cockroachlabs.com/docs/v21.2/backup) to buffer and merge smaller files to reduce the number of small individual files created by `BACKUP`. [#66856][#66856] -- Increased the timeout for range MVCC garbage collection from 1 minute to 10 minutes, to allow larger jobs to run to completion. [#65001][#65001] -- MVCC and intent garbage collection now triggers when the average intent age is 8 hours, down from 10 days. [#65001][#65001] -- Added a `server.authentication_cache.enabled` [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) that defaults to `true`. When enabled, this cache stores authentication-related data and will improve the latency of authentication attempts. Keeping the cache up to date adds additional overhead when using the [`CREATE`](https://www.cockroachlabs.com/docs/v21.2/create-role), [`ALTER`](https://www.cockroachlabs.com/docs/v21.2/alter-role), and [`DROP ROLE`](https://www.cockroachlabs.com/docs/v21.2/drop-role) commands. To minimize the overhead, any bulk `ROLE` operations should be run inside of a transaction. To make the cache more effective, any regularly-scheduled `ROLE` updates should be done all together, rather than occurring throughout the day at all times. [#66919][#66919] -- Introduced a new metric `exportrequest.delay.total` to track how long `ExportRequests` (issued by [`BACKUP`](https://www.cockroachlabs.com/docs/v21.2/backup)) are delayed by throttling mechansisms. [#67310][#67310] -- Enabling `admission.kv.enabled` may provide better inter-tenant isolation for multi-tenant KV nodes. [#67533][#67533] -- [`debug.zip`](https://www.cockroachlabs.com/docs/v21.2/cockroach-debug-zip) files no longer contain the file `threads.txt`, which was previously used to list RocksDB background threads. [#67389][#67389] -- DistSQL response admission control can now be enabled using the [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `admission.sql_sql_response.enabled`. [#67531][#67531] -- Added the `kv.bulk_sst.target_size` and `kv.bulk_sst.max_allowed_overage` [cluster settings](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) that control the batch size used by export requests during [`BACKUP`](https://www.cockroachlabs.com/docs/v21.2/backup). [#67705][#67705] -- [`RESTORE`](https://www.cockroachlabs.com/docs/v21.2/restore) no longer dynamically reads from the `kv.bulk_ingest.batch_size` [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) to determine its batch size. If the value is updated, [`RESTORE`](https://www.cockroachlabs.com/docs/v21.2/restore) jobs need to be `PAUSE`d and `RESUME`d to adopt the updated setting. [#68105][#68105] -- The memory pool used for SQL is now also used to cover KV memory used for scans. [#66362][#66362] -- CockroachDB now records a log event and counter increment when removing an expired session. [#68476][#68476] -- Added an automatically created, on by default, emergency ballast file. This new ballast defaults to the minimum of 1% total disk capacity or 1GiB. The size of the ballast may be configured via the `--store` flag with a `ballast-size` field, accepting the same value formats as the `size` field. Also, added a new `Disk Full (10)` exit code that indicates that the node exited because disk space on at least one store is exhausted. On node start, if any store has less than half the ballast's size bytes available, the node immediately exits with the `Disk Full (10)` exit code. The operator may manually remove the configured ballast (assuming they haven't already) to allow the node to start, and they can take action to remedy the disk space exhaustion. The ballast will automatically be recreated when available disk space is 4x the ballast size, or at least 10 GiB is available after the ballast is created. [#66893][#66893] -- Added a new [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings), `sql.mutations.max_row_size.log`, which controls large row logging. Whenever a row larger than this size is written (or a single column family if multiple column families are in use) a `LargeRow` event is logged to the [`SQL_PERF`](https://www.cockroachlabs.com/docs/v21.2/logging#sql_perf) channel (or a `LargeRowInternal` event is logged to [`SQL_INTERNAL_PERF`](https://www.cockroachlabs.com/docs/v21.2/logging#sql_internal_perf) if the row was added by an internal query). This could occur for [`INSERT`](https://www.cockroachlabs.com/docs/v21.2/insert), [`UPSERT`](https://www.cockroachlabs.com/docs/v21.2/upsert), [`UPDATE`](https://www.cockroachlabs.com/docs/v21.2/update), [`CREATE TABLE AS`](https://www.cockroachlabs.com/docs/v21.2/create-table), [`CREATE INDEX`](https://www.cockroachlabs.com/docs/v21.2/create-index), [`ALTER TABLE`](https://www.cockroachlabs.com/docs/v21.2/alter-table), [`ALTER INDEX`](https://www.cockroachlabs.com/docs/v21.2/alter-index), [`IMPORT`](https://www.cockroachlabs.com/docs/v21.2/import), or [`RESTORE`](https://www.cockroachlabs.com/docs/v21.2/restore) statements. [`SELECT`](https://www.cockroachlabs.com/docs/v21.2/select-clause), [`DELETE`](https://www.cockroachlabs.com/docs/v21.2/delete), [`TRUNCATE`](https://www.cockroachlabs.com/docs/v21.2/truncate), and [`DROP`](https://www.cockroachlabs.com/docs/v21.2/drop-table) are not affected by this setting. [#67953][#67953] -- Added a new [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings), `sql.mutations.max_row_size.err`, which limits the size of rows written to the database (or individual column families, if multiple column families are in use). Statements trying to write a row larger than this will fail with a code `54000 (program_limit_exceeded)` error. (Internal queries writing a row larger than this will not fail, but will log a `LargeRowInternal` event to the SQL_INTERNAL_PERF channel.) This limit is enforced for INSERT, UPSERT, and UPDATE statements. [`CREATE TABLE`](https://www.cockroachlabs.com/docs/v21.2/create-table) AS, CREATE INDEX, ALTER TABLE, ALTER INDEX, IMPORT, and [`RESTORE`](https://www.cockroachlabs.com/docs/v21.2/restore) will not fail with an error, but will log LargeRowInternal events to the [`SQL_INTERNAL_PERF`](https://www.cockroachlabs.com/docs/v21.2/logging#sql_internal_perf) channel. [`SELECT`](https://www.cockroachlabs.com/docs/v21.2/select-clause), [`DELETE`](https://www.cockroachlabs.com/docs/v21.2/delete), [`TRUNCATE`](https://www.cockroachlabs.com/docs/v21.2/truncate), and [`DROP`](https://www.cockroachlabs.com/docs/v21.2/drop-table) are not affected by this limit. Note that existing rows violating the limit **cannot** be updated, unless the update shrinks the size of the row below the limit, but *can* be selected, deleted, altered, backed-up, and restored. For this reason we recommend using the accompanying setting `sql.mutations.max_row_size.log` in conjunction with `SELECT pg_column_size()` queries to detect and fix any existing large rows before lowering `sql.mutations.max_row_size.err`. [#67953][#67953] -- The new [cluster settings](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `admission.l0_sub_level_count_overload_threshold` and `admission.l0_file_count_overload_threshold` can be used to tune admission control. [#69311][#69311] -- The new [cluster settings](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) `sql.defaults.transaction_rows_written_log`, `sql.defaults.transaction_rows_written_err`, `sql.defaults.transaction_rows_read_log`, and `sql.defaults.transaction_rows_read_err` (as well as the corresponding session variables) have been introduced. These settings determine the "size" of the transactions in written and read rows upon reaching of which the transactions are logged or rejected. The logging will go into the [`SQL_PERF`](https://www.cockroachlabs.com/docs/v21.2/logging#sql_perf) logging channel. Note that the internal queries (i.e., those issued by CockroachDB internally) cannot error out but can be logged instead into [`SQL_INTERNAL_PERF`](https://www.cockroachlabs.com/docs/v21.2/logging#sql_internal_perf) logging channel. The "written" limits apply to [`INSERT`](https://www.cockroachlabs.com/docs/v21.2/insert), [`INSERT INTO SELECT FROM`](https://www.cockroachlabs.com/docs/v21.2/insert), [`INSERT ON CONFLICT`](https://www.cockroachlabs.com/docs/v21.2/insert), [`UPSERT`](https://www.cockroachlabs.com/docs/v21.2/upsert), [`UPDATE`](https://www.cockroachlabs.com/docs/v21.2/update), and [`DELETE`](https://www.cockroachlabs.com/docs/v21.2/delete) whereas the "read" limits apply to [`SELECT`](https://www.cockroachlabs.com/docs/v21.2/select-clause) statement in addition to all of these. These limits will not apply to [`CREATE TABLE AS`](https://www.cockroachlabs.com/docs/v21.2/create-table), [`SELECT`](https://www.cockroachlabs.com/docs/v21.2/select-clause), [`IMPORT`](https://www.cockroachlabs.com/docs/v21.2/import), [`TRUNCATE`](https://www.cockroachlabs.com/docs/v21.2/truncate), [`DROP`](https://www.cockroachlabs.com/docs/v21.2/drop-table), [`ALTER TABLE`](https://www.cockroachlabs.com/docs/v21.2/alter-table), [`BACKUP`](https://www.cockroachlabs.com/docs/v21.2/backup), [`RESTORE`](https://www.cockroachlabs.com/docs/v21.2/restore), or [`CREATE STATISTICS`](https://www.cockroachlabs.com/docs/v21.2/create-statistics) statements. Note that enabling `transaction_rows_read_err` guardrail comes at the cost of disabling the usage of the auto commit optimization for the mutation statements in implicit transactions. [#69202][#69202] -- The `cockroach debug tsdump` command now downloads histogram timeseries it silently omitted previously. [#69469][#69469] -- New variables `sql.mutations.max_row_size.{log|err}` were renamed to `sql.guardrails.max_row_size_{log|err}` for consistency with other variables and metrics. [#69457][#69457] -- Improved range feed observability by adding a `crdb_internal.active_range_feeds` virtual table which lists all currently executing range feeds on the node. [#69055][#69055] -- Upgrading to the next version will be blocked if interleaved tables/indexes exist. Users should convert existing interleaved tables/indexes to non-interleaved ones or drop any interleaved tables/indexes before upgrading to the next version. [#68074][#68074] -- Added support for the DataDog tracer. Set the `trace.datadog.agent` [cluster setting](https://www.cockroachlabs.com/docs/v21.2/cluster-settings) to enable it if you have got the DataDog collector service running. [#61602][#61602] -- Upgraded the Lightstep tracer version, resulting in better observability for Lightstep users. [#61593][#61593] -- Added four new metrics, `sql.guardrails.max_row_size_{log|err}.count{.internal}`, which are incremented whenever a large row violates the corresponding `sql.guardrails.max_row_size_{log|err}` limit. [#69457][#69457] - -Command-line changes
- -- Added `load show` args to display subset of backup metadata. Users can display subsets of metadata of a single manifest by using `load show files/descriptors/metadata/spans
diff --git a/src/current/_includes/v21.2/misc/movr-workflow.md b/src/current/_includes/v21.2/misc/movr-workflow.md
deleted file mode 100644
index 948d95dc1de..00000000000
--- a/src/current/_includes/v21.2/misc/movr-workflow.md
+++ /dev/null
@@ -1,76 +0,0 @@
-The workflow for MovR is as follows:
-
-1. A user loads the app and sees the 25 closest vehicles.
-
- For example:
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > SELECT id, city, status FROM vehicles WHERE city='amsterdam' limit 25;
- ~~~
-
-2. The user signs up for the service.
-
- For example:
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > INSERT INTO users (id, name, address, city, credit_card)
- VALUES ('66666666-6666-4400-8000-00000000000f', 'Mariah Lam', '88194 Angela Gardens Suite 60', 'amsterdam', '123245696');
- ~~~
-
- {{site.data.alerts.callout_info}}Usually for | Variable name | -Description | -Initial value | -Modify with
- SET
- ? |
- View with
- SHOW
- ? |
-
|---|---|---|---|---|
- application_name
- |
- The current application name for statistics collection. | -Empty string, or cockroach for sessions from the built-in SQL client. |
- Yes | -Yes | -
- bytea_output
- |
- The mode for conversions from STRING to BYTES. |
- hex | -Yes | -Yes | -
- client_min_messages
- |
- The severity level of notices displayed in the SQL shell.
- Accepted values include debug5, debug4, debug3, debug2, debug1, log, notice, warning, and error. |
-
- notice
- |
- Yes | -Yes | -
- crdb_version
- |
- The version of CockroachDB. | -CockroachDB OSS version |
- No | -Yes | -
- database
- |
- The current database. | -Database in connection string, or empty if not specified. | -Yes | -Yes | -
- datestyle
- |
- {% include_cached new-in.html version="v21.2" %} The input string format for DATE and TIMESTAMP values.
- Accepted values include ISO,MDY, ISO,DMY, and ISO,YMD.
- To set datestyle to a value other than the default (ISO,MDY), you must first set the datestyle_enabled session variable to true. |
- The value set by the sql.defaults.datestyle cluster setting (ISO,MDY, by default). |
- Yes | -Yes | -
- datestyle_enabled
- |
- {% include_cached new-in.html version="v21.2" %} Enables setting the datestyle session variable to a supported format. |
- The value set by the sql.defaults.datestyle.enabled cluster setting (false, by default). |
- Yes | -Yes | -
- default_int_size
- |
- The size, in bytes, of an INT type. |
-
- 8
- |
- Yes | -Yes | -
- default_transaction_isolation
- |
- All transactions execute with SERIALIZABLE isolation. See Transactions: Isolation levels. |
-
- SERIALIZABLE
- |
- No | -Yes | -
- default_transaction_priority
- |
- The default transaction priority for the current session.
- The supported options are low, normal, and high. |
-
- normal
- |
- Yes | -Yes | -
- default_transaction_read_only
- |
- The default transaction access mode for the current session.
- If set to on, only read operations are allowed in transactions in the current session; if set to off, both read and write operations are allowed. See SET TRANSACTION for more details. |
-
- off
- |
- Yes | -Yes | -
- default_transaction_use_follower_reads
- |
- If set to on, all read-only transactions use AS OF SYSTEM TIME follower_read_timestamp(), to allow the transaction to use follower reads.If set to off, read-only transactions will only use follower reads if an AS OF SYSTEM TIME clause is specified in the statement, with an interval of at least 4.8 seconds. |
-
- off
- |
- Yes | -Yes | -
- disallow_full_table_scans
- |
- If set to on, all queries that have planned a full table or full secondary index scan will return an error message.
- This setting does not apply to internal queries, which may plan full table or index scans without checking the session variable. |
-
- off
- |
- Yes | -Yes | -
- distsql
- |
- The query distribution mode for the session.
- By default, CockroachDB determines which queries are faster to execute if distributed across multiple nodes, and all other queries are run through the gateway node. |
-
- auto
- |
- Yes | -Yes | -
- enable_drop_enum_value
- |
- Indicates whether DROP VALUE clauses are enabled for ALTER TYPE statements. |
-
- off
- |
- Yes | -Yes | -
-
- enable_implicit_select_for_update
- |
- Indicates whether UPDATE and UPSERT statements acquire locks using the FOR UPDATE locking mode during their initial row scan, which improves performance for contended workloads.
- For more information about how FOR UPDATE locking works, see the documentation for SELECT FOR UPDATE. |
-
- on
- |
- Yes | -Yes | -
- enable_insert_fast_path
- |
- Indicates whether CockroachDB will use a specialized execution operator for inserting into a table. We recommend leaving this setting on. |
-
- on
- |
- Yes | -Yes | -
- enable_zigzag_join
- |
- Indicates whether the cost-based optimizer will plan certain queries using a zig-zag merge join algorithm, which searches for the desired intersection by jumping back and forth between the indexes based on the fact that after constraining indexes, they share an ordering. | -
- on
- |
- Yes | -Yes | -
- extra_float_digits
- |
- The number of digits displayed for floating-point values.
- Only values between -15 and 3 are supported. |
-
- 0
- |
- Yes | -Yes | -
force_savepoint_restart |
- When set to true, allows the SAVEPOINT statement to accept any name for a savepoint. |
-
- off
- |
- Yes | -Yes | -
foreign_key_cascades_limit |
- Limits the number of cascading operations that run as part of a single query. | -
- 10000
- |
- Yes | -Yes | -
idle_in_session_timeout |
- Automatically terminates sessions that idle past the specified threshold. When set to 0, the session will not timeout. |
- The value set by the sql.defaults.idle_in_session_timeout cluster setting (0s, by default). |
- Yes | -Yes | -
- idle_in_transaction_session_timeout
- |
- Automatically terminates sessions that are idle in a transaction past the specified threshold. When set to 0, the session will not timeout. |
- The value set by the sql.defaults.idle_in_transaction_session_timeout cluster setting (0s, by default). |
- Yes | -Yes | -
- intervalstyle
- |
- {% include_cached new-in.html version="v21.2" %} The input string format for INTERVAL values.
- Accepted values include postgres, iso_8601, and sql_standard.
- To set intervalstyle to a value other than the default (postgres), you must first set the intervalstyle_enabled session variable to true. |
- The value set by the sql.defaults.intervalstyle cluster setting (postgres, by default). |
- Yes | -Yes | -
- intervalstyle_enabled
- |
- {% include_cached new-in.html version="v21.2" %} Enables setting the intervalstyle session variable to a supported format. |
- The value set by the sql.defaults.intervalstyle.enabled cluster setting (false, by default). |
- Yes | -Yes | -
- is_superuser
- |
- {% include_cached new-in.html version="v21.2" %} If on or true, the current user is a member of the `admin` role. |
- User-dependent | -No | -Yes | -
- large_full_scan_rows
- |
- {% include_cached new-in.html version="v21.2" %} Determines which tables are considered "large" such that disallow_full_table_scans rejects full table or index scans of "large" tables. The default value is 1000. To reject all full table or index scans, set to 0. |
- User-dependent | -No | -Yes | -
- locality
- |
- The location of the node. For more information, see Locality. |
- Node-dependent | -No | -Yes | -
- lock_timeout
- |
- {% include_cached new-in.html version="v21.2" %} The amount of time a query can spend acquiring or waiting for a single row-level lock. - In CockroachDB, unlike in PostgreSQL, non-locking reads wait for conflicting locks to be released. As a result, the lock_timeout configuration applies to writes, and to locking and non-locking reads in read-write and read-only transactions.- If lock_timeout = 0, queries do not timeout due to lock acquisitions.
- |
-
- The value set by the sql.defaults.lock_timeout cluster setting (0, by default)
- |
- Yes | -Yes | -
- node_id
- |
- The ID of the node currently connected to. - This variable is particularly useful for verifying load balanced connections. |
- Node-dependent | -No | -Yes | -
- optimizer_use_histograms
- |
- If on, the optimizer uses collected histograms for cardinality estimation. |
-
- on
- |
- No | -Yes | -
- optimizer_use_multicol_stats
- |
- If on, the optimizer uses collected multi-column statistics for cardinality estimation. |
-
- on
- |
- No | -Yes | -
- prefer_lookup_joins_for_fks
- |
- If on, the optimizer prefers lookup joins to merge joins when performing foreign key checks. |
-
- off
- |
- Yes | -Yes | -
- reorder_joins_limit
- |
- Maximum number of joins that the optimizer will attempt to reorder when searching for an optimal query execution plan.
- For more information, see Join reordering. |
-
- 8
- |
- Yes | -Yes | -
- results_buffer_size
- |
- The default size of the buffer that accumulates results for a statement or a batch of statements before they are sent to the client.
- This can also be set for all connections using the sql.defaults.results_buffer_size cluster setting. Note that auto-retries generally only happen while no results have been delivered to the client, so reducing this size can increase the number of retriable errors a client receives. On the other hand, increasing the buffer size can increase the delay until the client receives the first result row. Setting to 0 disables any buffering.
- |
- 16384
- |
- Yes | -Yes | -
- require_explicit_primary_keys
- |
- If on, CockroachDB throws on error for all tables created without an explicit primary key defined.
- |
-
- off
- |
- Yes | -Yes | -
- search_path
- |
- A list of schemas that will be searched to resolve unqualified table or function names.
- For more details, see SQL name resolution. |
-
- public
- |
- Yes | -Yes | -
- serial_normalization
- |
- Specifies the default handling of SERIAL in table definitions. Valid options include 'rowid', 'virtual_sequence', sql_sequence, and sql_sequence_cached.
- If set to 'virtual_sequence', the SERIAL type auto-creates a sequence for better compatibility with Hibernate sequences.
- If set to sql_sequence_cached, the sql.defaults.serial_sequences_cache_size cluster setting can be used to control the number of values to cache in a user's session, with a default of 256. |
-
- 'rowid'
- |
- Yes | -Yes | -
- server_version
- |
- The version of PostgreSQL that CockroachDB emulates. | -Version-dependent | -No | -Yes | -
- server_version_num
- |
- The version of PostgreSQL that CockroachDB emulates. | -Version-dependent | -Yes | -Yes | -
- session_id
- |
- The ID of the current session. | -Session-dependent | -No | -Yes | -
- session_user
- |
- The user connected for the current session. | -User in connection string | -No | -Yes | -
- sql_safe_updates
- |
- If false, potentially unsafe SQL statements are allowed, including DROP of a non-empty database and all dependent objects, DELETE without a WHERE clause, UPDATE without a WHERE clause, and ALTER TABLE .. DROP COLUMN.
- See Allow Potentially Unsafe SQL Statements for more details. |
-
- true for interactive sessions from the built-in SQL client,false for sessions from other clients |
- Yes | -Yes | -
- statement_timeout
- |
- The amount of time a statement can run before being stopped.
- This value can be an int (e.g., 10) and will be interpreted as milliseconds. It can also be an interval or string argument, where the string can be parsed as a valid interval (e.g., '4s').
- A value of 0 turns it off. |
- The value set by the sql.defaults.statement_timeout cluster setting (0s, by default). |
- Yes | -Yes | -
- stub_catalog_tables
- |
- If off, querying an unimplemented, empty pg_catalog table will result in an error, as is the case in v20.2 and earlier.
- If on, querying an unimplemented, empty pg_catalog table simply returns no rows. |
-
- on
- |
- Yes | -Yes | -
- timezone
- |
- The default time zone for the current session.
- This session variable was named "time zone" (with a space) in CockroachDB 1.x. It has been renamed for compatibility with PostgreSQL. |
-
- UTC
- |
- Yes | -Yes | -
- tracing
- |
- The trace recording state. | -
- off
- |
- - | -Yes | -
- transaction_isolation
- |
- All transactions execute with SERIALIZABLE isolation.
- See Transactions: Isolation levels. - This session variable was called transaction isolation level (with spaces) in CockroachDB 1.x. It has been renamed for compatibility with PostgreSQL. |
-
- SERIALIZABLE
- |
- No | -Yes | -
- transaction_priority
- |
- The priority of the current transaction.
- See Transactions: Transaction priorities for more details. - This session variable was called transaction priority (with a space) in CockroachDB 1.x. It has been renamed for compatibility with PostgreSQL. |
-
- NORMAL
- |
- Yes | -Yes | -
- transaction_read_only
- |
- The access mode of the current transaction.
- See Set Transaction for more details. |
-
- off
- |
- Yes | -Yes | -
- transaction_rows_read_err
- |
- {% include_cached new-in.html version="v21.2" %} The limit for the number of rows read by a SQL transaction. If this value is exceeded the transaction will fail (or the event will be logged to SQL_INTERNAL_PERF for internal transactions). |
-
- 0
- |
- Yes | -Yes | -
- transaction_rows_read_log
- |
- {% include_cached new-in.html version="v21.2" %} The threshold for the number of rows read by a SQL transaction. If this value is exceeded, the event will be logged to SQL_PERF (or SQL_INTERNAL_PERF for internal transactions). |
-
- 0
- |
- Yes | -Yes | -
- transaction_rows_written_err
- |
- {% include_cached new-in.html version="v21.2" %} The limit for the number of rows written by a SQL transaction. If this value is exceeded the transaction will fail (or the event will be logged to SQL_INTERNAL_PERF for internal transactions). |
-
- 0
- |
- Yes | -Yes | -
- transaction_rows_written_log
- |
- {% include_cached new-in.html version="v21.2" %} The threshold for the number of rows written by a SQL transaction. If this value is exceeded, the event will be logged to SQL_PERF (or SQL_INTERNAL_PERF for internal transactions). |
-
- 0
- |
- Yes | -Yes | -
- transaction_status
- |
- The state of the current transaction.
- See Transactions for more details. - This session variable was called transaction status (with a space) in CockroachDB 1.x. It has been renamed for compatibility with PostgreSQL. |
-
- NoTxn
- |
- No | -Yes | -
- vectorize
- |
- The vectorized execution engine mode.
- Options include on and off.
- For more details, see Configure vectorized execution for CockroachDB. - |
-
- on
- |
- Yes | -Yes | -
- backslash_quote
- |
- (Reserved; exposed only for ORM compatibility.) | -
- safe_encoding
- |
- No | -Yes | -
- client_encoding
- |
- (Reserved; exposed only for ORM compatibility.) | -
- UTF8
- |
- No | -Yes | -
- default_tablespace
- |
- (Reserved; exposed only for ORM compatibility.) | -
- |
- No | -Yes | -
- enable_seqscan
- |
- (Reserved; exposed only for ORM compatibility.) | -
- on
- |
- Yes | -Yes | -
- escape_string_warning
- |
- (Reserved; exposed only for ORM compatibility.) | -
- on
- |
- No | -Yes | -
- integer_datetimes
- |
- (Reserved; exposed only for ORM compatibility.) | -
- on
- |
- No | -Yes | -
- max_identifier_length
- |
- (Reserved; exposed only for ORM compatibility.) | -
- 128
- |
- No | -Yes | -
- max_index_keys
- |
- (Reserved; exposed only for ORM compatibility.) | -
- 32
- |
- No | -Yes | -
- row_security
- |
- (Reserved; exposed only for ORM compatibility.) | -
- off
- |
- No | -Yes | -
- standard_conforming_strings
- |
- (Reserved; exposed only for ORM compatibility.) | -
- on
- |
- No | -Yes | -
- server_encoding
- |
- (Reserved; exposed only for ORM compatibility.) | -
- UTF8
- |
- Yes | -Yes | -
- synchronize_seqscans
- |
- (Reserved; exposed only for ORM compatibility.) | -
- on
- |
- No | -Yes | -
- synchronous_commit
- |
- (Reserved; exposed only for ORM compatibility.) | -
- on
- |
- Yes | -Yes | -
- troubleshooting_mode_enabled
- |
- When enabled, avoid performing additional work on queries, such as collecting and emitting telemetry data. This session variable is particularly useful when the cluster is experiencing issues, unavailability, or failure. | -
- off
- |
- Yes | -Yes | -
[pq](https://github.com/lib/pq) | {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/pgx.go ||var supportedPGXTag = "||"\n\n %}
(use latest version of CockroachDB adapter)
{% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/libpq.go ||var libPQSupportedTag = "||"\n\n %} | Full
Full | [`crdbpgx`](https://pkg.go.dev/github.com/cockroachdb/cockroach-go/crdb/crdbpgx)
(includes client-side transaction retry handling)
N/A | [Build a Go App with CockroachDB (pgx)](build-a-go-app-with-cockroachdb.html)
[Build a Go App with CockroachDB (pq)](build-a-go-app-with-cockroachdb-pq.html) | -| Java | [JDBC](https://jdbc.postgresql.org/download/) | {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/pgjdbc.go ||var supportedPGJDBCTag = "||"\n\n %} | Full | N/A | [Build a Java App with CockroachDB (JDBC)](build-a-java-app-with-cockroachdb.html) | -| JavaScript | [pg](https://www.npmjs.com/package/pg) | 8.2.1 | Full | N/A | [Build a Node.js App with CockroachDB (pg)](build-a-nodejs-app-with-cockroachdb.html) | -| Python | [psycopg2](https://www.psycopg.org/docs/install.html) | 2.8.6 | Full | N/A | [Build a Python App with CockroachDB (psycopg2)](build-a-python-app-with-cockroachdb.html) | -| Ruby | [pg](https://rubygems.org/gems/pg) | {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/ruby_pg.go ||var rubyPGVersion = "||"\n\n %} | Full | N/A | [Build a Ruby App with CockroachDB (pg)](build-a-ruby-app-with-cockroachdb.html) | -| Rust | [rust-postgres](https://github.com/sfackler/rust-postgres) | 0.19.2 | Beta | N/A | [Build a Rust App with CockroachDB](build-a-rust-app-with-cockroachdb.html) | - -## Data access frameworks (e.g., ORMs) - -| Language | Framework | Latest tested version | Support level | CockroachDB adapter | Tutorial | -|----------+-----------+-----------------------+---------------+---------------------+----------| -| Go | [GORM](https://github.com/jinzhu/gorm/releases)
[go-pg](https://github.com/go-pg/pg)
[upper/db](https://github.com/upper/db) | {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/gorm.go ||var gormSupportedTag = "||"\n\n %}
{% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/gopg.go ||var gopgSupportedTag = "||"\n\n %}
v4 | Full
Full
Full | [`crdbgorm`](https://pkg.go.dev/github.com/cockroachdb/cockroach-go/crdb/crdbgorm)
(includes client-side transaction retry handling)
N/A
N/A | [Build a Go App with CockroachDB (GORM)](build-a-go-app-with-cockroachdb-gorm.html)
N/A
[Build a Go App with CockroachDB (upper/db)](build-a-go-app-with-cockroachdb-upperdb.html) | -| Java | [Hibernate](https://hibernate.org/orm/)
(including [Hibernate Spatial](https://docs.jboss.org/hibernate/orm/current/userguide/html_single/Hibernate_User_Guide.html#spatial))
[jOOQ](https://www.jooq.org/)
[MyBatis](https://mybatis.org/mybatis-3/) | {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/hibernate.go ||var supportedHibernateTag = "||"\n\n %} (must be 5.4.19)
3.13.2 (must be 3.13.0)
3.5.5| Full
Full
Full | N/A
N/A
N/A | [Build a Java App with CockroachDB (Hibernate)](build-a-java-app-with-cockroachdb-hibernate.html)
[Build a Java App with CockroachDB (jOOQ)](build-a-java-app-with-cockroachdb-jooq.html)
[Build a Spring App with CockroachDB (MyBatis)](build-a-spring-app-with-cockroachdb-mybatis.html) | -| JavaScript/TypeScript | [Sequelize](https://www.npmjs.com/package/sequelize)
[Knex.js](https://knexjs.org/)
[Prisma](https://prisma.io)
[TypeORM](https://www.npmjs.com/package/typeorm) | {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/sequelize.go ||var supportedSequelizeCockroachDBRelease = "||"\n\n %}
(use latest version of CockroachDB adapter)
{% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/knex.go ||const supportedKnexTag = "||"\n\n %}
3.9.0
0.3.17 {% comment %}{% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/master/pkg/cmd/roachtest/tests/typeorm.go ||const supportedTypeORMRelease = "||"\n %}{% endcomment %} | Full
Full
Full
Full | [`sequelize-cockroachdb`](https://www.npmjs.com/package/sequelize-cockroachdb)
N/A
N/A
N/A | [Build a Node.js App with CockroachDB (Sequelize)](build-a-nodejs-app-with-cockroachdb-sequelize.html)
[Build a Node.js App with CockroachDB (Knex.js)](build-a-nodejs-app-with-cockroachdb-knexjs.html)
[Build a Node.js App with CockroachDB (Prisma)](build-a-nodejs-app-with-cockroachdb-prisma.html)
[Build a TypeScript App with CockroachDB (TypeORM)](build-a-typescript-app-with-cockroachdb.html) | -| Ruby | [ActiveRecord](https://rubygems.org/gems/activerecord)
[RGeo/RGeo-ActiveRecord](https://github.com/cockroachdb/activerecord-cockroachdb-adapter#working-with-spatial-data) | {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/activerecord.go ||var supportedRailsVersion = "||"\nvar %}
(use latest version of CockroachDB adapter) | Full | [`activerecord-cockroachdb-adapter`](https://rubygems.org/gems/activerecord-cockroachdb-adapter)
(includes client-side transaction retry handling) | [Build a Ruby App with CockroachDB (ActiveRecord)](build-a-ruby-app-with-cockroachdb-activerecord.html) | -| Python | [Django](https://pypi.org/project/Django/)
(including [GeoDjango](https://docs.djangoproject.com/en/3.1/ref/contrib/gis/))
[peewee](https://github.com/coleifer/peewee/)
[SQLAlchemy](https://www.sqlalchemy.org/) | {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/release-21.2/pkg/cmd/roachtest/tests/django.go ||var djangoSupportedTag = "cockroach-||"\nvar %}
(use latest version of CockroachDB adapter)
3.13.3
0.7.13
1.4.17
(use latest version of CockroachDB adapter) | Full
Full
Full
Full | [`django-cockroachdb`](https://pypi.org/project/django-cockroachdb/)
N/A
N/A
[`sqlalchemy-cockroachdb`](https://pypi.org/project/sqlalchemy-cockroachdb)
(includes client-side transaction retry handling) | [Build a Python App with CockroachDB (Django)](build-a-python-app-with-cockroachdb-django.html)
N/A (See [peewee docs](http://docs.peewee-orm.com/en/latest/peewee/playhouse.html#cockroach-database).)
[Build a Python App with CockroachDB (SQLAlchemy)](build-a-python-app-with-cockroachdb-sqlalchemy.html) | - -## Application frameworks - -| Framework | Data access | Latest tested version | Support level | Tutorial | -|-----------+-------------+-----------------------+---------------+----------| -| Spring | [JDBC](build-a-spring-app-with-cockroachdb-jdbc.html)
[JPA (Hibernate)](build-a-spring-app-with-cockroachdb-jpa.html)
[MyBatis](build-a-spring-app-with-cockroachdb-mybatis.html) | See individual Java ORM or [driver](#drivers) for data access version support. | See individual Java ORM or [driver](#drivers) for data access support level. | [Build a Spring App with CockroachDB (JDBC)](build-a-spring-app-with-cockroachdb-jdbc.html)
[Build a Spring App with CockroachDB (JPA)](build-a-spring-app-with-cockroachdb-jpa.html)
[Build a Spring App with CockroachDB (MyBatis)](build-a-spring-app-with-cockroachdb-mybatis.html) - -## Graphical user interfaces (GUIs) - -| GUI | Latest tested version | Support level | Tutorial | -|-----+-----------------------+---------------+----------| -| [DBeaver](https://dbeaver.com/) | 5.2.3 | Full | [Visualize CockroachDB Schemas with DBeaver](dbeaver.html) - -## Integrated development environments (IDEs) - -| IDE | Latest tested version | Support level | Tutorial | -|-----+-----------------------+---------------+----------| -| [DataGrip](https://www.jetbrains.com/datagrip/) | 2021.1 | Full | N/A -| [IntelliJ IDEA](https://www.jetbrains.com/idea/) | 2021.1 | Full | [Use IntelliJ IDEA with CockroachDB](intellij-idea.html) - -## Schema migration tools - -| Tool | Latest tested version | Support level | Tutorial | -|-----+------------------------+----------------+----------| -| [Alembic](https://alembic.sqlalchemy.org/en/latest/) | 1.7 | Full | [Migrate CockroachDB Schemas with Alembic](alembic.html) -| [Flyway](https://flywaydb.org/documentation/commandline/#download-and-installation) | 7.1.0 | Full | [Migrate CockroachDB Schemas with Flyway](flyway.html) -| [Liquibase](https://www.liquibase.org/download) | 4.2.0 | Full | [Migrate CockroachDB Schemas with Liquibase](liquibase.html) - -## Other tools - -| Tool | Latest tested version | Support level | Tutorial | -|-----+------------------------+---------------+----------| -| [Flowable](https://github.com/flowable/flowable-engine) | 6.4.2 | Full | [Getting Started with Flowable and CockroachDB (external)](https://blog.flowable.org/2019/07/11/getting-started-with-flowable-and-cockroachdb/) diff --git a/src/current/_includes/v21.2/misc/userfile.md b/src/current/_includes/v21.2/misc/userfile.md deleted file mode 100644 index 1a23d5d2c39..00000000000 --- a/src/current/_includes/v21.2/misc/userfile.md +++ /dev/null @@ -1,3 +0,0 @@ -{{site.data.alerts.callout_info}} - CockroachDB now supports uploading files to a [user-scoped file storage](use-userfile-for-bulk-operations.html) using a SQL connection. We recommend using `userfile` instead of `nodelocal`, as it is user-scoped and more secure. -{{site.data.alerts.end}} diff --git a/src/current/_includes/v21.2/orchestration/apply-custom-resource.md b/src/current/_includes/v21.2/orchestration/apply-custom-resource.md deleted file mode 100644 index e7aacf41a1e..00000000000 --- a/src/current/_includes/v21.2/orchestration/apply-custom-resource.md +++ /dev/null @@ -1,6 +0,0 @@ -Apply the new settings to the cluster: - -{% include_cached copy-clipboard.html %} -~~~ shell -$ kubectl apply -f example.yaml -~~~ \ No newline at end of file diff --git a/src/current/_includes/v21.2/orchestration/apply-helm-values.md b/src/current/_includes/v21.2/orchestration/apply-helm-values.md deleted file mode 100644 index 90f9c8783f8..00000000000 --- a/src/current/_includes/v21.2/orchestration/apply-helm-values.md +++ /dev/null @@ -1,6 +0,0 @@ -Apply the custom values to override the default Helm chart [values](https://github.com/cockroachdb/helm-charts/blob/master/cockroachdb/values.yaml): - -{% include_cached copy-clipboard.html %} -~~~ shell -$ helm upgrade {release-name} --values {custom-values}.yaml cockroachdb/cockroachdb -~~~ \ No newline at end of file diff --git a/src/current/_includes/v21.2/orchestration/apply-statefulset-manifest.md b/src/current/_includes/v21.2/orchestration/apply-statefulset-manifest.md deleted file mode 100644 index 0236903c497..00000000000 --- a/src/current/_includes/v21.2/orchestration/apply-statefulset-manifest.md +++ /dev/null @@ -1,6 +0,0 @@ -Apply the new settings to the cluster: - -{% include_cached copy-clipboard.html %} -~~~ shell -$ kubectl apply -f {statefulset-manifest}.yaml -~~~ \ No newline at end of file diff --git a/src/current/_includes/v21.2/orchestration/kubernetes-basic-sql.md b/src/current/_includes/v21.2/orchestration/kubernetes-basic-sql.md deleted file mode 100644 index f7cfbd76641..00000000000 --- a/src/current/_includes/v21.2/orchestration/kubernetes-basic-sql.md +++ /dev/null @@ -1,44 +0,0 @@ -1. Run some basic [CockroachDB SQL statements](learn-cockroachdb-sql.html): - - {% include_cached copy-clipboard.html %} - ~~~ sql - > CREATE DATABASE bank; - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ sql - > CREATE TABLE bank.accounts (id INT PRIMARY KEY, balance DECIMAL); - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ sql - > INSERT INTO bank.accounts VALUES (1, 1000.50); - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ sql - > SELECT * FROM bank.accounts; - ~~~ - - ~~~ - id | balance - +----+---------+ - 1 | 1000.50 - (1 row) - ~~~ - -1. [Create a user with a password](create-user.html#create-a-user-with-a-password): - - {% include_cached copy-clipboard.html %} - ~~~ sql - > CREATE USER roach WITH PASSWORD 'Q7gc8rEdS'; - ~~~ - - You will need this username and password to access the DB Console later. - -1. Exit the SQL shell and pod: - - {% include_cached copy-clipboard.html %} - ~~~ sql - > \q - ~~~ \ No newline at end of file diff --git a/src/current/_includes/v21.2/orchestration/kubernetes-cockroach-cert.md b/src/current/_includes/v21.2/orchestration/kubernetes-cockroach-cert.md deleted file mode 100644 index ff44cf183a4..00000000000 --- a/src/current/_includes/v21.2/orchestration/kubernetes-cockroach-cert.md +++ /dev/null @@ -1,90 +0,0 @@ -{{site.data.alerts.callout_info}} -The below steps use [`cockroach cert` commands](cockroach-cert.html) to quickly generate and sign the CockroachDB node and client certificates. Read our [Authentication](authentication.html#using-digital-certificates-with-cockroachdb) docs to learn about other methods of signing certificates. -{{site.data.alerts.end}} - -1. Create two directories: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ mkdir certs my-safe-directory - ~~~ - - Directory | Description - ----------|------------ - `certs` | You'll generate your CA certificate and all node and client certificates and keys in this directory. - `my-safe-directory` | You'll generate your CA key in this directory and then reference the key when generating node and client certificates. - -1. Create the CA certificate and key pair: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cockroach cert create-ca \ - --certs-dir=certs \ - --ca-key=my-safe-directory/ca.key - ~~~ - -1. Create a client certificate and key pair for the root user: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cockroach cert create-client \ - root \ - --certs-dir=certs \ - --ca-key=my-safe-directory/ca.key - ~~~ - -1. Upload the client certificate and key to the Kubernetes cluster as a secret: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ kubectl create secret \ - generic cockroachdb.client.root \ - --from-file=certs - ~~~ - - ~~~ - secret/cockroachdb.client.root created - ~~~ - -1. Create the certificate and key pair for your CockroachDB nodes: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cockroach cert create-node \ - localhost 127.0.0.1 \ - cockroachdb-public \ - cockroachdb-public.default \ - cockroachdb-public.default.svc.cluster.local \ - *.cockroachdb \ - *.cockroachdb.default \ - *.cockroachdb.default.svc.cluster.local \ - --certs-dir=certs \ - --ca-key=my-safe-directory/ca.key - ~~~ - -1. Upload the node certificate and key to the Kubernetes cluster as a secret: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ kubectl create secret \ - generic cockroachdb.node \ - --from-file=certs - ~~~ - - ~~~ - secret/cockroachdb.node created - ~~~ - -1. Check that the secrets were created on the cluster: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ kubectl get secrets - ~~~ - - ~~~ - NAME TYPE DATA AGE - cockroachdb.client.root Opaque 3 41m - cockroachdb.node Opaque 5 14s - default-token-6qjdb kubernetes.io/service-account-token 3 4m - ~~~ \ No newline at end of file diff --git a/src/current/_includes/v21.2/orchestration/kubernetes-expand-disk-helm.md b/src/current/_includes/v21.2/orchestration/kubernetes-expand-disk-helm.md deleted file mode 100644 index 4ec3d2f171f..00000000000 --- a/src/current/_includes/v21.2/orchestration/kubernetes-expand-disk-helm.md +++ /dev/null @@ -1,118 +0,0 @@ -You can expand certain [types of persistent volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#types-of-persistent-volumes -) (including GCE Persistent Disk and Amazon Elastic Block Store) by editing their persistent volume claims. - -{{site.data.alerts.callout_info}} -These steps assume you followed the tutorial [Deploy CockroachDB on Kubernetes](deploy-cockroachdb-with-kubernetes.html?filters=helm). -{{site.data.alerts.end}} - -1. Get the persistent volume claims for the volumes: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ kubectl get pvc - ~~~ - - ~~~ - NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE - datadir-my-release-cockroachdb-0 Bound pvc-75dadd4c-01a1-11ea-b065-42010a8e00cb 100Gi RWO standard 17m - datadir-my-release-cockroachdb-1 Bound pvc-75e143ca-01a1-11ea-b065-42010a8e00cb 100Gi RWO standard 17m - datadir-my-release-cockroachdb-2 Bound pvc-75ef409a-01a1-11ea-b065-42010a8e00cb 100Gi RWO standard 17m - ~~~ - -1. In order to expand a persistent volume claim, `AllowVolumeExpansion` in its storage class must be `true`. Examine the storage class: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ kubectl describe storageclass standard - ~~~ - - ~~~ - Name: standard - IsDefaultClass: Yes - Annotations: storageclass.kubernetes.io/is-default-class=true - Provisioner: kubernetes.io/gce-pd - Parameters: type=pd-standard - AllowVolumeExpansion: False - MountOptions:
When using `minikube`, persistent volumes are external temporary directories that endure until they are manually deleted or until the entire Kubernetes cluster is deleted. -[persistent volume claim](http://kubernetes.io/docs/user-guide/persistent-volumes/#persistentvolumeclaims) | When pods are created (one per CockroachDB node), each pod will request a persistent volume claim to “claim” durable storage for its node. - -## Step 1. Start Kubernetes - -1. Follow Kubernetes' [documentation](https://kubernetes.io/docs/tasks/tools/install-minikube/) to install `minikube`, the tool used to run Kubernetes locally, for your OS. This includes installing a hypervisor and `kubectl`, the command-line tool used to manage Kubernetes from your local workstation. - - {{site.data.alerts.callout_info}}Make sure you install
minikube version 0.21.0 or later. Earlier versions do not include a Kubernetes server that supports the maxUnavailability field and PodDisruptionBudget resource type used in the CockroachDB StatefulSet configuration.{{site.data.alerts.end}}
-
-2. Start a local Kubernetes cluster:
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- $ minikube start
- ~~~
diff --git a/src/current/_includes/v21.2/orchestration/monitor-cluster.md b/src/current/_includes/v21.2/orchestration/monitor-cluster.md
deleted file mode 100644
index 5cadf9609a3..00000000000
--- a/src/current/_includes/v21.2/orchestration/monitor-cluster.md
+++ /dev/null
@@ -1,95 +0,0 @@
-To access the cluster's [DB Console](ui-overview.html):
-
-{% if page.secure == true %}
-
-1. On secure clusters, [certain pages of the DB Console](ui-overview.html#db-console-access) can only be accessed by `admin` users.
-
- Get a shell into the pod and start the CockroachDB [built-in SQL client](cockroach-sql.html):
-
- port-forward command must be run on the same machine as the web browser in which you want to view the DB Console. If you have been running these commands from a cloud instance or other non-local shell, you will not be able to view the UI without configuring kubectl locally and running the above port-forward command on your local machine.{{site.data.alerts.end}}
-
-{% if page.secure == true %}
-
-1. Go to https://localhost:8080 and log in with the username and password you created earlier.
-
- {% include {{ page.version.version }}/misc/chrome-localhost.md %}
-
-{% else %}
-
-1. Go to http://localhost:8080.
-
-{% endif %}
-
-1. In the UI, verify that the cluster is running as expected:
- - View the [Node List](ui-cluster-overview-page.html#node-list) to ensure that all nodes successfully joined the cluster.
- - Click the **Databases** tab on the left to verify that `bank` is listed.
diff --git a/src/current/_includes/v21.2/orchestration/operator-check-namespace.md b/src/current/_includes/v21.2/orchestration/operator-check-namespace.md
deleted file mode 100644
index d6c70aa03dc..00000000000
--- a/src/current/_includes/v21.2/orchestration/operator-check-namespace.md
+++ /dev/null
@@ -1,3 +0,0 @@
-{{site.data.alerts.callout_info}}
-All `kubectl` steps should be performed in the [namespace where you installed the Operator](deploy-cockroachdb-with-kubernetes.html#install-the-operator). By default, this is `cockroach-operator-system`.
-{{site.data.alerts.end}}
\ No newline at end of file
diff --git a/src/current/_includes/v21.2/orchestration/start-cockroachdb-helm-insecure.md b/src/current/_includes/v21.2/orchestration/start-cockroachdb-helm-insecure.md
deleted file mode 100644
index 21061db1776..00000000000
--- a/src/current/_includes/v21.2/orchestration/start-cockroachdb-helm-insecure.md
+++ /dev/null
@@ -1,115 +0,0 @@
-{{site.data.alerts.callout_danger}}
-The CockroachDB Helm chart is undergoing maintenance for compatibility with Kubernetes versions 1.17 through 1.21 (the latest version as of this writing). No new feature development is currently planned. For new production and local deployments, we currently recommend using a manual configuration (**Configs** option). If you are experiencing issues with a Helm deployment on production, contact our [Support team](https://support.cockroachlabs.com/).
-{{site.data.alerts.end}}
-
-1. [Install the Helm client](https://helm.sh/docs/intro/install) (version 3.0 or higher) and add the `cockroachdb` chart repository:
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- $ helm repo add cockroachdb https://charts.cockroachdb.com/
- ~~~
-
- ~~~
- "cockroachdb" has been added to your repositories
- ~~~
-
-2. Update your Helm chart repositories to ensure that you're using the [latest CockroachDB chart](https://github.com/cockroachdb/helm-charts/blob/master/cockroachdb/Chart.yaml):
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- $ helm repo update
- ~~~
-
-3. Modify our Helm chart's [`values.yaml`](https://github.com/cockroachdb/helm-charts/blob/master/cockroachdb/values.yaml) parameters for your deployment scenario.
-
- Create a `my-values.yaml` file to override the defaults in `values.yaml`, substituting your own values in this example based on the guidelines below.
-
- {% include_cached copy-clipboard.html %}
- ~~~
- statefulset:
- resources:
- limits:
- memory: "8Gi"
- requests:
- memory: "8Gi"
- conf:
- cache: "2Gi"
- max-sql-memory: "2Gi"
- ~~~
-
- 1. To avoid running out of memory when CockroachDB is not the only pod on a Kubernetes node, you *must* set memory limits explicitly. This is because CockroachDB does not detect the amount of memory allocated to its pod when run in Kubernetes. We recommend setting `conf.cache` and `conf.max-sql-memory` each to 1/4 of the `memory` allocation specified in `statefulset.resources.requests` and `statefulset.resources.limits`.
-
- {{site.data.alerts.callout_success}}
- For example, if you are allocating 8Gi of `memory` to each CockroachDB node, allocate 2Gi to `cache` and 2Gi to `max-sql-memory`.
- {{site.data.alerts.end}}
-
- 1. For an insecure deployment, set `tls.enabled` to `false`. For clarity, this example includes the example configuration from the previous steps.
-
- {% include_cached copy-clipboard.html %}
- ~~~
- statefulset:
- resources:
- limits:
- memory: "8Gi"
- requests:
- memory: "8Gi"
- conf:
- cache: "2Gi"
- max-sql-memory: "2Gi"
- tls:
- enabled: false
- ~~~
-
- 1. You may want to modify `storage.persistentVolume.size` and `storage.persistentVolume.storageClass` for your use case. This chart defaults to 100Gi of disk space per pod. For more details on customizing disks for performance, see [these instructions](kubernetes-performance.html#disk-type).
-
- {{site.data.alerts.callout_info}}
- If necessary, you can [expand disk size](/docs/{{ page.version.version }}/configure-cockroachdb-kubernetes.html?filters=helm#expand-disk-size) after the cluster is live.
- {{site.data.alerts.end}}
-
-1. Install the CockroachDB Helm chart.
-
- Provide a "release" name to identify and track this particular deployment of the chart, and override the default values with those in `my-values.yaml`.
-
- {{site.data.alerts.callout_info}}
- This tutorial uses `my-release` as the release name. If you use a different value, be sure to adjust the release name in subsequent commands.
- {{site.data.alerts.end}}
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- $ helm install my-release --values my-values.yaml cockroachdb/cockroachdb
- ~~~
-
- Behind the scenes, this command uses our `cockroachdb-statefulset.yaml` file to create the StatefulSet that automatically creates 3 pods, each with a CockroachDB node running inside it, where each pod has distinguishable network identity and always binds back to the same persistent storage on restart.
-
-1. Confirm that CockroachDB cluster initialization has completed successfully, with the pods for CockroachDB showing `1/1` under `READY` and the pod for initialization showing `COMPLETED` under `STATUS`:
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- $ kubectl get pods
- ~~~
-
- ~~~
- NAME READY STATUS RESTARTS AGE
- my-release-cockroachdb-0 1/1 Running 0 8m
- my-release-cockroachdb-1 1/1 Running 0 8m
- my-release-cockroachdb-2 1/1 Running 0 8m
- my-release-cockroachdb-init-hxzsc 0/1 Completed 0 1h
- ~~~
-
-1. Confirm that the persistent volumes and corresponding claims were created successfully for all three pods:
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- $ kubectl get pv
- ~~~
-
- ~~~
- NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE
- pvc-71019b3a-fc67-11e8-a606-080027ba45e5 100Gi RWO Delete Bound default/datadir-my-release-cockroachdb-0 standard 11m
- pvc-7108e172-fc67-11e8-a606-080027ba45e5 100Gi RWO Delete Bound default/datadir-my-release-cockroachdb-1 standard 11m
- pvc-710dcb66-fc67-11e8-a606-080027ba45e5 100Gi RWO Delete Bound default/datadir-my-release-cockroachdb-2 standard 11m
- ~~~
-
-{{site.data.alerts.callout_success}}
-The StatefulSet configuration sets all CockroachDB nodes to log to `stderr`, so if you ever need access to logs for a pod, use `kubectl logs 
-
-To check at a more granular level, SSH to one of the instances not running CockroachDB and run the `SHOW EXPERIMENTAL_RANGES` statement on the `vehicles` table:
-
-{% include_cached copy-clipboard.html %}
-~~~ shell
-$ cockroach sql \
-{{page.certs}} \
---host= \
---database=movr \
---execute="SELECT * FROM \
-[SHOW EXPERIMENTAL_RANGES FROM TABLE vehicles] \
-WHERE \"start_key\" IS NOT NULL \
- AND \"start_key\" NOT LIKE '%Prefix%';"
-~~~
-
-~~~
- start_key | end_key | range_id | replicas | lease_holder
-+------------------+----------------------------+----------+----------+--------------+
- /"boston" | /"boston"/PrefixEnd | 105 | {1,2,3} | 3
- /"los angeles" | /"los angeles"/PrefixEnd | 121 | {7,8,9} | 8
- /"new york" | /"new york"/PrefixEnd | 101 | {1,2,3} | 3
- /"san francisco" | /"san francisco"/PrefixEnd | 117 | {7,8,9} | 8
- /"seattle" | /"seattle"/PrefixEnd | 113 | {4,5,6} | 5
- /"washington dc" | /"washington dc"/PrefixEnd | 109 | {1,2,3} | 1
-(6 rows)
-~~~
-
-For reference, here's how the nodes map to zones:
-
-Node IDs | Zone
----------|-----
-1-3 | `us-east1-b` (South Carolina)
-4-6 | `us-west1-a` (Oregon)
-7-9 | `us-west2-a` (Los Angeles)
-
-We can see that, after partitioning, the replicas for New York, Boston, and Washington DC are located on nodes 1-3 in `us-east1-b`, replicas for Seattle are located on nodes 4-6 in `us-west1-a`, and replicas for San Francisco and Los Angeles are located on nodes 7-9 in `us-west2-a`.
diff --git a/src/current/_includes/v21.2/performance/check-rebalancing.md b/src/current/_includes/v21.2/performance/check-rebalancing.md
deleted file mode 100644
index 8694c920127..00000000000
--- a/src/current/_includes/v21.2/performance/check-rebalancing.md
+++ /dev/null
@@ -1,33 +0,0 @@
-Since you started each node with the `--locality` flag set to its GCE zone, over the next minutes, CockroachDB will rebalance data evenly across the zones.
-
-To check this, access the DB Console on any node at `
-
-For reference, here's how the nodes map to zones:
-
-Node IDs | Zone
----------|-----
-1-3 | `us-east1-b` (South Carolina)
-4-6 | `us-west1-a` (Oregon)
-7-9 | `us-west2-a` (Los Angeles)
-
-To verify even balancing at range level, SSH to one of the instances not running CockroachDB and run the `SHOW EXPERIMENTAL_RANGES` statement:
-
-{% include_cached copy-clipboard.html %}
-~~~ shell
-$ cockroach sql \
-{{page.certs}} \
---host= \
---database=movr \
---execute="SHOW EXPERIMENTAL_RANGES FROM TABLE vehicles;"
-~~~
-
-~~~
- start_key | end_key | range_id | replicas | lease_holder
-+-----------+---------+----------+----------+--------------+
- NULL | NULL | 33 | {3,4,7} | 7
-(1 row)
-~~~
-
-In this case, we can see that, for the single range containing `vehicles` data, one replica is in each zone, and the leaseholder is in the `us-west2-a` zone.
diff --git a/src/current/_includes/v21.2/performance/configure-network.md b/src/current/_includes/v21.2/performance/configure-network.md
deleted file mode 100644
index e9abeb94df3..00000000000
--- a/src/current/_includes/v21.2/performance/configure-network.md
+++ /dev/null
@@ -1,18 +0,0 @@
-CockroachDB requires TCP communication on two ports:
-
-- **26257** (`tcp:26257`) for inter-node communication (i.e., working as a cluster)
-- **8080** (`tcp:8080`) for accessing the DB Console
-
-Since GCE instances communicate on their internal IP addresses by default, you do not need to take any action to enable inter-node communication. However, to access the DB Console from your local network, you must [create a firewall rule for your project](https://cloud.google.com/vpc/docs/using-firewalls):
-
-Field | Recommended Value
-------|------------------
-Name | **cockroachweb**
-Source filter | IP ranges
-Source IP ranges | Your local network's IP ranges
-Allowed protocols | **tcp:8080**
-Target tags | `cockroachdb`
-
-{{site.data.alerts.callout_info}}
-The **tag** feature will let you easily apply the rule to your instances.
-{{site.data.alerts.end}}
diff --git a/src/current/_includes/v21.2/performance/import-movr.md b/src/current/_includes/v21.2/performance/import-movr.md
deleted file mode 100644
index c61a32f64ce..00000000000
--- a/src/current/_includes/v21.2/performance/import-movr.md
+++ /dev/null
@@ -1,160 +0,0 @@
-Now you'll import Movr data representing users, vehicles, and rides in 3 eastern US cities (New York, Boston, and Washington DC) and 3 western US cities (Los Angeles, San Francisco, and Seattle).
-
-1. Still on the fourth instance, start the [built-in SQL shell](cockroach-sql.html), pointing it at one of the CockroachDB nodes:
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- $ cockroach sql {{page.certs}} --host=
- ~~~
-
-2. Create the `movr` database and set it as the default:
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > CREATE DATABASE movr;
- ~~~
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > SET DATABASE = movr;
- ~~~
-
-3. Use the [`IMPORT`](import.html) statement to create and populate the `users`, `vehicles,` and `rides` tables:
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > IMPORT TABLE users (
- id UUID NOT NULL,
- city STRING NOT NULL,
- name STRING NULL,
- address STRING NULL,
- credit_card STRING NULL,
- CONSTRAINT "primary" PRIMARY KEY (city ASC, id ASC)
- )
- CSV DATA (
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/users/n1.0.csv'
- );
- ~~~
-
- ~~~
- job_id | status | fraction_completed | rows | index_entries | system_records | bytes
- +--------------------+-----------+--------------------+------+---------------+----------------+--------+
- 390345990764396545 | succeeded | 1 | 1998 | 0 | 0 | 241052
- (1 row)
-
- Time: 2.882582355s
- ~~~
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > IMPORT TABLE vehicles (
- id UUID NOT NULL,
- city STRING NOT NULL,
- type STRING NULL,
- owner_id UUID NULL,
- creation_time TIMESTAMP NULL,
- status STRING NULL,
- ext JSON NULL,
- mycol STRING NULL,
- CONSTRAINT "primary" PRIMARY KEY (city ASC, id ASC),
- INDEX vehicles_auto_index_fk_city_ref_users (city ASC, owner_id ASC)
- )
- CSV DATA (
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/vehicles/n1.0.csv'
- );
- ~~~
-
- ~~~
- job_id | status | fraction_completed | rows | index_entries | system_records | bytes
- +--------------------+-----------+--------------------+-------+---------------+----------------+---------+
- 390346109887250433 | succeeded | 1 | 19998 | 19998 | 0 | 3558767
- (1 row)
-
- Time: 5.803841493s
- ~~~
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > IMPORT TABLE rides (
- id UUID NOT NULL,
- city STRING NOT NULL,
- vehicle_city STRING NULL,
- rider_id UUID NULL,
- vehicle_id UUID NULL,
- start_address STRING NULL,
- end_address STRING NULL,
- start_time TIMESTAMP NULL,
- end_time TIMESTAMP NULL,
- revenue DECIMAL(10,2) NULL,
- CONSTRAINT "primary" PRIMARY KEY (city ASC, id ASC),
- INDEX rides_auto_index_fk_city_ref_users (city ASC, rider_id ASC),
- INDEX rides_auto_index_fk_vehicle_city_ref_vehicles (vehicle_city ASC, vehicle_id ASC),
- CONSTRAINT check_vehicle_city_city CHECK (vehicle_city = city)
- )
- CSV DATA (
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.0.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.1.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.2.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.3.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.4.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.5.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.6.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.7.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.8.csv',
- 'https://s3-us-west-1.amazonaws.com/cockroachdb-movr/datasets/perf-tuning/rides/n1.9.csv'
- );
- ~~~
-
- ~~~
- job_id | status | fraction_completed | rows | index_entries | system_records | bytes
- +--------------------+-----------+--------------------+--------+---------------+----------------+-----------+
- 390346325693792257 | succeeded | 1 | 999996 | 1999992 | 0 | 339741841
- (1 row)
-
- Time: 44.620371424s
- ~~~
-
- {{site.data.alerts.callout_success}}
- You can observe the progress of imports as well as all schema change operations (e.g., adding secondary indexes) on the [**Jobs** page](ui-jobs-page.html) of the DB Console.
- {{site.data.alerts.end}}
-
-7. Logically, there should be a number of [foreign key](foreign-key.html) relationships between the tables:
-
- Referencing columns | Referenced columns
- --------------------|-------------------
- `vehicles.city`, `vehicles.owner_id` | `users.city`, `users.id`
- `rides.city`, `rides.rider_id` | `users.city`, `users.id`
- `rides.vehicle_city`, `rides.vehicle_id` | `vehicles.city`, `vehicles.id`
-
- As mentioned earlier, it wasn't possible to put these relationships in place during `IMPORT`, but it was possible to create the required secondary indexes. Now, let's add the foreign key constraints:
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > ALTER TABLE vehicles
- ADD CONSTRAINT fk_city_ref_users
- FOREIGN KEY (city, owner_id)
- REFERENCES users (city, id);
- ~~~
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > ALTER TABLE rides
- ADD CONSTRAINT fk_city_ref_users
- FOREIGN KEY (city, rider_id)
- REFERENCES users (city, id);
- ~~~
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > ALTER TABLE rides
- ADD CONSTRAINT fk_vehicle_city_ref_vehicles
- FOREIGN KEY (vehicle_city, vehicle_id)
- REFERENCES vehicles (city, id);
- ~~~
-
-4. Exit the built-in SQL shell:
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- > \q
- ~~~
diff --git a/src/current/_includes/v21.2/performance/lease-preference-system-database.md b/src/current/_includes/v21.2/performance/lease-preference-system-database.md
deleted file mode 100644
index 4bfbb8b4931..00000000000
--- a/src/current/_includes/v21.2/performance/lease-preference-system-database.md
+++ /dev/null
@@ -1,8 +0,0 @@
-To reduce latency while making {% if page.name == "online-schema-changes.md" %}online schema changes{% else %}[online schema changes](online-schema-changes.html){% endif %}, we recommend specifying a `lease_preference` [zone configuration](configure-replication-zones.html) on the `system` database to a single region and running all subsequent schema changes from a node within that region. For example, if the majority of online schema changes come from machines that are geographically close to `us-east1`, run the following:
-
-{% include_cached copy-clipboard.html %}
-~~~ sql
-ALTER DATABASE system CONFIGURE ZONE USING constraints = '{"+region=us-east1": 1}', lease_preferences = '[[+region=us-east1]]';
-~~~
-
-Run all subsequent schema changes from a node in the specified region.
diff --git a/src/current/_includes/v21.2/performance/overview.md b/src/current/_includes/v21.2/performance/overview.md
deleted file mode 100644
index e3d66721de7..00000000000
--- a/src/current/_includes/v21.2/performance/overview.md
+++ /dev/null
@@ -1,38 +0,0 @@
-### Topology
-
-You'll start with a 3-node CockroachDB cluster in a single Google Compute Engine (GCE) zone, with an extra instance for running a client application workload:
-
-
-
-{{site.data.alerts.callout_info}}
-Within a single GCE zone, network latency between instances should be sub-millisecond.
-{{site.data.alerts.end}}
-
-You'll then scale the cluster to 9 nodes running across 3 GCE regions, with an extra instance in each region for a client application workload:
-
-
-
-{{site.data.alerts.callout_info}}
-Network latencies will increase with geographic distance between nodes. You can observe this in the [Network Latency page](ui-network-latency-page.html) of the DB Console.
-{{site.data.alerts.end}}
-
-To reproduce the performance demonstrated in this tutorial:
-
-- For each CockroachDB node, you'll use the [`n2-standard-4`](https://cloud.google.com/compute/docs/machine-types#standard_machine_types) machine type (4 vCPUs, 16 GB memory) with the Ubuntu 16.04 OS image and a [local SSD](https://cloud.google.com/compute/docs/disks/#localssds) disk.
-- For running the client application workload, you'll use smaller instances, such as `n2-standard-2`.
-
-### Schema
-
-Your schema and data will be based on our open-source, fictional peer-to-peer vehicle-sharing application, [MovR](movr.html).
-
-
-
-A few notes about the schema:
-
-- There are just three self-explanatory tables: In essence, `users` represents the people registered for the service, `vehicles` represents the pool of vehicles for the service, and `rides` represents when and where users have participated.
-- Each table has a composite primary key, with `city` being first in the key. Although not necessary initially in the single-region deployment, once you scale the cluster to multiple regions, these compound primary keys will enable you to [geo-partition data at the row level](partitioning.html#partition-using-primary-key) by `city`. As such, this tutorial demonstrates a schema designed for future scaling.
-- The [`IMPORT`](import.html) feature you'll use to import the data does not support foreign keys, so you'll import the data without [foreign key constraints](foreign-key.html). However, the import will create the secondary indexes required to add the foreign keys later.
-
-### Important concepts
-
-To understand the techniques in this tutorial, and to be able to apply them in your own scenarios, it's important to first understand [how reads and writes work in CockroachDB](architecture/reads-and-writes-overview.html). Review that document before getting started here.
diff --git a/src/current/_includes/v21.2/performance/partition-by-city.md b/src/current/_includes/v21.2/performance/partition-by-city.md
deleted file mode 100644
index 2634a204d33..00000000000
--- a/src/current/_includes/v21.2/performance/partition-by-city.md
+++ /dev/null
@@ -1,419 +0,0 @@
-For this service, the most effective technique for improving read and write latency is to [geo-partition](partitioning.html) the data by city. In essence, this means changing the way data is mapped to ranges. Instead of an entire table and its indexes mapping to a specific range or set of ranges, all rows in the table and its indexes with a given city will map to a range or set of ranges. Once ranges are defined in this way, we can then use the [replication zone](configure-replication-zones.html) feature to pin partitions to specific locations, ensuring that read and write requests from users in a specific city do not have to leave that region.
-
-1. Partitioning is an enterprise feature, so start off by [registering for a 30-day trial license](https://www.cockroachlabs.com/get-cockroachdb/enterprise/).
-
-2. Once you've received the trial license, SSH to any node in your cluster and [apply the license](licensing-faqs.html#set-a-license):
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- $ cockroach sql \
- {{page.certs}} \
- --host= \
- --execute="SET CLUSTER SETTING cluster.organization = 'This value must route to an IP address the node is listening on (with `--listen-addr` unspecified, the node listens on all IP addresses).
In some networking scenarios, you may need to use `--advertise-addr` and/or `--listen-addr` differently. For more details, see [Networking](recommended-production-settings.html#networking). -`--join` | Identifies the address of 3-5 of the initial nodes of the cluster. These addresses should match the addresses that the target nodes are advertising. diff --git a/src/current/_includes/v21.2/prod-deployment/aws-inbound-rules.md b/src/current/_includes/v21.2/prod-deployment/aws-inbound-rules.md deleted file mode 100644 index 8be748205a6..00000000000 --- a/src/current/_includes/v21.2/prod-deployment/aws-inbound-rules.md +++ /dev/null @@ -1,31 +0,0 @@ -#### Inter-node and load balancer-node communication - - Field | Value --------|------------------- - Port Range | **26257** - Source | The ID of your security group (e.g., *sg-07ab277a*) - -#### Application data - - Field | Value --------|------------------- - Port Range | **26257** - Source | Your application's IP ranges - -#### DB Console - - Field | Value --------|------------------- - Port Range | **8080** - Source | Your network's IP ranges - -You can set your network IP by selecting "My IP" in the Source field. - -#### Load balancer-health check communication - - Field | Value --------|------------------- - Port Range | **8080** - Source | The IP range of your VPC in CIDR notation (e.g., 10.12.0.0/16) - - To get the IP range of a VPC, open the [Amazon VPC console](https://console.aws.amazon.com/vpc/) and find the VPC listed in the section called Your VPCs. \ No newline at end of file diff --git a/src/current/_includes/v21.2/prod-deployment/backup.sh b/src/current/_includes/v21.2/prod-deployment/backup.sh deleted file mode 100644 index efcbd4c7041..00000000000 --- a/src/current/_includes/v21.2/prod-deployment/backup.sh +++ /dev/null @@ -1,21 +0,0 @@ -#!/bin/bash - -set -euo pipefail - -# This script creates full backups when run on the configured -# day of the week and incremental backups when run on other days, and tracks -# recently created backups in a file to pass as the base for incremental backups. - -what="" # Leave empty for cluster backup, or add "DATABASE database_name" to backup a database. -base="
-
-
-
-
-
-
-
-
-
-
-
-This value must route to an IP address the node is listening on (with `--listen-addr` unspecified, the node listens on all IP addresses).
In some networking scenarios, you may need to use `--advertise-addr` and/or `--listen-addr` differently. For more details, see [Networking](recommended-production-settings.html#networking). - `--join` | Identifies the address of 3-5 of the initial nodes of the cluster. These addresses should match the addresses that the target nodes are advertising. - `--cache`
`--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size](recommended-production-settings.html#cache-and-sql-memory-size). - `--background` | Starts the node in the background so you gain control of the terminal to issue more commands. - - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain enterprise features. For more details, see [Locality](cockroach-start.html#locality). - - For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=localhost:8080`. To set these options manually, see [Start a Node](cockroach-start.html). - -6. Repeat these steps for each additional node that you want in your cluster. - -
-
-
-
-
-
-
-
-
-
-
-
-This value must route to an IP address the node is listening on (with `--listen-addr` unspecified, the node listens on all IP addresses).
In some networking scenarios, you may need to use `--advertise-addr` and/or `--listen-addr` differently. For more details, see [Networking](recommended-production-settings.html#networking). - `--join` | Identifies the address of 3-5 of the initial nodes of the cluster. These addresses should match the addresses that the target nodes are advertising. - `--cache`
`--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size](recommended-production-settings.html#cache-and-sql-memory-size). - `--background` | Starts the node in the background so you gain control of the terminal to issue more commands. - - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features](enterprise-licensing.html). For more details, see [Locality](cockroach-start.html#locality). - - For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-EXPLAIN",
- "urls": [
- "/${VERSION}/sql-tuning-with-explain.html"
- ]
- },
- {
- "title": "Apply SQL Statement Performance Rules",
- "urls": [
- "/${VERSION}/apply-statement-performance-rules.html"
- ]
- },
- {
- "title": "SQL Performance Best Practices",
- "urls": [
- "/${VERSION}/performance-best-practices-overview.html"
- ]
- },
- {
- "title": "Performance Tuning Recipes",
- "urls": [
- "/${VERSION}/performance-recipes.html"
- ]
- },
- {
- "title": "Performance Features",
- "items":
- [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/performance-features-overview.html"
- ]
- },
- {
- "title": "Indexes",
- "urls": [
- "/${VERSION}/indexes.html"
- ]
- },
- {
- "title": "Cost-Based Optimizer",
- "urls": [
- "/${VERSION}/cost-based-optimizer.html"
- ]
- },
- {
- "title": "Vectorized Execution Engine",
- "urls": [
- "/${VERSION}/vectorized-execution.html"
- ]
- },
- {
- "title": "Load-Based Splitting",
- "urls": [
- "/${VERSION}/load-based-splitting.html"
- ]
- }
- ]
- }
- ]
- },
- {
- "title": "Example Applications",
- "items": [
- {
- "title": "Overview of Example Applications",
- "urls": [
- "/${VERSION}/example-apps.html"
- ]
- },
- {
- "title": "Build the Roach Data Application using Spring Boot",
- "items": [
- {
- "title": "Spring Boot with JDBC",
- "urls": [
- "/${VERSION}/build-a-spring-app-with-cockroachdb-jdbc.html"
- ]
- },
- {
- "title": "Spring Boot with JPA",
- "urls": [
- "/${VERSION}/build-a-spring-app-with-cockroachdb-jpa.html"
- ]
- }
- ]
- },
- {
- "title": "The MovR Example Application",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/movr.html"
- ]
- },
- {
- "title": "Global Application",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/movr-flask-overview.html"
- ]
- },
- {
- "title": "Global Application Use Case",
- "urls": [
- "/${VERSION}/movr-flask-use-case.html"
- ]
- },
- {
- "title": "Multi-region Database Schema",
- "urls": [
- "/${VERSION}/movr-flask-database.html"
- ]
- },
- {
- "title": "Set up a Development Environment",
- "urls": [
- "/${VERSION}/movr-flask-setup.html"
- ]
- },
- {
- "title": "Develop a Global Application",
- "urls": [
- "/${VERSION}/movr-flask-application.html"
- ]
- },
- {
- "title": "Deploy a Global Application",
- "urls": [
- "/${VERSION}/movr-flask-deployment.html"
- ]
- }
- ]
- }
- ]
- },
- {
- "title": "Deploy a Python To-Do App with Flask, Kubernetes, and CockroachDB Cloud",
- "urls": [
- "/cockroachcloud/deploy-a-python-to-do-app-with-flask-kubernetes-and-cockroachcloud.html"
- ]
- }
- ]
- },
- {
- "title": "Tutorials",
- "items": [
- {
- "title": "Schema Migration Tools",
- "items": [
- {
- "title": "Alembic",
- "urls": [
- "/${VERSION}/alembic.html"
- ]
- },
- {
- "title": "Flyway",
- "urls": [
- "/${VERSION}/flyway.html"
- ]
- },
- {
- "title": "Liquibase",
- "urls": [
- "/${VERSION}/liquibase.html"
- ]
- }
- ]
- },
- {
- "title": "GUIs & IDEs",
- "items": [
- {
- "title": "DBeaver GUI",
- "urls": [
- "/${VERSION}/dbeaver.html"
- ]
- },
- {
- "title": "IntelliJ IDEA",
- "urls": [
- "/${VERSION}/intellij-idea.html"
- ]
- }
- ]
- }
- ]
- }
- ]
-}
diff --git a/src/current/_includes/v21.2/sidebar-data/get-started.json b/src/current/_includes/v21.2/sidebar-data/get-started.json
deleted file mode 100644
index 2d622e9e005..00000000000
--- a/src/current/_includes/v21.2/sidebar-data/get-started.json
+++ /dev/null
@@ -1,167 +0,0 @@
-{
- "title": "Get Started",
- "is_top_level": true,
- "items": [{
- "title": "Quickstart",
- "urls": [
- "/cockroachcloud/quickstart.html"
- ]
- },
- {
- "title": "Learn CockroachDB SQL",
- "urls": [
- "/cockroachcloud/learn-cockroachdb-sql.html",
- "/${VERSION}/learn-cockroachdb-sql.html"
- ]
- },
- {
- "title": "Build a Sample Application",
- "items": [
- {
- "title": "JavaScript/TypeScript",
- "urls": [
- "/${VERSION}/build-a-nodejs-app-with-cockroachdb.html",
- "/${VERSION}/build-a-nodejs-app-with-cockroachdb-sequelize.html",
- "/${VERSION}/build-a-nodejs-app-with-cockroachdb-knexjs.html",
- "/${VERSION}/build-a-nodejs-app-with-cockroachdb-prisma.html",
- "/${VERSION}/build-a-typescript-app-with-cockroachdb.html"
- ]
- },
- {
- "title": "Python",
- "urls": [
- "/${VERSION}/build-a-python-app-with-cockroachdb-psycopg3.html",
- "/${VERSION}/build-a-python-app-with-cockroachdb.html",
- "/${VERSION}/build-a-python-app-with-cockroachdb-sqlalchemy.html",
- "/${VERSION}/build-a-python-app-with-cockroachdb-django.html"
- ]
- },
- {
- "title": "Go",
- "urls": [
- "/${VERSION}/build-a-go-app-with-cockroachdb.html",
- "/${VERSION}/build-a-go-app-with-cockroachdb-gorm.html",
- "/${VERSION}/build-a-go-app-with-cockroachdb-pq.html",
- "/${VERSION}/build-a-go-app-with-cockroachdb-upperdb.html"
- ]
- },
- {
- "title": "Java",
- "urls": [
- "/${VERSION}/build-a-java-app-with-cockroachdb.html",
- "/${VERSION}/build-a-java-app-with-cockroachdb-hibernate.html",
- "/${VERSION}/build-a-java-app-with-cockroachdb-jooq.html",
- "/${VERSION}/build-a-spring-app-with-cockroachdb-mybatis.html"
- ]
- },
- {
- "title": "Ruby",
- "urls": [
- "/${VERSION}/build-a-ruby-app-with-cockroachdb.html",
- "/${VERSION}/build-a-ruby-app-with-cockroachdb-activerecord.html"
- ]
- },
- {
- "title": "C# (.NET)",
- "urls": [
- "/${VERSION}/build-a-csharp-app-with-cockroachdb.html"
- ]
- },
- {
- "title": "Rust",
- "urls": [
- "/${VERSION}/build-a-rust-app-with-cockroachdb.html"
- ]
- }
- ]
- },
- {
- "title": "Build a Serverless Application",
- "items": [
- {
- "title": "AWS Lambda",
- "urls": [
- "/${VERSION}/deploy-lambda-function.html"
- ]
- },
- {
- "title": "Google Cloud Run",
- "urls": [
- "/${VERSION}/deploy-app-gcr.html"
- ]
- },
- {
- "title": "Netlify",
- "urls": [
- "/${VERSION}/deploy-app-netlify.html"
- ]
- },
- {
- "title": "Vercel",
- "urls": [
- "/${VERSION}/deploy-app-vercel.html"
- ]
- },
- {
- "title": "Serverless Function Best Practices",
- "urls": [
- "/${VERSION}/serverless-function-best-practices.html"
- ]
- }
- ]
- },
- {
- "title": "Glossary",
- "urls": [
- "/${VERSION}/architecture/glossary.html"
- ]
- },
- {
- "title": "FAQs",
- "items": [
- {
- "title": "CockroachDB FAQs",
- "urls": [
- "/${VERSION}/frequently-asked-questions.html"
- ]
- },
- {
- "title": "SQL FAQs",
- "urls": [
- "/${VERSION}/sql-faqs.html"
- ]
- },
- {
- "title": "Operational FAQs",
- "urls": [
- "/${VERSION}/operational-faqs.html"
- ]
- },
- {
- "title": "Availability FAQs",
- "urls": [
- "/${VERSION}/multi-active-availability.html"
- ]
- },
- {
- "title": "Licensing FAQs",
- "urls": [
- "/${VERSION}/licensing-faqs.html"
- ]
- },
- {
- "title": "Enterprise Features",
- "urls": [
- "/${VERSION}/enterprise-licensing.html"
- ]
- },
- {
- "title": "CockroachDB in Comparison",
- "urls": [
- "/${VERSION}/cockroachdb-in-comparison.html"
- ]
- }
- ]
- }
- ]
-}
diff --git a/src/current/_includes/v21.2/sidebar-data/manage.json b/src/current/_includes/v21.2/sidebar-data/manage.json
deleted file mode 100644
index b2a79705747..00000000000
--- a/src/current/_includes/v21.2/sidebar-data/manage.json
+++ /dev/null
@@ -1,532 +0,0 @@
-{
- "title": "Manage",
- "is_top_level": true,
- "items": [
- {
- "title": "Manage CockroachDB Cloud Clusters",
- "items": [
- {
- "title": "Plan Your Cluster",
- "urls": [
- "/cockroachcloud/plan-your-cluster.html"
- ]
- },
- {
- "title": "Manage a CockroachDB Serverless (Basic) Cluster",
- "urls": [
- "/cockroachcloud/basic-cluster-management.html"
- ]
- },
- {
- "title": "Manage a CockroachDB Dedicated Cluster",
- "urls": [
- "/cockroachcloud/cluster-management.html"
- ]
- },
- {
- "title": "Manage Billing",
- "urls": [
- "/cockroachcloud/billing-management.html"
- ]
- },
- {
- "title": "Use the Cloud API",
- "urls": [
- "/cockroachcloud/cloud-api.html"
- ]
- },
- {
- "title": "Use the ccloud command",
- "urls": [
- "/cockroachcloud/ccloud-get-started.html"
- ]
- }
- ]
- },
- {
- "title": "Operate CockroachDB on Kubernetes",
- "items": [
- {
- "title": "Pod Scheduling",
- "urls": [
- "/${VERSION}/schedule-cockroachdb-kubernetes.html"
- ]
- },
- {
- "title": "Resource Management",
- "urls": [
- "/${VERSION}/configure-cockroachdb-kubernetes.html"
- ]
- },
- {
- "title": "Certificate Management",
- "urls": [
- "/${VERSION}/secure-cockroachdb-kubernetes.html"
- ]
- },
- {
- "title": "Cluster Scaling",
- "urls": [
- "/${VERSION}/scale-cockroachdb-kubernetes.html"
- ]
- },
- {
- "title": "Cluster Monitoring",
- "urls": [
- "/${VERSION}/monitor-cockroachdb-kubernetes.html"
- ]
- },
- {
- "title": "Cluster Upgrades",
- "urls": [
- "/${VERSION}/upgrade-cockroachdb-kubernetes.html"
- ]
- },
- {
- "title": "Optimizing Performance",
- "urls": [
- "/${VERSION}/kubernetes-performance.html"
- ]
- }
- ]
- },
- {
- "title": "Back Up and Restore Data",
- "items": [
- {
- "title": "Back Up and Restore CockroachDB Cloud Clusters",
- "items": [
- {
- "title": "Take and Restore Customer-Owned Backups",
- "urls": [
- "/cockroachcloud/take-and-restore-self-managed-backups.html"
- ]
- },
- {
- "title": "Use Managed-Service Backups",
- "urls": [
- "/cockroachcloud/managed-backups.html"
- ]
- }
- ]
- },
- {
- "title": "Back Up and Restore CockroachDB Self-Hosted Clusters",
- "items": [
- {
- "title": "Full and Incremental Backups",
- "urls": [
- "/${VERSION}/take-full-and-incremental-backups.html"
- ]
- },
- {
- "title": "Backups with Revision History and Point-in-time Restore",
- "urls": [
- "/${VERSION}/take-backups-with-revision-history-and-restore-from-a-point-in-time.html"
- ]
- },
- {
- "title": "Encrypted Backup and Restore",
- "urls": [
- "/${VERSION}/take-and-restore-encrypted-backups.html"
- ]
- },
- {
- "title": "Locality-aware Backup and Restore",
- "urls": [
- "/${VERSION}/take-and-restore-locality-aware-backups.html"
- ]
- },
- {
- "title": "Scheduled Backups",
- "urls": [
- "/${VERSION}/manage-a-backup-schedule.html"
- ]
- }
- ]
- },
- {
- "title": "Restoring Backups Across Versions",
- "urls": [
- "/${VERSION}/restoring-backups-across-versions.html"
- ]
- }
- ]
- },
- {
- "title": "File Storage for Bulk Operations",
- "items": [
- {
- "title": "Cloud Storage",
- "urls": [
- "/${VERSION}/use-cloud-storage-for-bulk-operations.html"
- ]
- },
- {
- "title": "Userfile Storage",
- "urls": [
- "/${VERSION}/use-userfile-for-bulk-operations.html"
- ]
- },
- {
- "title": "Local File Server",
- "urls": [
- "/${VERSION}/use-a-local-file-server-for-bulk-operations.html"
- ]
- }
- ]
- },
- {
- "title": "Security",
- "items": [
- {
- "title": "Secure CockroachDB Cloud Clusters",
- "items": [
- {
- "title": "Authentication",
- "items": [
- {
- "title": "Authentication Overview",
- "urls": [
- "/cockroachcloud/authentication.html"
- ]
- },
- {
- "title": "Single Sign-On (SSO)",
- "urls": [
- "/cockroachcloud/cloud-org-sso.html"
- ]
- },
- {
- "title": "Configure Cloud Organization SSO",
- "urls": [
- "/cockroachcloud/configure-cloud-org-sso.html"
- ]
- }
- ]
- },
- {
- "title": "Configure SQL Authentication for Hardened Serverless Cluster Security",
- "urls": [
- "/${VERSION}/security-reference/config-secure-hba.html"
- ]
- },
- {
- "title": "Network Authorization",
- "urls": [
- "/cockroachcloud/network-authorization.html"
- ]
- },
- {
- "title": "SQL Audit Logging",
- "urls": [
- "/cockroachcloud/sql-audit-logging.html"
- ]
- },
- {
- "title": "Managing Access in CockroachDB Cloud",
- "urls": [
- "/cockroachcloud/managing-access.html"
- ]
- }
- ]
- },
- {
- "title": "Secure CockroachDB Self-Hosted Clusters",
- "items": [
- {
- "title": "Authentication",
- "urls": [
- "/${VERSION}/authentication.html"
- ]
- },
- {
- "title": "Encryption",
- "urls": [
- "/${VERSION}/encryption.html"
- ]
- },
- {
- "title": "Authorization",
- "urls": [
- "/${VERSION}/authorization.html"
- ]
- },
- {
- "title": "SQL Audit Logging",
- "urls": [
- "/${VERSION}/sql-audit-logging.html"
- ]
- },
- {
- "title": "GSSAPI Authentication",
- "urls": [
- "/${VERSION}/gssapi_authentication.html"
- ]
- },
- {
- "title": "Single Sign-on",
- "urls": [
- "/${VERSION}/sso.html"
- ]
- },
- {
- "title": "Rotate Security Certificates",
- "urls": [
- "/${VERSION}/rotate-certificates.html"
- ]
- }
- ]
- }
- ]
- },
- {
- "title": "Monitoring and Alerting",
- "items": [
- {
- "title": "Monitor a CockroachDB Cloud Cluster",
- "items": [
- {
- "title": "Cluster Overview Page",
- "urls": [
- "/cockroachcloud/cluster-overview-page.html"
- ]
- },
- {
- "title": "Alerts Page",
- "urls": [
- "/cockroachcloud/alerts-page.html"
- ]
- },
- {
- "title": "Tools Page",
- "urls": [
- "/cockroachcloud/tools-page.html"
- ]
- },
- {
- "title": "Statements Page",
- "urls": [
- "/cockroachcloud/statements-page.html"
- ]
- },
- {
- "title": "Sessions Page",
- "urls": [
- "/cockroachcloud/sessions-page.html"
- ]
- },
- {
- "title": "Transactions Page",
- "urls": [
- "/cockroachcloud/transactions-page.html"
- ]
- }
- ]
- },
- {
- "title": "Monitor a CockroachDB Self-Hosted Cluster",
- "items": [
- {
- "title": "Monitoring Clusters Overview",
- "urls": [
- "/${VERSION}/monitoring-and-alerting.html"
- ]
- },
- {
- "title": "Common Issues to Monitor",
- "urls": [
- "/${VERSION}/common-issues-to-monitor.html"
- ]
- },
- {
- "title": "Enable the Node Map",
- "urls": [
- "/${VERSION}/enable-node-map.html"
- ]
- },
- {
- "title": "Use Prometheus and Alertmanager",
- "urls": [
- "/${VERSION}/monitor-cockroachdb-with-prometheus.html"
- ]
- },
- {
- "title": "Cluster API",
- "urls": [
- "/${VERSION}/cluster-api.html"
- ]
- }
- ]
- },
- {
- "title": "Third-Party Monitoring Integrations",
- "items": [
- {
- "title": "Third-Party Monitoring Integration Overview",
- "urls": [
- "/${VERSION}/third-party-monitoring-tools.html"
- ]
- },
- {
- "title": "Monitor CockroachDB {{ site.data.products.core }} with Datadog",
- "urls": [
- "/${VERSION}/datadog.html"
- ]
- },
- {
- "title": "Monitor with DBmarlin",
- "urls": [
- "/${VERSION}/dbmarlin.html"
- ]
- },
- {
- "title": "Monitor with Kibana",
- "urls": [
- "/${VERSION}/kibana.html"
- ]
- }
- ]
- }
- ]
- },
- {
- "title": "Logging",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/logging-overview.html"
- ]
- },
- {
- "title": "Configure Logs",
- "urls": [
- "/${VERSION}/configure-logs.html"
- ]
- },
- {
- "title": "Logging Use Cases",
- "urls": [
- "/${VERSION}/logging-use-cases.html"
- ]
- }
- ]
- },
- {
- "title": "Cluster Maintenance",
- "items": [
- {
- "title": "Upgrade a Cluster",
- "items": [
- {
- "title": "Uprade a CockroachDB Cloud Cluster",
- "items": [
- {
- "title": "Upgrade Policy",
- "urls": [
- "/cockroachcloud/upgrade-policy.html"
- ]
- },
- {
- "title": "Upgrade a cluster",
- "urls": [
- "/cockroachcloud/upgrade-cockroach-version.html"
- ]
- }
- ]
- },
- {
- "title": "Upgrade a CockroachDB Self-Hosted Cluster",
- "items": [
- {
- "title": "Upgrade to CockroachDB v21.2",
- "urls": [
- "/${VERSION}/upgrade-cockroach-version.html"
- ]
- }
- ]
- }
- ]
- },
- {
- "title": "Manage Long-Running Queries",
- "urls": [
- "/${VERSION}/manage-long-running-queries.html"
- ]
- },
- {
- "title": "Node Shutdown",
- "urls": [
- "/${VERSION}/node-shutdown.html"
- ]
- },
- {
- "title": "Disaster Recovery",
- "urls": [
- "/${VERSION}/disaster-recovery.html"
- ]
- }
- ]
- },
- {
- "title": "Replication Controls",
- "urls": [
- "/${VERSION}/configure-replication-zones.html"
- ]
- },
- {
- "title": "Troubleshooting",
- "items": [
- {
- "title": "Troubleshooting Overview",
- "urls": [
- "/${VERSION}/troubleshooting-overview.html"
- ]
- },
- {
- "title": "Common Errors and Solutions",
- "urls": [
- "/${VERSION}/common-errors.html"
- ]
- },
- {
- "title": "Troubleshoot Cluster Setup",
- "urls": [
- "/${VERSION}/cluster-setup-troubleshooting.html"
- ]
- },
- {
- "title": "Troubleshoot Statement Behavior",
- "urls": [
- "/${VERSION}/query-behavior-troubleshooting.html"
- ]
- },
- {
- "title": "Troubleshoot CockroachDB Cloud",
- "urls": [
- "/cockroachcloud/troubleshooting-page.html"
- ]
- },
- {
- "title": "Replication Reports",
- "urls": [
- "/${VERSION}/query-replication-reports.html"
- ]
- },
- {
- "title": "Support Resources",
- "urls": [
- "/${VERSION}/support-resources.html"
- ]
- },
- {
- "title": "File an Issue",
- "urls": [
- "/${VERSION}/file-an-issue.html"
- ]
- }
- ]
- }
- ]
-}
diff --git a/src/current/_includes/v21.2/sidebar-data/migrate.json b/src/current/_includes/v21.2/sidebar-data/migrate.json
deleted file mode 100644
index 7332c7ba312..00000000000
--- a/src/current/_includes/v21.2/sidebar-data/migrate.json
+++ /dev/null
@@ -1,77 +0,0 @@
-{
- "title": "Migrate",
- "is_top_level": true,
- "items": [
- {
- "title": "Migration Overview",
- "urls": [
- "/${VERSION}/migration-overview.html"
- ]
- },
- {
- "title": "Use the Schema Conversion Tool",
- "urls": [
- "/cockroachcloud/migrations-page.html"
- ]
- },
- {
- "title": "Migrate Data to CockroachDB",
- "items": [
- {
- "title": "Migrate data using AWS DMS",
- "urls": [
- "/${VERSION}/aws-dms.html"
- ]
- },
- {
- "title": "Migrate from CSV",
- "urls": [
- "/${VERSION}/migrate-from-csv.html"
- ]
- },
- {
- "title": "Migrate from Avro",
- "urls": [
- "/${VERSION}/migrate-from-avro.html"
- ]
- },
- {
- "title": "Migrate from Shapefiles",
- "urls": [
- "/${VERSION}/migrate-from-shapefiles.html"
- ]
- },
- {
- "title": "Migrate from OpenStreetMap",
- "urls": [
- "/${VERSION}/migrate-from-openstreetmap.html"
- ]
- },
- {
- "title": "Migrate from GeoJSON",
- "urls": [
- "/${VERSION}/migrate-from-geojson.html"
- ]
- },
- {
- "title": "Migrate from GeoPackage",
- "urls": [
- "/${VERSION}/migrate-from-geopackage.html"
- ]
- },
- {
- "title": "Import Performance Best Practices",
- "urls": [
- "/${VERSION}/import-performance-best-practices.html"
- ]
- }
- ]
- },
- {
- "title": "Export Spatial Data",
- "urls": [
- "/${VERSION}/export-spatial-data.html"
- ]
- }
- ]
-}
diff --git a/src/current/_includes/v21.2/sidebar-data/reference.json b/src/current/_includes/v21.2/sidebar-data/reference.json
deleted file mode 100644
index 9de10775d12..00000000000
--- a/src/current/_includes/v21.2/sidebar-data/reference.json
+++ /dev/null
@@ -1,1758 +0,0 @@
-{
- "title": "Reference",
- "is_top_level": true,
- "items": [
- {
- "title": "Architecture",
- "items": [
- {
- "title": "Architecture Overview",
- "urls": [
- "/${VERSION}/architecture/overview.html"
- ]
- },
- {
- "title": "SQL Layer",
- "urls": [
- "/${VERSION}/architecture/sql-layer.html"
- ]
- },
- {
- "title": "Transaction Layer",
- "urls": [
- "/${VERSION}/architecture/transaction-layer.html"
- ]
- },
- {
- "title": "Distribution Layer",
- "urls": [
- "/${VERSION}/architecture/distribution-layer.html"
- ]
- },
- {
- "title": "Replication Layer",
- "urls": [
- "/${VERSION}/architecture/replication-layer.html"
- ]
- },
- {
- "title": "Storage Layer",
- "urls": [
- "/${VERSION}/architecture/storage-layer.html"
- ]
- },
- {
- "title": "Life of a Distributed Transaction",
- "urls": [
- "/${VERSION}/architecture/life-of-a-distributed-transaction.html"
- ]
- },
- {
- "title": "Reads and Writes Overview",
- "urls": [
- "/${VERSION}/architecture/reads-and-writes-overview.html"
- ]
- },
- {
- "title": "Admission Control",
- "urls": [
- "/${VERSION}/architecture/admission-control.html"
- ]
- }
- ]
- },
- {
- "title": "SQL",
- "items": [
- {
- "title": "SQL Overview",
- "urls": [
- "/${VERSION}/sql-feature-support.html"
- ]
- },
- {
- "title": "PostgreSQL Compatibility",
- "urls": [
- "/${VERSION}/postgresql-compatibility.html"
- ]
- },
- {
- "title": "SQL Syntax",
- "items": [
- {
- "title": "Full SQL Grammar",
- "urls": [
- "/${VERSION}/sql-grammar.html"
- ]
- },
- {
- "title": "Keywords & Identifiers",
- "urls": [
- "/${VERSION}/keywords-and-identifiers.html"
- ]
- },
- {
- "title": "Constants",
- "urls": [
- "/${VERSION}/sql-constants.html"
- ]
- },
- {
- "title": "Selection Queries",
- "urls": [
- "/${VERSION}/selection-queries.html"
- ]
- },
- {
- "title": "Table Expressions",
- "urls": [
- "/${VERSION}/table-expressions.html"
- ]
- },
- {
- "title": "Common Table Expressions",
- "urls": [
- "/${VERSION}/common-table-expressions.html"
- ]
- },
- {
- "title": "Scalar Expressions",
- "urls": [
- "/${VERSION}/scalar-expressions.html"
- ]
- },
- {
- "title": "NULL Handling",
- "urls": [
- "/${VERSION}/null-handling.html"
- ]
- }
- ]
- },
- {
- "title": "SQL Statements",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/sql-statements.html"
- ]
- },
- {
- "title": "ADD COLUMN",
- "urls": [
- "/${VERSION}/add-column.html"
- ]
- },
- {
- "title": "ADD CONSTRAINT",
- "urls": [
- "/${VERSION}/add-constraint.html"
- ]
- },
- {
- "title": "ADD REGION (Enterprise)",
- "urls": [
- "/${VERSION}/add-region.html"
- ]
- },
- {
- "title": "ALTER COLUMN",
- "urls": [
- "/${VERSION}/alter-column.html"
- ]
- },
- {
- "title": "ALTER DATABASE",
- "urls": [
- "/${VERSION}/alter-database.html"
- ]
- },
- {
- "title": "ALTER DEFAULT PRIVILEGES",
- "urls": [
- "/${VERSION}/alter-default-privileges.html"
- ]
- },
- {
- "title": "ALTER INDEX",
- "urls": [
- "/${VERSION}/alter-index.html"
- ]
- },
- {
- "title": "ALTER PARTITION (Enterprise)",
- "urls": [
- "/${VERSION}/alter-partition.html"
- ]
- },
- {
- "title": "ALTER PRIMARY KEY",
- "urls": [
- "/${VERSION}/alter-primary-key.html"
- ]
- },
- {
- "title": "ALTER RANGE",
- "urls": [
- "/${VERSION}/alter-range.html"
- ]
- },
- {
- "title": "ALTER ROLE",
- "urls": [
- "/${VERSION}/alter-role.html"
- ]
- },
- {
- "title": "ALTER SCHEMA",
- "urls": [
- "/${VERSION}/alter-schema.html"
- ]
- },
- {
- "title": "ALTER SEQUENCE",
- "urls": [
- "/${VERSION}/alter-sequence.html"
- ]
- },
- {
- "title": "ALTER TABLE",
- "urls": [
- "/${VERSION}/alter-table.html"
- ]
- },
- {
- "title": "ALTER TYPE",
- "urls": [
- "/${VERSION}/alter-type.html"
- ]
- },
- {
- "title": "ALTER USER",
- "urls": [
- "/${VERSION}/alter-user.html"
- ]
- },
- {
- "title": "ALTER VIEW",
- "urls": [
- "/${VERSION}/alter-view.html"
- ]
- },
- {
- "title": "EXPERIMENTAL_AUDIT",
- "urls": [
- "/${VERSION}/experimental-audit.html"
- ]
- },
- {
- "title": "BACKUP",
- "urls": [
- "/${VERSION}/backup.html"
- ]
- },
- {
- "title": "BEGIN",
- "urls": [
- "/${VERSION}/begin-transaction.html"
- ]
- },
- {
- "title": "CANCEL JOB",
- "urls": [
- "/${VERSION}/cancel-job.html"
- ]
- },
- {
- "title": "CANCEL QUERY",
- "urls": [
- "/${VERSION}/cancel-query.html"
- ]
- },
- {
- "title": "CANCEL SESSION",
- "urls": [
- "/${VERSION}/cancel-session.html"
- ]
- },
- {
- "title": "COMMENT ON",
- "urls": [
- "/${VERSION}/comment-on.html"
- ]
- },
- {
- "title": "COMMIT",
- "urls": [
- "/${VERSION}/commit-transaction.html"
- ]
- },
- {
- "title": "CONFIGURE ZONE",
- "urls": [
- "/${VERSION}/configure-zone.html"
- ]
- },
- {
- "title": "CONVERT TO SCHEMA",
- "urls": [
- "/${VERSION}/convert-to-schema.html"
- ]
- },
- {
- "title": "COPY FROM",
- "urls": [
- "/${VERSION}/copy-from.html"
- ]
- },
- {
- "title": "CREATE CHANGEFEED (Enterprise)",
- "urls": [
- "/${VERSION}/create-changefeed.html"
- ]
- },
- {
- "title": "CREATE DATABASE",
- "urls": [
- "/${VERSION}/create-database.html"
- ]
- },
- {
- "title": "CREATE INDEX",
- "urls": [
- "/${VERSION}/create-index.html"
- ]
- },
- {
- "title": "CREATE ROLE",
- "urls": [
- "/${VERSION}/create-role.html"
- ]
- },
- {
- "title": "CREATE SCHEDULE FOR BACKUP",
- "urls": [
- "/${VERSION}/create-schedule-for-backup.html"
- ]
- },
- {
- "title": "CREATE SCHEMA",
- "urls": [
- "/${VERSION}/create-schema.html"
- ]
- },
- {
- "title": "CREATE SEQUENCE",
- "urls": [
- "/${VERSION}/create-sequence.html"
- ]
- },
- {
- "title": "CREATE STATISTICS",
- "urls": [
- "/${VERSION}/create-statistics.html"
- ]
- },
- {
- "title": "CREATE TABLE",
- "urls": [
- "/${VERSION}/create-table.html"
- ]
- },
- {
- "title": "CREATE TABLE AS",
- "urls": [
- "/${VERSION}/create-table-as.html"
- ]
- },
- {
- "title": "CREATE TYPE",
- "urls": [
- "/${VERSION}/create-type.html"
- ]
- },
- {
- "title": "CREATE USER",
- "urls": [
- "/${VERSION}/create-user.html"
- ]
- },
- {
- "title": "CREATE VIEW",
- "urls": [
- "/${VERSION}/create-view.html"
- ]
- },
- {
- "title": "DELETE",
- "urls": [
- "/${VERSION}/delete.html"
- ]
- },
- {
- "title": "DROP COLUMN",
- "urls": [
- "/${VERSION}/drop-column.html"
- ]
- },
- {
- "title": "DROP CONSTRAINT",
- "urls": [
- "/${VERSION}/drop-constraint.html"
- ]
- },
- {
- "title": "DROP DATABASE",
- "urls": [
- "/${VERSION}/drop-database.html"
- ]
- },
- {
- "title": "DROP REGION (Enterprise)",
- "urls": [
- "/${VERSION}/drop-region.html"
- ]
- },
- {
- "title": "DROP TYPE",
- "urls": [
- "/${VERSION}/drop-type.html"
- ]
- },
- {
- "title": "DROP INDEX",
- "urls": [
- "/${VERSION}/drop-index.html"
- ]
- },
- {
- "title": "DROP ROLE",
- "urls": [
- "/${VERSION}/drop-role.html"
- ]
- },
- {
- "title": "DROP SCHEDULES",
- "urls": [
- "/${VERSION}/drop-schedules.html"
- ]
- },
- {
- "title": "DROP SCHEMA",
- "urls": [
- "/${VERSION}/drop-schema.html"
- ]
- },
- {
- "title": "DROP SEQUENCE",
- "urls": [
- "/${VERSION}/drop-sequence.html"
- ]
- },
- {
- "title": "DROP TABLE",
- "urls": [
- "/${VERSION}/drop-table.html"
- ]
- },
- {
- "title": "DROP USER",
- "urls": [
- "/${VERSION}/drop-user.html"
- ]
- },
- {
- "title": "DROP VIEW",
- "urls": [
- "/${VERSION}/drop-view.html"
- ]
- },
- {
- "title": "EXPERIMENTAL CHANGEFEED FOR",
- "urls": [
- "/${VERSION}/changefeed-for.html"
- ]
- },
- {
- "title": "EXPLAIN",
- "urls": [
- "/${VERSION}/explain.html"
- ]
- },
- {
- "title": "EXPLAIN ANALYZE",
- "urls": [
- "/${VERSION}/explain-analyze.html"
- ]
- },
- {
- "title": "EXPORT",
- "urls": [
- "/${VERSION}/export.html"
- ]
- },
- {
- "title": "GRANT",
- "urls": [
- "/${VERSION}/grant.html"
- ]
- },
- {
- "title": "IMPORT",
- "urls": [
- "/${VERSION}/import.html"
- ]
- },
- {
- "title": "IMPORT INTO",
- "urls": [
- "/${VERSION}/import-into.html"
- ]
- },
- {
- "title": "INSERT",
- "urls": [
- "/${VERSION}/insert.html"
- ]
- },
- {
- "title": "JOIN",
- "urls": [
- "/${VERSION}/joins.html"
- ]
- },
- {
- "title": "LIMIT/OFFSET",
- "urls": [
- "/${VERSION}/limit-offset.html"
- ]
- },
- {
- "title": "ORDER BY",
- "urls": [
- "/${VERSION}/order-by.html"
- ]
- },
- {
- "title": "OWNER TO",
- "urls": [
- "/${VERSION}/owner-to.html"
- ]
- },
- {
- "title": "PARTITION BY (Enterprise)",
- "urls": [
- "/${VERSION}/partition-by.html"
- ]
- },
- {
- "title": "PAUSE JOB",
- "urls": [
- "/${VERSION}/pause-job.html"
- ]
- },
- {
- "title": "PAUSE SCHEDULES",
- "urls": [
- "/${VERSION}/pause-schedules.html"
- ]
- },
- {
- "title": "PLACEMENT (RESTRICTED | DEFAULT)",
- "urls": [
- "/${VERSION}/placement-restricted.html"
- ]
- },
- {
- "title": "REASSIGN OWNED",
- "urls": [
- "/${VERSION}/reassign-owned.html"
- ]
- },
- {
- "title": "REFRESH",
- "urls": [
- "/${VERSION}/refresh.html"
- ]
- },
- {
- "title": "RENAME COLUMN",
- "urls": [
- "/${VERSION}/rename-column.html"
- ]
- },
- {
- "title": "RENAME CONSTRAINT",
- "urls": [
- "/${VERSION}/rename-constraint.html"
- ]
- },
- {
- "title": "RENAME DATABASE",
- "urls": [
- "/${VERSION}/rename-database.html"
- ]
- },
- {
- "title": "RENAME INDEX",
- "urls": [
- "/${VERSION}/rename-index.html"
- ]
- },
- {
- "title": "RENAME TABLE",
- "urls": [
- "/${VERSION}/rename-table.html"
- ]
- },
- {
- "title": "RELEASE SAVEPOINT",
- "urls": [
- "/${VERSION}/release-savepoint.html"
- ]
- },
- {
- "title": "RESET {session variable}",
- "urls": [
- "/${VERSION}/reset-vars.html"
- ]
- },
- {
- "title": "RESET CLUSTER SETTING",
- "urls": [
- "/${VERSION}/reset-cluster-setting.html"
- ]
- },
- {
- "title": "RESTORE",
- "urls": [
- "/${VERSION}/restore.html"
- ]
- },
- {
- "title": "RESUME JOB",
- "urls": [
- "/${VERSION}/resume-job.html"
- ]
- },
- {
- "title": "RESUME SCHEDULES",
- "urls": [
- "/${VERSION}/resume-schedules.html"
- ]
- },
- {
- "title": "REVOKE",
- "urls": [
- "/${VERSION}/revoke.html"
- ]
- },
- {
- "title": "ROLLBACK",
- "urls": [
- "/${VERSION}/rollback-transaction.html"
- ]
- },
- {
- "title": "SAVEPOINT",
- "urls": [
- "/${VERSION}/savepoint.html"
- ]
- },
- {
- "title": "SELECT",
- "urls": [
- "/${VERSION}/select-clause.html"
- ]
- },
- {
- "title": "SELECT FOR UPDATE",
- "urls": [
- "/${VERSION}/select-for-update.html"
- ]
- },
- {
- "title": "SET {session variable}",
- "urls": [
- "/${VERSION}/set-vars.html"
- ]
- },
- {
- "title": "SET CLUSTER SETTING",
- "urls": [
- "/${VERSION}/set-cluster-setting.html"
- ]
- },
- {
- "title": "SET LOCALITY",
- "urls": [
- "/${VERSION}/set-locality.html"
- ]
- },
- {
- "title": "SET PRIMARY REGION (Enterprise)",
- "urls": [
- "/${VERSION}/set-primary-region.html"
- ]
- },
- {
- "title": "SET SCHEMA",
- "urls": [
- "/${VERSION}/set-schema.html"
- ]
- },
- {
- "title": "SET TRANSACTION",
- "urls": [
- "/${VERSION}/set-transaction.html"
- ]
- },
- {
- "title": "SHOW {session variable}",
- "urls": [
- "/${VERSION}/show-vars.html"
- ]
- },
- {
- "title": "SHOW BACKUP",
- "urls": [
- "/${VERSION}/show-backup.html"
- ]
- },
- {
- "title": "SHOW CLUSTER SETTING",
- "urls": [
- "/${VERSION}/show-cluster-setting.html"
- ]
- },
- {
- "title": "SHOW COLUMNS",
- "urls": [
- "/${VERSION}/show-columns.html"
- ]
- },
- {
- "title": "SHOW CONSTRAINTS",
- "urls": [
- "/${VERSION}/show-constraints.html"
- ]
- },
- {
- "title": "SHOW CREATE",
- "urls": [
- "/${VERSION}/show-create.html"
- ]
- },
- {
- "title": "SHOW CREATE SCHEDULE",
- "urls": [
- "/${VERSION}/show-create-schedule.html"
- ]
- },
- {
- "title": "SHOW DATABASES",
- "urls": [
- "/${VERSION}/show-databases.html"
- ]
- },
- {
- "title": "SHOW DEFAULT PRIVILEGES",
- "urls": [
- "/${VERSION}/show-default-privileges.html"
- ]
- },
- {
- "title": "SHOW ENUMS",
- "urls": [
- "/${VERSION}/show-enums.html"
- ]
- },
- {
- "title": "SHOW FULL TABLE SCANS",
- "urls": [
- "/${VERSION}/show-full-table-scans.html"
- ]
- },
- {
- "title": "SHOW GRANTS",
- "urls": [
- "/${VERSION}/show-grants.html"
- ]
- },
- {
- "title": "SHOW INDEX",
- "urls": [
- "/${VERSION}/show-index.html"
- ]
- },
- {
- "title": "SHOW JOBS",
- "urls": [
- "/${VERSION}/show-jobs.html"
- ]
- },
- {
- "title": "SHOW LOCALITY",
- "urls": [
- "/${VERSION}/show-locality.html"
- ]
- },
- {
- "title": "SHOW PARTITIONS (Enterprise)",
- "urls": [
- "/${VERSION}/show-partitions.html"
- ]
- },
- {
- "title": "SHOW RANGES",
- "urls": [
- "/${VERSION}/show-ranges.html"
- ]
- },
- {
- "title": "SHOW RANGE FOR ROW",
- "urls": [
- "/${VERSION}/show-range-for-row.html"
- ]
- },
- {
- "title": "SHOW REGIONS",
- "urls": [
- "/${VERSION}/show-regions.html"
- ]
- },
- {
- "title": "SHOW ROLES",
- "urls": [
- "/${VERSION}/show-roles.html"
- ]
- },
- {
- "title": "SHOW SCHEDULES",
- "urls": [
- "/${VERSION}/show-schedules.html"
- ]
- },
- {
- "title": "SHOW SCHEMAS",
- "urls": [
- "/${VERSION}/show-schemas.html"
- ]
- },
- {
- "title": "SHOW SEQUENCES",
- "urls": [
- "/${VERSION}/show-sequences.html"
- ]
- },
- {
- "title": "SHOW SESSIONS",
- "urls": [
- "/${VERSION}/show-sessions.html"
- ]
- },
- {
- "title": "SHOW STATEMENTS",
- "urls": [
- "/${VERSION}/show-statements.html"
- ]
- },
- {
- "title": "SHOW STATISTICS",
- "urls": [
- "/${VERSION}/show-statistics.html"
- ]
- },
- {
- "title": "SHOW SAVEPOINT STATUS",
- "urls": [
- "/${VERSION}/show-savepoint-status.html"
- ]
- },
- {
- "title": "SHOW TABLES",
- "urls": [
- "/${VERSION}/show-tables.html"
- ]
- },
- {
- "title": "SHOW TRACE FOR SESSION",
- "urls": [
- "/${VERSION}/show-trace.html"
- ]
- },
- {
- "title": "SHOW TRANSACTIONS",
- "urls": [
- "/${VERSION}/show-transactions.html"
- ]
- },
- {
- "title": "SHOW TYPES",
- "urls": [
- "/${VERSION}/show-types.html"
- ]
- },
- {
- "title": "SHOW USERS",
- "urls": [
- "/${VERSION}/show-users.html"
- ]
- },
- {
- "title": "SHOW ZONE CONFIGURATIONS",
- "urls": [
- "/${VERSION}/show-zone-configurations.html"
- ]
- },
- {
- "title": "SPLIT AT",
- "urls": [
- "/${VERSION}/split-at.html"
- ]
- },
- {
- "title": "SURVIVE {ZONE,REGION} FAILURE",
- "urls": [
- "/${VERSION}/survive-failure.html"
- ]
- },
- {
- "title": "TRUNCATE",
- "urls": [
- "/${VERSION}/truncate.html"
- ]
- },
- {
- "title": "UNSPLIT AT",
- "urls": [
- "/${VERSION}/unsplit-at.html"
- ]
- },
- {
- "title": "UPDATE",
- "urls": [
- "/${VERSION}/update.html"
- ]
- },
- {
- "title": "UPSERT",
- "urls": [
- "/${VERSION}/upsert.html"
- ]
- },
- {
- "title": "VALIDATE CONSTRAINT",
- "urls": [
- "/${VERSION}/validate-constraint.html"
- ]
- }
- ]
- },
- {
- "title": "Data Types",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/data-types.html"
- ]
- },
- {
- "title": "ARRAY",
- "urls": [
- "/${VERSION}/array.html"
- ]
- },
- {
- "title": "BIT",
- "urls": [
- "/${VERSION}/bit.html"
- ]
- },
- {
- "title": "BOOL",
- "urls": [
- "/${VERSION}/bool.html"
- ]
- },
- {
- "title": "BYTES",
- "urls": [
- "/${VERSION}/bytes.html"
- ]
- },
- {
- "title": "COLLATE",
- "urls": [
- "/${VERSION}/collate.html"
- ]
- },
- {
- "title": "DATE",
- "urls": [
- "/${VERSION}/date.html"
- ]
- },
- {
- "title": "DECIMAL",
- "urls": [
- "/${VERSION}/decimal.html"
- ]
- },
- {
- "title": "ENUM",
- "urls": [
- "/${VERSION}/enum.html"
- ]
- },
- {
- "title": "FLOAT",
- "urls": [
- "/${VERSION}/float.html"
- ]
- },
- {
- "title": "INET",
- "urls": [
- "/${VERSION}/inet.html"
- ]
- },
- {
- "title": "INT",
- "urls": [
- "/${VERSION}/int.html"
- ]
- },
- {
- "title": "INTERVAL",
- "urls": [
- "/${VERSION}/interval.html"
- ]
- },
- {
- "title": "JSONB",
- "urls": [
- "/${VERSION}/jsonb.html"
- ]
- },
- {
- "title": "SERIAL",
- "urls": [
- "/${VERSION}/serial.html"
- ]
- },
- {
- "title": "STRING",
- "urls": [
- "/${VERSION}/string.html"
- ]
- },
- {
- "title": "TIME",
- "urls": [
- "/${VERSION}/time.html"
- ]
- },
- {
- "title": "TIMESTAMP",
- "urls": [
- "/${VERSION}/timestamp.html"
- ]
- },
- {
- "title": "UUID",
- "urls": [
- "/${VERSION}/uuid.html"
- ]
- }
- ]
- },
- {
- "title": "Constraints",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/constraints.html"
- ]
- },
- {
- "title": "Check",
- "urls": [
- "/${VERSION}/check.html"
- ]
- },
- {
- "title": "Default Value",
- "urls": [
- "/${VERSION}/default-value.html"
- ]
- },
- {
- "title": "Foreign Key",
- "urls": [
- "/${VERSION}/foreign-key.html"
- ]
- },
- {
- "title": "Not Null",
- "urls": [
- "/${VERSION}/not-null.html"
- ]
- },
- {
- "title": "Primary Key",
- "urls": [
- "/${VERSION}/primary-key.html"
- ]
- },
- {
- "title": "Unique",
- "urls": [
- "/${VERSION}/unique.html"
- ]
- }
- ]
- },
- {
- "title": "Functions and Operators",
- "urls": [
- "/${VERSION}/functions-and-operators.html"
- ]
- },
- {
- "title": "Window Functions",
- "urls": [
- "/${VERSION}/window-functions.html"
- ]
- },
- {
- "title": "Name Resolution",
- "urls": [
- "/${VERSION}/sql-name-resolution.html"
- ]
- },
- {
- "title": "System Catalogs",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/system-catalogs.html"
- ]
- },
- {
- "title": "crdb_internal",
- "urls": [
- "/${VERSION}/crdb-internal.html"
- ]
- },
- {
- "title": "information_schema",
- "urls": [
- "/${VERSION}/information-schema.html"
- ]
- },
- {
- "title": "pg_catalog",
- "urls": [
- "/${VERSION}/pg-catalog.html"
- ]
- },
- {
- "title": "pg_extension",
- "urls": [
- "/${VERSION}/pg-extension.html"
- ]
- }
- ]
- },
- {
- "title": "Spatial Features",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/spatial-features.html"
- ]
- },
- {
- "title": "Working with Spatial Data",
- "urls": [
- "/${VERSION}/spatial-data.html"
- ]
- },
- {
- "title": "Spatial and GIS Glossary",
- "urls": [
- "/${VERSION}/spatial-glossary.html"
- ]
- },
- {
- "title": "POINT",
- "urls": [
- "/${VERSION}/point.html"
- ]
- },
- {
- "title": "LINESTRING",
- "urls": [
- "/${VERSION}/linestring.html"
- ]
- },
- {
- "title": "POLYGON",
- "urls": [
- "/${VERSION}/polygon.html"
- ]
- },
- {
- "title": "MULTIPOINT",
- "urls": [
- "/${VERSION}/multipoint.html"
- ]
- },
- {
- "title": "MULTILINESTRING",
- "urls": [
- "/${VERSION}/multilinestring.html"
- ]
- },
- {
- "title": "MULTIPOLYGON",
- "urls": [
- "/${VERSION}/multipolygon.html"
- ]
- },
- {
- "title": "GEOMETRYCOLLECTION",
- "urls": [
- "/${VERSION}/geometrycollection.html"
- ]
- },
- {
- "title": "Well Known Text (WKT)",
- "urls": [
- "/${VERSION}/well-known-text.html"
- ]
- },
- {
- "title": "Well Known Binary (WKB)",
- "urls": [
- "/${VERSION}/well-known-binary.html"
- ]
- },
- {
- "title": "GeoJSON",
- "urls": [
- "/${VERSION}/geojson.html"
- ]
- },
- {
- "title": "SRID 4326 - longitude and latitude",
- "urls": [
- "/${VERSION}/srid-4326.html"
- ]
- },
- {
- "title": "ST_Contains",
- "urls": [
- "/${VERSION}/st_contains.html"
- ]
- },
- {
- "title": "ST_Within",
- "urls": [
- "/${VERSION}/st_within.html"
- ]
- },
- {
- "title": "ST_Intersects",
- "urls": [
- "/${VERSION}/st_intersects.html"
- ]
- },
- {
- "title": "ST_CoveredBy",
- "urls": [
- "/${VERSION}/st_coveredby.html"
- ]
- },
- {
- "title": "ST_Covers",
- "urls": [
- "/${VERSION}/st_covers.html"
- ]
- },
- {
- "title": "ST_Disjoint",
- "urls": [
- "/${VERSION}/st_disjoint.html"
- ]
- },
- {
- "title": "ST_Equals",
- "urls": [
- "/${VERSION}/st_equals.html"
- ]
- },
- {
- "title": "ST_Overlaps",
- "urls": [
- "/${VERSION}/st_overlaps.html"
- ]
- },
- {
- "title": "ST_Touches",
- "urls": [
- "/${VERSION}/st_touches.html"
- ]
- },
- {
- "title": "ST_ConvexHull",
- "urls": [
- "/${VERSION}/st_convexhull.html"
- ]
- },
- {
- "title": "ST_Union",
- "urls": [
- "/${VERSION}/st_union.html"
- ]
- }
- ]
- },
- {
- "title": "Experimental Features",
- "urls": [
- "/${VERSION}/experimental-features.html"
- ]
- }
- ]
- },
- {
- "title": "Cluster Settings",
- "urls": [
- "/${VERSION}/cluster-settings.html"
- ]
- },
- {
- "title": "Security",
- "items": [
- {
- "title": "Security Overview",
- "urls": [
- "/${VERSION}/security-reference/security-overview.html"
- ]
- },
- {
- "title": "Authentication",
- "urls": [
- "/${VERSION}/security-reference/authentication.html"
- ]
- },
- {
- "title": "Authorization",
- "urls": [
- "/${VERSION}/security-reference/authorization.html"
- ]
- },
- {
- "title": "Encryption",
- "urls": [
- "/${VERSION}/security-reference/encryption.html"
- ]
- }
- ]
- },
- {
- "title": "CLI",
- "items": [
- {
- "title": "Cockroach Commands",
- "urls": [
- "/${VERSION}/cockroach-commands.html"
- ]
- },
- {
- "title": "Client Connection Parameters",
- "urls": [
- "/${VERSION}/connection-parameters.html"
- ]
- },
- {
- "title": "cockroach Commands",
- "items": [
- {
- "title": "cockroach start",
- "urls": [
- "/${VERSION}/cockroach-start.html"
- ]
- },
- {
- "title": "cockroach init",
- "urls": [
- "/${VERSION}/cockroach-init.html"
- ]
- },
- {
- "title": "cockroach start-single-node",
- "urls": [
- "/${VERSION}/cockroach-start-single-node.html"
- ]
- },
- {
- "title": "cockroach cert",
- "urls": [
- "/${VERSION}/cockroach-cert.html"
- ]
- },
- {
- "title": "cockroach sql",
- "urls": [
- "/${VERSION}/cockroach-sql.html"
- ]
- },
- {
- "title": "cockroach sqlfmt",
- "urls": [
- "/${VERSION}/cockroach-sqlfmt.html"
- ]
- },
- {
- "title": "cockroach node",
- "urls": [
- "/${VERSION}/cockroach-node.html"
- ]
- },
- {
- "title": "cockroach nodelocal upload",
- "urls": [
- "/${VERSION}/cockroach-nodelocal-upload.html"
- ]
- },
- {
- "title": "cockroach auth-session",
- "urls": [
- "/${VERSION}/cockroach-auth-session.html"
- ]
- },
- {
- "title": "cockroach demo",
- "urls": [
- "/${VERSION}/cockroach-demo.html"
- ]
- },
- {
- "title": "cockroach debug ballast",
- "urls": [
- "/${VERSION}/cockroach-debug-ballast.html"
- ]
- },
- {
- "title": "cockroach debug encryption-active-key",
- "urls": [
- "/${VERSION}/cockroach-debug-encryption-active-key.html"
- ]
- },
- {
- "title": "cockroach debug job-trace",
- "urls": [
- "/${VERSION}/cockroach-debug-job-trace.html"
- ]
- },
- {
- "title": "cockroach debug list-files",
- "urls": [
- "/${VERSION}/cockroach-debug-list-files.html"
- ]
- },
- {
- "title": "cockroach debug merge-logs",
- "urls": [
- "/${VERSION}/cockroach-debug-merge-logs.html"
- ]
- },
- {
- "title": "cockroach debug tsdump",
- "urls": [
- "/${VERSION}/cockroach-debug-tsdump.html"
- ]
- },
- {
- "title": "cockroach debug zip",
- "urls": [
- "/${VERSION}/cockroach-debug-zip.html"
- ]
- },
- {
- "title": "cockroach statement-diag",
- "urls": [
- "/${VERSION}/cockroach-statement-diag.html"
- ]
- },
- {
- "title": "cockroach gen",
- "urls": [
- "/${VERSION}/cockroach-gen.html"
- ]
- },
- {
- "title": "cockroach userfile upload",
- "urls": [
- "/${VERSION}/cockroach-userfile-upload.html"
- ]
- },
- {
- "title": "cockroach userfile list",
- "urls": [
- "/${VERSION}/cockroach-userfile-list.html"
- ]
- },
- {
- "title": "cockroach userfile get",
- "urls": [
- "/${VERSION}/cockroach-userfile-get.html"
- ]
- },
- {
- "title": "cockroach userfile delete",
- "urls": [
- "/${VERSION}/cockroach-userfile-delete.html"
- ]
- },
- {
- "title": "cockroach version",
- "urls": [
- "/${VERSION}/cockroach-version.html"
- ]
- },
- {
- "title": "cockroach workload",
- "urls": [
- "/${VERSION}/cockroach-workload.html"
- ]
- },
- {
- "title": "cockroach import",
- "urls": [
- "/${VERSION}/cockroach-import.html"
- ]
- }
- ]
- }
- ]
- },
- {
- "title": "DB Console",
- "items": [
- {
- "title": "DB Console Overview",
- "urls": [
- "/${VERSION}/ui-overview.html"
- ]
- },
- {
- "title": "Cluster Overview Page",
- "urls": [
- "/${VERSION}/ui-cluster-overview-page.html"
- ]
- },
- {
- "title": "Metrics Dashboards",
- "items": [
- {
- "title": "Overview Dashboard",
- "urls": [
- "/${VERSION}/ui-overview-dashboard.html"
- ]
- },
- {
- "title": "Hardware Dashboard",
- "urls": [
- "/${VERSION}/ui-hardware-dashboard.html"
- ]
- },
- {
- "title": "Runtime Dashboard",
- "urls": [
- "/${VERSION}/ui-runtime-dashboard.html"
- ]
- },
- {
- "title": "SQL Dashboard",
- "urls": [
- "/${VERSION}/ui-sql-dashboard.html"
- ]
- },
- {
- "title": "Storage Dashboard",
- "urls": [
- "/${VERSION}/ui-storage-dashboard.html"
- ]
- },
- {
- "title": "Replication Dashboard",
- "urls": [
- "/${VERSION}/ui-replication-dashboard.html"
- ]
- },
- {
- "title": "Changefeeds Dashboard",
- "urls": [
- "/${VERSION}/ui-cdc-dashboard.html"
- ]
- },
- {
- "title": "Overload Dashboard",
- "urls": [
- "/${VERSION}/ui-overload-dashboard.html"
- ]
- },
- {
- "title": "Custom Chart",
- "urls": [
- "/${VERSION}/ui-custom-chart-debug-page.html"
- ]
- }
- ]
- },
- {
- "title": "Databases Page",
- "urls": [
- "/${VERSION}/ui-databases-page.html"
- ]
- },
- {
- "title": "Sessions Page",
- "urls": [
- "/${VERSION}/ui-sessions-page.html"
- ]
- },
- {
- "title": "Statements Page",
- "urls": [
- "/${VERSION}/ui-statements-page.html"
- ]
- },
- {
- "title": "Transactions Page",
- "urls": [
- "/${VERSION}/ui-transactions-page.html"
- ]
- },
- {
- "title": "Network Latency Page",
- "urls": [
- "/${VERSION}/ui-network-latency-page.html"
- ]
- },
- {
- "title": "Hot Ranges Page",
- "urls": [
- "/${VERSION}/ui-hot-ranges-page.html"
- ]
- },
- {
- "title": "Jobs Page",
- "urls": [
- "/${VERSION}/ui-jobs-page.html"
- ]
- },
- {
- "title": "Advanced Debug Page",
- "urls": [
- "/${VERSION}/ui-debug-pages.html"
- ]
- }
- ]
- },
- {
- "title": "Transaction Retry Error Reference",
- "urls": [
- "/${VERSION}/transaction-retry-error-reference.html"
- ]
- },
- {
- "title": "Cluster API",
- "urls": [
- "https://www.cockroachlabs.com/docs/api/cluster/v2"
- ]
- },
- {
- "title": "Cloud API",
- "urls": [
- "https://www.cockroachlabs.com/docs/api/cloud/v1"
- ]
- },
- {
- "title": "Logging",
- "items": [
- {
- "title": "Logging Levels and Channels",
- "urls": [
- "/${VERSION}/logging.html"
- ]
- },
- {
- "title": "Log Formats",
- "urls": [
- "/${VERSION}/log-formats.html"
- ]
- },
- {
- "title": "Notable Event Types",
- "urls": [
- "/${VERSION}/eventlog.html"
- ]
- }
- ]
- },
- {
- "title": "Diagnostics Reporting",
- "urls": [
- "/${VERSION}/diagnostics-reporting.html"
- ]
- },
- {
- "title": "Benchmarking",
- "items": [
- {
- "title": "Overview",
- "urls": [
- "/${VERSION}/performance.html"
- ]
- },
- {
- "title": "Benchmarking Instructions",
- "urls": [
- "/${VERSION}/performance-benchmarking-with-tpcc-local.html",
- "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html",
- "/${VERSION}/performance-benchmarking-with-tpcc-small.html",
- "/${VERSION}/performance-benchmarking-with-tpcc-medium.html",
- "/${VERSION}/performance-benchmarking-with-tpcc-large.html"
- ]
- }
- ]
- },
- {
- "title": "Third-Party Support",
- "items": [
- {
- "title": "Tools Supported by Cockroach Labs",
- "urls": [
- "/${VERSION}/third-party-database-tools.html"
- ]
- },
- {
- "title": "Tools Supported by the Community",
- "urls": [
- "/${VERSION}/community-tooling.html"
- ]
- }
- ]
- }
- ]
- }
diff --git a/src/current/_includes/v21.2/sidebar-data/releases.json b/src/current/_includes/v21.2/sidebar-data/releases.json
deleted file mode 100644
index 18f2a1b7c6a..00000000000
--- a/src/current/_includes/v21.2/sidebar-data/releases.json
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "title": "Releases",
- "is_top_level": true,
- "items": [
- {% include_cached sidebar-releases.json %}
- ]
- }
diff --git a/src/current/_includes/v21.2/sidebar-data/stream.json b/src/current/_includes/v21.2/sidebar-data/stream.json
deleted file mode 100644
index fa555b7310c..00000000000
--- a/src/current/_includes/v21.2/sidebar-data/stream.json
+++ /dev/null
@@ -1,60 +0,0 @@
-{
- "title": "Stream Data",
- "is_top_level": true,
- "items": [
- {
- "title": "Change Data Capture Overview",
- "urls": [
- "/${VERSION}/change-data-capture-overview.html"
- ]
- },
- {
- "title": "Use Changefeeds",
- "urls": [
- "/${VERSION}/use-changefeeds.html"
- ]
- },
- {
- "title": "Create and Configure Changefeeds",
- "urls": [
- "/${VERSION}/create-and-configure-changefeeds.html"
- ]
- },
- {
- "title": "Changefeed Sinks",
- "urls": [
- "/${VERSION}/changefeed-sinks.html"
- ]
- },
- {
- "title": "Changefeeds in Multi-Region Deployments",
- "urls": [
- "/${VERSION}/changefeeds-in-multi-region-deployments.html"
- ]
- },
- {
- "title": "Monitor and Debug Changefeeds",
- "urls": [
- "/${VERSION}/monitor-and-debug-changefeeds.html"
- ]
- },
- {
- "title": "Changefeed Examples",
- "urls": [
- "/${VERSION}/changefeed-examples.html"
- ]
- },
- {
- "title": "Stream a Changefeed from CockroachDB Cloud to Snowflake",
- "urls": [
- "/cockroachcloud/stream-changefeed-to-snowflake-aws.html"
- ]
- },
- {
- "title": "Advanced Changefeed Configuration",
- "urls": [
- "/${VERSION}/advanced-changefeed-configuration.html"
- ]
- }
- ]
-}
diff --git a/src/current/_includes/v21.2/spatial/ogr2ogr-supported-version.md b/src/current/_includes/v21.2/spatial/ogr2ogr-supported-version.md
deleted file mode 100644
index ad444257227..00000000000
--- a/src/current/_includes/v21.2/spatial/ogr2ogr-supported-version.md
+++ /dev/null
@@ -1,3 +0,0 @@
-{{site.data.alerts.callout_info}}
-An `ogr2ogr` version of 3.1.0 or higher is required to generate data that can be imported into CockroachDB.
-{{site.data.alerts.end}}
diff --git a/src/current/_includes/v21.2/spatial/zmcoords.md b/src/current/_includes/v21.2/spatial/zmcoords.md
deleted file mode 100644
index fedbb74e703..00000000000
--- a/src/current/_includes/v21.2/spatial/zmcoords.md
+++ /dev/null
@@ -1,27 +0,0 @@
- You can also store a `{{page.title}}` with the following additional dimensions:
-
-- A third dimension coordinate `Z` (`{{page.title}}Z`).
-- A measure coordinate `M` (`{{page.title}}M`).
-- Both a third dimension and a measure coordinate (`{{page.title}}ZM`).
-
-The `Z` and `M` dimensions can be accessed or modified using a number of [built-in functions](functions-and-operators.html#spatial-functions), including:
-
-- `ST_Z`
-- `ST_M`
-- `ST_Affine`
-- `ST_Zmflag`
-- `ST_MakePoint`
-- `ST_MakePointM`
-- `ST_Force3D`
-- `ST_Force3DZ`
-- `ST_Force3DM`
-- `ST_Force4D`
-- `ST_Snap`
-- `ST_SnapToGrid`
-- `ST_RotateZ`
-- `ST_AddMeasure`
-
-Note that CockroachDB's [spatial indexing](spatial-indexes.html) is still based on the 2D coordinate system. This means that:
-
-- The Z/M dimension is not index accelerated when using spatial predicates.
-- Some spatial functions ignore the Z/M dimension, with transformations discarding the Z/M value.
diff --git a/src/current/_includes/v21.2/sql/add-size-limits-to-indexed-columns.md b/src/current/_includes/v21.2/sql/add-size-limits-to-indexed-columns.md
deleted file mode 100644
index 91cf3d61a1e..00000000000
--- a/src/current/_includes/v21.2/sql/add-size-limits-to-indexed-columns.md
+++ /dev/null
@@ -1,22 +0,0 @@
-We **strongly recommend** adding size limits to all [indexed columns](indexes.html), which includes columns in [primary keys](primary-key.html).
-
-Values exceeding 1 MiB can lead to [storage layer write amplification](architecture/storage-layer.html#write-amplification) and cause significant performance degradation or even [crashes due to OOMs (out of memory errors)](cluster-setup-troubleshooting.html#out-of-memory-oom-crash).
-
-To add a size limit using [`CREATE TABLE`](create-table.html):
-
-{% include_cached copy-clipboard.html %}
-~~~ sql
-CREATE TABLE name (first STRING(100), last STRING(100));
-~~~
-
-To add a size limit using [`ALTER TABLE ... ALTER COLUMN`](alter-column.html):
-
-{% include_cached copy-clipboard.html %}
-~~~ sql
-SET enable_experimental_alter_column_type_general = true;
-~~~
-
-{% include_cached copy-clipboard.html %}
-~~~ sql
-ALTER TABLE name ALTER first TYPE STRING(99);
-~~~
diff --git a/src/current/_includes/v21.2/sql/begin-transaction-as-of-system-time-example.md b/src/current/_includes/v21.2/sql/begin-transaction-as-of-system-time-example.md
deleted file mode 100644
index 7f2c11dac77..00000000000
--- a/src/current/_includes/v21.2/sql/begin-transaction-as-of-system-time-example.md
+++ /dev/null
@@ -1,19 +0,0 @@
-{% include_cached copy-clipboard.html %}
-~~~ sql
-> BEGIN AS OF SYSTEM TIME '2019-04-09 18:02:52.0+00:00';
-~~~
-
-{% include_cached copy-clipboard.html %}
-~~~ sql
-> SELECT * FROM orders;
-~~~
-
-{% include_cached copy-clipboard.html %}
-~~~ sql
-> SELECT * FROM products;
-~~~
-
-{% include_cached copy-clipboard.html %}
-~~~ sql
-> COMMIT;
-~~~
diff --git a/src/current/_includes/v21.2/sql/cannot-refresh-materialized-views-inside-transactions.md b/src/current/_includes/v21.2/sql/cannot-refresh-materialized-views-inside-transactions.md
deleted file mode 100644
index f61bac51deb..00000000000
--- a/src/current/_includes/v21.2/sql/cannot-refresh-materialized-views-inside-transactions.md
+++ /dev/null
@@ -1,31 +0,0 @@
-CockroachDB cannot refresh {% if page.name == "views.md" %} materialized views {% else %} [materialized views](views.html#materialized-views) {% endif %} inside [explicit transactions](begin-transaction.html). Trying to refresh a materialized view inside an explicit transaction will result in an error, as shown below.
-
-1. First, start [`cockroach demo`](cockroach-demo.html) with the sample `bank` data set:
-
- {% include_cached copy-clipboard.html %}
- ~~~ shell
- cockroach demo bank
- ~~~
-
-2. Create the materialized view described in [Materialized views → Usage](views.html#usage).
-
-3. Start a new multi-statement transaction with [`BEGIN TRANSACTION`](begin-transaction.html):
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- BEGIN TRANSACTION;
- ~~~
-
-4. Inside the open transaction, attempt to [refresh the view](refresh.html) as shown below. This will result in an error.
-
- {% include_cached copy-clipboard.html %}
- ~~~ sql
- REFRESH MATERIALIZED VIEW overdrawn_accounts;
- ~~~
-
- ~~~
- ERROR: cannot refresh view in an explicit transaction
- SQLSTATE: 25000
- ~~~
-
-[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/66008)
diff --git a/src/current/_includes/v21.2/sql/combine-alter-table-commands.md b/src/current/_includes/v21.2/sql/combine-alter-table-commands.md
deleted file mode 100644
index 62839cce017..00000000000
--- a/src/current/_includes/v21.2/sql/combine-alter-table-commands.md
+++ /dev/null
@@ -1,3 +0,0 @@
-{{site.data.alerts.callout_success}}
-This command can be combined with other `ALTER TABLE` commands in a single statement. For a list of commands that can be combined, see [`ALTER TABLE`](alter-table.html). For a demonstration, see [Add and rename columns atomically](rename-column.html#add-and-rename-columns-atomically).
-{{site.data.alerts.end}}
diff --git a/src/current/_includes/v21.2/sql/connection-parameters.md b/src/current/_includes/v21.2/sql/connection-parameters.md
deleted file mode 100644
index 9e0699b0614..00000000000
--- a/src/current/_includes/v21.2/sql/connection-parameters.md
+++ /dev/null
@@ -1,9 +0,0 @@
-Flag | Description
------|------------
-`--host` | The server host and port number to connect to. This can be the address of any node in the cluster. **Env Variable:** `COCKROACH_HOST`
**Default:** `localhost:26257` -`--port`
`-p` | The server port to connect to. Note: The port number can also be specified via `--host`.
**Env Variable:** `COCKROACH_PORT`
**Default:** `26257` -`--user`
`-u` | The [SQL user](create-user.html) that will own the client session.
**Env Variable:** `COCKROACH_USER`
**Default:** `root` -`--insecure` | Use an insecure connection.
**Env Variable:** `COCKROACH_INSECURE`
**Default:** `false` -`--cert-principal-map` | A comma-separated list of `
**Env Variable:** `COCKROACH_CERTS_DIR`
**Default:** `${HOME}/.cockroach-certs/` - `--url` | A [connection URL](connection-parameters.html#connect-using-a-url) to use instead of the other arguments. To convert a connection URL to the syntax that works with your client driver, run [`cockroach convert-url`](connection-parameters.html#convert-a-url-for-different-drivers).
**Env Variable:** `COCKROACH_URL`
**Default:** no URL \ No newline at end of file diff --git a/src/current/_includes/v21.2/sql/covering-index.md b/src/current/_includes/v21.2/sql/covering-index.md deleted file mode 100644 index 366d4500b2c..00000000000 --- a/src/current/_includes/v21.2/sql/covering-index.md +++ /dev/null @@ -1 +0,0 @@ -An index that stores all the columns needed by a query is also known as a _covering index_ for that query. When a query has a covering index, CockroachDB can use that index directly instead of doing a [join](joins.html) with the [primary key](primary-key.html), which is likely to be slower. diff --git a/src/current/_includes/v21.2/sql/crdb-internal-partitions-example.md b/src/current/_includes/v21.2/sql/crdb-internal-partitions-example.md deleted file mode 100644 index 680b0adf261..00000000000 --- a/src/current/_includes/v21.2/sql/crdb-internal-partitions-example.md +++ /dev/null @@ -1,43 +0,0 @@ -## Querying partitions programmatically - -The `crdb_internal.partitions` internal table contains information about the partitions in your database. In testing, scripting, and other programmatic environments, we recommend querying this table for partition information instead of using the `SHOW PARTITIONS` statement. For example, to get all `us_west` partitions of in your database, you can run the following query: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SELECT * FROM crdb_internal.partitions WHERE name='us_west'; -~~~ - -~~~ - table_id | index_id | parent_name | name | columns | column_names | list_value | range_value | zone_id | subzone_id -+----------+----------+-------------+---------+---------+--------------+-------------------------------------------------+-------------+---------+------------+ - 53 | 1 | NULL | us_west | 1 | city | ('seattle'), ('san francisco'), ('los angeles') | NULL | 0 | 0 - 54 | 1 | NULL | us_west | 1 | city | ('seattle'), ('san francisco'), ('los angeles') | NULL | 54 | 1 - 54 | 2 | NULL | us_west | 1 | city | ('seattle'), ('san francisco'), ('los angeles') | NULL | 54 | 2 - 55 | 1 | NULL | us_west | 1 | city | ('seattle'), ('san francisco'), ('los angeles') | NULL | 55 | 1 - 55 | 2 | NULL | us_west | 1 | city | ('seattle'), ('san francisco'), ('los angeles') | NULL | 55 | 2 - 55 | 3 | NULL | us_west | 1 | vehicle_city | ('seattle'), ('san francisco'), ('los angeles') | NULL | 55 | 3 - 56 | 1 | NULL | us_west | 1 | city | ('seattle'), ('san francisco'), ('los angeles') | NULL | 56 | 1 - 58 | 1 | NULL | us_west | 1 | city | ('seattle'), ('san francisco'), ('los angeles') | NULL | 58 | 1 -(8 rows) -~~~ - -Other internal tables, like `crdb_internal.tables`, include information that could be useful in conjunction with `crdb_internal.partitions`. - -For example, if you want the output for your partitions to include the name of the table and database, you can perform a join of the two tables: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SELECT - partitions.name AS partition_name, column_names, list_value, tables.name AS table_name, database_name - FROM crdb_internal.partitions JOIN crdb_internal.tables ON partitions.table_id=tables.table_id - WHERE tables.name='users'; -~~~ - -~~~ - partition_name | column_names | list_value | table_name | database_name -+----------------+--------------+-------------------------------------------------+------------+---------------+ - us_west | city | ('seattle'), ('san francisco'), ('los angeles') | users | movr - us_east | city | ('new york'), ('boston'), ('washington dc') | users | movr - europe_west | city | ('amsterdam'), ('paris'), ('rome') | users | movr -(3 rows) -~~~ diff --git a/src/current/_includes/v21.2/sql/crdb-internal-partitions.md b/src/current/_includes/v21.2/sql/crdb-internal-partitions.md deleted file mode 100644 index ebab5abe4ed..00000000000 --- a/src/current/_includes/v21.2/sql/crdb-internal-partitions.md +++ /dev/null @@ -1,3 +0,0 @@ -{{site.data.alerts.callout_success}} -In testing, scripting, and other programmatic environments, we recommend querying the `crdb_internal.partitions` internal table for partition information instead of using the `SHOW PARTITIONS` statement. For more information, see [Querying partitions programmatically](show-partitions.html#querying-partitions-programmatically). -{{site.data.alerts.end}} diff --git a/src/current/_includes/v21.2/sql/db-terms.md b/src/current/_includes/v21.2/sql/db-terms.md deleted file mode 100644 index e74ca554ad7..00000000000 --- a/src/current/_includes/v21.2/sql/db-terms.md +++ /dev/null @@ -1,3 +0,0 @@ -{{site.data.alerts.callout_info}} -To avoid confusion with the general term "[database](https://en.wikipedia.org/wiki/Database)", throughout this guide we refer to the logical object as a *database*, to CockroachDB by name, and to a deployment of CockroachDB as a [*cluster*](architecture/overview.html#cockroachdb-architecture-terms). -{{site.data.alerts.end}} diff --git a/src/current/_includes/v21.2/sql/dev-schema-change-limits.md b/src/current/_includes/v21.2/sql/dev-schema-change-limits.md deleted file mode 100644 index fbcac99f13c..00000000000 --- a/src/current/_includes/v21.2/sql/dev-schema-change-limits.md +++ /dev/null @@ -1,3 +0,0 @@ -Review the [limitations of online schema changes in CockroachDB](online-schema-changes.html#limitations). Note that CockroachDB has [limited support for schema changes within the same explicit transaction](online-schema-changes.html#limited-support-for-schema-changes-within-transactions). - - We recommend doing schema changes outside explicit transactions, where possible. When a database [schema management tool](third-party-database-tools.html#schema-migration-tools) manages transactions on your behalf, we recommend only including one schema change operation per transaction. \ No newline at end of file diff --git a/src/current/_includes/v21.2/sql/dev-schema-changes.md b/src/current/_includes/v21.2/sql/dev-schema-changes.md deleted file mode 100644 index d1f63bbcff5..00000000000 --- a/src/current/_includes/v21.2/sql/dev-schema-changes.md +++ /dev/null @@ -1 +0,0 @@ -As a general best practice, we discourage the use of client libraries to execute [database schema changes](online-schema-changes.html). Instead, use a database schema migration tool, or the [CockroachDB SQL client](cockroach-sql.html). \ No newline at end of file diff --git a/src/current/_includes/v21.2/sql/expression-indexes-cannot-reference-computed-columns.md b/src/current/_includes/v21.2/sql/expression-indexes-cannot-reference-computed-columns.md deleted file mode 100644 index 4c66aca7d8b..00000000000 --- a/src/current/_includes/v21.2/sql/expression-indexes-cannot-reference-computed-columns.md +++ /dev/null @@ -1,3 +0,0 @@ -CockroachDB does not allow {% if page.name == "expression-indexes.md" %} expression indexes {% else %} [expression indexes](expression-indexes.html) {% endif %} to reference [computed columns](computed-columns.html). - - [Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/67900) diff --git a/src/current/_includes/v21.2/sql/expressions-as-on-conflict-targets.md b/src/current/_includes/v21.2/sql/expressions-as-on-conflict-targets.md deleted file mode 100644 index 2b328c1e4f3..00000000000 --- a/src/current/_includes/v21.2/sql/expressions-as-on-conflict-targets.md +++ /dev/null @@ -1,40 +0,0 @@ -CockroachDB does not support expressions as `ON CONFLICT` targets. This means that unique {% if page.name == "expression-indexes.md" %} expression indexes {% else %} [expression indexes](expression-indexes.html) {% endif %} cannot be selected as arbiters for [`INSERT .. ON CONFLICT`](insert.html#on-conflict-clause) statements. For example: - -{% include_cached copy-clipboard.html %} -~~~ sql -CREATE TABLE t (a INT, b INT, UNIQUE INDEX ((a + b))); -~~~ - -~~~ -CREATE TABLE -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -INSERT INTO t VALUES (1, 2) ON CONFLICT ((a + b)) DO NOTHING; -~~~ - -~~~ -invalid syntax: statement ignored: at or near "(": syntax error -SQLSTATE: 42601 -DETAIL: source SQL: -INSERT INTO t VALUES (1, 2) ON CONFLICT ((a + b)) DO NOTHING - ^ -HINT: try \h INSERT -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -INSERT INTO t VALUES (1, 2) ON CONFLICT ((a + b)) DO UPDATE SET a = 10; -~~~ - -~~~ -invalid syntax: statement ignored: at or near "(": syntax error -SQLSTATE: 42601 -DETAIL: source SQL: -INSERT INTO t VALUES (1, 2) ON CONFLICT ((a + b)) DO UPDATE SET a = 10 - ^ -HINT: try \h INSERT -~~~ - -[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/67893) diff --git a/src/current/_includes/v21.2/sql/function-special-forms.md b/src/current/_includes/v21.2/sql/function-special-forms.md deleted file mode 100644 index b9ac987444a..00000000000 --- a/src/current/_includes/v21.2/sql/function-special-forms.md +++ /dev/null @@ -1,29 +0,0 @@ -| Special form | Equivalent to | -|-----------------------------------------------------------|---------------------------------------------| -| `AT TIME ZONE` | `timezone()` | -| `CURRENT_CATALOG` | `current_catalog()` | -| `COLLATION FOR` | `pg_collation_for()` | -| `CURRENT_DATE` | `current_date()` | -| `CURRENT_ROLE` | `current_user()` | -| `CURRENT_SCHEMA` | `current_schema()` | -| `CURRENT_TIMESTAMP` | `current_timestamp()` | -| `CURRENT_TIME` | `current_time()` | -| `CURRENT_USER` | `current_user()` | -| `EXTRACT(