Docs about Docs logo Docs about Docs

Destination Stitch details data file template reference

HOME > REFERENCE > DESTINATION TEMPLATES > DESTINATION STITCH DETAILS DATA FILE TEMPLATE REFERENCE

About this template

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

This template is used to add Stitch details pertaining to 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 info about Stitch’s implementation of the destination.

Parameter Description
pricing-tier
STRING

The name of the Stitch plan required to use the destination.

Example values:

  • Standard
  • Enterprise
supported-versions
STRING

The versions of the destination that Stitch supports, if applicable.

For example: For PostgreSQL destinations, Stitch requires a minimum database version of 9.3 to connect and function successfully.

Example values:

  • n/a
  • 9.3 or higher
available-in-connect
BOOLEAN

If true, the destination is available in the Connect API.
api-type
STRING

The name of the connection property object that corresponds to the destination in the Connect API.
loader-name
STRING

The internal name of the loader backing the destination. This is typically the name of the stitchdata/loader-{destination} GitHub repository.

For example: loader-bq backs Stitch’s Google BigQuery (v1) destination.
Back to top

Connection methods

These properties contain info about Stitch’s support of various connection methods to the destination.

Parameter Description
ssl
BOOLEAN

If true, Stitch supports connecting to the destination via user-configured SSL.
connect-ssl
BOOLEAN

If true, users can configure SSL for the destination using the Connect API.
ssh
BOOLEAN

If true, Stitch supports connecting to the destination via SSH tunnel.
vpn
BOOLEAN

If true, Stitch supports connecting to the destination via VPN.
Back to top

Workload performance management

These properties contain details about the work performance management tools Stitch supports for the destination.

Note: These aren’t features that Stitch itself offers. Rather, these are features built into the destination that are compatible with the use of Stitch.

Parameter Description
workload-performance-management
BOOLEAN

If true, the destination offers work performance management tools.
workload-performance-management-description
STRING

A block of text providing additional details about the supported work performance managment tools.

For example:

workload-performance-management-description: |
  To improve your query performance, you can apply encodings, SORT, and DIST keys to Stitch-created tables in your {{ destination.display_name }} destination. Your settings will remain intact even when new data is loaded.

  Refer to the [Encodings, SORT, and DIST Keys guide]({{ link.destinations.storage.redshift-encodings | prepend: site.baseurl }}) for application instructions.
Back to top
Back to top

Last updated: 28 July 2021