Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 3.41 KB

destination-overview-template.md

File metadata and controls

79 lines (51 loc) · 3.41 KB

{This is a template for standard destination connector docs. Items between curly brackets need to be replaced with specific names or directions. For links to Fivetran documentation pages/sections, do not use the absolute path format like page name, use page/section name instead. Also, do not include /index.md in the path, trim the path at the page directory. For example, connector page name is correct while connector page name is incorrect.}


name: {Item name in the left nav menu} title: {SEO title} description: {Meta Description} hidden: {true or false. Set to true if the article should only be accessible via a direct link and not indexed by crawlers.}

{Destination Name}

{Description - Required - What is the service? Overview of what the service is (for example, Snowflake/Redshift). You can refer to publicly available documentation, however, remember to tailor it to Fivetran's context. Also, add a link to the related public website for the user’s reference.}

{Example: Azure Data Lake Storage is a cloud-based, scalable data storage solution for big data analytics. ADLS allows you to store and manage massive amounts of data in any format. Fivetran supports data lakes built on ADLS as a destination.}

{Add this text to partner-built destination files: This destination is partner-built. For any questions related to {destination name} destination and its documentation, contact [{destination name} Support](add support link).}


Setup guide

Follow our step-by-step {Destination} setup guide to connect your {Destination} destination with Fivetran.


Type transformation and mapping

The data types in your {New Destination} follow Fivetran's standard data type storage.

We use the following data type conversions:

Fivetran Data Type Destination Data Type Notes
BOOLEAN BOOLEAN
SHORT SMALLINT
INT INTEGER
LONG BIGINT
FLOAT REAL
DOUBLE DOUBLEPRECISION
BIGDECIMAL DECIMAL
LOCALDATE DATE
INSTANT TIMESTAMP_TZ
LOCALDATETIME TIMESTAMP_NTZ
STRING VARCHAR or TEXT VARCHAR if bytelengthis present, else TEXT
JSON VARIANT
BINARY BINARY

NOTE: SMALLINT, INTEGER, and BIGINT are synonymous with NUMBER.


Hybrid Deployment support

We {support/do not support} for the Hybrid Deployment model for {destination name} destinations.


Limitations (if applicable)

{Document the destination's limitations - for example, this destination does not support history mode.}


Optimize {Destination} (if applicable)

{List steps to optimize destination performance.}


Data load costs

List any additional cost info our customers need to know.

Migrate destinations {This is an example section}

  1. Enumerate the steps.
  2. Use screenshots if necessary.