You are viewing an older version of this section. View current production version.
SingleStore Managed Service does not support this command.
Takes a snapshot of the given database and truncates the transaction log.
SNAPSHOT [DATABASE] <database_name>;
database_nameis the name of the database to snapshot.
- The engine variable, snapshot_trigger_size, sets a threshold for the size, in bytes, that the transaction log must reach before the next snapshot is taken.
- A user must have either the
BACKUPprivilege to run this command.
SNAPSHOT DATABASEforces a manual snapshot, and can only be run on the master aggregator.
During normal operation, SingleStore DB logs writes and DDL commands to transaction log files. When a snapshot is taken, a compact snapshot with an incremented index of the entire database is automatically written out to the disk. The transaction log is also truncated, meaning that future transactions are added to a new log with the same incremented index until the next snapshot is taken. The snapshot holds all the data, with the index, up to the point when it was taken. This occurs at the following times:
When the transaction log reached the threshold set by
After large ingests to columnstore tables, during which new columnstore segments are written or merged during ingest, and old (immutable) segments need to be cleared out. The snapshot effectively accomplishes this, since they are stored as long as the transaction log references them.
SNAPSHOT DATABASE command allows you to force a snapshot operation on a given database across all the partitions in a cluster.
SNAPSHOT DATABASE is primarily useful to compact the logs to enable faster recovery if the SingleStore DB service is
restarted. There are two situations in which we would typically recommend performing a manual
SNAPSHOT on a database:
After changing the schema of a large table using
ALTER TABLEto avoid the cost of replaying the
ALTERoperation if a leaf were ever to restart. In practice, this situation comes up most often during prototyping and development of your application when schemas are frequently changed.
Prior to performing maintenance operations (such as SingleStore DB upgrades) that require you to take leaves offline, especially if your workload is highly transactional.
Consider a database where DDL queries being run frequently cancel each other out, such as
CREATE TABLE and
DROP TABLE for the same table. These commands would always be written to the transaction log as two commands. Comparatively, a snapshot of the same set of transactions would merge out these operations. Effectively, this means reduced recovery work in cases where a snapshot is taken immediately prior to a restart or any maintenance. This is because SingleStore DB only needs to recover the snapshot, rather than replaying the transaction log and recovering the previous snapshot.
Note: For workloads with ETL transactions, some users choose to take a snapshot at the end of each transaction in order to keep the cluster ready for a restart. This is not always necessary, however. In many cases, the amount of work being done during ETL is enough to make the transaction log surpass the
snapshot_trigger_size (sometimes more than once), or enough data is ingested to trigger a snapshot.
Although taking frequent snapshots is beneficial in many cases, users who utilize DR cluster replication should exercise caution when configuring
snapshot_trigger_size or triggering manual snapshots with
SNAPSHOT DATABASE. For example, consider a case where a secondary DR cluster falls behind replaying transactions from snapshot A, while the primary cluster is logging transactions to what will be snapshot B. Then, the primary cluster ingests enough data to trigger snapshot B, and moves on to logging what will be snapshot C. The secondary cluster no longer has the capability to catch up on old write operations from snapshot A, and will reprovision instead. This causes the secondary cluster to drop its data, and start replaying the newest snapshot B from the primary cluster. While the secondary cluster reprovisions, it cannot be queried, which could impact any analytical workload running on the secondary cluster. For more information about replication, see Replicating Data Across Clusters.
SNAPSHOT DATABASE database_name; **** Query OK, 0 rows affected (45.36 sec)