Command referencesΒΆ

Usage: pool [OPTIONS] COMMAND [ARGS]...

  the `pool` command provides sub commands to run imports from eawag data
  warehouse landing zones and supports test runs during development and
  integration of data sources

Options:
  --pdb   start python debugger in case of exceptions.
  --help  Show this message and exit.

Commands:
  add                 creates new entries in development landing zone you...
  check               checks scripts and produced results in given...
  create-example      setup landing zone in given folder with example files.
  delete-entity       This command deletes a given entity (like site,...
  delete-facts        This command deletes all facts where all filter...
  start-develop       setup local landing zone for adding new site /...
  start-rename        This creates a special development landing zone to...
  update-operational  updates operantional landing zone from development...
  admin               commands for datatpool administration
Usage: pool admin init-config [OPTIONS] LANDING_ZONE_FOLDER
                              [EXTRA_CONFIG_SETTINGS]...

  initializes /etc/datapool/ folder with config files.

  landing_zone_folder must be a non-existing folder on the current machine.

Options:
  --verbose       dumps lots of output from interaction with db
  --use-sqlitedb  use sqlite db
  --force         use this twice to overwrite existing config files
  --help          Show this message and exit.
Usage: pool admin check-config [OPTIONS]

  checks if config file(s) in /etc/datapool are valid.

Options:
  --verbose  dumps lots of output from interaction with db
  --help     Show this message and exit.
Usage: pool admin init-db [OPTIONS]

  creates empty tables in operational database. Run check_config first to see
  if the configured data base settings are valid.

Options:
  --verbose  dumps lots of output from interaction with db
  --force    use this twice to overwrite existing db
  --help     Show this message and exit.
Usage: pool check [OPTIONS] DEVELOPMENT_LANDING_ZONE_FOLDER

  checks scripts and produced results in given landing zone. does not write to
  database.

Options:
  --result-folder TEXT  provide target for results
  --verbose             might dump lots of output
  --help                Show this message and exit.
Usage: pool start-develop [OPTIONS] DEVELOPMENT_LANDING_ZONE_FOLDER

  setup local landing zone for adding new site / instrument / conversion
  script.  this command will clone the operational landing zone (might be
  empty).

Options:
  --verbose  dumps lots of output from interaction with db
  --force    use this twice to overwrite existing db
  --help     Show this message and exit.
Usage: pool update-operational [OPTIONS] DEVELOPMENT_LANDING_ZONE_FOLDER

  updates operantional landing zone from development landing zone

Options:
  --verbose         might dump lots of output
  --force           use this twice to overwrite existing landing zone in case
                    of errors when checking
  --copy-raw-files  copy raw files also to operational landing zone
  --help            Show this message and exit.
Usage: pool add [OPTIONS] WHAT [DEVELOPMENT_LANDING_ZONE_FOLDER] [SETTINGS]...

  creates new entries in development landing zone you can specify --info to
  check for available fields:

  $ pool add site --info

Options:
  --info  show more detailed info
  --help  Show this message and exit.
Usage: pool start-rename [OPTIONS] RENAME_LANDING_ZONE_FOLDER OLD_NAME
                         NEW_NAME

  This creates a special development landing zone to rename entities and
  related scripts.

Options:
  --what TEXT
  --help       Show this message and exit.
Usage: pool delete-entity [OPTIONS] NAME

  This command deletes a given entity (like site, source..) and the
  corresponding facts.

Options:
  --what TEXT
  --force             use this twice to perform deletion, else only checks are
                      performed and number of affected db entries is estimated
  --max-rows INTEGER  number of facts to print before deletion, default is 10
  --help              Show this message and exit.
Usage: pool delete-facts [OPTIONS] FACT_TABLE [FILTERS]...

  This command deletes all facts where all filter conditions are true.

  Example:

      pool delete-facts signals "timestamp>=2000-01-01" "site==abc"

  The surrounding quotes are required if symbols '<' or '>' occur in such
  expressions or if the values contain spaces.

Options:
  --force             use this twice to perform deletion, else only checks are
                      performed and number of affected db entries is estimated
  --max-rows INTEGER  number of facts to print before deletion, default is 20
  --help              Show this message and exit.
Usage: pool admin show [OPTIONS] WHAT

  shows table from data base

Options:
  --no-pager          suppress paging of larger output
  --max-rows INTEGER  number of rows to fetch from db, default is all
  --help              Show this message and exit.