Build Azure Synapse-Connect Apps in Choreo

Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

  Free Trial


Use CData Connect Cloud to connect to Azure Synapse from Choreo and build custom apps using live Azure Synapse data.

Choreo is a versatile and comprehensive platform for low-code and cloud-native engineering. Even without any advanced coding skills, developers can make use of Choreo's low-code environment, which simplifies building applications. When paired with CData Connect Cloud, you get instant, cloud-to-cloud access to Azure Synapse data for applications. This article shows how to connect to Azure Synapse in Connect Cloud and build an application with access to live Azure Synapse data in Choreo.

CData Connect Cloud provides a pure cloud-to-cloud interface for Azure Synapse, allowing you to build applications using live Azure Synapse data in Choreo — without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to Azure Synapse, leveraging server-side processing to quickly return the requested Azure Synapse data.

Connect to Azure Synapse in Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "Azure Synapse" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to Azure Synapse.

    Connecting to Azure Synapse

    In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

    • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
    • Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

    Authenticating to Azure Synapse

    Connect to Azure Synapse using the following properties:

    • User: The username provided for authentication with Azure.
    • Password: The password associated with the authenticating user.
  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Azure Synapse Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

  1. Click on your username at the top right of the Connect Cloud app and click User Profile.
  2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
  3. Give your PAT a name and click Create.
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured, you are ready to connect to Azure Synapse data from Choreo.

Connect to Azure Synapse in Choreo

The steps below outline connecting to CData Connect Cloud from Choreo to create a new application with access to live Azure Synapse data.

Creating a Construct

  1. Sign in to the Choreo platform. Note: This article is from the perspective of an Anonymous user.
  2. Select Components from the left sidebar and then click +Create. Next, choose Manual Trigger and then Start from scratch.
  3. Give the manual trigger a Name and Description and click Create.
  4. After the trigger is created, click on Edit Code.
  5. The Ballerina Low-Code IDE is displayed. Choreo automatically generates a construct in the low-code diagram view. Delete this construct by highlighting it and clicking on the trashcan icon.
  6. Click the + icon towards the top of the screen and select Main from the Add Constructs toolbar on the right. In the following Function Configuration form, click Save.

Adding the CData Connect Cloud Connector

  1. Click the + icon between the Start and End ellipses and click Connector.
  2. In the Connectors sidebar on the right, search for "CData". Click CData Connect to open the Connector settings pane.
  3. In the Connector settings pane, enter the configuration settings:
    • Enter an Endpoint Name for your use. In this example, we use "connectEndpoint".
    • In the User field, enter the email address of the CData Connect Cloud user, wrapped in quotation marks (for example, "user@cdata.com").
    • In the Password field, enter the PAT you generated earlier, wrapped in quotation marks (for example, "SampleToken").
  4. After clicking Save, the low-code editor appears with the CData Connect Cloud logo.

Adding a Query Action

  1. Click the + icon between the new and end shapes, select Action, and then select our existing connector endpoint.
  2. Select query for the connector Operation. There is now an Action pane on the right.
  3. Enter a SQL query to retrieve Azure Synapse data as the sqlQuery parameter for the query. For example: SELECT * FROM AzureSynapse1.AzureSynapse.Products LIMIT 10
    • When writing the query, be sure to specify the Connection Name as the catalog and Data Source Name as the schema. For example, AzureSynapse1.AzureSynapse.
    • These parameters appear on the Connections page of your CData Connect Cloud dashboard.

Iterating over Azure Synapse Data

  1. Click the Show Source icon in the top right of the code editor.
  2. Add an import statment to import the ballerina/io library:
    		
    		import ballerina/io;
    	
  3. Next, add a from statement after the query action to iterate through the results of the SQL query:
  4. 		
    		check from record{} result in resultStream
    		do {
    			io:println("Full Products details: ", result);
    		};
    	
  5. The code for the construct will now look similar to this:
  6. 			
    			import ballerinax/cdata.connect;
    			import ballerinax/cdata.connect.driver as _;
    			import ballerina/io;
    
    			public function main() returns error? {
    				connect:Client connectEp = check new (user = "connect_cloud_username", password="connect_cloud_pat");
    
    				stream<record {}, error=""?> resultStream =
    				connectEp->query(sqlQuery = `SELECT * FROM AzureSynapse1.AzureSynapse.Products LIMIT 10`);
    
    				check from record{} result in resultStream
    				do {
    					io:println("Full Products details: ", result);
    				};
    			}
    		
  7. Click Save to save the action. The diagram should now look similar to this:

Deploying the Program

Once you have added all of your desired actions to your program, follow these steps:

  1. Commit and push your final source code in the web editor and sync those changes with the Choreo platform.
  2. Click Deploy in the left navigation bar of the Choreo Console.
  3. Under Build Area, click Configure & Deploy to deploy your program.
  4. When prompted, enter the same CData Connect Cloud username and password that you used earlier and click Deploy.

You have now created an application with access to live Azure Synapse data in Choreo.

Get CData Connect Cloud

For more information about using Choreo with CData Connect Cloud, see the CData Connect Ballerina Guide. To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect Cloud today!