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 |
free-option STRING |
If Must be one of the following:
|
pricing-model STRING |
Indicates how the destination provider charges. Example values:
|
pricing-details STRING |
Additional info about the destination’s pricing. For example:
|
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 Example values:
|
max-tables-per-database STRING |
The maximum number of tables a database can have in the destination. A value of Example values:
|
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: In a case insensitive destinations, object names must be unique outside of case. For example: Must be one of the following:
|
table-name-length STRING |
The number of characters the destination will allow in a table name, formatted as For example: |
column-name-length STRING |
The number of characters the destination will allow in a column name, formatted as For example: |
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:
|
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:
|
source-column STRING |
The name of the column as it may exist in the source, enclosed in For example:
|
destination-column STRING |
The name of the transformed column as it will be loaded in the destination, enclosed in For example:
|
Back to top
Last updated: 28 July 2021