Console
Start free

Azure Synapse

The Azure Synapse connector lets you connect to a Azure Synapse SQL pools and use SQL to retrieve and update the Azure Synapse data.

Before you begin

Before using the Azure Synapse connector, do the following tasks:

Configure the connector

A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following:

  • In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.

    Go to the Connections page

  • Click + Create new to open the Create Connection page.
  • In the Location section, choose the location for the connection.
    1. Region: Select a location from the drop-down list.

      Supported regions for connectors include:

      For the list of all the supported regions, see Locations.

    2. Click Next.
    • In the Connection Details section, complete the following:
    1. Connector: Select Azure Synapse from the drop down list of available Connectors.
    2. Connector version: Select the Connector version from the drop down list of available versions.
    3. In the Connection Name field, enter a name for the Connection instance.

      Connection names must meet the following criteria:

    4. Optionally, enter a Description for the connection instance.
    5. Service Account: Select a service account that has the required roles.
    6. Optionally, configure the Connection node settings:

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

    7. Azure Tenant: This property specifies The Microsoft Azure tenant being used to access data.
    8. Database: This property specifies The name of the Synapse database in the serverless sql pool or dedicated sql pool .
    9. Under Destinations enter the following properties:
      10. .
    10. Optionally enter the following properties for SSL:
    11. Optionally, click + Add label to add a label to the Connection in the form of a key/value pair.
    12. Click Next.
    13. In the Authentication section, enter the authentication details.
      1. Select an Authentication type and enter the relevant details.

        The following authentication types are supported by the Azure Synapse connection:

        • User Password
        • Azure AD

        2. To understand how to configure these authentication types, see Configure authentication.

      2. Click Next.
    14. Review: Review your connection and authentication details.
    15. Click Create.

      16. Configure authentication

      Enter the details based on the authentication you want to use.

      Additional steps after connection creation

      If you selected OAuth 2.0 - Authorization code for authentication, you must do the following additional steps after creating the connection:

      1. In the Connections page, locate the newly created connection.

        Notice that the Status for the new connector will be Authorization required.

      2. Click Authorization required.

        This shows the Edit authorization pane.

      3. Copy the Redirect URI value to your external application.
      4. Verify the authorization details.
      5. Click Authorize.

        If the authorization is successful, the connection status will be set to Active in the Connections page.

      Re-authorization for authorization code

      If you are using Authorization code authentication type and have made any cofiguration changes in your Azure Synapse application, you must re-authorize your Azure Synapse connection. To re-authorize a connection, perform the following steps:

      1. Click on the required connection in the Connections page.

        This opens the connection details page.

      2. Click Edit to edit the connection details.
      3. Verify the OAuth 2.0 - Authorization code details in the Authentication section.

        If required, make the necessary changes.

      4. Click Save. This takes you to the connection details page.
      5. Click Edit authorization in the Authentication section. This shows the Authorize pane.
      6. Click Authorize.

        If the authorization is successful, the connection status will be set to Active in the Connections page.

      Entities, operations, and actions

      All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

      System limitations

      The Azure Synapse connector can process a maximum of 4 transactions per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

      For information on the limits applicable to Integration Connectors, see Limits.

      Supported data types

      The following are the supported data types for this connector:

      Actions

      The Azure Synapse connector lets you execute your stored procedures and custom SQL queries in the format supported by your Azure Synapse. To execute custom SQL queries, the connector provides the Execute custom query action.

      To create a custom query, follow these steps:

      1. Follow the detailed instructions to add a connectors task.
      2. When you configure the connector task, in the type of action you want to perform, select Actions.
      3. In the Action list, select Execute custom query, and then click Done.

        image showing execute-custom-query-action image showing execute-custom-query-action

      4. Expand the Task input section, and then do the following:
        1. In the Timeout after field, enter the number of seconds to wait till the query executes.

          Default value: 180 seconds.

        2. In the Maximum number of rows field, enter the maximum number of rows to be returned from the database.

          Default value: 25.

        3. To update the custom query, click Edit Custom Script. The Script editor dialog opens.

          image showing custom-sql-query image showing custom-sql-query

        4. In the Script editor dialog, enter the SQL query and click Save.

          You can use a question mark (?) in a SQL statement to represent a single parameter that must be specified in the query parameters list. For example, the following SQL query selects all rows from the Employees table that matches the values specified for the LastName column: 

          SELECT * FROM Employees where LastName=?
        5. If you've used question marks in your SQL query, you must add the parameter by clicking + Add Parameter Name for each question mark. While executing the integration, these parameters replace the question marks (?) in the SQL query sequentially. For example, if you have added three question marks (?), then you must add three parameters in order of sequence.

          image showing add-query-param image showing add-query-param

          To add query parameters, do the following:

          1. From the Type list, select the data type of the parameter.
          2. In the Value field, enter the value of the parameter.
          3. To add multiple parameters, click + Add Query Parameter.

          6. The Execute custom query action does not support array variables.

    Entity operation examples

    Example - List records of an entity

    This example lists the records of the Users entity.

    1. In the Configure connector task dialog, click Entities.
    2. Select Users from the Entity list.
    3. Select the List operation, and then click Done.
    4. In the Task Input section of the Connectors task, you can set the filterClause as per your requirement.

      For example, setting the filter clause to employeeCode='5100' and startDate='2010-01-01 00:00:00', lists only those records whose employeeCode is 5100 and startDate is 2010-01-01 00:00:00.

    Example - Get a single record from an entity

    This example fetches a record from the Users entity.

    1. In the Configure connector task dialog, click Entities.
    2. Select User from the Entity list.
    3. Select the Get operation, and then click Done.
    4. In the Task Input section of the Connectors task, click entityId and then enter 103032 in the Default Value field.

      Here, 103032 is the primary key value of the Users entity.

    Example - Delete a record from an entity

    This example deletes a record from the Users entity.

    1. In the Configure connector task dialog, click Entities.
    2. Select Users from the Entity list.
    3. Select the Delete operation, and then click Done.
    4. In the Task Input section of the Connectors task, click entityId and then enter 113132 in the Default Value field.

      Alternately, if the entity has composite primary keys instead of specifying the entityId, you can set the filterClause. For example, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

    Example - Create a record in an entity

    This example creates a record in the Users entity.

    1. In the Configure connector task dialog, click Entities.
    2. Select Users from the Entity list.
    3. Select the Create operation, and then click Done.
    4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
      {
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}

      5. If the integration is successful, the connector task's connectorOutputPayload field will have the response of the create operation.

    Example - Update a record in an entity

    This example updates a record in the Users entity.

    1. In the Configure connector task dialog, click Entities.
    2. Select Users from the Entity list.
    3. Select the Update operation, and then click Done.
    4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
      {
"country": "IN"
}
    5. In the Task Input section of the Connectors task, click entityId and then enter 113132 in the Default Value field.

      Alternately, if the entity has composite primary keys instead of specifying the entityId, you can set the filterClause. For example, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

      6. If the integration is successful, the connector task's connectorOutputPayload field will have the response of the update operation.

    Use the Azure Synapse connection in an integration

    After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

    Get help from the Google Cloud community

    You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

    What's next