VOOZH about

URL: https://www.cdata.com/kb/tech/singlestore-cloud-retool.rst

⇱ Seamlessly Bring SingleStore Data into Retool Using CData Connect AI

Seamlessly Bring SingleStore Data into Retool Using CData Connect AI

👁 Mohsin Turki
Mohsin Turki
Technical Marketing Engineer
Integrate SingleStore data into Retool with CData Connect AI to build smarter apps and streamline workflows with real-time data access.

Retool enables the rapid creation of custom internal tools using a low-code or no-code approach. By integrating SingleStore into Retool with CData Connect AI, you can access live data from SingleStore in real time, enabling you to build more efficient apps and streamline workflows.

This guide walks you through the simple steps to connect SingleStore to Retool via CData Connect AI using OpenAPI or the Virtual SQL Server API. You can securely connect to your SingleStore data, ensuring seamless integration and real-time updates, empowering you to create smarter apps and enhance operational efficiency. Let's get started!

Configure the SingleStore Connectivity for Retool (in CData Connect AI)

Overview

Here is an overview of the steps:

  1. Configure: (Optional) Set up your SingleStore data source in CData Connect AI, add a Workspace, add assets to your Workspace, and generate a Personal Access Token (PAT).
  2. Connect: Link Retool to CData Connect AI using OpenAPI or the Virtual SQL Server API.
  3. Explore: Use your connected data to build smarter apps and explore advanced integrations.

Prerequisites

Ensure you have the following before starting:

  1. An active SingleStore account and credentials.
  2. A CData Connect AI account. Log in or sign up for a free trial here.
  3. A Retool account. Sign up here.

Connect to SingleStore from Connect AI

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

  1. Log into Connect AI, click Sources, and then click Add Connection
    2. 👁 Adding a Connection
  2. Select "SingleStore" from the Add Connection panel
    3. 👁 Selecting a data source
  3. Enter the necessary authentication properties to connect to SingleStore.

    The following connection properties are required in order to connect to data.

    • Server: The host name or IP of the server hosting the SingleStore database.
    • Port: The port of the server hosting the SingleStore database.
    • Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.

    Connect Using Standard Authentication

    To authenticate using standard authentication, set the following:

    • User: The user which will be used to authenticate with the SingleStore server.
    • Password: The password which will be used to authenticate with the SingleStore server.

    Connect Using Integrated Security

    As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.

    Connect Using SSL Authentication

    You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

    • SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
    • SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
    • SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
    • SSLClientCertType: The certificate type of the client store.
    • SSLServerCert: The certificate to be accepted from the server.

    Connect Using SSH Authentication

    Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

    • SSHClientCert: Set this to the name of the certificate store for the client certificate.
    • SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
    • SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
    • SSHClientCertType: The certificate type of the client store.
    • SSHPassword: The password that you use to authenticate with the SSH server.
    • SSHPort: The port used for SSH operations.
    • SSHServer: The SSH authentication server you are trying to authenticate against.
    • SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
    • SSHUser: Set this to the username that you use to authenticate with the SSH server.
    👁 Configuring a connection (Salesforce is shown)
  4. Click Save & Test
  5. Navigate to the Permissions tab in the Add SingleStore Connection page and update the User-based permissions. 👁 Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. 👁 Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure SingleStore Endpoints for Retool

After connecting to SingleStore, create a workspace for your desired table(s).

  1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace). 👁 The Workspaces page.
    👁 Adding a new Workspace.
  2. Click Add to add new assets to the Workspace.
  3. Select the SingleStore connection (e.g. SingleStore1) and click Next. 👁 Selecting an Asset (Salesforce is shown).
  4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
  5. Make note of the OpenAPI URL or the Virtual SQL Server URL for your workspace, e.g. https://cloud.cdata.com/api/openapi/v3/{workspace_name}...

With the connection, PAT, and Workspace configured, you are ready to connect to SingleStore data from Retool.


Connect Retool to SingleStore in CData Connect AI

Now that you've configured your SingleStore connection in CData Connect AI, it's time to integrate it with Retool.

Retool can be connected to SingleStore in CData Connect AI via either OpenAPI or the Virtual SQL Server API. Choose the method that best suits your workflow:

