Skip to content

study revert

Rob Flickenger edited this page Aug 9, 2021 · 1 revision

The biograph vdb study revert command removes checkpoints, starting with the most recent. All data from the reverted checkpoints is deleted. You can use this to roll a study back to a previous point.

With no additional options, the revert command will roll back the most recent checkpoint. To revert to a point further back, use the --checkpoint option.

$ biograph vdb study show my_study
study_name: my_study
      created_on: 2021-05-19 12:30:25
         refname: hs37d5

checkpoints:
   1: added HGDP01213: 9080bc7b-08db-4674-ab2f-f8b82441ae6e; HGDP01233: d2ed8a1d-6dd2-455b-ba7b-c2973bbf2a72; HGDP01243: 26f2763b-ec41-4959-99b2-505fb0004216; HGDP01263: 83d7acd4-595e-4394-9466-efca354da852; HGDP01273: 8880fef5-19d0-4207-ad8d-bb73032b9e2f; HGDP01283: 3f606e13-380c-4ac0-98e2-7cd8dd9bdb77; HGDP01293: 81d97984-c9b7-4fe6-9f44-2d603cfce28e
   2: include FILTER = 'PASS'
   3: include SVTYPE = 'INS'

sample_name      variant_count
HGDP01213        11449
HGDP01233        16511
HGDP01243        11847
HGDP01263        17773
HGDP01273        16431
HGDP01283        13677
HGDP01293        16224

$ biograph vdb study revert my_study
Removing S3 data for 'my_study' at checkpoint 3
Dropping SQL partitions for 'my_study' at checkpoint 3
Study 'my_study' reverted to checkpoint 2

$ biograph vdb study show my_study
study_name: my_study
      created_on: 2021-05-19 12:30:25
         refname: hs37d5

checkpoints:
   1: added HGDP01213: 9080bc7b-08db-4674-ab2f-f8b82441ae6e; HGDP01233: d2ed8a1d-6dd2-455b-ba7b-c2973bbf2a72; HGDP01243: 26f2763b-ec41-4959-99b2-505fb0004216; HGDP01263: 83d7acd4-595e-4394-9466-efca354da852; HGDP01273: 8880fef5-19d0-4207-ad8d-bb73032b9e2f; HGDP01283: 3f606e13-380c-4ac0-98e2-7cd8dd9bdb77; HGDP01293: 81d97984-c9b7-4fe6-9f44-2d603cfce28e
   2: include FILTER = 'PASS'

sample_name      variant_count
HGDP01213        3842924
HGDP01233        4466976
HGDP01243        3926228
HGDP01263        4666962
HGDP01273        4638898
HGDP01283        4724812
HGDP01293        4446851

Getting more help

$ biograph vdb study revert --help
usage: biograph vdb study revert [-h] [--checkpoint CHECKPOINT] study_name

Revert to a previous checkpoint

positional arguments:
  study_name            Name of the study

optional arguments:
  -h, --help            show this help message and exit
  --checkpoint CHECKPOINT
                        Revert to this checkpoint (default: roll back one)
Clone this wiki locally