Skip to content

Commit

Permalink
TDL-24621 + TDL-24622 Add guides for different MSSQL and MySQL enviro…
Browse files Browse the repository at this point in the history
…nments (#986)

* TDL-24621 add mssql guides

* TDL-24622 add mysql guides
  • Loading branch information
lmilan authored Dec 14, 2023
1 parent 283ddbb commit c3ac470
Show file tree
Hide file tree
Showing 9 changed files with 861 additions and 5 deletions.
8 changes: 6 additions & 2 deletions _data/destinations/microsoft-sql-server/user-privileges.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -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
command: *grant-permissions-sql
amazon-rds-microsoft-sql-server: *mssql-steps
azure-sql-database: *mssql-steps
azure-sql-managed-instance: *mssql-steps
8 changes: 6 additions & 2 deletions _data/destinations/mysql/user-privileges.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<STRONG_PASSWORD_HERE>` 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
command: *grant-permissions-sql
amazon-aurora-mysql: *mysql-steps
amazon-rds-mysql: *mysql-steps
mariadb-mysql: *mysql-steps
Original file line number Diff line number Diff line change
@@ -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 %}
Original file line number Diff line number Diff line change
@@ -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 %}
Loading

0 comments on commit c3ac470

Please sign in to comment.