API Reference

pgclone.dump(*, exclude=None, pre_dump_hooks=None, instance=None, database=None, storage_location=None, config=None)[source]

Dumps a database.

Parameters

  • exclude (List[str], default=None) – The models to exclude when dumping the utils.

  • pre_dump_hooks (List[str], default=None) – A list of management command names to run before dumping the utils.

  • instance (str, default=None) – The instance name to use in the dump key.

  • database (str, default=None) – The database to dump.

  • storage_location (str, default=None) – The storage location to store dumps.

  • config (str, default=None) – The configuration name from settings.PGCLONE_CONFIGS.

Returns

The dump key associated with the database dump.

Return type

str

pgclone.ls(dump_key=None, *, instances=False, databases=False, configs=False, local=False, database=None, storage_location=None, config=None)[source]

Lists dump keys.

Parameters

  • dump_key (str, default=None) – Filter by this dump key prefix.

  • instances (boolean, default=False) – Lists only the unique instances associated with the dump keys.

  • databases (boolean, default=False) – Lists only the unique databases associated with the dump keys.

  • configs (boolean, default=False) – Lists only the unique configs associated with the dump keys.

  • local (bool, default=False) – Only list local restore keys.

  • database (str, default=None) – The database to restore.

  • storage_location (str, default=None) – The storage location to use for the restore.

  • config (str, default=None) – The configuration name from settings.PGCLONE_CONFIGS.

Returns

The list of dump keys.

Return type

List[str]

pgclone.restore(dump_key=None, *, pre_swap_hooks=None, reversible=None, database=None, storage_location=None, config=None)[source]

Restores a database dump.

Parameters

  • dump_key (str, default=None) – Restores the specific dump key or the most recent dump matching the prefix.

  • pre_swap_hooks (List[str], default=None) – The list of pre-swap hooks to run before swapping the temp restore database with the main utils. The strings are management command names.

  • reversible (bool, default=None) – True if the dump can be reversed.

  • database (str, default=None) – The database to restore.

  • storage_location (str, default=None) – The storage location to use for the restore.

  • config (str, default=None) – The configuration name from settings.PGCLONE_CONFIGS.

Returns

The dump key that was restored.

Return type

str