title	summary	toc	docs_area
cockroach-sql	cockroach-sql is a client for executing SQL statements from an interactive shell or directly from the command line.	true	reference.cli

{% assign release = site.data.releases | where_exp: "release", "release.major_version == page.version.version" | last %}

The cockroach-sql command is a client for executing SQL statements from an interactive shell or directly from the command line. To use this client, run cockroach-sql as described below.

{{site.data.alerts.callout_info}} cockroach-sql is functionally equivalent to the cockroach sql command. {{site.data.alerts.end}}

To exit the interactive shell, use \q, quit, exit, or ctrl-d.

Install `cockroach-sql`

Linux Mac Windows

Download the binary and copy it into your PATH.

{% include_cached copy-clipboard.html %} ~~~ shell curl https://binaries.cockroachdb.com/cockroach-sql-{{ page.release_info.version }}.linux-amd64.tgz | tar -xz && sudo cp -i cockroach-sql-{{ page.release_info.version }}.linux-amd64/cockroach-sql /usr/local/bin/ && if [ ! -f /usr/local/bin/cockroach ]; then sudo ln -s /usr/local/bin/cockroach-sql /usr/local/bin/cockroach; fi ~~~

If you don't have an existing cockroach binary in /usr/local/bin this will create a symbolic link to cockroach so you can use the cockroach sql command.

{% include_cached copy-clipboard.html %} ~~~ shell curl https://binaries.cockroachdb.com/cockroach-sql-{{ r.version }}.darwin-10.9-amd64.tgz | tar -xz && sudo cp -i cockroach-sql-{{ r.version }}.darwin-10.9-amd64/cockroach-sql /usr/local/bin && if [ ! -f /usr/local/bin/cockroach ]; then sudo ln -s /usr/local/bin/cockroach-sql /usr/local/bin/cockroach; fi ~~~

If you don't have an existing cockroach binary in /usr/local/bin this will create a symbolic link to cockroach so you can use the cockroach sql command.

Open a PowerShell terminal as an Administrator, then run the following command:

{% include_cached copy-clipboard.html %}

