Skip to content

OpenDBAPI 0.3.0

Choose a tag to compare

@viethqb viethqb released this 18 Nov 07:30
· 5 commits to main since this release
8e119fc

Four more database types, HTTP APIs as a datasource, and endpoints organized in groups.

Run it

docker pull ghcr.io/egret-data/opendbapi:0.3.0
helm install opendbapi deploy/helm/opendbapi --set database.url=jdbc:postgresql://… --set existingSecret=…

Upgrading from 0.2.0: no schema migrations; replace the image.

Datasources

  • Trino, StarRocks, Apache Doris and ClickHouse, next to PostgreSQL, MySQL, MariaDB, SQL Server and Oracle. Trino
    uses its own driver (the database field is a catalog or catalog.schema, the password is optional and needs SSL=true)
    and pages with OFFSET … FETCH; StarRocks and Doris go through the MySQL driver; ClickHouse uses its HTTP driver.
  • Read only is enforced per engine: Trino runs statements in read-only transactions, StarRocks and Doris rely on the
    MySQL driver's own check, ClickHouse on its readonly = 2 setting.
  • StarRocks, Doris and ClickHouse cannot roll back. On them preview refuses statements that change data
    (preview_cannot_roll_back) and endpoints cannot run in a transaction (transaction_unsupported).
  • HTTP APIs: a datasource with a base URL, static headers and authentication (bearer token, Basic, or an API key
    header). An endpoint on it sends one request, built from its parameters, and answers the JSON at a JSON Pointer as
    rows, which go through masks, output mapping and the cache. Redirects are never followed, the host policy is checked
    on every call, and preview sends GET only. Workflows call HTTP endpoints through Call endpoint nodes.
  • The DBAPI importer reads jdbc:trino: and jdbc:clickhouse: URLs.

Endpoints

  • Groups work like folders: the Endpoints list is grouped under collapsible headings; create, rename and delete groups
    there; move endpoints by drag and drop, from the row menu, or several at once with Select. A move that changes who
    can call an endpoint (grants on a group) asks first and applies on every instance at once.

Documentation

Fixes

  • Opening or reloading /account/tokens no longer answers 404.