Skip to content

Arguments for Dataset Dump Include Private and States #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JVickery-TBS wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Arguments for Dataset Dump Include Private and States #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a4c63e
feat(dev): package list;
JVickery-TBS Dec 23, 2025
b151bd8
fix(lint): typing;
JVickery-TBS Dec 23, 2025
51c08a7
fix(lint): typing;
JVickery-TBS Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion ckanapi/cli/dump.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,10 @@ def dump_things(ckan, thing, arguments,
}[thing]
params = dict(
all_fields=False, # for user_list
)
include_private='--include-private' in arguments, # for package_list
include_drafts='--include-drafts' in arguments, # for package_list
include_deleted='--include-deleted' in arguments, # for package_list
)
names = ckan.call_action(get_thing_list, params)

else:
Expand Down
5 changes: 4 additions & 1 deletion ckanapi/cli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
[[-c CONFIG] [-u USER] | -r SITE_URL [-a APIKEY] [--insecure]]
ckanapi dump (datasets | groups | organizations | users | related)
(ID_OR_NAME ... | --all) ([-O JSONL_OUTPUT] | [-D DIRECTORY])
[-p PROCESSES] [-dqwzRU]
[-p PROCESSES] [-dqwzRU --include-private --include-drafts --include-deleted]
[[-c CONFIG] [-u USER] | -r SITE_URL [-a APIKEY] [-g] [--insecure]]
ckanapi load datasets
[--upload-resources] [-I JSONL_INPUT] [-s START] [-m MAX]
Expand Down Expand Up @@ -44,6 +44,9 @@
defaults to $CKAN_INI or development.ini
-d --datastore-fields export datastore field information along with
resource metadata as datastore_fields lists
--include-private include private datasets in the dump
--include-drafts include draft datasets in the dump
--include-deleted include deleted datasets in the dump
-D --datapackages=DIR download resources and output as datapackages
in DIR instead of metadata-only json lines
-g --get-request use GET instead of POST for API calls
Expand Down