The cockroach dump command outputs the SQL statements required to recreate tables, views, and sequences. This command can be used to back up or export each database in a cluster. The output should also be suitable for importing into other relational databases, with minimal adjustments.
CockroachDB enterprise license users can also back up their cluster's data using BACKUP.
Considerations
When cockroach dump is executed:
- Table, sequence, and view schemas and table data are dumped as they appeared at the time that the command is started. Any changes after the command starts will not be included in the dump.
- Table and view schemas are dumped in the order in which they can successfully be recreated. As of v2.0, this is true of sequences as well.
- If the dump takes longer than the
ttlsecondsreplication setting for the table (25 hours by default), the dump may fail. - Reads, writes, and schema changes can happen while the dump is in progress, but will not affect the output of the dump.
The user must have the SELECT privilege on the target table(s).
Synopsis
Dump the schemas and data of specific tables to stdout:
$ cockroach dump <database> <table> <table...> <flags>
Dump just the data of specific tables to stdout:
$ cockroach dump <database> <table> <table...> --dump-mode=data <other flags>
Dump just the schemas of specific tables to stdout:
$ cockroach dump <database> <table> <table...> --dump-mode=schema <other flags>
Dump the schemas and data of all tables in a database to stdout:
$ cockroach dump <database> <flags>
Dump just the schemas of all tables in a database to stdout:
$ cockroach dump <database> --dump-mode=schema <other flags>
Dump just the data of all tables in a database to stdout:
$ cockroach dump <database> --dump-mode=data <other flags>
Dump to a file:
$ cockroach dump <database> <table> <flags> > dump-file.sql
View help:
$ cockroach dump --help
Flags
The dump command supports the following general-use and logging flags.
General
| Flag | Description |
|---|---|
--as-of |
Dump table schema and/or data as they appear at the specified timestamp. See this example for a demonstration. Note that historical data is available only within the garbage collection window, which is determined by the ttlseconds replication setting for the table (25 hours by default). If this timestamp is earlier than that window, the dump will fail.Default: Current time |
--dump-mode |
Whether to dump table and view schemas, table data, or both. To dump just table and view schemas, set this to schema. To dump just table data, set this to data. To dump both table and view schemas and table data, leave this flag out or set it to both.Table and view schemas are dumped in the order in which they can successfully be recreated. For example, if a database includes a table, a second table with a foreign key dependency on the first, and a view that depends on the second table, the dump will list the schema for the first table, then the schema for the second table, and then the schema for the view. Default: both |
--echo-sql |
Reveal the SQL statements sent implicitly by the command-line utility. |
Client connection
| 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_HOSTDefault: localhost:26257 |
--port-p |
The server port to connect to. Note: The port number can also be specified via --host. Env Variable: COCKROACH_PORTDefault: 26257 |
--user-u |
The SQL user that will own the client session. Env Variable: COCKROACH_USERDefault: root |
--insecure |
Use an insecure connection. Env Variable: COCKROACH_INSECUREDefault: false |
--certs-dir |
The path to the certificate directory containing the CA and client certificates and client key. Env Variable: COCKROACH_CERTS_DIRDefault: ${HOME}/.cockroach-certs/ |
--url |
A connection URL to use instead of the other arguments. Env Variable: COCKROACH_URLDefault: no URL |
See Client Connection Parameters for more details.
The user specified with --user must have the SELECT privilege on the target tables.
Logging
By default, the dump command logs errors to stderr.
If you need to troubleshoot this command's behavior, you can change its logging behavior.
Examples
These examples use our sample startrek database, which you can add to a cluster via the cockroach gen command. Also, the examples assume that the maxroach user has been granted the SELECT privilege on all target tables.
Dump a table's schema and data
$ cockroach dump startrek episodes --insecure --user=maxroach > backup.sql
$ cat backup.sql
CREATE TABLE episodes (
id INT NOT NULL,
season INT NULL,
num INT NULL,
title STRING NULL,
stardate DECIMAL NULL,
CONSTRAINT "primary" PRIMARY KEY (id),
FAMILY "primary" (id, season, num),
FAMILY fam_1_title (title),
FAMILY fam_2_stardate (stardate)
);
INSERT INTO episodes (id, season, num, title, stardate) VALUES
(1, 1, 1, 'The Man Trap', 1531.1),
(2, 1, 2, 'Charlie X', 1533.6),
(3, 1, 3, 'Where No Man Has Gone Before', 1312.4),
(4, 1, 4, 'The Naked Time', 1704.2),
(5, 1, 5, 'The Enemy Within', 1672.1),
(6, 1, 6, e'Mudd\'s Women', 1329.8),
(7, 1, 7, 'What Are Little Girls Made Of?', 2712.4),
(8, 1, 8, 'Miri', 2713.5),
(9, 1, 9, 'Dagger of the Mind', 2715.1),
(10, 1, 10, 'The Corbomite Maneuver', 1512.2),
...
Dump just a table's schema
$ cockroach dump startrek episodes --insecure --user=maxroach --dump-mode=schema > backup.sql
$ cat backup.sql
CREATE TABLE episodes (
id INT NOT NULL,
season INT NULL,
num INT NULL,
title STRING NULL,
stardate DECIMAL NULL,
CONSTRAINT "primary" PRIMARY KEY (id),
FAMILY "primary" (id, season, num),
FAMILY fam_1_title (title),
FAMILY fam_2_stardate (stardate)
);
Dump just a table's data
$ cockroach dump startrek episodes --insecure --user=maxroach --dump-mode=data > backup.sql
$ cat backup.sql
INSERT INTO episodes (id, season, num, title, stardate) VALUES
(1, 1, 1, 'The Man Trap', 1531.1),
(2, 1, 2, 'Charlie X', 1533.6),
(3, 1, 3, 'Where No Man Has Gone Before', 1312.4),
(4, 1, 4, 'The Naked Time', 1704.2),
(5, 1, 5, 'The Enemy Within', 1672.1),
(6, 1, 6, e'Mudd\'s Women', 1329.8),
(7, 1, 7, 'What Are Little Girls Made Of?', 2712.4),
(8, 1, 8, 'Miri', 2713.5),
(9, 1, 9, 'Dagger of the Mind', 2715.1),
(10, 1, 10, 'The Corbomite Maneuver', 1512.2),
...
Dump all tables in a database
$ cockroach dump startrek --insecure --user=maxroach > backup.sql
$ cat backup.sql
CREATE TABLE episodes (
id INT NOT NULL,
season INT NULL,
num INT NULL,
title STRING NULL,
stardate DECIMAL NULL,
CONSTRAINT "primary" PRIMARY KEY (id),
FAMILY "primary" (id, season, num),
FAMILY fam_1_title (title),
FAMILY fam_2_stardate (stardate)
);
CREATE TABLE quotes (
quote STRING NULL,
characters STRING NULL,
stardate DECIMAL NULL,
episode INT NULL,
INDEX quotes_episode_idx (episode),
FAMILY "primary" (quote, rowid),
FAMILY fam_1_characters (characters),
FAMILY fam_2_stardate (stardate),
FAMILY fam_3_episode (episode)
);
INSERT INTO episodes (id, season, num, title, stardate) VALUES
(1, 1, 1, 'The Man Trap', 1531.1),
(2, 1, 2, 'Charlie X', 1533.6),
(3, 1, 3, 'Where No Man Has Gone Before', 1312.4),
(4, 1, 4, 'The Naked Time', 1704.2),
(5, 1, 5, 'The Enemy Within', 1672.1),
(6, 1, 6, e'Mudd\'s Women', 1329.8),
(7, 1, 7, 'What Are Little Girls Made Of?', 2712.4),
(8, 1, 8, 'Miri', 2713.5),
(9, 1, 9, 'Dagger of the Mind', 2715.1),
(10, 1, 10, 'The Corbomite Maneuver', 1512.2),
...
INSERT INTO quotes (quote, characters, stardate, episode) VALUES
('"... freedom ... is a worship word..." "It is our worship word too."', 'Cloud William and Kirk', NULL, 52),
('"Beauty is transitory." "Beauty survives."', 'Spock and Kirk', NULL, 72),
('"Can you imagine how life could be improved if we could do away with jealousy, greed, hate ..." "It can also be improved by eliminating love, tenderness, sentiment -- the other side of the coin"', 'Dr. Roger Corby and Kirk', 2712.4, 7),
...
Dump fails (user does not have SELECT privilege)
In this example, the dump command fails for a user that does not have the SELECT privilege on the episodes table.
$ cockroach dump startrek episodes --insecure --user=leslieroach > backup.sql
Error: pq: user leslieroach has no privileges on table episodes
Failed running "dump"
Restore a table from a backup file
In this example, a user that has the CREATE privilege on the startrek database uses the cockroach sql command to recreate a table, based on a file created by the dump command.
$ cat backup.sql
CREATE TABLE quotes (
quote STRING NULL,
characters STRING NULL,
stardate DECIMAL NULL,
episode INT NULL,
INDEX quotes_episode_idx (episode),
FAMILY "primary" (quote, rowid),
FAMILY fam_1_characters (characters),
FAMILY fam_2_stardate (stardate),
FAMILY fam_3_episode (episode)
);
INSERT INTO quotes (quote, characters, stardate, episode) VALUES
('"... freedom ... is a worship word..." "It is our worship word too."', 'Cloud William and Kirk', NULL, 52),
('"Beauty is transitory." "Beauty survives."', 'Spock and Kirk', NULL, 72),
('"Can you imagine how life could be improved if we could do away with jealousy, greed, hate ..." "It can also be improved by eliminating love, tenderness, sentiment -- the other side of the coin"', 'Dr. Roger Corby and Kirk', 2712.4, 7),
...
$ cockroach sql --insecure --database=startrek --user=maxroach < backup.sql
CREATE TABLE
INSERT 100
INSERT 100
Dump table data as of a specific time
In this example, we assume there were several inserts into a table both before and after 2017-03-07 19:55:00.
First, let's use the built-in SQL client to view the table at the current time:
$ cockroach sql --insecure --execute="SELECT * FROM db1.dump_test"
+--------------------+------+
| id | name |
+--------------------+------+
| 225594758537183233 | a |
| 225594758537248769 | b |
| 225594758537281537 | c |
| 225594758537314305 | d |
| 225594758537347073 | e |
| 225594758537379841 | f |
| 225594758537412609 | g |
| 225594758537445377 | h |
| 225594991654174721 | i |
| 225594991654240257 | j |
| 225594991654273025 | k |
| 225594991654305793 | l |
| 225594991654338561 | m |
| 225594991654371329 | n |
| 225594991654404097 | o |
| 225594991654436865 | p |
+--------------------+------+
(16 rows)
Next, let's use a time-travel query to view the contents of the table as of 2017-03-07 19:55:00:
$ cockroach sql --insecure --execute="SELECT * FROM db1.dump_test AS OF SYSTEM TIME '2017-03-07 19:55:00'"
+--------------------+------+
| id | name |
+--------------------+------+
| 225594758537183233 | a |
| 225594758537248769 | b |
| 225594758537281537 | c |
| 225594758537314305 | d |
| 225594758537347073 | e |
| 225594758537379841 | f |
| 225594758537412609 | g |
| 225594758537445377 | h |
+--------------------+------+
(8 rows)
Finally, let's use cockroach dump with the --as-of flag set to dump the contents of the table as of 2017-03-07 19:55:00.
$ cockroach dump db1 dump_test --insecure --dump-mode=data --as-of='2017-03-07 19:55:00'
INSERT INTO dump_test (id, name) VALUES
(225594758537183233, 'a'),
(225594758537248769, 'b'),
(225594758537281537, 'c'),
(225594758537314305, 'd'),
(225594758537347073, 'e'),
(225594758537379841, 'f'),
(225594758537412609, 'g'),
(225594758537445377, 'h');
As you can see, the results of the dump are identical to the earlier time-travel query.
Known limitations
Dumping a table with no user-visible columns
It is not currently possible to use cockroach dump to dump the schema and data of a table with no user-defined columns. See #35462 for more details.
Importing an interleaved table from a cockroach dump output
After using cockroach dump to dump the schema and data of an interleaved table, the output must be edited before it can be imported via IMPORT. See #35462 for the workaround and more details.
See also
Was this helpful?
