Azure Synapse - Placeholder values - 1.7
Please consult the article Replace the placeholders in the Artifacts to learn how to replace the placeholders with the values explained below.
Placeholder values
Depending on the Generator Configuration you are using for an Azure Synapse Target Technology, you can replace the placeholder values with the following:
database_name
Each database_name is filled by default with the layer name (example: rawvault).
It should contain the database name of the Target Data Lake.
If you are using a Linked Project (from a Stage JDBC or a Stage File Project), it should contain the database name of the Target Data Lake containing the source table created before with the Linked Project.
database_directory
Each database_directory placeholder should contain the path to create the Target Parquet files.
If you are using our Azure Synapse environment example, the path is the one inside the Storage Account chosen to store the Target Data Lake
abfss://docu-datalake@bgsynapsedatalake1.dfs.core.windows.net/rawvault/ for the Raw Vault layer placeholder
- docu-datalake is the name of the folder we created inside the Storage Account
- bgsynapsedatalake1 is the name of the Storage Account itself
All the paths should have a slash appended at the end: abfss://docu-datalake@bgsynapsedatalake1.dfs.core.windows.net/rawvault/
schema_name
Each database_directory must be empty, it is not needed for Azure Synapse.
execution_dependencies_file_path
If you plan to use a native loaded control using multi-threading load, please update the execution_dependencies_file_path placeholder with the path that contains the dependencies file.
Example: abfss://docu-datalake@bgsynapsedatalake1.dfs.core.windows.net/dependencies/
file_path
Each file_path placeholder should contain the path where the Source Parquet files are available.
Suppose you are using our Azure Synapse Stage File environment example. In that case, the path is the one inside the Storage Account chosen to store the Source Parquet filesabfss://source@bgsynapselandingzone1.dfs.core.windows.net/adventureworks
- source is the name of the folder we created inside the Storage Account
- bgsynapselandingzone1 is the name of the Storage Account itself
- adventureworks is the name of the subfolder we created inside the source folder
Please use the same path for all the file_path placeholder. Each Parquet source file is stored in an uppercase folder with the same name. This folder name will be generated automatically. Please don't use it in the placeholder replacement.
All the paths should have a slash appended at the end: abfss://docu-datalake@bgsynapsedatalake1.dfs.core.windows.net/stage/
jdbc_url
For a SQL Server JDBC source, for example: jdbc:sqlserver://{ServerName}.database.windows.net:1433;encrypt=true;databaseName={DatabaseName};trustServerCertificate=true;
Replace:
- {ServerName} with your Azure SQL Server name
- {DatabaseName} with your SQL Server database name.
jdbc_driver
For a SQL Server JDBC source, for example:
com.microsoft.sqlserver.jdbc.SQLServerDriver
jdbc_user
For a SQL Server JDBC source, for example:
'{DatabaseUser}'
Replace {DatabaseUser} with your SQL Server user
Putting the user inside quotes 'user_name' is essential.
Or you can use KeyVault to store a secret.
In this case, the syntax should be:
dbutils.secrets.get(scope='jdbc', key='<name of the secret>')
jdbc_password
For a SQL Server JDBC source, for example:
'{DatabasePassword}'
Replace {DatabasePassword} with your SQL Server password
Putting the password inside quotes 'password' is essential.
You can download a replacement_config.json example here for: