Databases

Learn how to configure Datasherlock for your specific needs. This guide provides insights into setting up your Datasherlock instance with all major sql databases

Database Configurations

Datasherlock offers support for all major databases. Choose the database type that suits your application's requirements and configure it accordingly.

MySQL

Configuration

type: "mysql"
database:
  host: "<DB_HOST>"
  username: "<DB_USERNAME>"
  port: "<DB_PORT>"
  database: "<DB_NAME>"
  ssl: "<DB_SSL>" 

Configuration Options

• host : Your database host URL

• username : Your Database Username

• port : Your Database Password, default 3306

• database : "Your Database name"

• ssl : "SSL is enabled or disable (true, false)"

PostgresSQL

Configuration

type: "postgres"
database:
  host: "<DB_HOST>"
  username: "<DB_USERNAME>"
  port: "<DB_PORT>"
  database: "<DB_NAME>"
  ssl: "<DB_SSL>" 

Configuration Options

• host : Your database host URL

• username : Your Database Username

• port : Your Database Password, default 5432

• database : "Your Database name"

• ssl : "SSL is enabled or disable (enable, disable)"

BigQuery

Configuration

type: "bigquery"
database:
  database: "<DB_NAME>"
  project_id: "<GCP_PROJECT_ID>" 

Configuration Options

• database : "Your Database name"

• project_id : GCP Project id

SnowFlake

Configuration

type: "snowflake"
database:
  database: "<DB_NAME>"
  username: "<SNOWFLAKE_USERNAME>"
  account: "<SNOW_FLAKE_ACCOUNT>"
  warehouse: "<SNOW_FLAKE_WAREHOUSE>"
  schema: "<SNOW_FLAKE_SCHEMA>"

Configuration Options

• database : "Your Database name"

• account : "Only used for snowflake account"

• warehouse : "Only used for snowflake warehouse"

• schema : "Only used for snowflake schema name"

• username : Your Database Username

MsSQL

Configuration

type: "mssql"
database:
  host: "<DB_HOST>"
  username: "<DB_USERNAME>"
  port: "<DB_PORT>"
  database: "<DB_NAME>"

Configuration Options

• host : Your database host URL

• username : Your Database Username

• port : Your Database Password, default 3306

• database : "Your Database name"

Redshift

Configuration

type: "redshift"
database:
  host: "<DB_HOST>"
  username: "<DB_USERNAME>"
  port: "<DB_PORT>"
  database: "<DB_NAME>"
  ssl: "<DB_SSL>" 

Configuration Options

• host : Your database host URL

• username : Your Database Username

• port : Your Database Password, default 443

• database : "Your Database name"

Create Agent

NOTE: On Catalog page will will see API Keys, Each API keys are tightly coupled with agent.

Export Environments variables

export DS_API_KEY=****
export DB_PASSWORD=college

export GOOGLE_APPLICATION_CREDENTIALS=<PATH TO GCP CREDENTIALS> // Only required for bigquery

Register Database Metadata in the Cloud

To connect your agent to the Datasherlock cloud, use the following command. It will register your database schema with cloud

sherlock register --config config.yaml -n <AGENT_NAME>

Run an Agent Locally

To run an API server locally on port 8080, use the following command. You can then use this URL to interact with the platform:

sherlock serve --config config.yaml