Skip to main content

Exasol

Test data in Exasol.

1. Install

uv tool install --python python3.11 --upgrade 'datacontract-cli[exasol]'

See Installation for pip, pipx, and Docker.

2. Authenticate

Create a .env file in your working directory (or export the variables):

# .env
DATACONTRACT_EXASOL_USERNAME=sys
DATACONTRACT_EXASOL_PASSWORD=mysecretpassword
Environment variableDefaultDescription
DATACONTRACT_EXASOL_USERNAMEDatabase user (required)
DATACONTRACT_EXASOL_PASSWORDPassword (required)
DATACONTRACT_EXASOL_FINGERPRINTSHA-256 fingerprint of the server certificate, see TLS
DATACONTRACT_EXASOL_VALIDATE_CERTIFICATEtrueSet to false to skip the certificate check, see TLS
DATACONTRACT_EXASOL_HOSTOverrides host in the servers block
DATACONTRACT_EXASOL_PORT8563Overrides port in the servers block
DATACONTRACT_EXASOL_SCHEMAOverrides schema in the servers block

3. Describe the server in the contract

The exasol server type was added in ODCS v3.2.0, so the contract has to declare apiVersion: v3.2.0.

apiVersion: v3.2.0
kind: DataContract
id: orders
version: 1.0.0
status: active
servers:
- server: production
type: exasol
host: exasol.acme.com
port: 8563
schema: sales
schema:
- name: orders
properties:
- name: order_id
logicalType: integer
physicalType: DECIMAL(18,0)
primaryKey: true
- name: order_total
logicalType: number
physicalType: DECIMAL(10,2)

host may be a cluster range (n11..14.acme.com).

4. Test actual data

datacontract test datacontract.yaml
Testing datacontract.yaml
Server: production (type=exasol, host=exasol.acme.com, port=8563, schema=sales)
╭────────┬─────────────────────────────────────────────────┬─────────────────┬─────────╮
│ Result │ Check │ Field │ Details │
├────────┼─────────────────────────────────────────────────┼─────────────────┼─────────┤
│ passed │ Check that field 'order_id' is present │ orders.order_id │ │
│ passed │ Check that field order_id has no missing values │ orders.order_id │ │
│ ... │ │ │ │
╰────────┴─────────────────────────────────────────────────┴─────────────────┴─────────╯
🟢 data contract is valid. Run 12 checks. Took 1.4 seconds.

5. Add quality checks

Add a quality rule to a schema in datacontract.yaml:

schema:
- name: orders
# ...
quality:
- type: sql
description: No order has a negative total
query: SELECT COUNT(*) FROM orders WHERE order_total < 0
mustBe: 0

Run datacontract test datacontract.yaml again: every violation is listed as an error, and the command exits with code 1 — ready for CI/CD and scheduled runs so you catch drift before your consumers do.

TLS

Connections are always encrypted, and the server certificate is verified against the system CA store. For a cluster with a self-signed certificate, pin it by its SHA-256 fingerprint instead — the value Exasol clients accept after the host in a connection string:

# .env
DATACONTRACT_EXASOL_FINGERPRINT=135A1D2DCE102DE866F58267521F4232153545A075DC85F8F7596F57E588A181

DATACONTRACT_EXASOL_VALIDATE_CERTIFICATE=false skips the verification altogether. A CA bundle of your own goes into the WEBSOCKET_CLIENT_CA_BUNDLE environment variable.

Troubleshooting

  • Could not connect to Exasol: [SSL: CERTIFICATE_VERIFY_FAILED] — the cluster uses a certificate the system CA store does not know; pin it with DATACONTRACT_EXASOL_FINGERPRINT, see TLS.
  • Connection exception - schema ... not found — the schema in the servers block must exist, and a mixed-case schema created with quotes must be spelled exactly ("Sales" is not found by sales).