Skip to content

ftmq

Usage:

ftmq [OPTIONS] COMMAND [ARGS]...

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]

apply-dataset

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

Usage:

ftmq apply-dataset [OPTIONS]

catalog

Usage:

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

generate

Convert catalog YAML specification into json and fetch dataset metadata

Usage:

ftmq catalog generate [OPTIONS]

iterate

Usage:

ftmq catalog iterate [OPTIONS]

dataset

Usage:

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

generate

Convert dataset YAML specification into json and optionally calculate statistics

Usage:

ftmq dataset generate [OPTIONS]

iterate

Usage:

ftmq dataset iterate [OPTIONS]

fragments

Usage:

ftmq fragments [OPTIONS] COMMAND [ARGS]...

iterate

Iterate all entities from a fragments dataset

Usage:

ftmq fragments iterate [OPTIONS]

iterate-fragments

Iterate all fragments from a dataset, unsorted and not aggregated. Useful for streaming into another storage that does dedupe by itself.

Usage:

ftmq fragments iterate-fragments [OPTIONS]

list-datasets

List datasets within a fragments store

Usage:

ftmq fragments list-datasets [OPTIONS]

q

Apply ftmq filter to a json stream of ftm entities.

Writes the matching entities - or, instead of them, their coverage statistics (--stats) or the result of an aggregating query.

Usage:

ftmq q [OPTIONS]

Search stores for followthemoney entities

Usage:

ftmq search [OPTIONS] COMMAND [ARGS]...

autocomplete

Autocomplete based on entities captions

Usage:

ftmq search autocomplete [OPTIONS] {q}

index

Index a stream of search documents to a store

Usage:

ftmq search index [OPTIONS]

search

Simple search against the store

Usage:

ftmq search search [OPTIONS] {q}

transform

Create search documents from a stream of followthemoney entities

Usage:

ftmq search transform [OPTIONS]

statements

Usage:

ftmq statements [OPTIONS] COMMAND [ARGS]...

cast-types

Cast statement values into the canonical format of their property type (number, date), moving the raw value into the original_value column.

This is the format the read side (in particular the SQL backends) assumes, as followthemoney doesn't normalize these types on write.

Usage:

ftmq statements cast-types [OPTIONS]

read

Dump the raw statements of a store into a statement stream.

The rows come back as stored, external statements included and in no particular order, so the dump loads back verbatim via ftmq statements write. Only the SQL family of backends can do this.

Usage:

ftmq statements read [OPTIONS]

write

Load a statement stream into a store.

Each statement keeps the canonical_id it carries - it is never re-derived from a resolver - so a stream stamped by nomenklatura apply-statements stays resolved. A SQL store upserts on the statement id, so loading a dump back into the store it came from updates it in place.

Usage:

ftmq statements write [OPTIONS]

store

Usage:

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

iterate

Iterate all entities from in to out

Usage:

ftmq store iterate [OPTIONS]

list-datasets

List datasets within a store

Usage:

ftmq store list-datasets [OPTIONS]