Connect with GoodData

Prerequisites

An active SingleStore Helios deployment.
Add the GoodData Cloud IP address to the IP Allowlist (firewall) of your SingleStore Helios deployment (go to Cloud Portal > your_workspace > Firewall > IP Allowlist > Edit).
SingleStore recommends using a dedicated SingleStore database user with the required privileges for integration with GoodData.

Run the following command to create a user:
SQL
```
CREATE USER <username> IDENTIFIED BY '<password>';
```
Refer to CREATE USER for more information.

Create a SingleStore Data Source in GoodData

The SingleStore data source can be configured in GoodData using any of the following methods:

Using the GoodData UI
Using the GoodData Entity API

Using the GoodData UI

To connect to SingleStore from GoodData:

On the GoodData homepage, select Data sources > Connect data.
On the Connect data dialog, select SingleStore from the list of supported databases.
Enter a name for the data source, for example, SingleStore.
Enter or select the following information in the Enter your SingleStore credentials section:
- Connection URL:
  - Enter the hostname or IP address of your SingleStore Helios deployment.
  - Enter the port of your SingleStore Helios deployment. Default is 3306.
- SSL mode: Select the SSL mode from the list.
- Username: Enter the username of the SingleStore database user.
- Password: Enter the password for the SingleStore database user.
- Database name: Enter the name of the SingleStore database to connect with.
Select Connect.
From the Set cache preference list, select the cache preference.
Select Save.

The SingleStore data source is configured and ready to use.

Using the GoodData Entity API

To configure a data source via the GoodData Entity API, make an API call to the ../api/v1/entities/dataSources endpoint. Here's an example:

Shell

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:mysql://<SINGLESTORE_HOST>:<SINGLESTORE_PORT>/<SINGLESTORE_DBNAME>",
    "schema": "<SINGLESTORE_DBNAME>",
    "type": "SINGLESTORE",
    "username": "<SINGLESTORE_USER>",
    "password": "<SINGLESTORE_PASSWORD>"
}}}' | jq .

On a successful API call, the server returns a response similar to the following:

{
  "data": {
    "type": "dataSource",
    "id": "<unique_id_for_the_data_source>",
    "attributes": {
      "name": "<data_source_display_name>",
      "url": "jdbc:mysql://<SINGLESTORE_HOST>:<SINGLESTORE_PORT>/<SINGLESTORE_DBNAME>",
      "schema": "<SINGLESTORE_DBNAME>",
      "type": "SINGLESTORE",
      "username": "<SINGLESTORE_USER>"
    }
  },
  "links": {
    "self": "$HOST_URL/api/v1/entities/dataSources/<unique_id_for_the_data_source>"
  }
}

For more information, refer to GoodData API documentation.

Remarks

The SingleStore data source only supports Basic Authentication.

The following table lists the minimum permissions required for the SingleStore database user to perform the respective task:

Task	Minimum Permission Required
Data Rendering	`SELECT`
Caching database	`CREATE`, `DROP`

Refer to GRANT for more information.

For a list of SingleStore features that are not supported by GoodData, refer to Unsupported Features and Limitations.