Vertica

target-vertica (full360 variant)🥈

Data Warehouse and Unified Analytics Platform

The target-vertica loader sends data into Vertica after it was pulled from a source using an extractor

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the target-vertica loader to your project using
    meltano add
    :
  2. meltano add loader target-vertica
  3. Configure the target-vertica settings using
    meltano config
    :
  4. meltano config target-vertica set --interactive

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for target-vertica may have been automatically set when originally added to the Hub. Please review the capabilities when using this loader. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this loader.

This plugin has the following capabilities:

  • schema-flattening

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The target-vertica settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config target-vertica list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Add Metadata Columns (add_metadata_columns)

  • Environment variable: TARGET_VERTICA_ADD_METADATA_COLUMNS
  • Default Value: false

Metadata columns add extra row level information about data ingestion's, (i.e. when was the row read in source, when was inserted or deleted in vertica etc.) Metadata columns are creating automatically by adding extra columns to the tables with a column prefix SDC. The column names are following the stitch naming conventions documented at https://www.stitchdata.com/docs/data-structure/integration-schemas#sdc-columns. Enabling metadata columns will flag the deleted rows by setting the _SDC_DELETED_AT metadata column. Without the add_metadata_columns option the deleted rows from singer taps will not be recognizable in Vertica.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set add_metadata_columns [value]

Batch Size Rows (batch_size_rows)

  • Environment variable: TARGET_VERTICA_BATCH_SIZE_ROWS
  • Default Value: 100000

Maximum number of rows in each batch. At the end of each batch, the rows in the batch are loaded into Vertica.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set batch_size_rows [value]

Data Flattening Max Level (data_flattening_max_level)

  • Environment variable: TARGET_VERTICA_DATA_FLATTENING_MAX_LEVEL
  • Default Value: 0

Object type RECORD items from taps can be transformed to flattened columns by creating columns automatically. When value is 0 (default) then flattening functionality is turned off.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set data_flattening_max_level [value]

Database Name (dbname)

  • Environment variable: TARGET_VERTICA_DBNAME

Vertica database name


Configure this setting directly using the following Meltano command:

meltano config target-vertica set dbname [value]

Default Target Schema (default_target_schema)

  • Environment variable: TARGET_VERTICA_DEFAULT_TARGET_SCHEMA

Name of the schema where the tables will be created. If schema_mapping is not defined then every stream sent by the tap is loaded into this schema.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set default_target_schema [value]

Default Target Schema Select Permission (default_target_schema_select_permission)

  • Environment variable: TARGET_VERTICA_DEFAULT_TARGET_SCHEMA_SELECT_PERMISSION

Grant USAGE privilege on newly created schemas and grant SELECT privilege on newly created


Configure this setting directly using the following Meltano command:

meltano config target-vertica set default_target_schema_select_permission [value]

Flush All Streams (flush_all_streams)

  • Environment variable: TARGET_VERTICA_FLUSH_ALL_STREAMS
  • Default Value: false

Flush and load every stream into Vertica when one batch is full. Warning: This may trigger the COPY command to use files with low number of records.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set flush_all_streams [value]

Hard Delete (hard_delete)

  • Environment variable: TARGET_VERTICA_HARD_DELETE
  • Default Value: false

When hard_delete option is true then DELETE SQL commands will be performed in Vertica to delete rows in tables. It's achieved by continuously checking the _SDC_DELETED_AT metadata column sent by the singer tap. Due to deleting rows requires metadata columns, hard_delete option automatically enables the add_metadata_columns option as well.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set hard_delete [value]

Host (host)

  • Environment variable: TARGET_VERTICA_HOST

Vertica host


Configure this setting directly using the following Meltano command:

meltano config target-vertica set host [value]

Max Parallelism (max_parallelism)

  • Environment variable: TARGET_VERTICA_MAX_PARALLELISM
  • Default Value: 16

Max number of parallel threads to use when flushing tables.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set max_parallelism [value]

Parallelism (parallelism)

  • Environment variable: TARGET_VERTICA_PARALLELISM
  • Default Value: 0

The number of threads used to flush tables. 0 will create a thread for each stream, up to parallelism_max. -1 will create a thread for each CPU core. Any other positive number will create that number of threads, up to parallelism_max.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set parallelism [value]

Password (password)

  • Environment variable: TARGET_VERTICA_PASSWORD

Vertica password


Configure this setting directly using the following Meltano command:

meltano config target-vertica set password [value]

Port (port)

  • Environment variable: TARGET_VERTICA_PORT

Vertica port


Configure this setting directly using the following Meltano command:

meltano config target-vertica set port [value]

Primary Key Required (primary_key_required)

  • Environment variable: TARGET_VERTICA_PRIMARY_KEY_REQUIRED
  • Default Value: true

Log based and Incremental replications on tables with no Primary Key cause duplicates when merging UPDATE events. When set to true, stop loading data if no Primary Key is defined.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set primary_key_required [value]

Schema Mapping (schema_mapping)

  • Environment variable: TARGET_VERTICA_SCHEMA_MAPPING

Useful if you want to load multiple streams from one tap to multiple Vertica schemas. If the tap sends the stream_id in - format then this option overwrites the default_target_schema value. Note, that using schema_mapping you can overwrite the default_target_schema_select_permission value to grant SELECT permissions to different groups per schemas or optionally you can create indices automatically for the replicated tables. Note: This is an experimental feature and recommended to use via PipelineWise YAML files that will generate the object mapping in the right JSON format. For further info check a PipelineWise YAML Example.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set schema_mapping [value]

Temp Directory (temp_dir)

  • Environment variable: TARGET_VERTICA_TEMP_DIR

Directory of temporary CSV files with RECORD messages.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set temp_dir [value]

User (user)

  • Environment variable: TARGET_VERTICA_USER

Vertica user


Configure this setting directly using the following Meltano command:

meltano config target-vertica set user [value]

Validate Records (validate_records)

  • Environment variable: TARGET_VERTICA_VALIDATE_RECORDS
  • Default Value: false

Validate every single record message to the corresponding JSON schema. This option is disabled by default and invalid RECORD messages will fail only at load time by Vertica. Enabling this option will detect invalid records earlier but could cause performance degradation.


Configure this setting directly using the following Meltano command:

meltano config target-vertica set validate_records [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the target-vertica loader to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add loader target-vertica

Maintenance Status

  • Maintenance Status

Repo

https://github.com/full360/pipelinewise-target-vertica
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • full360

Meltano Stats

  • Projects (Last 3 Months)

Keywords

  • database