Options
An option has the following caracteristics:
- it has a name prefixed by two hyphens (e.g.
--version). - it may have a shortcut prefixed by one hyphen (e.g.
-his a shortcut of--help). - it is case-sensitive
Shortcuts can be grouped behind one hyphen (e.g. -vh is equivalent to -v -h).
The options default values are system-independent.
General-purpose options used by various commands.
| Name | Shortcut | Parameter | Description |
|---|---|---|---|
--verbose |
-v |
- | Enable verbose mode. |
--explain |
- | - | Show execution plan on stderr. |
--help |
-h |
- | Show this help message and exit. |
--version |
-V |
- | Print version information and exit. |
--no-parallel |
- | - | Disable parallel execution. |
--sort |
- | - | Sort output by natural order. |
SDMX-specific options.
| Name | Shortcut | Parameter | Description |
|---|---|---|---|
--sources |
-s |
<file> |
File that provides data source definitions. |
--database |
-d |
<database> |
Database reference. |
--languages |
-l |
<langs> |
Language priority list. |
Options shared by every list subcommand to search/rank results by free text instead of listing everything.
When --query is empty (the default), results are returned sorted/unranked instead.
| Name | Shortcut | Parameter | Description |
|---|---|---|---|
--query |
-q |
<query> |
Free-text search query, with typo-tolerant ranking. |
--max-results |
-m |
<n> |
Maximum number of results to return (default: 0, meaning no limit). |
Options used by list flows and search flows to clean up the flow Description column.
| Name | Shortcut | Parameter | Description |
|---|---|---|---|
--plain-description |
- | - | Strip markup (e.g. HTML tags) and collapse whitespace in descriptions. |
--max-description-length |
- | <length> |
Maximum length of descriptions, truncated with an ellipsis (default: 0, meaning no limit). |
Optional filters that reduce the observations returned by the fetch data command.
When a data source cannot apply a filter server-side, it is applied client-side after download,
so the result is always consistent (but the download is not necessarily smaller).
| Name | Shortcut | Parameter | Description |
|---|---|---|---|
--start |
- | <period> |
Start period (inclusive), e.g. 2020. |
--end |
- | <period> |
End period (inclusive), e.g. 2020-12. |
--first-n |
- | <count> |
Keep only the first N observations per series. |
--last-n |
- | <count> |
Keep only the last N observations per series. |
When --first-n and --last-n are combined, the result is the union of the first N and the last N
observations of each series (computed independently after any period filtering).
CSV options used to output content.
The format is RFC4180.
| Name | Shortcut | Parameter | Description |
|---|---|---|---|
--output |
-o |
<file> |
Output to a file instead of stdout. |
--gzipped |
-z |
- | Compress the output file with gzip. |
--append |
- | - | Append to the end of the output file. |
--encoding |
-e |
<encoding> |
Charset used to encode text. |
Network-related options used to deal with performance, proxies, security and authentication.
| Name | Shortcut | Parameter | Description |
|---|---|---|---|
--[no-]auto-proxy |
- | - | Enable automatic proxy detection. |
--[no-]curl |
- | - | Use curl backend instead of JDK. |
--[no-]default-ssl |
- | - | Disable default truststore. |
--[no-]system-ssl |
- | - | Disable system truststore. |
--no-cache |
- | - | Disable caching. |
--system-auth |
- | - | Disable system authentication. |
--user |
- | <user:password> |
Specify the user and password to use for server authentication. |