GPSS load configuration file (version 3).

Synopsis

version: v3

targets:
- gpdb:
    host: <host>
    port: <greenplum_port>
    user: <user_name>
    password: <password>
    database: <db_name>
    work_schema: <work_schema_name>
    error_limit: <num_errors> | <percentage_errors>
    filter_expression: <filter_string>
    tables:
      - table: <table_name>
        schema: <schema_name>
        mode:
          # specify a single mode property block (described below)
          insert: {}
          update:
            <mode_specific_property>: <value>
            ...
          merge:
            <mode_specific_property>: <value>
            ...
        mapping:
          <target_column_name> : <source_column_name> | <expression>
          ...
        filter: <output_filter_string>
      ...

sources:
- <DATASOURCE>:
    <DATASOURCE_specific_properties>
    content:
      <data_format>:
        <column_spec>
        <other_props>

option:
  schedule:
    max_retries: <num_retries>
    retry_interval: <retry_time>
    running_duration: <run_time>
    auto_stop_restart_interval: <restart_time>
    max_restart_times: <num_restarts>
    quit_at_eof_after: <clock_time>
  alert:
    command: <command_to_run>
    workdir: <directory>
    timeout: <alert_time>

Where the mode_specific_propertys that you can specify for update and merge mode follow:

update:
  match_columns: [<match_column_names>]
  order_columns: [<order_column_names>]
  update_columns: [<update_column_names>]
  update_condition: <update_condition>

merge:
  match_columns: [<match_column_names>]
  update_columns: [<update_column_names>]
  order_columns: [<order_column_names>]
  update_condition: <update_condition>
  delete_condition: <delete_condition>

Where data_format, column_spec, and other_props are one of the following blocks (data source-specific):

avro:
  source_column_name: <column_name>
  schema_url: <http://schemareg_host:schemareg_port> %, ...%
  bytes_to_base64: <boolean>

binary:
  source_column_name: <column_name>

csv:
  columns:
    - name: <column_name>
      type: <column_data_type>
    ...
  delimiter: <delim_char>
  quote: <quote_char>
  null_string: <nullstr_val>
  escape: <escape_char>
  force_not_null: <columns>
  fill_missing_fields: <boolean>

custom:
  columns:
    - name: <column_name>
      type: <column_data_type>
    ...
  name: <formatter_name>
  options:
    - <optname>=<optvalue>
    ...

delimited:
  columns:
    - name: <column_name>
      type: <column_data_type>
    ...
  delimiter: <delimiter_string>
  eol_prefix: <prefix_string>
  quote: <quote_char>
  escape: <escape_char>

json:
  column:
    name: <column_name>
    type: json | jsonb
  is_jsonl: <boolean>
  newline: <newline_str>

And where you may specify any property value with a template variable that GPSS substitutes at runtime using the following syntax:

<property:> {{<template_var>}}

Description

Version 3 of the GPSS load configuration file is different in both content and format than previous versions of the file. Certain symbols used in the GPSS version 1 and 2 configuration file reference page syntax have different meanings in version 3 syntax:

• Brackets [] are literal and are used to specify a list in version 3. They are no longer used to signify the optionality of a property.
• Curly braces {} are literal and are used to specify YAML mappings in version 3 syntax. They are no longer used with the pipe symbol (|) to identify a list of choices.

You specify the configuration properties for a VMware Tanzu Greenplum streaming server (GPSS) job in a YAML-formatted configuration file that you provide to the gpsscli submit or gpsscli load command. There are three types of configuration information in this file - target VMware Tanzu Greenplum connection and data import properties, properties specific to the data source from which you will load data into Greenplum, and properties specific to the GPSS job.

This reference page uses the name gpsscli-v3.yaml to refer to this file; you may choose your own name for the file.

The gpsscli utility processes the YAML configuration file in order, using indentation (spaces) to determine the document hierarchy and the relationships between the sections. The use of white space in the file is significant. Keywords are not case-sensitive.

You can use the gpsscli convert command to convert a V2 load configuration file to V3 syntax.

Keywords and Values

version Property

version: v3

The version of the configuration file. You must specify version: v3.

targets:gpdb Properties

host: host

The host name or IP address of the Tanzu Greenplum coordinator host.

port: greenplum_port

The port number of the Tanzu Greenplum server on the coordinator host.

user: user_name

