MSSQL
Features
Feature | Supported?(Yes/No) | Notes |
---|---|---|
Full Refresh Sync | Yes | |
Incremental - Append Sync | Yes | |
Incremental - Append + Deduped | Yes | |
Namespaces | Yes |
Output Schema
Each stream will be output into its own table in SQL Server. Each table will contain 3 columns:
-
_airbyte_ab_id
: a uuid assigned by HeroPixelto each event that is processed. The column type in SQL Server isVARCHAR(64)
. -
_airbyte_emitted_at
: a timestamp representing when the event was pulled from the data source. The column type in SQL Server isDATETIMEOFFSET(7)
. -
_airbyte_data
: a JSON blob representing with the event data. The column type in SQL Server isNVARCHAR(MAX)
.
Microsoft SQL Server specifics or why NVARCHAR type is used here:
- NVARCHAR is Unicode - 2 bytes per character, therefore max. of 1 billion characters; will handle East Asian, Arabic, Hebrew, Cyrillic etc. characters just fine.
- VARCHAR is non-Unicode - 1 byte per character, max. capacity is 2 billion characters, but limited to the character set you're SQL Server is using, basically - no support for those languages mentioned before
Getting Started
Requirements
To use the SQL Server destination, you'll need:
MS SQL Server: Azure SQL Database
,
Azure Synapse Analytics
,
Azure SQL Managed Instance
,
SQL Server 2019
,
SQL Server 2017
,
SQL Server 2016
,
SQL Server 2014
,
SQL Server 2012
, or
PDW 2008R2 AU34
.
Normalization Requirements
To sync with normalization
you'll need to use MS SQL Server of the
following versions: SQL Server 2019
,
SQL Server 2017
,
SQL Server 2016
,
SQL Server 2014
. The work of
normalization on SQL Server 2012
and
bellow are not guaranteed.
Setup guide
-
MS SQL Server:
Azure SQL Database
,Azure Synapse Analytics
,Azure SQL Managed Instance
,SQL Server 2019
,SQL Server 2017
,SQL Server 2016
,SQL Server 2014
,SQL Server 2012
, orPDW 2008R2 AU34
.
Network Access
Make sure your SQL Server database can be accessed by HeroPixel If your database is within a VPC, you may need to allow access from the HHeroPixelPs.
Permissions
You need a user configured in SQL Server that can create tables and write rows. We highly recommend creating an HeroPixelspecific user for this purpose. In order to allow for normalization, please grant ALTER permissions for the user configured.
Target Database
You will need to choose an existing database or create a new database that will be used to store synced data from HeroPixel
SSL configuration (optional)
HeroPixelsupports a SSL-encrypted connection to the database. If you want to use SSL to securely access your database, ensure that the server is configured to use an SSL certificate.
Setup the MSSQL destination in HeroPixel
You should now have all the requirements needed to configure SQL Server as a destination in the UI. You'll need the following information to configure the MSSQL destination:
- Host
- Port
- Username
- Password
- Schema
-
Database
- This database needs to exist within the schema provided.
-
SSL Method:
-
The SSL configuration supports three modes:
Unencrypted, Encrypted (trust server
certificate), and Encrypted (verify
certificate).
- Unencrypted: Do not use SSL encryption on the database connection
- Encrypted (trust server certificate): Use SSL encryption without verifying the server's certificate. This is useful for self-signed certificates in testing scenarios, but should not be used in production.
- Encrypted (verify certificate): Use the server's SSL certificate, after standard certificate verification.
- Host Name In Certificate (optional): When using certificate verification, this property can be set to specify an expected name for added security. If this value is present, and the server's certificate's host name does not match it, certificate verification will fail.
-
The SSL configuration supports three modes:
Unencrypted, Encrypted (trust server
certificate), and Encrypted (verify
certificate).
Connection via SSH Tunnel
HeroPixelhas the ability to connect to the MS SQL Server instance via an SSH Tunnel. The reason you might want to do this because it is not possible (or against security policy) to connect to the database directly (e.g. it does not have a public IP address).
When using an SSH tunnel, you are configuring HeroPixelto connect to an intermediate server (a.k.a. a bastion sever) that have direct access to the database. HHeroPixelonnects to the bastion and then asks the bastion to connect directly to the server.
Using this feature requires additional configuration, when creating the source. We will talk through what each piece of configuration means.
-
Configure all fields for the source as you normally would, except
SSH Tunnel Method
. -
SSH Tunnel Method
defaults toNo Tunnel
(meaning a direct connection). If you want to use an SSH Tunnel chooseSSH Key Authentication
orPassword Authentication
. -
Choose
Key Authentication
if you will be using an RSA private key as your secret for establishing the SSH Tunnel (see below for more information on generating this key). -
Choose
Password Authentication
if you will be using a password as your secret for establishing the SSH Tunnel. -
SSH Tunnel Jump Server Host
refers to the intermediate (bastion) server that HeroPixelwill connect to. This should be a hostname or an IP Address. -
SSH Connection Port
is the port on the bastion server with which to make the SSH connection. The default port for SSH connections is22
,so unless you have explicitly changed something, go with the default.
-
SSH Login Username
is the username that HeroPixelshould use when connection to the bastion server. This is NOT the MS SQL Server username. -
If you are using
Password Authentication
, thenSSH Login Username
should be set to the password of the User from the previous step.If you are using
SSH Key Authentication
leave this blank. Again, this is not the MS SQL Server password, but the password for the OS-user thatHeroPixelis using to perform commands on the bastion.
-
If you are using
SSH Key Authentication
, thenSSH Private Key
should be set to the RSA Private Key that you are using to create the SSH connection.This should be the full contents of the key file starting with
-----BEGIN RSA PRIVATE KEY-----
and ending with-----END RSA PRIVATE KEY-----
.