Docs about Docs logo Docs about Docs

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 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/pricing

These properties contain general info about the destination, such as a description and pricing details, if known.

Parameter Description
description
STRING

A general description of the destination. This is used in multiple places throughout the docs.

fully-managed
BOOLEAN

If true, the destination’s provider offers a fully managed option. This means that the end user doesn’t need to manually upgrade the database or handle other typical administrative/upkeep tasks.

free-option
STRING

If Yes, the destination’s provider offers a free option.

Must be one of the following:

  • Yes
  • No
pricing-model
STRING

Indicates how the destination provider charges.

Example values:

  • Monthly
  • Hourly
  • Storage
  • Usage
  • Varies
pricing-details
STRING

Additional info about the destination’s pricing.

For example:

"Currently, { destination.display_name }} bases their pricing on an hourly rate that varies depending on the type and number of nodes in a cluster. The type and number of nodes you choose when creating a cluster is dependent on your needs and data set, but you can scale up or down over time should your requirements change."
Back to top

Table limits

These properties contain info about the limits the destination places on tables, if known.

Parameter Description
max-columns-per-table
STRING

The maximum number of columns a table can have in the destination. Typically, when Stitch attempts to load tables that exceed this limit, it’ll result in a loading error.

A value of None indicates that the destination either doesn’t have a limit, or a limit isn’t known.

Example values:

  • 10,000
  • 1,600
  • None
max-tables-per-database
STRING

The maximum number of tables a database can have in the destination.

A value of None indicates that the destination either doesn’t have a limit, or a limit isn’t known.

Example values:

  • None
  • 100,000
Back to top

Object name limits

These properties contain info about the limits the destination places on object names, if known.

Parameter Description
case-sensitivity
STRING

Indicates if object names are case sensitive or case insensitive in the destination.

If a destination is case sensitive, it means that object names can be unique based on case alone. For example: customer and CUSTOMER are both unique.

In a case insensitive destinations, object names must be unique outside of case. For example: customer and CUSTOMER would be considered equal. If a two columns in a table canonicalize to the same name (like customer and CUSTOMER), it can result in object name collisions and prevent loading.

Must be one of the following:

  • Sensitive
  • Insensitive
table-name-length
STRING

The number of characters the destination will allow in a table name, formatted as XX characters

For example: 127 characters indicates that the destination will allow tables to have up to 127 characters in their name. Tables with names exceeding this character limit will raise loading errors.

column-name-length
STRING

The number of characters the destination will allow in a column name, formatted as XX characters

For example: 115 characters indicates that the destination will allow column to have up to 127 characters in their name. Columns with names exceeding this character limit will raise loading errors.

Back to top

Column naming rules

This parameter contains info about the criteria object names must meet to be considered valid by the destination, if known.

Parameter Description
column-name-rules
STRING

A block of text containing info about the criteria the destination requires when naming objects, if known. Can be formatted as Markdown or HTML.

For example:

- Must contain only letters (a-z, A-Z), numbers (0-9), or underscores (`_`)
- Must begin with a letter
- Must be less than the maximum length of {{ site.data.destinations.redshift.destination-details.column-name-length }}. Columns that exceed this limit will be [rejected by {{ destination.display_name }}]({{ link.destinations.storage.rejected-records | prepend: site.baseurl }}).
- Must not be prefixed or suffixed with any of [{{ destination.display_name }}'s or Stitch's reserved keyword prefixes or suffixes]({{ link.destinations.storage.reserved-keywords.redshift | prepend: site.baseurl }})
Back to top

Column name transformations

The column-name-transformations property is a list of transformations Stitch will perform on column names when loading data into the destination. Stitch performs these transformations to ensure column names meet destination requirements and won’t result in loading errors.

For example:

column-name-transformations:
  - transformation: "Convert uppercase and mixed case to lowercase"
    source-column: "<code>CuStOmErId</code> or <code>CUSTOMERID</code>"
    destination-column: "<code>customerid</code>"

  - transformation: "Remove special characters"
    source-column: "<code>customer#id</code> or <code>!CuStOMerID</code>"
    destination-column: "<code>customerid</code> and <code>customerid</code>"

  - transformation: "Remove non-letter leading characters"
    source-column: "<code>4customerid</code> or <code>_customerid</code>"
    destination-column: "<code>customerid</code>"
Parameter Description
transformation
STRING

A description of the transformation Stitch will perform on the column name.

Example values:

  • Convert uppercase and mixed case to lowercase
  • Remove special characters
  • Remove non-letter leading characters
source-column
STRING

The name of the column as it may exist in the source, enclosed in <code></code> tags. The name of the column should be an example that will trigger the transformation.

For example:

<code>CuStOmErId</code> or <code>CUSTOMERID</code>
destination-column
STRING

The name of the transformed column as it will be loaded in the destination, enclosed in <code></code> tags.

For example:

<code>customerid</code>
Back to top
Back to top

Last updated: 28 July 2021