Docs about Docs logo Docs about Docs

Destination data types data file template reference

HOME > REFERENCE > DESTINATION TEMPLATES > DESTINATION DATA TYPES 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 data type mapping info 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.

Specific

The specific list contains a list of data types that are supported by Stitch but are also specific to the destination.

Parameter Description
name
STRING

The name of the specific data type, in lower case. The layout that uses the data in this file will use this value as a key to look up other information about the data type, so it must match whatever the key for the data type is.

For example: The array value in the specific list matches the key (array) containing info about the array data type:

## _data/destinations/bigquery/v2/data-types.yml

specific:
  - name: "array"
  - name: "record"

array:
  destination-type: "array"
  suffix: "ar"
  doc-link: "https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#array-type"
Back to top

[DATA_TYPE]

Every data type in specific and every applicable Stitch data type should have an object containing the properties in this section.

For example:

number:
  destination-type: "decimal"
  suffix: "de"
  description: |
    Precision must be between 1 and 38; scale must be between 0 and the precision value
  doc-link: "https://docs.aws.amazon.com/redshift/latest/dg/r_Numeric_types201.html#r_Numeric_types201-decimal-or-numeric-type"
  range: "Precision must be between 1 and 38; scale must be between 0 and the precision value"
  loading-error: "{{ site.data.destinations.common.loading-errors.decimal-out-of-range }}"
Parameter Description
destination-type
STRING

The destination data type that the Stitch type maps to.

For example: In Amazon Redshift destinations, date data will be typed as timestamp.
suffix
STRING

The column name suffix Stitch will apply to columns of this type when handling columns containing mixed data types.

For example: In Amazon Redshift destinations, Stitch appends __ti to the names of columns that contain timestamp data when a column split occurs.
doc-link
STRING

A link to documentation about the destination data type, if applicable.
range
STRING

The acceptable range for the data type, if applicable.

For example: In Amazon Redshift destinations, date values must be between 4713 BC to 294276 AD.
loading-error
STRING

The raw loading error message that will surface if values for the data type exceed the destination’s acceptable range. This is usually a reference to the destination’s loading errors data file.
Back to top
Back to top

Last updated: 04 August 2021