Skip to main content

A python command line tool to provide the commands necessary to run on citus to have a balanced cluster

Project description

# Citus loader

Citus loader is a tool that will allow you to do dump and restore on citus formations.

Here is how it works:

## citus-dump

The command citus-dump will:

  • Do a schema dump of your formation

  • Create a file with the distribute statements

  • Take a pg_dump of each of your nodes and coordinator.

Here are the options you can configure:

  • host: should the the host of your initial formation

  • db: database you want to dump

  • port: default 5432

  • pwd: password

  • pg_dump: if necessary, the path to the pg_dump you want to use

  • pg_dump_jobs: value of the –jobs argument in pg_dump

  • parallel_tasks: number of pg_dump tasks running in parallel

  • dump_schema: default True, take a pg_dump of the schema

  • dump_data: default True, take a pg_dump of the data

  • ignore_write_locks: by default, citus-dump will try to lock the tables to ensure that before running pg_dump, no insert/update/delete statement is running on the workers.

  • config_file: path to your yaml file with the configuration for the citus-dump command

We strongly recommend using a yaml configurattion file. You can find an example in tests/configuration.yml

## citus-restore

On your destination formation, citus-restore will:

  • Restore the schema

  • Distribute the tables

  • Restore the shards to their appropriate worker.

  • host: should the the host of your destination formation

  • db: database you want to reestore

  • port: default 5432

  • pwd: password

  • pg_restore: if necessary, the path to the pg_dump you want to use

  • pg_restore_jobs: value of the –jobs argument in pg_restore

  • parallel_tasks: number of pg_dump tasks running in parallel

  • restore_schema: default True, restores the schema and distribute the tables

  • restore_data: default True, does a pg_restore of the shards data

  • config_file: path to your yaml file with the configuration for the citus-restore command

We strongly recommend using a yaml configurattion file. You can find an example in tests/configuration.yml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py-citus-loader-2.1.0.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

py_citus_loader-2.1.0-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file py-citus-loader-2.1.0.tar.gz.

File metadata

  • Download URL: py-citus-loader-2.1.0.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.7

File hashes

Hashes for py-citus-loader-2.1.0.tar.gz
Algorithm Hash digest
SHA256 978ff48c89ffcd0e8b832fb5a18328f0df62146fce03dd8bffdaff1306ba0354
MD5 50277db894f2c48b07af16b2b2921d98
BLAKE2b-256 d54fbfec8638ca29c296df80d0b66e627a4e0ed7817a297cf53ffc8ec1134400

See more details on using hashes here.

File details

Details for the file py_citus_loader-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: py_citus_loader-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.7

File hashes

Hashes for py_citus_loader-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 56baa38ee1172d9ae1289d4d98e00c50469592feca01c45789ecd1cd962a3d3d
MD5 ab6eb103a6e5c15649f97daddcfbd8d0
BLAKE2b-256 01ccfe69ea3d425d5cb22ba1b8e4e216400988f534a4be11ea531d577013eeb5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page