Database credentials
Under the hood, Embeddable relies on an open-source library called Cube (opens in a new tab) to connect to your database.
Below are the type and credentials fields you’ll need when connecting your database.
Athena
Cube docs (opens in a new tab)
type: 'athena',
credentials: {
accessKeyId: '...',
secretAccessKey: '...',
region: '...',
// S3OutputLocation: '...',
// workGroup: '...',
// catalog: '...',
// schema: '...',
// concurrency: '...',
}BigQuery
Cube docs (opens in a new tab)
type: 'bigquery',
credentials: {
projectId: '...',
credentials: {
"type": "service_account",
"project_id": "...",
"private_key_id": "...",
"private_key": "...",
// ...
}
}Clickhouse
Cube docs (opens in a new tab)
type: 'clickhouse',
credentials: {
database: '...',
host: '...',
user: '...',
password: '...',
port: 8443
}Databricks
Cube docs (opens in a new tab)
type: 'databricks-jdbc',
credentials: {
url: '...',
token: '...',
}Druid
Cube docs (opens in a new tab)
type: 'druid',
credentials: {
url: '...',
user: '...',
password: '...',
// database: '...'
}
Elasticsearch
Cube docs (opens in a new tab)
type: 'elasticsearch',
credentials: {
url: '...',
// queryFormat: '...',
// openDistro: '...',
// ssl: '...',
}MySQL / MariaDB
Cube docs (opens in a new tab)
type: 'mysql',
credentials: {
database: '...',
host: '...',
user: '...',
password: '...',
port: 3306,
ssl: true
}Postgres
Cube docs (opens in a new tab)
type: 'postgres',
credentials: {
database: '...',
host: '...',
user: '...',
password: '...',
port: 5432,
ssl: true // or { rejectUnauthorized: false }
}Redshift
Cube docs (opens in a new tab)
type: 'redshift',
credentials: {
database: '...',
host: '...',
user: '...',
password: '...',
port: 5439,
ssl: true
}Snowflake
Cube docs (opens in a new tab)
type: 'snowflake',
credentials: {
account: '...',
warehouse: '...',
database: '...',
username: '...',
"authenticator": "SNOWFLAKE_JWT",
"privateKey": "-----BEGIN PRIVATE KEY-----\n........\n-----END PRIVATE KEY-----"
// password: '...',
// role: '...',
// region: '...',
}MS SQL / SQL Server
Cube docs (opens in a new tab)
type: 'mssql',
credentials: {
server: '...',
port: 1433,
user: '...',
password: '...',
database: '...',
options: {
// trustServerCertificate: true
}
}Trino
Cube docs (opens in a new tab)
type: 'trino',
credentials: {
host: "...",
port: "...",
catalog: "...",
schema: "...",
user: "...",
basic_auth: {
user: "...",
password: "..."
},
ssl: {}
}More databases
For the full list of supported databases, click here (opens in a new tab).