Connect via OpenAPI

To connect using the OpenAPI specification, follow these steps:

  1. On CData Connect AI, from the left-hand side, go to Workspaces then select a Workspace.
  2. Click the View Endpoints, and under the OpenAPI, copy the OpenAPI URL for the workspace. Keep the default options. See OpenAPI section for more information. 👁 Copying OpenAPI URL in CData Connect AI
  3. Login to Retool and then go to the Resources tab, click Create new > Resource.
  4. In the Select a resource type search bar, and search for OpenAPI.
  5. Click OpenAPI. The Configure OpenAPI screen appears. Enter the following information to configure the OpenAPI connector:
    • Name: The Connection Name to identify the connector on Retool.
    • Specification URL: The OpenAPI URL you copied from the Workspace in CData Connect AI. Paste the URL here.
    • Forward headers when fetching OpenAPI spec: Check this box.
    • Under the URL parameters, keep the key-value pair unchanged.
    • In the Headers section, write the key as Authorization and in the value, write Basic.
    • For the Basic connection value, Retool requires a base64-encoded version of your CData Connect AI username:PAT combination (where PAT is the token you generated earlier). Use a tool like this to encode the value. For example, [email protected]:12345 encodes to dGVzdEBjZGF0YS5TIzNDU=. Copy this encoded value and paste it into the value field after Basic with a space.
    • Username: Enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
    • Password: Enter the PAT you generated on the Settings page.
    👁 Configuring OpenAPI Resource in Retool
  6. Click Test connection to test your connection configuration. Once you have a successful connection, click Create resource.
  7. Create the app in Retool in which to integrate your data.
  8. Click Create resource query. 👁 Resource Query Screen for OpenAPI in Retool
  9. Select the new resource you created, and view the endpoints that are available. 👁 Resource Query Screen for OpenAPI in Retool
  10. You can now build your app with your live SingleStore data. 👁 Resource Query Screen for OpenAPI in Retool

Connect via Virtual SQL Server API

To connect using the Virtual SQL Server API, follow these steps:

  1. Login to Retool, then go to Resources. Click Connect New at the top-right and select Resources.
    2. 👁 Retool OpenAPI Resource Search
  2. Enter Microsoft SQL in the search bar, click the resulting option, and enter the following details:
    3. 👁 Microsoft SQL Resource Searched in Retool
    • Name: A name for the connection to CData Connect AI.
    • Host: tds.cdata.com.
    • Port: 1433.
    • Database Name: Enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Salesforce1).
    • Database Username: Enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
    • Database Password: Enter the PAT you generated on the Settings page.
    👁 Microsoft SQL Resource Details in Retool
  3. Click Test Connection. If the connection fails, you might need to whitelist CData Connect AI IPs for Retool and other data sources. Check out the documentation here.
  4. If it succeeds, click Create Resource.
  5. Your connection is now set up, and you can build your app with live SingleStore data.

Build Retool Apps with Your Live SingleStore Data

Now that you have integrated SingleStore with Retool using CData Connect AI, it's time to utilize your live data to its full potential. Let's build a simple app:

  • Step 1: Set Up the Table (on home screen)
    • Create a New App in Retool.
    • Select your SingleStore connection.
    • Add a Table component and bind it to SingleStore's data.
      • 👁 New App in Retool
  • Step 2: Add Filters (on top-right)
  • Step 3: Display Key Metrics (below Table)
    • Add a Text component to show Total Amount of filtered opportunities.
    • Use a query to sum the Amount for filtered data.
  • Step 4: Add Visuals (top-right or side panel)
    • Add a Bar Chart to visualize opportunities by Stage.
    • Add a Line Chart to show Expected Revenue over time.
  • Step 5: Test and Deploy (top-right)
    • Test filters, search, and charts.
    • Deploy the app and share the link for access.

With these steps, you've successfully created a dynamic app to manage and visualize your Salesforce opportunities. Enjoy exploring your live data and leveraging it for better insights!


Try CData Connect AI Free for 14 Days

Experience real-time SingleStore data access and enhanced app development with CData Connect AI in Retool. Start your free trial today!

Ready to get started?

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

Free Trial