The name of the Tanzu Greenplum user/role. This user_name must have permissions as described in the Configuring Tanzu Greenplum Role Privileges.

password: password

The password for the Tanzu Greenplum user/role.

database: db_name

The name of the Tanzu Greenplum.

work_schema: work_schema_name

The name of the Tanzu Greenplum schema in which GPSS creates internal tables. The default work_schema_name is public.

error_limit: num_errors | percentage_errors

The error threshold, specified as either an absolute number or a percentage. GPSS stops running the job when this limit is reached.

filter_expression: filter_string

The filter to apply to the input data before GPSS loads the data into Tanzu Greenplum. If the filter evaluates to true, GPSS loads the message. If the filter evaluates to false, the message is dropped. filter_string must be a valid SQL conditional expression and may reference one or more source value, key, or meta column names.

tables:

The Tanzu Greenplum tables, and the data that GPSS will load into each.

table: table_name

The name of the Tanzu Greenplum table into which GPSS loads the data.

schema: schema_name

The name of the Tanzu Greenplum schema in which table_name resides. Optional, the default schema is the public schema.

mode:

The table load mode; insert, merge, or update. The default mode is insert.

update and merge are not supported if the target table column name is a reserved keyword, has capital letters, or includes any character that requires quotes (" ") to identify the column.

insert:

Inserts source data into Greenplum.

update:

Updates the target table columns that are listed in update_columns when the input columns identified in match_columns match the named target table columns and the optional update_condition is true.

merge:

Inserts new rows and updates existing rows when:

• columns are listed in update_columns,
• the match_columns target table column values are equal to the input data, and
• an optional update_condition is specified and met. Deletes rows when:
• the match_columns target table column values are equal to the input data, and
• an optional delete_condition is specified and met.

New rows are identified when the match_columns value in the source data does not have a corresponding value in the existing data of the target table. In those cases, the entire row from the source file is inserted, not only the match_columns and update_columns. If there are multiple new match_columns values in the input data that are the same, GPSS inserts or updates the target table using a random matching input row. When you specify order_columns, GPSS sorts the input data on the specified column(s) and inserts or updates from the input row with the largest value.

mode_property_name: value

The name to value mapping for a mode property. Each mode supports one or more of the following properties as specified in the Synopsis.

match_columns: [match_column_names]

A comma-separated list that specifies the column(s) to use as the join condition for the update. The attribute value in the specified target column(s) must be equal to that of the corresponding source data column(s) in order for the row to be updated in the target table.

Required when mode is merge or update.

order_columns: [order_column_names]

A comma-separated list that specifies the column(s) by which GPSS sorts the rows. When multiple matching rows exist in a batch, order_columns is used with match_columns to determine the input row with the largest value; GPSS uses that row to write/update the target.

Optional. May be specified in merge mode to sort the input data rows.

update_columns: [update_column_names]

A column-sparated list that specifies the column(s) to update for the rows that meet the match_columns criteria and the optional update_condition.

Required when mode is merge or update.

update_condition: update_condition

Specifies a boolean condition, similar to that which you would declare in a WHERE clause, that must be met in order for a row in the target table to be updated (or inserted, in the case of a merge). Optional.

delete_condition: delete_condition

In merge mode, specifies a boolean condition, similar to that which you would declare in a WHERE clause, that must be met for GPSS to delete rows in the target table that meet the match_columns criteria. Optional.

mapping:

Optional. Overrides the default source-to-target column mapping.

When you specify a mapping, ensure that you provide a mapping for all source data elements of interest. GPSS does not automatically match column names when you provide a mapping block.

target\_column\_name: source\_column\_name \| expression
:   target\_column\_name specifies the target Tanzu Greenplum table column name. GPSS maps this column name to the source column name specified in source\_column\_name, or to an expression. When you specify an expression, you may provide a value expression that you would specify in the `SELECT` list of a query, such as a constant value, a column reference, an operator invocation, a built-in or user-defined function call, and so on.

filter: output_filter_string

The filter to apply to the output data before GPSS loads the data into Tanzu Greenplum. If the filter evaluates to true, GPSS loads the message. If the filter evaluates to false, the message is dropped. output_filter_string must be a valid SQL conditional expression and may reference one or more META or VALUE column names.

sources: Properties

sources:

The data source.

DATASOURCE

GPSS currently supports file, kafka, rabbitmq, and s3 data sources.