$ErrorActionPreference = "Stop"; [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12;$ProgressPreference = 'SilentlyContinue'; $null = New-Item -Type Directory -Force $env:appdata/cockroach; Invoke-WebRequest -Uri https://binaries.cockroachdb.com/cockroach-sql-{{ page.release_info.version }}.windows-6.2-amd64.zip -OutFile cockroach-sql.zip; Expand-Archive -Force -Path cockroach-sql.zip; Copy-Item -Force "cockroach-sql/cockroach-sql-{{ page.release_info.version }}.windows-6.2-amd64/cockroach-sql.exe" -Destination $env:appdata/cockroach; $Env:PATH += ";$env:appdata/cockroach"; if (!(Test-Path "$env:appdata/cockroach/cockroach.exe")) { New-Item -ItemType SymbolicLink -Path $env:appdata/cockroach/cockroach.exe -Target $env:appdata/cockroach/cockroach-sql.exe }

If you don't have an existing cockroach binary in $env:appdata/cockroach/ this will create a symbolic link to cockroach so you can use the cockroach sql command.

Or you can download the [binary from the releases page](../releases/{{ page.version.version }}.html) and install it manually.

Prerequisites

The role option of the user logging in must be LOGIN or SQLLOGIN, which are granted by default. If the user's role option has been set to NOLOGIN or NOSQLLOGIN, the user cannot log in using the SQL CLI with any authentication method.

Synopsis

Start the interactive SQL shell:

$ cockroach-sql <flags>

Execute SQL from the command line:

$ cockroach-sql --execute="<sql statement>;<sql statement>" --execute="<sql-statement>" <flags>

$ echo "<sql statement>;<sql statement>" | cockroach-sql <flags>

$ cockroach-sql <flags> --file file-containing-statements.sql

Exit the interactive SQL shell:

> \q

> quit

> exit

ctrl-d

View help:

$ cockroach-sql --help

Flags

The sql command supports the following types of flags:

General Use
Client Connection
Logging

General

To start an interactive SQL shell, run cockroach-sql with all appropriate connection flags or use just the --url flag, which includes connection details.
To execute SQL statements from the command line, use the --execute flag.

Flag	Description
`--database` `-d`	A database name to use as current database in the newly created session.
`--embedded`	Minimizes the SQL shell welcome text to be appropriate for embedding in playground-type environments. Specifically, this flag removes details that users in an embedded environment have no control over (e.g., networking information).
`--echo-sql`	Reveal the SQL statements sent implicitly by the command-line utility. For a demonstration, see the example below. This can also be enabled within the interactive SQL shell via the `\set echo` shell command.
`--execute` `-e`	Execute SQL statements directly from the command line, without opening a shell. This flag can be set multiple times, and each instance can contain one or more statements separated by semi-colons. If an error occurs in any statement, the command exits with a non-zero status code and further statements are not executed. The results of each statement are printed to the standard output (see `--format` for formatting options). For a demonstration of this and other ways to execute SQL from the command line, see the example below.
`--file <filename>` `-f <filename>` `< <filename>`	Read SQL statements from `<filename>`.
`--format`	How to display table rows printed to the standard output. Possible values: `tsv`, `csv`, `table`, `raw`, `records`, `sql`, `html`. Default: `table` for sessions that output on a terminal; `tsv` otherwise This flag corresponds to the `display_format` client-side option.
`--read-only`	New in v22.1: Sets the `default_transaction_read_only` session variable to `on` upon connecting.
`--safe-updates`	Disallow potentially unsafe SQL statements, including `DELETE` without a `WHERE` clause, `UPDATE` without a `WHERE` clause, and `ALTER TABLE ... DROP COLUMN`. Default: `true` for interactive sessions; `false` otherwise Potentially unsafe SQL statements can also be allowed/disallowed for an entire session via the `sql_safe_updates` session variable.
`--set`	Set a client-side option before starting the SQL shell or executing SQL statements from the command line via `--execute`. This flag may be specified multiple times, once per option. After starting the SQL shell, the `\set` and `unset` commands can be use to enable and disable client-side options as well.
`--watch`	Repeat the SQL statements specified with `--execute` or `-e` until a SQL error occurs or the process is terminated. `--watch` applies to all `--execute` or `-e` flags in use. You must also specify an interval at which to repeat the statement, followed by a time unit. For example, to specify an interval of 5 seconds, use `5s`. Note that this flag is intended for simple monitoring scenarios during development and testing. See the example below.

Client connection

{% include {{ page.version.version }}/sql/connection-parameters.md %}

See Client Connection Parameters for more details.

Logging

{% include {{ page.version.version }}/misc/logging-defaults.md %}

Session and output types

cockroach-sql exhibits different behaviors depending on whether or not the session is interactive and/or whether or not the session outputs on a terminal.

A session is interactive when cockroach-sql is invoked without the --execute flag and input is not redirected from a file. In such cases:
- The errexit option defaults to false.
- The check_syntax option defaults to true if supported by the CockroachDB server (this is checked when the shell starts up).
- Ctrl+C at the prompt will only terminate the shell if no other input was entered on the same line already.
- The shell will attempt to set the safe_updates session variable to true on the server.
A session outputs on a terminal when output is not redirected to a file. In such cases:
- The --format flag and its corresponding display_format option default to table. These default to tsv otherwise.
- The show_times option defaults to true.

When a session is both interactive and outputs on a terminal, cockroach-sql also activates the interactive prompt with a line editor that can be used to modify the current line of input. Also, command history becomes active.

SQL shell

Welcome message

When the SQL shell connects (or reconnects) to a CockroachDB node, it prints a welcome text with some tips and CockroachDB version and cluster details:

#
# Welcome to the CockroachDB SQL shell.
# All statements must be terminated by a semicolon.
# To exit, type: \q.
#
# Server version: CockroachDB CCL {{page.release_info.version}} (x86_64-apple-darwin17.7.0, built 2019/09/13 00:07:19, go1.12.6) (same version as client)
# Cluster ID: 7fb9f5b4-a801-4851-92e9-c0db292d03f1
#
# Enter \? for a brief introduction.
#
>

The Version and Cluster ID details are particularly noteworthy:

When the client and server versions of CockroachDB are the same, the shell prints the Server version followed by (same version as client).
When the client and server versions are different, the shell prints both the Client version and Server version. In this case, you may want to plan an upgrade of earlier client or server versions.
Since every CockroachDB cluster has a unique ID, you can use the Cluster ID field to verify that your client is always connecting to the correct cluster.

Commands

{% include {{ page.version.version }}/sql/shell-commands.md %}

Client-side options

{% include {{ page.version.version }}/sql/shell-options.md %}

Help

{% include {{ page.version.version }}/sql/shell-help.md %}

Shortcuts

{% include {{ page.version.version }}/sql/shell-shortcuts.md %}

Error messages and `SQLSTATE` codes

When CockroachDB encounters a SQL error, it returns the following information to the client (whether cockroach-sql or another client application):

An error message, prefixed with the "Severity" field of the PostgreSQL wire protocol. For example, ERROR: insert on table "shipments" violates foreign key constraint "fk_customers".
A 5-digit SQLSTATE error code as defined by the SQL standard. For example, SQLSTATE: 23503.

For example, the following query (taken from this example of adding multiple foreign key constraints) results in a SQL error, and returns both an error message and a SQLSTATE code as described above.

{% include_cached copy-clipboard.html %}

> INSERT INTO shipments (carrier, status, customer_id) VALUES ('DHL', 'At facility', 2000);

ERROR: insert on table "shipments" violates foreign key constraint "fk_customers"
SQLSTATE: 23503
DETAIL: Key (customer_id)=(2000) is not present in table "customers".

The SQLSTATE code in particular can be helpful in the following ways:

It is a standard SQL error code that you can look up in documentation and search for on the web. For any given error state, CockroachDB tries to produce the same SQLSTATE code as PostgreSQL.
If you are developing automation that uses the CockroachDB SQL shell, it is more reliable to check for SQLSTATE values than for error message strings, which are likely to change.

Examples

Start a SQL shell

In these examples, we connect a SQL shell to a secure cluster.

{% include_cached copy-clipboard.html %}

# Using standard connection flags:
$ cockroach-sql \
--certs-dir=certs \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

{% include_cached copy-clipboard.html %}

# Using the --url flag:
$ cockroach-sql \
--url="postgresql://maxroach@12.345.67.89:26257/critterdb?sslcert=certs/client.maxroach.crt&sslkey=certs/client.maxroach.key&sslmode=verify-full&sslrootcert=certs/ca.crt"

In these examples, we connect a SQL shell to an insecure cluster.

{% include_cached copy-clipboard.html %}

# Using standard connection flags:
$ cockroach-sql --insecure \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

{% include_cached copy-clipboard.html %}

# Using the --url flag:
$ cockroach-sql \
--url="postgresql://maxroach@12.345.67.89:26257/critterdb?sslmode=disable"

Execute SQL statement within the SQL shell

This example assume that we have already started the SQL shell (see examples above).

{% include_cached copy-clipboard.html %}

> CREATE TABLE animals (id INT PRIMARY KEY DEFAULT unique_rowid(), name STRING);

{% include_cached copy-clipboard.html %}

> INSERT INTO animals (name) VALUES ('bobcat'), ('🐢 '), ('barn owl');

{% include_cached copy-clipboard.html %}

> SELECT * FROM animals;

          id         |   name
---------------------+-----------
  710907071259213825 | bobcat
  710907071259279361 | 🐢
  710907071259312129 | barn owl
(3 rows)

Execute SQL statements from the command line

In these examples, we use the --execute flag to execute statements from the command line:

{% include_cached copy-clipboard.html %}

# Statements with a single --execute flag:
$ cockroach-sql --insecure \
--execute="CREATE TABLE roaches (name STRING, country STRING); INSERT INTO roaches VALUES ('American Cockroach', 'United States'), ('Brownbanded Cockroach', 'United States')" \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

CREATE TABLE
INSERT 2

{% include_cached copy-clipboard.html %}

# Statements with multiple --execute flags:
$ cockroach-sql --insecure \
--execute="CREATE TABLE roaches (name STRING, country STRING)" \
--execute="INSERT INTO roaches VALUES ('American Cockroach', 'United States'), ('Brownbanded Cockroach', 'United States')" \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

CREATE TABLE
INSERT 2

In this example, we use the echo command to execute statements from the command line:

{% include_cached copy-clipboard.html %}

# Statements with the echo command:
$ echo "SHOW TABLES; SELECT * FROM roaches;" | cockroach-sql --insecure --user=maxroach --host=12.345.67.89 --database=critterdb

  schema_name | table_name | type  | owner | estimated_row_count | locality
--------------+------------+-------+-------+---------------------+-----------
  public      | animals    | table | demo  |                   0 | NULL
  public      | roaches    | table | demo  |                   0 | NULL
(2 rows)

          name          |    country
------------------------+----------------
  American Cockroach    | United States
  Brownbanded Cockroach | United States

Control how table rows are printed

In these examples, we show tables and special characters printed in various formats.

When the standard output is a terminal, --format defaults to table and tables are printed with ASCII art and special characters are not escaped for easy human consumption:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--execute="SELECT '🐥' AS chick, '🐢' AS turtle" \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

  chick | turtle
--------+---------
  🐥    | 🐢

However, you can explicitly set --format to another format, for example, tsv or html:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--format=tsv \
--execute="SELECT '🐥' AS chick, '🐢' AS turtle" \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

chick	turtle
🐥	🐢

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--format=html \
--execute="SELECT '🐥' AS chick, '🐢' AS turtle" \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

<table>
<thead><tr><th>row</th><th>chick</th><th>turtle</th></tr></thead>
<tbody>
<tr><td>1</td><td>🐥</td><td>🐢</td></tr>
</tbody>
<tfoot><tr><td colspan=3>1 row</td></tr></tfoot></table>

When piping output to another command or a file, --format defaults to tsv:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--execute="SELECT '🐥' AS chick, '🐢' AS turtle" > out.txt \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

{% include_cached copy-clipboard.html %}

$ cat out.txt

1 row
chick	turtle
🐥	🐢

However, you can explicitly set --format to another format, for example, table:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--format=table \
--execute="SELECT '🐥' AS chick, '🐢' AS turtle" > out.txt \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

{% include_cached copy-clipboard.html %}

$ cat out.txt

  chick | turtle
--------+---------
  🐥    | 🐢
(1 row)

Show borders around the statement output within the SQL shell

To display outside and inside borders in the statement output, set the border SQL shell option to 3.

{% include_cached copy-clipboard.html %}

\set border=3
SELECT * FROM animals;

+--------------------+----------+
|         id         |   name   |
+--------------------+----------+
| 710907071259213825 | bobcat   |
+--------------------+----------+
| 710907071259279361 | 🐢       |
+--------------------+----------+
| 710907071259312129 | barn owl |
+--------------------+----------+

Make the output of `SHOW` statements selectable

To make it possible to select from the output of SHOW statements, set --format to raw:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--format=raw \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb

{% include_cached copy-clipboard.html %}

> SHOW CREATE customers;

# 2 columns
# row 1
## 14
test.customers
## 185
CREATE TABLE customers (
	id INT NOT NULL,
	email STRING NULL,
	CONSTRAINT "primary" PRIMARY KEY (id ASC),
	UNIQUE INDEX customers_email_key (email ASC),
	FAMILY "primary" (id, email)
)
# 1 row

When --format is not set to raw, you can use the display_format SQL shell option to change the output format within the interactive session:

{% include_cached copy-clipboard.html %}

> \set display_format raw

# 2 columns
# row 1
## 14
test.customers
## 185
CREATE TABLE customers (
  id INT NOT NULL,
  email STRING NULL,
  CONSTRAINT "primary" PRIMARY KEY (id ASC),
  UNIQUE INDEX customers_email_key (email ASC),
  FAMILY "primary" (id, email)
)
# 1 row

Execute SQL statements from a file

In this example, we show and then execute the contents of a file containing SQL statements.

{% include_cached copy-clipboard.html %}

$ cat statements.sql

CREATE TABLE roaches (name STRING, country STRING);
INSERT INTO roaches VALUES ('American Cockroach', 'United States'), ('Brownbanded Cockroach', 'United States');

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--user=maxroach \
--host=12.345.67.89 \
--database=critterdb \
-f statements.sql

CREATE TABLE
INSERT 2

Run external commands from the SQL shell

In this example, we use \! to look at the rows in a CSV file before creating a table and then using \| to insert those rows into the table.

{{site.data.alerts.callout_info}}This example works only if the values in the CSV file are numbers. For values in other formats, use an online CSV-to-SQL converter or make your own import program.{{site.data.alerts.end}}

{% include_cached copy-clipboard.html %}

> \! cat test.csv

12, 13, 14
10, 20, 30

{% include_cached copy-clipboard.html %}

> CREATE TABLE csv (x INT, y INT, z INT);

{% include_cached copy-clipboard.html %}

> \| IFS=","; while read a b c; do echo "insert into csv values ($a, $b, $c);"; done < test.csv;

{% include_cached copy-clipboard.html %}

> SELECT * FROM csv;

  x  | y  | z
-----+----+-----
  12 | 13 | 14
  10 | 20 | 30

In this example, we create a table and then use \| to programmatically insert values.

{% include_cached copy-clipboard.html %}

> CREATE TABLE for_loop (x INT);

{% include_cached copy-clipboard.html %}

> \| for ((i=0;i<10;++i)); do echo "INSERT INTO for_loop VALUES ($i);"; done

{% include_cached copy-clipboard.html %}

> SELECT * FROM for_loop;

Edit SQL statements in an external editor

In applications that use GNU Readline (such as bash), you can edit a long line in your preferred editor by typing Ctrl-x Ctrl-e. However, CockroachDB uses the BSD-licensed libedit, which does not include this functionality.

If you would like to be able to edit the current line in an external editor by typing C-x C-e as in bash, do the following:

Install the vipe program (from the moreutils suite of tools).
Edit your ~/.editrc to add the following line, which takes advantage of the SQL client's ability to run external commands:

{% include_cached copy-clipboard.html %}
```
cockroach:bind -s ^X^E '^A^K\\\| echo \"^Y\" | vipe\r'
```

This tells libedit to translate C-x C-e into the following commands:

Move to the beginning of the current line.
Cut the whole line.
Paste the line into your editor via vipe.
Pass the edited file back to the SQL client when vipe exits.

{{site.data.alerts.callout_info}} Future versions of the SQL client may opt to use a different back-end for reading input, in which case please refer to this page for additional updates. {{site.data.alerts.end}}

Allow potentially unsafe SQL statements

The --safe-updates flag defaults to true. This prevents SQL statements that may have broad, undesired side-effects. For example, by default, we cannot use DELETE without a WHERE clause to delete all rows from a table:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure --execute="SELECT * FROM db1.t1"

  id | name
-----+-------
   1 | a
   2 | b
   3 | c
   4 | d
   5 | e
   6 | f
   7 | g
   8 | h
   9 | i
  10 | j
-----+-------
(10 rows)

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure --execute="DELETE FROM db1.t1"

Error: pq: rejected: DELETE without WHERE clause (sql_safe_updates = true)
Failed running "sql"

However, to allow an "unsafe" statement, you can set --safe-updates=false:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure --safe-updates=false --execute="DELETE FROM db1.t1"

DELETE 10

{{site.data.alerts.callout_info}}Potentially unsafe SQL statements can also be allowed/disallowed for an entire session via the sql_safe_updates session variable.{{site.data.alerts.end}}

Reveal the SQL statements sent implicitly by the command-line utility

In this example, we use the --execute flag to execute statements from the command line and the --echo-sql flag to reveal SQL statements sent implicitly:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--execute="CREATE TABLE t1 (id INT PRIMARY KEY, name STRING)" \
--execute="INSERT INTO t1 VALUES (1, 'a'), (2, 'b'), (3, 'c')" \
--user=maxroach \
--host=12.345.67.89 \
--database=db1
--echo-sql

# Server version: CockroachDB CCL f8f3c9317 (darwin amd64, built 2017/09/13 15:05:35, go1.8) (same version as client)
# Cluster ID: 847a4ba5-c78a-465a-b1a0-59fae3aab520
> SET sql_safe_updates = TRUE
> CREATE TABLE t1 (id INT PRIMARY KEY, name STRING)
CREATE TABLE
> INSERT INTO t1 VALUES (1, 'a'), (2, 'b'), (3, 'c')
INSERT 3

In this example, we start the interactive SQL shell and enable the echo shell option to reveal SQL statements sent implicitly:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--user=maxroach \
--host=12.345.67.89 \
--database=db1

{% include_cached copy-clipboard.html %}

> \set echo

{% include_cached copy-clipboard.html %}

> INSERT INTO db1.t1 VALUES (4, 'd'), (5, 'e'), (6, 'f');

> INSERT INTO db1.t1 VALUES (4, 'd'), (5, 'e'), (6, 'f');
INSERT 3

Time: 2.426534ms

> SHOW TRANSACTION STATUS
> SHOW DATABASE

Repeat a SQL statement

Repeating SQL queries on a table can be useful for monitoring purposes. With the --watch flag, you can repeat the statements specified with a --execute or -e flag periodically, until a SQL error occurs or the process is terminated.

For example, if you want to monitor the number of queries running on the current node, you can use cockroach-sql with the --watch flag to query the node's crdb_internal.node_statement_statistics table for the query count:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --insecure \
--execute="SELECT SUM(count) FROM crdb_internal.node_statement_statistics" \
--watch 1m

  sum
-------
  926
(1 row)
  sum
--------
  4227
(1 row)
^C

In this example, the statement is executed every minute. We let the process run for a couple minutes before terminating it with Ctrl+C.

Connect to a cluster listening for Unix domain socket connections

To connect to a cluster that is running on the same machine as your client and is listening for Unix domain socket connections, specify a Unix domain socket URI with the --url connection parameter.

For example, suppose you start a single-node cluster with the following cockroach start-single-node command:

{% include_cached copy-clipboard.html %}

$ cockroach start-single-node --insecure --socket-dir=/tmp

CockroachDB node starting at 2020-10-12 04:02:54.971369 +0000 UTC (took 1.3s)
build:               CCL v20.2.0 @ 2020/10/06 17:15:06 (go1.13.14)
webui:               http://Jesses-MBP-2:8080
sql:                 postgresql://root@Jesses-MBP-2:26257?sslmode=disable
RPC client flags:    ./cockroach <client cmd> --host=Jesses-MBP-2:26257 --insecure
socket:              /tmp/.s.PGSQL.26257
logs:                /Users/jesseseldess/Downloads/cockroach-v20.2.0-beta.4.darwin-10.9-amd64/cockroach-data/logs
temp dir:            /Users/jesseseldess/Downloads/cockroach-v20.2.0-beta.4.darwin-10.9-amd64/cockroach-data/cockroach-temp805054895
external I/O path:   /Users/jesseseldess/Downloads/cockroach-v20.2.0-beta.4.darwin-10.9-amd64/cockroach-data/extern
store[0]:            path=/Users/jesseseldess/Downloads/cockroach-v20.2.0-beta.4.darwin-10.9-amd64/cockroach-data
storage engine:      pebble
status:              initialized new cluster
clusterID:           455ad71d-21d4-424a-87ad-8097b6b5b99f
nodeID:              1

To connect to this cluster with a socket:

{% include_cached copy-clipboard.html %}

$ cockroach-sql --url='postgres://root@?host=/tmp&port=26257'

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cockroach-sql-binary.md

cockroach-sql-binary.md

Install `cockroach-sql`

Prerequisites

Synopsis

Flags

General

Client connection

Logging

Session and output types

SQL shell

Welcome message

Commands

Client-side options

Help

Shortcuts

Error messages and `SQLSTATE` codes

Examples

Start a SQL shell

Execute SQL statement within the SQL shell

Execute SQL statements from the command line

Control how table rows are printed

Show borders around the statement output within the SQL shell

Make the output of `SHOW` statements selectable

Execute SQL statements from a file

Run external commands from the SQL shell

Edit SQL statements in an external editor

Allow potentially unsafe SQL statements

Reveal the SQL statements sent implicitly by the command-line utility

Repeat a SQL statement

Connect to a cluster listening for Unix domain socket connections

See also

Files

cockroach-sql-binary.md

Latest commit

History

cockroach-sql-binary.md

File metadata and controls

Install cockroach-sql

Prerequisites

Synopsis

Flags

General

Client connection

Logging

Session and output types

SQL shell

Welcome message

Commands

Client-side options

Help

Shortcuts

Error messages and SQLSTATE codes

Examples

Start a SQL shell

Execute SQL statement within the SQL shell

Execute SQL statements from the command line

Control how table rows are printed

Show borders around the statement output within the SQL shell

Make the output of SHOW statements selectable

Execute SQL statements from a file

Run external commands from the SQL shell

Edit SQL statements in an external editor

Allow potentially unsafe SQL statements

Reveal the SQL statements sent implicitly by the command-line utility

Repeat a SQL statement

Connect to a cluster listening for Unix domain socket connections

See also

Install `cockroach-sql`

Error messages and `SQLSTATE` codes

Make the output of `SHOW` statements selectable