Command Line Interface

felis

Felis command line tools

felis [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

--log-level <log_level>

Felis log level

Options:

CRITICAL | FATAL | ERROR | WARNING | INFO | DEBUG

--log-file <log_file>

Felis log file path

Environment variables

FELIS_LOGLEVEL

Provide a default for --log-level

FELIS_LOGFILE

Provide a default for --log-file

create

Create database objects from the Felis file

felis create [OPTIONS] FILE

Options

--engine-url <engine_url>

SQLAlchemy Engine URL

--schema-name <schema_name>

Alternate schema name to override Felis file

--initialize

Create the schema in the database if it does not exist (error if already exists)

--drop

Drop schema if it already exists in the database (implies –initialize)

--echo

Echo database commands as they are executed

--dry-run

Dry run only to print out commands instead of executing

-o, --output-file <output_file>

Write SQL commands to a file instead of executing

--ignore-constraints

Ignore constraints when creating tables

Arguments

FILE

Required argument

Environment variables

FELIS_ENGINE_URL

Provide a default for --engine-url

init-tap

Initialize TAP_SCHEMA objects in the database

felis init-tap [OPTIONS] ENGINE_URL

Options

--tap-schema-name <tap_schema_name>

Alternate database schema name for ‘TAP_SCHEMA’

--tap-schemas-table <tap_schemas_table>

Alternate table name for ‘schemas’

--tap-tables-table <tap_tables_table>

Alternate table name for ‘tables’

--tap-columns-table <tap_columns_table>

Alternate table name for ‘columns’

--tap-keys-table <tap_keys_table>

Alternate table name for ‘keys’

--tap-key-columns-table <tap_key_columns_table>

Alternate table name for ‘key_columns’

Arguments

ENGINE_URL

Required argument

load-tap

Load metadata from a Felis file into a TAP_SCHEMA database

felis load-tap [OPTIONS] FILE

Options

--engine-url <engine_url>

SQLAlchemy Engine URL

--schema-name <schema_name>

Alternate Schema Name for Felis file

--catalog-name <catalog_name>

Catalog Name for Schema

--dry-run

Dry Run Only. Prints out the DDL that would be executed

--tap-schema-name <tap_schema_name>

Alternate schema name for ‘TAP_SCHEMA’

--tap-tables-postfix <tap_tables_postfix>

Postfix for TAP_SCHEMA table names

--tap-schemas-table <tap_schemas_table>

Alternate table name for ‘schemas’

--tap-tables-table <tap_tables_table>

Alternate table name for ‘tables’

--tap-columns-table <tap_columns_table>

Alternate table name for ‘columns’

--tap-keys-table <tap_keys_table>

Alternate table name for ‘keys’

--tap-key-columns-table <tap_key_columns_table>

Alternate table name for ‘key_columns’

--tap-schema-index <tap_schema_index>

TAP_SCHEMA index of the schema in this environment

Arguments

FILE

Required argument

Environment variables

FELIS_ENGINE_URL

Provide a default for --engine-url

validate

Validate one or more Felis YAML files

felis validate [OPTIONS] [FILES]...

Options

--check-description

Check that all objects have a description

--check-redundant-datatypes

Check for redundant datatype overrides

--check-tap-table-indexes

Check that every table has a unique TAP table index

--check-tap-principal

Check that at least one column per table is flagged as TAP principal

Arguments

FILES

Optional argument(s)