Repository navigation
HDXDSYS-3010 - Add datastore query and dump helpers to Resource - #115
Merged
Merged
Conversation
Add search_datastore, get_datastore_records, get_datastore_fields, search_datastore_sql, get_datastore_dump_url and download_datastore. Document datastore methods.
|
coverage: 97.187% (+0.05%) from 97.135% — datastore_queries into main |
mcarans
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds read helpers to
Resourcealongside the existingcreate_datastore/update_datastore/delete_datastore:search_datastore(filters, q, fields, sort, distinct, limit, offset, include_total, **kwargs)datastore_search, returns the result dictget_datastore_records(..., page_size=10000)datastore_search, generator paging through all matching rowsget_datastore_fields()datastore_searchwithlimit=0, excludes_idResource.search_datastore_sql(sql, configuration=None)datastore_search_sql, returns recordsget_datastore_dump_url(file_format="csv")/datastore/dump/{id}(csv, tsv, json, xml)download_datastore(folder, filename, file_format, retriever)get_ckan_ready_session, likedownload()Failures raise
HDXError(via_write_to_hdx). A new "Datastore" section indocumentation/index.mdcovers these and the existing datastore methods.hdx-scraper-jenkinsbuildsandhdx-scraper-jenkinsstatsbuild dump URLs by hand and could usedownload_datastoreonce released.Testing
aid-worker-security-data-global(5905 rows): all helpers worked, including full paging, SQL and dumps in all four formats./datastore/dump/behind basic auth (WWW-Authenticate: Basic realm="restricted").