Skip to content

Overview

CockroachDB plugin helps to virtualize CockroachDB data source leveraging the built-in cockroach backup and restore procedures. You can use the BACKUP statements to efficiently backup cockroach cluster and data to popular cloud services such as AWS S3, Google Cloud Storage, or NFS, and the RESTORE statement to efficiently restore schema and data as necessary.

Supported Backup Mechanisms:

  • AWS S3 backup : Backup location on AWS S3 bucket should be accessible from Staging host.

    • Backup: CockroachDB’s BACKUP statement to create full or incremental backups of your cluster’s schema and data that are consistent as of a given timestamp.
    • Full Cluster Backup 
      BACKUP INTO 's3://{BUCKET NAME}?AWS_ACCESS_KEY_ID={KEY ID}&AWS_SECRET_ACCESS_KEY={SECRET ACCESS KEY}' AS OF SYSTEM TIME '-10s';
    • Incremental Backup 
      BACKUP INTO LATEST IN 's3://{BUCKET NAME}?AWS_ACCESS_KEY_ID={KEY ID}&AWS_SECRET_ACCESS_KEY={SECRET ACCESS KEY}' AS OF SYSTEM TIME '-10s';
    • Restore: CockroachDB’s RESTORE statement restores your cluster’s schemas and data from a BACKUP stored on services such as AWS S3, Google Cloud Storage, or NFS.
    • Full Cluster Restore 
      RESTORE FROM LATEST IN 's3://{bucket_name}?AWS_ACCESS_KEY_ID={key_id}&AWS_SECRET_ACCESS_KEY={access_key}';

  • Disk backup : Backup location on Disk / NFS should be accessible from Staging host.

    • Backup: CockroachDB’s BACKUP statement to create full or incremental backups of your cluster’s schema and data that are consistent as of a given timestamp.
    • Full Cluster Backup 
      BACKUP INTO 'nodelocal://{DIRECTORY PATH INSIDE EXTERN IO DIR}' AS OF SYSTEM TIME '-10s';
    • Incremental Backup 
      BACKUP INTO LATEST IN 'nodelocal://{DIRECTORY PATH INSIDE EXTERN IO DIR}' AS OF SYSTEM TIME '-10s';
    • Restore: CockroachDB’s RESTORE statement restores your cluster’s schemas and data from a BACKUP stored on services such as AWS S3, Google Cloud Storage, or NFS.
    • Full Cluster Restore 
      RESTORE FROM LATEST IN 'nodelocal://{DIRECTORY PATH INSIDE EXTERN IO DIR}';

CockroachDB plugin allows you to use existing CockroachDB Backups as the source of dataset in Delphix. CockroachDB Plugin supports following use cases:

  1. Ingest Full and Incremental Backups using AWS S3 backups accessible from staging host. [ AWS S3 Amazon Simple Storage Service ]
  2. Ingest Full and Incremental Backups using Disk/NFS backups accessible from staging host.
  3. Create SEED database which you can fill with any data you like through any technique (built-in load generators, SQL Statements, IMPORT). Periodic snapshots can be taken and VDBs can be created from this database. Purpose for migrating existing applications to CockroachDB.