DATASOURCE_specific_properties

Configuration properties specific to the file, kafka, rabbitmq, or s3 data source; refer to filesource-v3.yaml, gpkafka-v3.yaml, rabbitmq-v3.yaml, and s3source-v3.yaml for version 3 configuration file format and properties for these sources.

option: Properties

schedule:

Controls the frequency and interval of restarting jobs.

retry_interval: retry_time

The period of time that GPSS waits before retrying a failed job. You can specify the time interval in day (d), hour (h), minute (m), second (s), or millisecond (ms) integer units; do not mix units. The default retry interval is 5m (5 minutes).

max_retries: num_retries

The maximum number of times that GPSS attempts to retry a failed job. The default is 0, do not retry. If you specify a negative value, GPSS retries the job indefinitely.

running_duration: run_time

The amount of time after which GPSS automatically stops a job. GPSS does not automatically stop a job by default.

auto_stop_restart_interval: restart_time

The amount of time after which GPSS restarts a job that it stopped due to reaching running_duration.

max_restart_times: num_restarts

The maximum number of times that GPSS restarts a job that it stopped due to reaching running_duration. The default is 0, do not restart the job. If you specify the value -1, GPSS restarts the job indefinitely. You may use gpsscli stop to stop the jobs from being restarted indefinitely.

quit_at_eof_after: clock_time

The clock time after which GPSS stops a job every day when it encounters an EOF. By default, GPSS does not automatically stop a job that reaches EOF. GPSS never stops a job when the current time is before clock_time, even when GPSS encounters an EOF.

alert:

Controls notification when a job is stopped for any reason (success, completion, error, user-initiated stop).

command: command_to_run

The program that the GPSS server runs on the GPSS server host, including arguments. The command must be executable by GPSS.

command_to_run has access to job-related environment variables that GPSS sets, including: $GPSSJOB_NAME, $GPSSJOB_STATUS, and $GPSSJOB_DETAIL.

workdir: directory

The working directory for command_to_run. The default working directory is the directory from which you started the GPSS server process. If you specify a relative path, it is relative to the directory from which you started the GPSS server process.

timeout: alert_time

The amount of time after a job stops, prompting GPSS to trigger the alert (and run command_to_run). You can specify the time interval in day (d), hour (h), minute (m), or second (s) integer units; do not mix units. The default alert timeout is -1s (no timeout).

Template Variables

GPSS supports using template variables to specify property values in the load configuration file.

You specify a template variable value in the load configuration file as follows:

<property>: {{<template_var>}}

For example:

max_retries: {{numretries}}

GPSS substitutes the template variable with a value that you specify via the -p | --property <template_var=value> option to the gpsscli dryrun, gpsscli submit, or gpsscli load command.

For example, if the command line specifies:

--property numretries=10

GPSS substitutes occurrences of {{numretries}} in the load configuration file with the value 10 before submitting the job, and uses that value while the job is running.

Notes

If you created a database object name using a double-quoted identifier (delimited identifier), you must specify the delimited name within single quotes in the load configuration file. For example, if you create a table as follows:

CREATE TABLE "MyTable" (c1 text);

Your YAML configuration file would refer to the table name as:

targets:
- gpdb:
    tables:
      - table: '"MyTable"'

You can specify backslash escape sequences in the CSV delimiter, quote, and escape options. GPSS supports the standard backslash escape sequences for backspace, form feed, newline, carriage return, and tab, as well as escape sequences that you specify in hexadecimal format (prefaced with \x). Refer to Backslash Escape Sequences in the PostgreSQL documentation for more information.

Examples

Submit a job to load data into Tanzu Greenplum as defined in the v3 load configuration file named loadit_v3.yaml:

$ gpsscli submit loadit_v3.yaml

Example Tanzu Greenplum configuration properties in loadit_v3.yaml:

version: v3
targets:
- gpdb:
    host: mdw-1
    port: 5432
    user: gpadmin
    password: changeme
    database: testdb
    work_schema: public
    error_limit: "25"
    tables:
      - table: orders
        schema: public
        mode:
          insert {}

sources:
- kafka:
    <kafka_specific_properties>

See Also

gpsscli convert, gpsscli submit, filesource-v3.yaml, gpkafka-v3.yaml, rabbitmq-v3.yaml, s3source-v3.yaml