Search for data using specific keywords.
The search uses the Data Catalog Cross Search System API.
If multiple keywords are used, specify space-separated strings.
dim search [options] <keyword>optional
Number of items to limit search results to.
A number between 1 and 100 can be specified.
The default value is set at 10.
optional
Download data from search results interactively.
In interactive installations, data search, retrieval, and post-processing are specified interactively.
Select the data you want to download from the search results.
The data selection uses a number allocated to each search result data.
The numbers are in the form 1.[Data name].
Specify a unique name.
This unique name will be used to specify the data in update and uninstall.
Also used as the name of a subdirectory storing data in the data_files directory.
If unspecified, it is automatically generated from xckan_title of the dataset name and name of the resource name.
The xckan_title and name are JSON keys obtained from the Data Catalog Cross Search System.
Specify post-processing for downloaded files.
(can be set multiple times)
| process name | description |
|---|---|
| unzip | Unzip the zip file downloaded on data_files/<name>. |
| encode <encoding> | Change the character encoding of the downloaded file. Supported encoding：UTF-16, UTF-16BE, UTF-16LE, UTF-8, ISO-2022-JP, Shift_JIS, EUC-JP, UNICODE |
| xlsx-to-csv | Convert the downloaded xlsx file to a csv file, and store in data_files/<name>. |
| csv-to-json | Convert the downloaded csv file to a json file, and store in data_files/<name>. |
| cmd <command> | Execute the command with the path of the downloaded file as an argument. |
# Search by specifying keyword.
dim search "Tokyo"
# Search by specifying two keywords.
dim search "Tokyo population"
# Show only one retrieved dataset.
dim search -n 1 "Tokyo"
# [title]
# - Catalog URL : URL of the site where the dataset is published
# - Catalog Description : Description of data set
# - Catalog License : licence
# 1. [Data name]
# * Resource URL : URL of the resource
# * Resource Description : Description of resource
# * Created : creation day
# * Format : File format
# 2. [Data name]
# .
# .
# .
# .
#
# [title]
# .
# .
# .
# .
# Interactively download data from retrieved datasets
dim search -i "Tokyo"
# Specify the number of data you want to download.
? Enter the number of data to install › 1
# Specify a unique name.
? Enter the name. Enter blank if want to use CKAN resource name. › example
# Specify post-processing.
? Enter the post-processing you want to add. Enter blank if not required. › encode utf-8
# Confirmation of additional post-processing.
? Is there a post-processing you would like to add next? (Y/n) › No