Command-line interface¶
./manage.py --help
Commands¶
load¶
Load data into a collection, asynchronously.
./manage.py load [OPTIONS] PATH [PATH ...]
- -s SOURCE, --source SOURCE
the source from which the files were retrieved, if loading into a new collection (please append “_local” if the data was not collected by Kingfisher Collect)
- -t TIME, --time TIME
the time at which the files were retrieved, if loading into a new collection, in “YYYY-MM-DD HH:MM:SS” format (defaults to the earliest file modification time)
- --sample
whether the files represent a sample from the source, if loading into a new collection
- -n NOTE, --note NOTE
add a note to the collection (required for a new collection)
- -f, --force
use the provided –source value, regardless of whether it is recognized
- -u, --upgrade
upgrade collection to latest version
- -c, --compile
compile collection
- -e, --check
check collection
- -k, --keep-open
keep collection open for future file additions
addfiles¶
Load data into an open root collection, asynchronously.
./manage.py addfiles collection_id path [path ...]
closecollection¶
Close an open root collection and its upgraded child collection, if any.
./manage.py closecollection collection_id
addchecks¶
Add processing steps to check data, if unchecked.
./manage.py addchecks collection_id
deletecollection¶
Delete a collection and its ancestors.
Rows in the package_data
and data
tables are not deleted.
./manage.py deletecollection collection_id
collectionstatus¶
Get the status of a root collection and its children.
./manage.py collectionstatus collection_id
Workers¶
api_loader¶
Create collection files.
Consumes messages published by other software, like Kingfisher Collect.
./manage.py api_loader
file_worker¶
Create records, releases and compiled releases.
./manage.py file_worker
checker¶
Check collection files.
Performs no checks if the collection’s steps
field excludes “check”.
Errors if the ENABLE_CHECKER
environment variable is not set.
./manage.py checker
compiler¶
Start compilation and route messages to the record or release compilers.
Performs no checks if the collection’s steps
field excludes “compile”.
For a collection of release packages, starts compilation at most once if all collection files are loaded and the collection is closed.
./manage.py compiler
record_compiler¶
Create compiled releases from records.
./manage.py record_compiler
release_compiler¶
Create compiled releases from releases with the same OCID.
./manage.py release_compiler
finisher¶
Set collections as completed, close compiled collections and cache row counts.
./manage.py finisher
wiper¶
Delete collections and their ancestors.
Rows in the package_data
and data
tables are not deleted.
./manage.py wiper