Skip to main content

# 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

Release files for py-citus-loader 2.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-citus-loader 2.1.0
File Size Uploaded
py-citus-loader-2.1.0.tar.gz 12.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for py-citus-loader 2.1.0
File Interpreter ABI Platform
py_citus_loader-2.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 31.7 kB

Release files / py-citus-loader-2.1.0.tar.gz

Download URL py-citus-loader-2.1.0.tar.gz
Size 12.4 kB
Tags Source
SHA-256 checksum
How to use checksums
978ff48c89ffcd0e8b832fb5a18328f0df62146fce03dd8bffdaff1306ba0354
BLAKE2b-256 checksum
How to use checksums
d54fbfec8638ca29c296df80d0b66e627a4e0ed7817a297cf53ffc8ec1134400
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / py_citus_loader-2.1.0-py3-none-any.whl

Download URL py_citus_loader-2.1.0-py3-none-any.whl
Size 19.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
56baa38ee1172d9ae1289d4d98e00c50469592feca01c45789ecd1cd962a3d3d
BLAKE2b-256 checksum
How to use checksums
01ccfe69ea3d425d5cb22ba1b8e4e216400988f534a4be11ea531d577013eeb5
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

2.1.0 This release

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.11

2 release files

1.1.10

2 release files

1.1.9

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page