Back to Genai Toolbox

SingleStore Source

docs/en/integrations/singlestore/source.md

1.1.05.0 KB
Original Source

About

SingleStore is a distributed SQL database built to power intelligent applications. It is both relational and multi-model, enabling developers to easily build and scale applications and workloads.

SingleStore is built around Universal Storage which combines in-memory rowstore and on-disk columnstore data formats to deliver a single table type that is optimized to handle both transactional and analytical workloads.

Available Tools

{{< list-tools >}}

Requirements

Database User

This source only uses standard authentication. You will need to create a database user to login to the database with.

Example

Basic

By default, connections use tls=preferred, which enables SSL/TLS if the server supports it and falls back to unencrypted otherwise.

yaml
kind: source
name: my-singlestore-source
type: singlestore
host: 127.0.0.1
port: 3306
database: my_db
user: ${USER_NAME}
password: ${PASSWORD}
queryTimeout: 30s # Optional: query timeout duration

With SSL required

yaml
kind: sources
name: my-singlestore-source
type: singlestore
host: svc-abc123.svc.singlestore.com
port: 3306
database: my_db
user: ${USER_NAME}
password: ${PASSWORD}
connectionParams:
  tls: "true" # Require TLS and verify the server certificate

With SSL verification disabled

yaml
kind: sources
name: my-singlestore-source
type: singlestore
host: svc-abc123.svc.singlestore.com
port: 3306
database: my_db
user: ${USER_NAME}
password: ${PASSWORD}
connectionParams:
  tls: "skip-verify" # Require TLS but skip server certificate verification

Without SSL

yaml
kind: sources
name: my-singlestore-source
type: singlestore
host: 127.0.0.1
port: 3306
database: my_db
user: ${USER_NAME}
password: ${PASSWORD}
connectionParams:
  tls: "false" # Disable TLS

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

Reference

fieldtyperequireddescription
typestringtrueMust be "singlestore".
hoststringtrueIP address or hostname to connect to (e.g. "127.0.0.1").
portstringtruePort to connect to (e.g. "3306").
databasestringtrueName of the SingleStore database to connect to (e.g. "my_db").
userstringtrueName of the SingleStore database user to connect as (e.g. "admin").
passwordstringtruePassword of the SingleStore database user.
queryTimeoutstringfalseMaximum time to wait for query execution (e.g. "30s", "2m"). By default, no timeout is applied.
connectionParamsmap[string]stringfalseAdditional driver parameters appended to the DSN. Supports any go-sql-driver/mysql DSN parameter. Commonly used for SSL configuration (see tls values below).