CKAN icon

CKAN

Interact with the CKAN API

Datastore Search

AI-generated

Summary

Search rows in a CKAN DataStore table using full-text search and optional column filters, field selection, sorting, distinct results, and pagination. Set the CKAN URL and required resource ID; each successful input item returns the API result under data.

Inputs

  • CKAN URL (required) — URL of the CKAN instance, such as https://demo.ckan.org.
  • Resource Id (required) — Unique ID of the DataStore resource to query.
  • Q — Full-text search query applied across text columns.
  • Filters — JSON object of column equality filters, such as {"country":"Germany","year":2023}.
  • Fields — Comma-separated columns to return; omitted to return all columns.
  • Sort — Sort order, such as "date desc"; separate multiple fields with commas.
  • Distinct — Return only unique rows. Defaults to false.
  • Limit — Maximum rows to return; defaults to 100, with an upper limit of 32,000.
  • Offset — Number of rows to skip for pagination; defaults to 0.

Output shape

One item per input item, containing a single record with success: true and data set to CKAN's result.

The request uses CKAN's datastore_search GET action. If “Continue On Fail” is enabled, failed items instead contain an error message.

Links

Discussion