Creating a Connection

This guide walks you through creating a database connection in DataRecs.

Prerequisites

• A DataRecs account with access to a workspace.
• Network connectivity from DataRecs to your database (your admin may need to allowlist DataRecs egress IPs).
• Database credentials with read access.

Create the connection

Console

1. Navigate to Connections in the sidebar.
2. Click New Connection.
3. Select your database type (e.g. MySQL, PostgreSQL, Oracle, DB2).
4. Fill in the connection details:
   • Name — a friendly label for this connection.
   • Host — the database hostname or IP.
   • Port — the database port.
   • Database — the schema/database name.
   • Username and Password.
5. Click Test Connection to validate.
6. Once the test passes, click Save.

DataRecs CLI

datarecs connection create \
  --name "production-mysql" \
  --type mysql \
  --host db.example.com \
  --port 3306 \
  --database mydb \
  --username readonly_user

You will be prompted for the password. The CLI encrypts it before transmission.

Terraform

resource "datarecs_connection" "prod_mysql" {
  workspace_id = datarecs_workspace.main.id
  name         = "production-mysql"
  type         = "mysql"
  host         = "db.example.com"
  port         = 3306
  database     = "mydb"
  username     = "readonly_user"
  password     = var.db_password
}

tofu plan
tofu apply

REST API

curl -X POST https://api.datarecs.com/v1/connections \
  -H "Authorization: Bearer $DATARECS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production-mysql",
    "type": "mysql",
    "host": "db.example.com",
    "port": 3306,
    "database": "mydb",
    "username": "readonly_user",
    "password": "REDACTED"
  }'

What happens behind the scenes

1. DataRecs validates connectivity by opening a test connection to your database.
2. Credentials are envelope-encrypted and stored in HashiCorp Vault.
3. A Kubernetes Network Policy is created to allow egress traffic to your database host.

Troubleshooting

Issue	Solution
Connection timeout	Verify your database is reachable from DataRecs. Check firewall rules and allowlisted IPs.
Authentication failed	Double-check username and password. Ensure the user has SELECT privileges.
SSL required	Add --ssl flag (CLI) or set "ssl": true in the connection config.