Exasol JSON over WebSockets API
February 9, 2026 ยท View on GitHub
This repository is dedicated solely to protocol documentation and does not provide any WebSocket drivers or driver support. However, it includes some implementation examples and a list of officially supported drivers at the bottom of the page.
Why a WebSockets API?
The JSON over WebSockets client-server protocol allows customers to implement their own drivers for all kinds of platforms using a connection-based web protocol.
The main advantages are performance improvements from lock-free metadata calls, flexibility regarding the programming languages you want to integrate Exasol into, and a more native access compared to the standardized ways of communicating with a database, such as JDBC, ODBC or ADO.NET, which are mostly old and static standards and create additional complexity due to the necessary driver managers.
Changes
- WebSocket API v5 support has been added in Exasol 8.32.0.
- WebSocket API v4 support has been added in Exasol 8.32.0.
- Autocommit was enabled by default for sessions in Exasol 7.1+.
- WebSocket API v3 support has been added in Exasol 7.1.
Supported versions
| WebSocket API v1 | WebSocket API v2 | WebSocket API v3 | WebSocket API v4 | WebSocket API v5 | |
|---|---|---|---|---|---|
| Exasol 8.32 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Exasol 8.0 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: |
| Exasol 7.1 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: |
Protocol Specifications
- WebSocket protocol v5 API specification
- WebSocket protocol v4 API specification
- WebSocket protocol v3 API specification
- WebSocket protocol v2 API specification
- WebSocket protocol v1 API specification
Example Implementations
- Python native driver implementation
- JavaScript native driver implementation
- EXAplusLua (Lua console client)