From 449e6ae09f0fb2cd53bfd6e3942b7732b92816c7 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Thu, 14 Dec 2023 12:25:18 +0100 Subject: [PATCH 1/2] TDL-24621 add mssql guides --- .../microsoft-sql-server/user-privileges.yml | 8 +- .../connecting-amazon-rds-for-sql-server.md | 123 ++++++++++++++++++ .../guides/connecting-azure-sql-database.md | 122 +++++++++++++++++ .../connecting-azure-sql-managed-instance.md | 123 ++++++++++++++++++ .../guides/microsoft-sql-server-setup.md | 2 +- 5 files changed, 375 insertions(+), 3 deletions(-) create mode 100644 _destinations/microsoft-sql-server/guides/connecting-amazon-rds-for-sql-server.md create mode 100644 _destinations/microsoft-sql-server/guides/connecting-azure-sql-database.md create mode 100644 _destinations/microsoft-sql-server/guides/connecting-azure-sql-managed-instance.md diff --git a/_data/destinations/microsoft-sql-server/user-privileges.yml b/_data/destinations/microsoft-sql-server/user-privileges.yml index b0c34641d..5f20b128a 100644 --- a/_data/destinations/microsoft-sql-server/user-privileges.yml +++ b/_data/destinations/microsoft-sql-server/user-privileges.yml @@ -71,7 +71,7 @@ grant-permissions-to-user: &grant-permissions-sql | ## The individual steps for creating a Microsoft SQL Server user for Stitch. -microsoft-sql-server: +microsoft-sql-server: &mssql-steps - copy: "If you haven't already, connect to your {{ page.display_name }} instance using your SQL client." - copy: "Navigate to the `master` database." - copy: | @@ -83,4 +83,8 @@ microsoft-sql-server: command: *grant-control-sql - copy: | Run the following commands to allow the user to create tables and schemas: - command: *grant-permissions-sql \ No newline at end of file + command: *grant-permissions-sql + +amazon-rds-microsoft-sql-server: *mssql-steps +azure-sql-database: *mssql-steps +azure-sql-managed-instance: *mssql-steps diff --git a/_destinations/microsoft-sql-server/guides/connecting-amazon-rds-for-sql-server.md b/_destinations/microsoft-sql-server/guides/connecting-amazon-rds-for-sql-server.md new file mode 100644 index 000000000..46bef4e24 --- /dev/null +++ b/_destinations/microsoft-sql-server/guides/connecting-amazon-rds-for-sql-server.md @@ -0,0 +1,123 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/destination-templates/destination-setup/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page Controls # +# -------------------------- # + +title: Connecting an Amazon RDS for SQL Server Destination to Stitch +permalink: /destinations/microsoft-sql-server/connecting-amazon-rds-for-sql-server-destination-to-stitch +keywords: microsoft sql server, microsoft sql server data warehouse, microsoft sql server data warehouse, microsoft sql server etl, etl to microsoft sql server, microsoft sql server destination, sql server rds, relational database services +summary: "Connect an Amazon RDS for SQL Server database to your Stitch account as a destination." + +content-type: "destination-setup" +key: "mssql-rds-destination-setup" +order: 2 + +toc: true +layout: tutorial +use-tutorial-sidebar: false + + +# -------------------------- # +# Destination Details # +# -------------------------- # + +display_name: "Amazon RDS for SQL Server" +name: "amazon-rds-microsoft-sql-server" + +type: "microsoft-sql-server" + +hosting-type: "amazon" + +ssh: true +ssl: true +port: 5432 + +api-type: "mssql_server" + +this-version: "1" + + +# -------------------------- # +# Introduction # +# -------------------------- # + +intro: | + +# -------------------------- # +# Requirements # +# -------------------------- # + +requirements: + - item: | + {% assign destination = page %} + **An up-and-running {{ destination.display_name }} instance.** Instructions for creating a {{ destination.display_name }} destination are outside the scope of this tutorial; our instructions assume that you have an instance up and running. For help getting started with {{ destination.display_name }}, refer to [AWS's documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.SQLServer.html){:target="new"}. + + +# -------------------------- # +# Instructions # +# -------------------------- # + +steps: + - title: "Verify your Stitch account's data pipeline region" + anchor: "verify-stitch-account-region" + content: | + {% include shared/whitelisting-ips/locate-region-ip-addresses.html first-step=true %} + + - title: "Configure database connection settings" + anchor: "connect-settings" + content: | + {% include integrations/templates/configure-connection-settings.html %} + + - title: "Create a Stitch {{ destination.display_name }} database user" + anchor: "create-database-user" + content: | + {% include note.html type="single-line" content="**Note**: You must have superuser privileges or the ability to create a user and grant privileges to complete this step." %} + + In the following tabs are the instructions for creating a Stitch {{ destination.display_name }} database user and explanations for the permissions Stitch requires. + + {% include destinations/templates/destination-user-setup.html %} + + - title: "Connect Stitch" + anchor: "connect-stitch" + content: | + To complete the setup, you need to enter your {{ destination.display_name }} connection details into the {{ app.page-names.dw-settings }} page in Stitch. + + substeps: + - title: "Enter connection details into Stitch" + anchor: "enter-connection-details-into-stitch" + content: | + {% include shared/database-connection-settings.html type="general" %} + + - title: "Define SSH connection details" + anchor: "define-ssh-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssh" %} + + - title: "Define SSL connection details" + anchor: "define-ssl-connection-details" + content: | + {% capture tsl-support-note %} + SSL can only be used with versions of {{ destination.display_name }} that support TSL 1.2. Check which versions support it in [Microsoft's documentation]({{ site.data.destinations.microsoft-sql-server.resource-links.tls-support }}). + {% endcapture %} + + {% include note.html type="single-line" content=tsl-support-note %} + + Check the **{{ defaults.field-names.ssl }}** checkbox. {{ defaults.field-copy.ssl }} + + + - title: "Save the destination" + anchor: "save-destination" + content: | + {% include shared/database-connection-settings.html type="finish-up" %} +--- +{% include misc/data-files.html %} +{% assign destination = page %} \ No newline at end of file diff --git a/_destinations/microsoft-sql-server/guides/connecting-azure-sql-database.md b/_destinations/microsoft-sql-server/guides/connecting-azure-sql-database.md new file mode 100644 index 000000000..0ac4c8ef6 --- /dev/null +++ b/_destinations/microsoft-sql-server/guides/connecting-azure-sql-database.md @@ -0,0 +1,122 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/destination-templates/destination-setup/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page formatting & Controls # +# -------------------------- # + +title: Connecting an Azure SQL Database Destination to Stitch +permalink: /destinations/microsoft-sql-server/connecting-azure-sql-database-destination-to-stitch + +keywords: azure sql database, azure sql database data warehouse, azure sql database data warehouse, azure sql database etl, etl to azure sql database, azure sql database destination +summary: "Connect an Azure SQL Database destination to your Stitch account." + +content-type: "destination-setup" +key: "azure-sql-database-destination-setup" +order: 2 + +toc: true +layout: tutorial +use-tutorial-sidebar: false + + +# -------------------------- # +# Destination Details # +# -------------------------- # + +type: "microsoft-sql-server" +display_name: "Azure SQL Database" +name: "azure-sql-database" + +ssh: true +ssl: true +port: 1433 + +hosting-type: "microsoft-azure" # amazon, generic, microsoft, etc. + +api-type: "mssql_server" + +this-version: "1" + + +# -------------------------- # +# Introduction # +# -------------------------- # + +intro: | + +# -------------------------- # +# Setup Requirements # +# -------------------------- # + +requirements: + - item: | + {% assign destination = page %} + **An up-and-running {{ destination.display_name }} instance.** Instructions for creating a {{ destination.display_name }} destination are outside the scope of this tutorial; our instructions assume that you have an instance up and running. For help getting started with {{ destination.display_name }}, refer to [Microsoft's documentation](https://learn.microsoft.com/en-us/azure/azure-sql/){:target="new"}. + + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +steps: + - title: "Verify your Stitch account's data pipeline region" + anchor: "verify-stitch-account-region" + content: | + {% include shared/whitelisting-ips/locate-region-ip-addresses.html first-step=true %} + + - title: "Configure database connection settings" + anchor: "connect-settings" + content: | + {% include integrations/templates/configure-connection-settings.html %} + + - title: "Create a Stitch {{ destination.display_name }} database user" + anchor: "create-database-user" + content: | + {% include note.html type="single-line" content="**Note**: You must have superuser privileges or the ability to create a user and grant privileges to complete this step." %} + + In the following tabs are the instructions for creating a Stitch {{ destination.display_name }} database user and explanations for the permissions Stitch requires. + + {% include destinations/templates/destination-user-setup.html %} + + - title: "Connect Stitch" + anchor: "connect-stitch" + content: | + To complete the setup, you need to enter your {{ destination.display_name }} connection details into the {{ app.page-names.dw-settings }} page in Stitch. + + substeps: + - title: "Enter connection details into Stitch" + anchor: "enter-connection-details-into-stitch" + content: | + {% include shared/database-connection-settings.html type="general" %} + + - title: "Define SSH connection details" + anchor: "define-ssh-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssh" %} + + - title: "Define SSL connection details" + anchor: "define-ssl-connection-details" + content: | + {% capture tsl-support-note %} + SSL can only be used with versions of {{ destination.display_name }} that support TSL 1.2. Check which versions support it in [Microsoft's documentation]({{ site.data.destinations.microsoft-sql-server.resource-links.tls-support }}). + {% endcapture %}s + {% include note.html type="single-line" content=tsl-support-note %} + + Check the **{{ defaults.field-names.ssl }}** checkbox. {{ defaults.field-copy.ssl }} + + + - title: "Save the destination" + anchor: "save-destination" + content: | + {% include shared/database-connection-settings.html type="finish-up" %} +--- +{% include misc/data-files.html %} +{% assign destination = page %} \ No newline at end of file diff --git a/_destinations/microsoft-sql-server/guides/connecting-azure-sql-managed-instance.md b/_destinations/microsoft-sql-server/guides/connecting-azure-sql-managed-instance.md new file mode 100644 index 000000000..51b9d7162 --- /dev/null +++ b/_destinations/microsoft-sql-server/guides/connecting-azure-sql-managed-instance.md @@ -0,0 +1,123 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/destination-templates/destination-setup/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page formatting & Controls # +# -------------------------- # + +title: Connecting an Azure SQL Managed Instance Destination to Stitch +permalink: /destinations/microsoft-sql-server/connecting-an-azure-sql-managed-instance-destination-to-stitch + +keywords: azure sql managed instance, azure sql managed instance data warehouse, azure sql managed instance data warehouse, azure sql managed instance etl, etl to azure sql managed instance, azure sql managed instance destination +summary: "Connect an Azure SQL Managed Instance destination to your Stitch account." + +content-type: "destination-setup" +key: "azure-sql-managed-instance-destination-setup" +order: 2 + +toc: true +layout: tutorial +use-tutorial-sidebar: false + + +# -------------------------- # +# Destination Details # +# -------------------------- # + +type: "microsoft-sql-server" +display_name: "Azure SQL Managed Instance" +name: "azure-sql-managed-instance" + +ssh: true +ssl: true +port: 1433 + +hosting-type: "microsoft-azure" # amazon, generic, microsoft, etc. + +api-type: "mssql_server" + +this-version: "1" + + +# -------------------------- # +# Introduction # +# -------------------------- # + +intro: | + +# -------------------------- # +# Setup Requirements # +# -------------------------- # + +requirements: + - item: | + {% assign destination = page %} + **An up-and-running {{ destination.display_name }} instance.** Instructions for creating a {{ destination.display_name }} destination are outside the scope of this tutorial; our instructions assume that you have an instance up and running. For help getting started with {{ destination.display_name }}, refer to [Microsoft's documentation](https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/){:target="new"}. + + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +steps: + - title: "Verify your Stitch account's data pipeline region" + anchor: "verify-stitch-account-region" + content: | + {% include shared/whitelisting-ips/locate-region-ip-addresses.html first-step=true %} + + - title: "Configure database connection settings" + anchor: "connect-settings" + content: | + {% include integrations/templates/configure-connection-settings.html %} + + - title: "Create a Stitch {{ destination.display_name }} database user" + anchor: "create-database-user" + content: | + {% include note.html type="single-line" content="**Note**: You must have superuser privileges or the ability to create a user and grant privileges to complete this step." %} + + In the following tabs are the instructions for creating a Stitch {{ destination.display_name }} database user and explanations for the permissions Stitch requires. + + {% include destinations/templates/destination-user-setup.html %} + + - title: "Connect Stitch" + anchor: "connect-stitch" + content: | + To complete the setup, you need to enter your {{ destination.display_name }} connection details into the {{ app.page-names.dw-settings }} page in Stitch. + + substeps: + - title: "Enter connection details into Stitch" + anchor: "enter-connection-details-into-stitch" + content: | + {% include shared/database-connection-settings.html type="general" %} + + - title: "Define SSH connection details" + anchor: "define-ssh-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssh" %} + + - title: "Define SSL connection details" + anchor: "define-ssl-connection-details" + content: | + {% capture tsl-support-note %} + SSL can only be used with versions of {{ destination.display_name }} that support TSL 1.2. Check which versions support it in [Microsoft's documentation]({{ site.data.destinations.microsoft-sql-server.resource-links.tls-support }}). + {% endcapture %} + + {% include note.html type="single-line" content=tsl-support-note %} + + Check the **{{ defaults.field-names.ssl }}** checkbox. {{ defaults.field-copy.ssl }} + + + - title: "Save the destination" + anchor: "save-destination" + content: | + {% include shared/database-connection-settings.html type="finish-up" %} +--- +{% include misc/data-files.html %} +{% assign destination = page %} \ No newline at end of file diff --git a/_destinations/microsoft-sql-server/guides/microsoft-sql-server-setup.md b/_destinations/microsoft-sql-server/guides/microsoft-sql-server-setup.md index 6cc2c2e81..10a08908d 100644 --- a/_destinations/microsoft-sql-server/guides/microsoft-sql-server-setup.md +++ b/_destinations/microsoft-sql-server/guides/microsoft-sql-server-setup.md @@ -15,7 +15,7 @@ title: Connecting a Microsoft SQL Server Destination to Stitch permalink: /destinations/microsoft-sql-server/connecting-a-microsoft-sql-server-destination-to-stitch -keywords: microsoft-sql-server, microsoft-sql-server data warehouse, microsoft-sql-server data warehouse, microsoft-sql-server etl, etl to microsoft-sql-server, microsoft-sql-server destination +keywords: microsoft sql server, microsoft sql server data warehouse, microsoft sql server data warehouse, microsoft sql server etl, etl to microsoft sql server, microsoft sql server destination summary: "Connect a Microsoft SQL Server destination to your Stitch account." content-type: "destination-setup" From 87175e48895491485ecf55200bd8ed86e149d177 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Thu, 14 Dec 2023 12:25:35 +0100 Subject: [PATCH 2/2] TDL-24622 add mysql guides --- _data/destinations/mysql/user-privileges.yml | 8 +- .../guides/connecting-amazon-aurora-mysql.md | 160 ++++++++++++++++++ .../guides/connecting-amazon-rds-for-mysql.md | 160 ++++++++++++++++++ .../mysql/guides/connecting-mariadb-mysql.md | 160 ++++++++++++++++++ 4 files changed, 486 insertions(+), 2 deletions(-) create mode 100644 _destinations/mysql/guides/connecting-amazon-aurora-mysql.md create mode 100644 _destinations/mysql/guides/connecting-amazon-rds-for-mysql.md create mode 100644 _destinations/mysql/guides/connecting-mariadb-mysql.md diff --git a/_data/destinations/mysql/user-privileges.yml b/_data/destinations/mysql/user-privileges.yml index 3d7e9ba03..029422150 100644 --- a/_data/destinations/mysql/user-privileges.yml +++ b/_data/destinations/mysql/user-privileges.yml @@ -127,11 +127,15 @@ grant-permissions-to-user: &grant-permissions-sql | ## The individual steps for creating a MySQL user for Stitch. -mysql: +mysql: &mysql-steps - copy: "If you haven't already, connect to your {{ page.display_name }} instance using your SQL client." - copy: | Run the following commands to create a login and a user named `stitch`. Replace `` with a strong password.: command: *create-user-sql - copy: | Run the following command to grant the required privileges to the Stitch user: - command: *grant-permissions-sql \ No newline at end of file + command: *grant-permissions-sql + +amazon-aurora-mysql: *mysql-steps +amazon-rds-mysql: *mysql-steps +mariadb-mysql: *mysql-steps \ No newline at end of file diff --git a/_destinations/mysql/guides/connecting-amazon-aurora-mysql.md b/_destinations/mysql/guides/connecting-amazon-aurora-mysql.md new file mode 100644 index 000000000..d3bdb7ce1 --- /dev/null +++ b/_destinations/mysql/guides/connecting-amazon-aurora-mysql.md @@ -0,0 +1,160 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/destination-templates/destination-setup/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page formatting & Controls # +# -------------------------- # + +title: Connecting an Amazon Aurora MySQL Destination to Stitch +permalink: /destinations/mysql/connecting-an-amazon-aurora-mysql-destination-to-stitch + +keywords: amazon aurora mysql, amazon aurora mysql data warehouse, amazon aurora mysql data warehouse, amazon aurora mysql etl, etl to amazon aurora mysql, amazon aurora mysql destination +summary: "Connect an Amazon Aurora MySQL destination to your Stitch account." + +content-type: "destination-setup" +key: "mysql-aurora-destination-setup" +order: 2 + +toc: true +layout: tutorial +use-tutorial-sidebar: false + + +# -------------------------- # +# Destination Details # +# -------------------------- # + +type: "mysql" +display_name: "Amazon Aurora MySQL" +name: "amazon-aurora-mysql" + +port: 3306 + +hosting-type: "amazon" # amazon, generic, microsoft, etc. + +api-type: "mysql_destination" + +this-version: "1" + +ssh: true + +# -------------------------- # +# Setup Requirements # +# -------------------------- # + +requirements: + - item: | + {% assign destination = page %} + **An up-and-running {{ destination.display_name }} instance.** Instructions for creating a {{ destination.display_name }} destination are outside the scope of this tutorial; our instructions assume that you have an instance up and running. For help getting started with {{ destination.display_name }}, refer to [AWS's documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_GettingStartedAurora.CreatingConnecting.Aurora.html){:target="new"}. + - item: | + **A database that uses the InnoDB storage engine.** This is the default storage engine for all supported {{ destination.display_name }} versions and the only one supported by Stitch's {{ destination.display_name }} destination. + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +steps: +## The Data pipeline region step is necessary ONLY +## if the user needs to whitelist Stitch's IP addresses +## for setup. + + - title: "Verify your Stitch account's data pipeline region" + anchor: "verify-stitch-account-region" + content: | + {% include shared/whitelisting-ips/locate-region-ip-addresses.html first-step=true %} + +## The database connection settings step is necessary ONLY +## if the user needs to whitelist Stitch's IP addresses +## for setup. + - title: "Configure database connection settings" + anchor: "connect-settings" + content: | + {% include integrations/templates/configure-connection-settings.html %} + + - title: "Create a Stitch {{ destination.display_name }} database user" + anchor: "create-database-user" + content: | + {% include note.html type="single-line" content="**Note**: You must have superuser privileges or the ability to create a user and grant privileges to complete this step." %} + + In the following tabs are the instructions for creating a Stitch {{ destination.display_name }} database user and explanations for the permissions Stitch requires. + + {% include destinations/templates/destination-user-setup.html %} + + - title: "Enable local data loading" + anchor: "enable-local-data-loading" + content: | + To allow Stitch to stream data from the cloud into your destination, you need to enable the `local_infile` parameter in MySQL. + + 1. Check if the feature is already enabled. You can: + - Look for the `local_infile` parameter in your `my.cnf` configuration file. + - Run the following command from the command line: + ``` + show global variables like 'local_infile'; + ``` + 1. If the feature is disabled, enable it. To do so, you can: + - Append the following line in `my.cnf`, after the `[mysqld]` tag. If this tag does not exist, create it. It should look like this: + ``` + [mysqld] + local_infile=true + ``` + - Run the following command while logged in with your root user: + ``` + set global local_infile=true + ``` + 1. If you are using a supported {{ destination.display_name }} version older than `8.0` (from `5.7.8` to `5.7.37`), you may run into errors stating that you are loading invalid UTF-8 characters. To avoid this issue, append the following lines in `my.cnf`: + ``` + [mysql] + default-character-set=utf8mb4 + + [mysqld] + character-set-server=utf8mb4 + collation-server=utf8mb4_general_ci + ``` + + If the `[mysql]` and `[mysqld]` tags already exist in the file, add the the values after each tag, otherwise add both the tags and values. + + 1. Restart your database server to apply the changes. + + + For more information, see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/load-data-local-security.html). + + + - title: "Connect Stitch" + anchor: "connect-stitch" + content: | + To complete the setup, you need to enter your {{ destination.display_name }} connection details into the {{ app.page-names.dw-settings }} page in Stitch. + + substeps: + - title: "Enter connection details into Stitch" + anchor: "enter-connection-details-into-stitch" + content: | + {% include shared/database-connection-settings.html type="general" %} + +## The SSH step should remain ONLY if the destination +## supports SSH. + - title: "Define SSH connection details" + anchor: "define-ssh-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssh" %} + +## The SSL step should remain ONLY if the destination +## supports SSL. + - title: "Define SSL connection details" + anchor: "define-ssl-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssl" ssl-fields=true %} + + - title: "Save the destination" + anchor: "save-destination" + content: | + {% include shared/database-connection-settings.html type="finish-up" %} +--- +{% include misc/data-files.html %} +{% assign destination = page %} \ No newline at end of file diff --git a/_destinations/mysql/guides/connecting-amazon-rds-for-mysql.md b/_destinations/mysql/guides/connecting-amazon-rds-for-mysql.md new file mode 100644 index 000000000..552dbb49a --- /dev/null +++ b/_destinations/mysql/guides/connecting-amazon-rds-for-mysql.md @@ -0,0 +1,160 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/destination-templates/destination-setup/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page formatting & Controls # +# -------------------------- # + +title: Connecting an Amazon RDS for MySQL Destination to Stitch +permalink: /destinations/mysql/connecting-an-amazon-rds-for-mysql-destination-to-stitch + +keywords: amazon rds for mysql, amazon rds for mysql data warehouse, amazon rds for mysql data warehouse, amazon rds for mysql etl, etl to amazon rds for mysql, amazon rds for mysql destination +summary: "Connect an Amazon RDS for MySQL destination to your Stitch account." + +content-type: "destination-setup" +key: "mysql-rds-destination-setup" +order: 2 + +toc: true +layout: tutorial +use-tutorial-sidebar: false + + +# -------------------------- # +# Destination Details # +# -------------------------- # + +type: "mysql" +display_name: "Amazon RDS for MySQL" +name: "amazon-rds-mysql" + +port: 3306 + +hosting-type: "amazon" # amazon, generic, microsoft, etc. + +api-type: "mysql_destination" + +this-version: "1" + +ssh: true + +# -------------------------- # +# Setup Requirements # +# -------------------------- # + +requirements: + - item: | + {% assign destination = page %} + **An up-and-running {{ destination.display_name }} instance.** Instructions for creating a {{ destination.display_name }} destination are outside the scope of this tutorial; our instructions assume that you have an instance up and running. For help getting started with {{ destination.display_name }}, refer to [AWS's documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html){:target="new"}. + - item: | + **A database that uses the InnoDB storage engine.** This is the default storage engine for all supported {{ destination.display_name }} versions and the only one supported by Stitch's {{ destination.display_name }} destination. + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +steps: +## The Data pipeline region step is necessary ONLY +## if the user needs to whitelist Stitch's IP addresses +## for setup. + + - title: "Verify your Stitch account's data pipeline region" + anchor: "verify-stitch-account-region" + content: | + {% include shared/whitelisting-ips/locate-region-ip-addresses.html first-step=true %} + +## The database connection settings step is necessary ONLY +## if the user needs to whitelist Stitch's IP addresses +## for setup. + - title: "Configure database connection settings" + anchor: "connect-settings" + content: | + {% include integrations/templates/configure-connection-settings.html %} + + - title: "Create a Stitch {{ destination.display_name }} database user" + anchor: "create-database-user" + content: | + {% include note.html type="single-line" content="**Note**: You must have superuser privileges or the ability to create a user and grant privileges to complete this step." %} + + In the following tabs are the instructions for creating a Stitch {{ destination.display_name }} database user and explanations for the permissions Stitch requires. + + {% include destinations/templates/destination-user-setup.html %} + + - title: "Enable local data loading" + anchor: "enable-local-data-loading" + content: | + To allow Stitch to stream data from the cloud into your destination, you need to enable the `local_infile` parameter in MySQL. + + 1. Check if the feature is already enabled. You can: + - Look for the `local_infile` parameter in your `my.cnf` configuration file. + - Run the following command from the command line: + ``` + show global variables like 'local_infile'; + ``` + 1. If the feature is disabled, enable it. To do so, you can: + - Append the following line in `my.cnf`, after the `[mysqld]` tag. If this tag does not exist, create it. It should look like this: + ``` + [mysqld] + local_infile=true + ``` + - Run the following command while logged in with your root user: + ``` + set global local_infile=true + ``` + 1. If you are using a supported {{ destination.display_name }} version older than `8.0` (from `5.7.8` to `5.7.37`), you may run into errors stating that you are loading invalid UTF-8 characters. To avoid this issue, append the following lines in `my.cnf`: + ``` + [mysql] + default-character-set=utf8mb4 + + [mysqld] + character-set-server=utf8mb4 + collation-server=utf8mb4_general_ci + ``` + + If the `[mysql]` and `[mysqld]` tags already exist in the file, add the the values after each tag, otherwise add both the tags and values. + + 1. Restart your database server to apply the changes. + + + For more information, see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/load-data-local-security.html). + + + - title: "Connect Stitch" + anchor: "connect-stitch" + content: | + To complete the setup, you need to enter your {{ destination.display_name }} connection details into the {{ app.page-names.dw-settings }} page in Stitch. + + substeps: + - title: "Enter connection details into Stitch" + anchor: "enter-connection-details-into-stitch" + content: | + {% include shared/database-connection-settings.html type="general" %} + +## The SSH step should remain ONLY if the destination +## supports SSH. + - title: "Define SSH connection details" + anchor: "define-ssh-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssh" %} + +## The SSL step should remain ONLY if the destination +## supports SSL. + - title: "Define SSL connection details" + anchor: "define-ssl-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssl" ssl-fields=true %} + + - title: "Save the destination" + anchor: "save-destination" + content: | + {% include shared/database-connection-settings.html type="finish-up" %} +--- +{% include misc/data-files.html %} +{% assign destination = page %} \ No newline at end of file diff --git a/_destinations/mysql/guides/connecting-mariadb-mysql.md b/_destinations/mysql/guides/connecting-mariadb-mysql.md new file mode 100644 index 000000000..c0e310455 --- /dev/null +++ b/_destinations/mysql/guides/connecting-mariadb-mysql.md @@ -0,0 +1,160 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/destination-templates/destination-setup/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page formatting & Controls # +# -------------------------- # + +title: Connecting a MariaDB MySQL Destination to Stitch +permalink: /destinations/mysql/connecting-a-mariadb-mysql-destination-to-stitch + +keywords: mariadb mysql, mariadb mysql data warehouse, mariadb mysql data warehouse, mariadb mysql etl, etl to mariadb mysql, mariadb mysql destination +summary: "Connect a MariaDB MySQL destination to your Stitch account." + +content-type: "destination-setup" +key: "mysql-mariadb-destination-setup" +order: 2 + +toc: true +layout: tutorial +use-tutorial-sidebar: false + + +# -------------------------- # +# Destination Details # +# -------------------------- # + +type: "mysql" +display_name: "MariaDB MySQL" +name: "mariadb-mysql" + +port: 3306 + +hosting-type: "generic" # amazon, generic, microsoft, etc. + +api-type: "mysql_destination" + +this-version: "1" + +ssh: true + +# -------------------------- # +# Setup Requirements # +# -------------------------- # + +requirements: + - item: | + {% assign destination = page %} + **An up-and-running {{ destination.display_name }} instance.** Instructions for creating a {{ destination.display_name }} destination are outside the scope of this tutorial; our instructions assume that you have an instance up and running. + - item: | + **A database that uses the InnoDB storage engine.** This is the default storage engine for all supported {{ destination.display_name }} versions and the only one supported by Stitch's {{ destination.display_name }} destination. + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +steps: +## The Data pipeline region step is necessary ONLY +## if the user needs to whitelist Stitch's IP addresses +## for setup. + + - title: "Verify your Stitch account's data pipeline region" + anchor: "verify-stitch-account-region" + content: | + {% include shared/whitelisting-ips/locate-region-ip-addresses.html first-step=true %} + +## The database connection settings step is necessary ONLY +## if the user needs to whitelist Stitch's IP addresses +## for setup. + - title: "Configure database connection settings" + anchor: "connect-settings" + content: | + {% include integrations/templates/configure-connection-settings.html %} + + - title: "Create a Stitch {{ destination.display_name }} database user" + anchor: "create-database-user" + content: | + {% include note.html type="single-line" content="**Note**: You must have superuser privileges or the ability to create a user and grant privileges to complete this step." %} + + In the following tabs are the instructions for creating a Stitch {{ destination.display_name }} database user and explanations for the permissions Stitch requires. + + {% include destinations/templates/destination-user-setup.html %} + + - title: "Enable local data loading" + anchor: "enable-local-data-loading" + content: | + To allow Stitch to stream data from the cloud into your destination, you need to enable the `local_infile` parameter in MySQL. + + 1. Check if the feature is already enabled. You can: + - Look for the `local_infile` parameter in your `my.cnf` configuration file. + - Run the following command from the command line: + ``` + show global variables like 'local_infile'; + ``` + 1. If the feature is disabled, enable it. To do so, you can: + - Append the following line in `my.cnf`, after the `[mysqld]` tag. If this tag does not exist, create it. It should look like this: + ``` + [mysqld] + local_infile=true + ``` + - Run the following command while logged in with your root user: + ``` + set global local_infile=true + ``` + 1. If you are using a supported {{ destination.display_name }} version older than `8.0` (from `5.7.8` to `5.7.37`), you may run into errors stating that you are loading invalid UTF-8 characters. To avoid this issue, append the following lines in `my.cnf`: + ``` + [mysql] + default-character-set=utf8mb4 + + [mysqld] + character-set-server=utf8mb4 + collation-server=utf8mb4_general_ci + ``` + + If the `[mysql]` and `[mysqld]` tags already exist in the file, add the the values after each tag, otherwise add both the tags and values. + + 1. Restart your database server to apply the changes. + + + For more information, see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/load-data-local-security.html). + + + - title: "Connect Stitch" + anchor: "connect-stitch" + content: | + To complete the setup, you need to enter your {{ destination.display_name }} connection details into the {{ app.page-names.dw-settings }} page in Stitch. + + substeps: + - title: "Enter connection details into Stitch" + anchor: "enter-connection-details-into-stitch" + content: | + {% include shared/database-connection-settings.html type="general" %} + +## The SSH step should remain ONLY if the destination +## supports SSH. + - title: "Define SSH connection details" + anchor: "define-ssh-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssh" %} + +## The SSL step should remain ONLY if the destination +## supports SSL. + - title: "Define SSL connection details" + anchor: "define-ssl-connection-details" + content: | + {% include shared/database-connection-settings.html type="ssl" ssl-fields=true %} + + - title: "Save the destination" + anchor: "save-destination" + content: | + {% include shared/database-connection-settings.html type="finish-up" %} +--- +{% include misc/data-files.html %} +{% assign destination = page %} \ No newline at end of file