Connection String Reference

The BEEM ODBC Driver accepts the following parameters in the connection string or DSN configuration. Most parameters are configured at install time — you typically only need to provide your credentials.

General parameters

Parameter	Required	Default	Description
`MODE`	No	`Direct`	Connection mode: `Direct` or `DataAPI`
`DATABASE`	Yes		Database name
`BACKEND_DRIVER`	No	`Amazon Redshift ODBC Driver (x64)`	Backend ODBC driver name (Direct mode only)

Direct mode parameters

Parameter	Required	Default	Description
`SERVER`	Yes		BEEM Data Warehouse endpoint hostname
`PORT`	No	`5439`	Connection port
`UID`	No		Database username
`PWD`	No		Database password
`SSL_MODE`	No	`verify-full`	SSL mode (`disable`, `require`, `verify-ca`, `verify-full`). Automatically downgraded to `require` when using a secure tunnel.

Tunnel parameters

These parameters configure the secure tunnel. They are typically configured at install time and do not need to be set manually. Only used in Direct mode.

Parameter	Required	Default	Description
`SSH_HOST`	Yes (for tunnel)		Tunnel host address
`SSH_PORT`	No	`22`	Tunnel port
`SSH_USER`	Yes (for tunnel)		Tunnel username
`SSH_AUTH`	No	`key`	Authentication method: `key` or `password`
`SSH_KEY_FILE`	Yes (if `SSH_AUTH=key`)		Path to private key file
`SSH_PASSPHRASE`	No		Passphrase for encrypted key
`SSH_PASSWORD`	Yes (if `SSH_AUTH=password`)		Tunnel password
`SSH_HOST_KEY_FP`	No		Expected host key fingerprint (`SHA256:...`). If not set, all host keys are accepted.
`SSH_KEEPALIVE`	No	`30`	Keepalive interval in seconds

Data API mode parameters

These parameters are for environments without bastion or SSH network permissions (e.g. due to org policies). Data API mode connects via HTTPS instead of a secure tunnel.

Parameter	Required	Default	Description
`CLUSTER_ID`	Yes*		Cluster identifier
`WORKGROUP_NAME`	Yes*		Serverless workgroup name
`REGION`	No	`us-east-1`	AWS region
`AWS_PROFILE`	No		AWS CLI profile name
`AWS_ACCESS_KEY_ID`	No		AWS access key (explicit credentials)
`AWS_SECRET_ACCESS_KEY`	No		AWS secret key
`AWS_SESSION_TOKEN`	No		AWS session token (temporary credentials)
`AWS_ROLE_ARN`	No		IAM role to assume
`SECRET_ARN`	No		Secrets Manager ARN for database credentials
`POLL_INTERVAL_MS`	No	`200`	Polling interval for async query execution
`POLL_MAX_MS`	No	`300000`	Maximum wait time for query results (5 minutes)

*Either CLUSTER_ID or WORKGROUP_NAME is required.

Examples

Direct mode (typical)

DRIVER={BEEM ODBC Driver};
MODE=Direct;
SERVER=your-beem-warehouse-endpoint;
PORT=5439;
DATABASE=analytics;
UID=admin;
PWD=secret

Server, database, and tunnel settings are typically configured at install time. You only need to provide credentials.

Direct mode without tunnel

DRIVER={BEEM ODBC Driver};
MODE=Direct;
SERVER=your-beem-warehouse-endpoint;
PORT=5439;
DATABASE=analytics;
UID=admin;
PWD=secret

Data API mode

DRIVER={BEEM ODBC Driver};
MODE=DataAPI;
DATABASE=analytics;
CLUSTER_ID=my-cluster;
REGION=us-east-1;
AWS_PROFILE=production

Data API mode with Serverless

DRIVER={BEEM ODBC Driver};
MODE=DataAPI;
DATABASE=analytics;
WORKGROUP_NAME=default;
REGION=us-east-1

Environment variables

Variable	Description
`BEEM_ODBC_LOG`	Path to the log file. Defaults to `C:\ODBC\BEEM\beem_odbc.log` on Windows.
`BEEM_ODBC_LOG_LEVEL`	Log verbosity: `error`, `info` (default), or `debug`