Docs about Docs logo Docs about Docs

About this template

File location: /_templates/destinations/version
Used in:
Repo link: Click to view in the Stitch Docs repo
Instructions:

This template is used to add replication details about a destination to the Stitch Docs.


Template sections

Each template is grouped into sections to make parameters easier to find. These sections and the parameters they contain are described below.

General

These properties contain general loading info about the destination.

Parameter Description
primary-key-support
BOOLEAN

If true, the destination has native support for Primary Keys. This means that when loading into these destinations, Stitch will likely apply Primary Key constraints to Primary Key columns.

If false, the destination doesn’t have native Primary Key support. Historically, destinations have been designed to use a Stitch-created system table to enforce the use of Primary Keys during loading.

nested-structure-support
BOOLEAN

If true, the destination natively supports nested data structures. This means that when Stitch loads JSON arrays or objects, the data will be loaded intacct.

If false, Stitch will flatten the nested structures into relational objects (tables and columns).

nested-structure-support-description
STRING

Additional details about nested structure support.

rename-original-column-in-split
BOOLEAN

If true, Stitch will re-name the original column when mixed data types in a single column are encountered.

Back to top

Loading behavior

These properties contain details about the loading behavior Stitch uses for the destination.

Parameter Description
configurable-loading-behavior
BOOLEAN

If true, users can choose which loading-behavior-type their destination uses.

default-loading-behavior
STRING

The name of the loading behavior type the destination uses by default.

Must be one of the following:

  • Upsert
  • Append-only
loading-behavior-types
ARRAY

A list of strings containing the loading behavior type(s) the destination supports. Each behavior type should be its own item in the list - for example:

loading-behavior-types:
  - "Upsert"
  - "Append-only"

Must be one of the following:

  • Upsert
  • Append-only
loading-behavior-description
STRING

Additional info about the loading behavior used by the destination.

Back to top
Back to top

Last updated: 28 July 2021