Create a Synapse SQL Data Source

Follow these steps to connect to a Synapse SQL and create a Synapse SQL data source:

  1. Configure User Access Rights

  2. Create a Synapse SQL Data Source

Refer to Additional Information for additional performance tips and information about Synapse SQL feature support.

Configure User Access Rights

We recommend that you create a dedicated user and user role for integration with the GoodData platform.

Steps:

  1. Create a user role and grant the following access rights to it:

     GRANT SELECT ON SCHEMA::{schema_name} TO {role_name} WITH GRANT OPTION;

    If you intend to enable pre-aggregation caching, additional usage rights have to be granted for your pre-aggregation schema cache_schema_name:

    GRANT CREATE TABLE TO {role_name};
GRANT ALTER, SELECT, INSERT ON SCHEMA::{cache_schema_name} TO {role_name} WITH GRANT OPTION;

  2. Create a user and grant it with the user role:

    EXEC sp_droprolemember '{role_name}', '{user_name}';

Create a Synapse SQL Data Source

Once you have configured your Synapse SQL user’s access rights, you can proceed to create a Synapse SQL data source that you can then connect to.

UI
API

Steps:

  1. On the home page switch to Data sources.

    data sources tab

  2. Click Connect data.

    connect data

  3. Select Synapse SQL.

    select data source type

  4. Name your data source and fill in your Synapse SQL credentials and click Connect:

    db cretentials

  5. Input your schema name and click Save:

    db cretentials

    Your data source is created!

    db creation complete

Steps:

  1. Create a Synapse SQL data source with the following API call:

    curl $HOST_URL/api/v1/entities/dataSources \
  -H "Content-Type: application/vnd.gooddata.api+json" \
  -H "Accept: application/vnd.gooddata.api+json" \
  -H "Authorization: Bearer $API_TOKEN" \
  -X POST \
  -d '{
    "data": {
    "type": "dataSource",
    "id": "<unique_id_for_the_data_source>",
    "attributes": {
      "name": "<data_source_display_name>",
      "url": "jdbc:sqlserver://<SYNAPSE_HOST>:5432",
      "schema": "<SYNAPSE_SCHEMA>",
      "type": "SYNAPSESQL",
      "username": "<SYNAPSE_USER>",
      "password": "<SYNAPSE_PASSWORD>"
    }
    }
  }' | jq .

  2. To confirm that the data source has been created, ensure the server returns the following response:

    {
  "data": {
    "type": "dataSource",
    "id": "<unique_id_for_the_data_source>",
    "attributes": {
      "name": "<data_source_display_name>",
      "url": "jdbc:sqlserver://<SYNAPSE_HOST>:5432",
      "schema": "<SYNAPSE_SCHEMA>",
      "type": "SYNAPSESQL",
      "username": "<SYNAPSE_USER>"
    }
  },
  "links": {
    "self": "$HOST_URL/api/v1/entities/dataSources/<unique_id_for_the_data_source>"
  }
}

Additional Information

Ensure you understand the following limitations and recommended practice.

Data Source Details

  • The JDBC URL must be in the following format:

    jdbc:sqlserver://<host>:<port>

  • Basic authentication is supported. Specify user and password.

  • GoodData uses up-to-date drivers.

  • The following database versions are supported:

    • 13.0 (SQL Server 2016)
    • 14.0 (SQL Server 2017)
    • 15.0 (SQL Server 2019)
    • 16.0 (SQL Server 2022)

Unsupported Features

GoodData does not support the following features:

  • Functions GREATEST, LEAST with more than two arguments

  • Aggregation functions: CORREL, COVAR and SLOPE

Known Issues

  • In a visualization if there are no results returned (for example by filtering them all out), you will still get a result containing one row with the number 0, instead of getting a true “no data” result.

Performance Tips

If your database holds a large amount of data, consider the following practices:

  • Denormalize the relational data model of your database. This helps avoid large JOIN operations. Because Synapse SQL is a columnar database, queries read only the required columns and each column is compressed separately.

  • Index the columns that are most frequently used for JOIN and aggregation operations. Those columns may be mapped to attributes, labels, primary and foreign keys.

Query Timeout

Query timeout is configurable per application instance. It is a parameter of the sql-executor service, default value is 160 seconds.

Query timeout is closely related to the ACK timeout. Proper configuration of the system requires that ACK timeout is longer than query timeout. Default ACK timeout value is 170 seconds.

Permitted parameters

  • AADSecurePrincipalId
  • AADSecurePrincipalSecret
  • accessToken
  • applicationIntent
  • applicationName
  • authentication
  • authenticationScheme
  • columnEncryptionSetting
  • connectRetryCount
  • connectRetryInterval
  • database
  • databaseName
  • delayLoadingLobs
  • disableStatementPooling
  • domainName
  • domain
  • enablePrepareOnFirstPreparedStatementCall
  • encrypt
  • hostNameInCertificate
  • instanceName
  • keyVaultProviderClientId
  • keyVaultProviderClientKey
  • lastUpdateCount
  • msiClientId
  • multiSubnetFailover
  • packetSize
  • port
  • portNumber
  • realm
  • replication
  • selectMethod
  • sendStringParametersAsUnicode
  • sendTemporalDataTypesAsStringForBulkCopy
  • sendTimeAsDatetime
  • server
  • serverName
  • serverNameAsACE
  • serverPreparedStatementDiscardThreshold
  • serverSpn
  • sslProtocol
  • TransparentNetworkIPResolution
  • trustServerCertificate
  • useFmtOnly
  • workstationID
  • xopenStates
PostgreSQL Server
Vertica