Sign inTry Free

Important

Helios features are now enabled during weekly update windows and are no longer directly tied to SingleStore engine releases. Refer to the release notes to view the latest features available in your Helios cluster.

Connect with Metabase

On this page

Metabase is an open-source business intelligence and data visualization platform. Use Metabase with SingleStore to explore data, create questions, build dashboards, and run analytics on SingleStore databases.

Prerequisites

  • A self-hosted Metabase instance, running on a local host or in a Docker container, with the required permissions.

  • An active SingleStore cluster.

  • Download the latest SingleStore Metabase driver JAR file (singlestore.metabase-driver.jar) from the SingleStore driver for Metabase GitHub repository.

Connect Metabase to SingleStore

Note

These connection configuration steps only apply to self-hosted Metabase deployments. Metabase Cloud does not support community drivers.

To configure a SingleStore database connection in Metabase:

  1. Copy the singlestore.metabase-driver.jar file to the plugins directory on the host or container where Metabase is running. By default, Metabase uses the plugins directory under its working directory. To use a custom directory, set the MB_PLUGINS_DIR environment variable to the custom directory path and then copy the file to this directory.

  2. Restart Metabase. Metabase loads drivers during startup.

    1. For a Docker container, run the following command:

      docker restart <container_name>

    2. For a non-Docker installation, restart the Metabase process.

  3. Confirm that the SingleStore driver is now loaded in Metabase.

    1. Sign in to Metabase, and select Databases > Add a database.

    2. Confirm that SingleStore appears in the Database type list, and select it.

    3. Under Display name, enter a name for the connection. For example, SingleStore.

  4. Add the SingleStore database. Specify the following to configure the SingleStore database connection.

    Field

    Description

    Host

    Hostname or IP address of the SingleStore cluster.

    Refer to SingleStore Helios Endpoints to determine the endpoint (host:port) of the cluster.

    Port

    Port of the SingleStore cluster. The default is 3306.

    Database Name

    Name of the SingleStore database to connect with.

    Username

    Username of the SingleStore database user.

    Password

    Password for the SingleStore database user.

    (Optional) If the connection requires SSL or an SSH tunnel, configure the corresponding options in the Metabase connection settings. For additional options, expand the Show advanced options section and specify the connection options in JDBC-compatible connection string format, for example connectTimeout=10000&socketTimeout=60000.

  5. Select Save to save the database connection. Wait until Metabase synchronizes the database schema and discovers all the tables in the specified database.

The SingleStore connection is now configured in Metabase.

Browse SingleStore Data

To verify the connection and browse the SingleStore data:

  1. Select New > Question.

  2. Under Data, select the SingleStore connection.

  3. Confirm that the expected schemas and tables are available, and then select the required table(s).

  4. Create a question or run a native SQL query to verify that Metabase can read data from SingleStore.

Update the SingleStore Database Connection Configuration

To update the SingleStore database connection configuration:

  1. On the Metabase Admin page, select Databases > SingleStore (name of the connection).

  2. Under Connection & sync, select Edit connection details.

  3. On the Edit connection details page, update the required connection configuration options.

  4. Select Save changes to update the connection configuration.

The SingleStore database connection is now updated.

Troubleshooting

  • If SingleStore does not appear in the database list:

    • Confirm that the driver JAR is in the Metabase plugins directory, on the same host, or in the same container where Metabase runs.

    • Restart Metabase after copying the JAR.

  • If Metabase cannot connect to SingleStore:

    • Verify the connection configuration for the SingleStore database.

    • Confirm that the Metabase host can reach the SingleStore endpoint over the network.

    • Confirm that the SingleStore database user has the required permissions to connect to the database and read the database and tables.

    • If SingleStore is configured to accept only encrypted connections or an SSH tunnel, configure these options in the Metabase database connection settings.

  • If tables do not appear after the connection succeeds:

    • Wait for the initial schema synchronization to finish.

    • Confirm that the selected database contains the expected tables.

    • Confirm that the configured SingleStore user has permission to view the database and tables.

    • Check the Metabase logs for synchronization errors.

Related Topics

Last modified:

Was this article helpful?

On this page

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined

  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined

  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
        cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
          --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
          --bundle undefined \
          --new-bundle-format -
    Verified OK

Try Out This Notebook to See What’s Possible in SingleStore

Get access to other groundbreaking datasets and engage with our community for expert advice.

Sign UpLog In