Azure Synapse Analytics is an analytics service that combines data warehousing capabilities with Big Data analytics. If offers a unified data engineering platform to ingest, explore, manage, and serve your data for analytics and Business Intelligence. You can query data on your own terms, using either serverless or dedicated computing resources based on your requirements.
RudderStack lets you configure Azure Synapse as a destination to which you can send your event data seamlessly.
Refer to the Warehouse Schemas guide for more information on how the events are mapped to the tables in Azure Synapse.
Find the open-source transformer code for this destination in the GitHub repository.
Before setting up Azure Synapse as a destination in RudderStack, make sure you have an Azure subscription and created the Azure Synapse Workspace.
Additionally, you need to create a dedicated SQL pool in Azure Synapse. You can create it by following the Azure Synapse documentation.
To create a user-defined schema on your dedicated SQL pool, run the following SQL command on your pool:
CREATE SCHEMA <schema_name>;
To send event data to Azure Synapse, you first need to add it as a destination in RudderStack and connect it to your data source. Once the destination is enabled, events will automatically start flowing to Azure Synapse via RudderStack.
To configure Azure Synapse as a destination in RudderStack, follow these steps:
- In your RudderStack dashboard, set up the data source. Then, select Azure Synapse from the list of destinations.
- Assign a name to your destination and then click on Next.
Enter the following credentials in the Connection Credentials page:
- Host: The host name of your Azure Synapse service.
- Database: The database name in your Azure Synapse instance where the data will be sent.
- User: The name of the user with the required read/write access to the above database.
- Password: The password for the above user.
- Port: The port number associated with the Azure Synapse database instance.
- Namespace: Enter the name of the schema created in the Prerequisites section, where RudderStack will create all the tables.
- SSL Mode: Choose the SSL mode through which RudderStack will connect to your Azure Synapse instance. RudderStack provides three options - disable, true, and false.
- Sync Frequency: Specify how often RudderStack should sync the data to your PostgreSQL database.
- Sync Starting At: This optional setting lets you specify the particular time of the day (in UTC) when you want RudderStack to sync the data to the warehouse.
- Exclude Window: This optional setting lets you set a time window when RudderStack will not sync the data to your database.
RudderStack lets you configure the following object storage configuration settings while setting up your Azure Synapse destination:
- Use RudderStack-managed object storage: Enable this setting to use RudderStack-managed buckets for object storage.
This option is applicable only for RudderStack-hosted data planes. For self-hosted data planes, you will have to specify your own object storage configuration settings.
Choose your storage provider: If Use RudderStack-managed object storage is disabled in the dashboard, select the cloud provider for your object storage and enter the relevant settings:
To enable network access to RudderStack, you will need to allowlist the following RudderStack IPs:
If you have your deployment in the EU region, you can allowlist only the following two IPs:
All the outbound traffic is routed through these RudderStack IPs.
There are some limitations when it comes to using reserved words in a schema, table, or column names. If such words are used as event names, traits or properties, they will be prefixed with a
_ when RudderStack creates tables or columns for them in your schema.
Also, note that integers are not allowed at the start of the schema or table name. Hence, RudderStack prefixes such schema, column, or table names with a
'25dollarpurchase' will be changed by RudderStack to
RudderStack converts the event keys into lower case before exporting the data into Azure Synapse, so that it does not create two tables if the event name has two different cases.
While setting up the Azure Synapse destination, RudderStack provides the following three SSL options:
- disable: The data sent from RudderStack to your database is not encrypted.
- false: The data sent from RudderStack to your database is not encrypted beyond the login packet.
- true: The data sent from RudderStack to your database is encrypted.
For more information on the above options, refer to this readme section.