Skip to content

ftmq

Usage:

ftmq [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

aggregate

In-memory aggregation of entities, allowing to merge entities with a common parent schema (as opposed to standard ftm aggregate)

Usage:

ftmq aggregate [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text input file or uri -
-o, --output-uri text output file or uri -
--downgrade boolean N/A False
--help boolean Show this message and exit. False

apply

Uplevel an entity stream to nomenklatura entities and apply dataset(s) property

Usage:

ftmq apply [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text input file or uri -
-o, --output-uri text output file or uri -
-d, --dataset text Dataset(s) to filter for None
--replace-dataset boolean N/A False
--help boolean Show this message and exit. False

catalog

Usage:

ftmq catalog [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

generate

Convert catalog YAML specification into json and fetch dataset metadata

Usage:

ftmq catalog generate [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text input file or uri -
-o, --output-uri text output file or uri -
--stats boolean Calculate stats for each dataset False
--help boolean Show this message and exit. False

iterate

Usage:

ftmq catalog iterate [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text input file or uri -
-o, --output-uri text output file or uri -
--help boolean Show this message and exit. False

dataset

Usage:

ftmq dataset [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

generate

Convert dataset YAML specification into json and optionally calculate statistics

Usage:

ftmq dataset generate [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text input file or uri -
-o, --output-uri text output file or uri -
--stats boolean Calculate stats False
--help boolean Show this message and exit. False

iterate

Usage:

ftmq dataset iterate [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text input file or uri -
-o, --output-uri text output file or uri -
--help boolean Show this message and exit. False

q

Apply ftmq filter to a json stream of ftm entities.

Usage:

ftmq q [OPTIONS] [PROPERTIES]...

Options:

Name Type Description Default
-i, --input-uri text input file or uri -
-o, --output-uri text output file or uri -
-d, --dataset text Dataset(s) to filter for None
-s, --schema text Schema(s) to filter for None
--schema-include-descendants boolean N/A False
--schema-include-matchable boolean N/A False
--sort text Properties to sort for None
--sort-ascending / --sort-descending boolean Sort in ascending order True
--stats-uri text If specified, print statistic coverage information to this uri None
--store-dataset text If specified, default dataset for source and target stores None
--sum text Properties for sum aggregation None
--min text Properties for min aggregation None
--max text Properties for max aggregation None
--avg text Properties for avg aggregation None
--count text Properties for count (distinct) aggregation None
--groups text Properties for grouping aggregation None
--aggregation-uri text If specified, print aggregation information to this uri None
--help boolean Show this message and exit. False

store

Usage:

ftmq store [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

iterate

Iterate all entities from in to out

Usage:

ftmq store iterate [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text store input uri -
-o, --output-uri text output file or uri None
--help boolean Show this message and exit. False

list-datasets

List datasets within a store

Usage:

ftmq store list-datasets [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text input file or uri -
-o, --output-uri text output file or uri -
--help boolean Show this message and exit. False

resolve

Apply nk resolver to a store

Usage:

ftmq store resolve [OPTIONS]

Options:

Name Type Description Default
-i, --input-uri text store input uri -
-o, --output-uri text output file or uri None
-r, --resolver-uri text resolver uri _required
--help boolean Show this message and exit. False