Repository navigation
Releases
Releases · egret-data/opendbapi
OpenDBAPI 0.3.1
Fixes for the two known issues of 0.3.0.
Run it
docker pull ghcr.io/egret-data/opendbapi:0.3.1
helm install opendbapi deploy/helm/opendbapi --set database.url=jdbc:postgresql://… --set existingSecret=…Upgrading from 0.3.0: no schema migrations; replace the image.
Fixes
- Time zones. PostgreSQL
timestamp with time zonevalues come back as ISO-8601 with an offset, for example
"2026-10-05T17:00Z". Before, they came back as local text with no offset. SQL Serverdatetimeoffsetand Oracle
timestamp with time zonetake the same path. - Keyset pagination on a
timestamptzcolumn. The second page no longer answers400 invalid_cursor. - Publish is disabled when the saved draft already matches the live version, and its tooltip says why. Before,
pressing it answered409 nothing_to_publish. - Version.
/admin/api/system/inforeports0.3.1. The 0.3.0 image reported0.1.0-SNAPSHOT. - Vietnamese UI. Each concept has one term throughout: xuất bản, bản nháp, đường dẫn, truy vấn, nguồn dữ liệu.
- On an endpoint over an HTTP API, the request's Query section is now called Query string, so it no longer
shares a name with the Query tab.
Documentation
- The documentation site is in English only. The Vietnamese pages and
README.vi.mdare gone.
OpenDBAPI 0.3.0
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 orcatalog.schema, the password is optional and needsSSL=true)
and pages withOFFSET … 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 itsreadonly = 2setting. - 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 sendsGETonly. Workflows call HTTP endpoints through Call endpoint nodes. - The DBAPI importer reads
jdbc:trino:andjdbc: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
- A documentation site at https://egret-data.github.io/opendbapi/, with a quick start and a page per feature.
- New README,
CONTRIBUTING.mdandSECURITY.md; private vulnerability reporting is on.
Fixes
- Opening or reloading
/account/tokensno longer answers 404.
OpenDBAPI 0.2.0
Configuration as code, API orchestration, and more ways to run OpenDBAPI in production.
Run it
docker pull ghcr.io/egret-data/opendbapi:0.2.0
helm install opendbapi deploy/helm/opendbapi --set database.url=jdbc:postgresql://… --set existingSecret=…Upgrading from 0.1.0: Flyway migrates the schema on start (V13–V17).
Configuration as code
- Plan / apply a workspace's YAML (
POST /config:plan,/config:apply): plan shows creates, updates (with the differing fields), deletes (withprune); apply writes everything in one transaction, then publishes endpoints marked live only after their tests pass. An export always plans as unchanged. - Environments map the file's datasource names to each workspace's datasources, so one file serves dev, staging and prod.
opendbapicommand line in the image:docker run ghcr.io/egret-data/opendbapi:0.2.0 plan|apply|export ….- API tokens (user menu → API tokens):
Authorization: Bearer odb_…, optionally limited to one workspace and given an expiry; the CLI readsOPENDBAPI_TOKEN. The README has a GitHub Actions example. - Lock a workspace to configuration files: endpoints, groups, service accounts and data policies then change through
applyonly (opendbapi.ui.read-onlylocks every workspace). - Major versions and deprecation travel in the files too.
- UI: Settings → Import & export → Apply YAML, and Environments.
Endpoints
- Major versions side by side: New major version… copies an endpoint to
v2/…; deprecated endpoints answer withDeprecation,Sunsetand a link to the newest live major; validation warns about breaking changes. - Groovy full mode: scripts run their own queries with
db.one / list / value / updateand return any answer; every query still goes through the static checks, row filter, masks and limits. - Workflows (DBAPI-style orchestration) on a drag-and-drop canvas: SQL and script nodes, Call endpoint nodes that reuse other endpoints, Decision nodes with Yes/No branches, End nodes per branch; independent nodes run in parallel; called endpoints on the same datasource join the workflow's transaction.
- GET endpoints never change data, neither through scripts nor through the endpoints they call.
Secrets
- HashiCorp Vault references
vault:PATH#KEY(token, AppRole or Kubernetes auth), each workspace confined to its own paths.
Running several instances
- Rate limits can be shared across pods (
OPENDBAPI_RATE_LIMIT_SHARED, on in the Helm chart).
Fixes
- Migration V14 now backfills endpoint lineages on databases that already have endpoints (it failed there before; nothing was half-applied). If an empty database ran the earlier V14 from a
mainimage, runflyway repair. - The image build retries when Maven Central throttles.
OpenDBAPI 0.1.0
First release of OpenDBAPI: write SQL, publish it as a REST API, and manage it from a web UI.
Run it
docker pull ghcr.io/egret-data/opendbapi:0.1.0
helm install opendbapi deploy/helm/opendbapi --set database.url=jdbc:postgresql://… --set existingSecret=…See the README's Deploy section for the database roles and the Secret keys.
What's in it
- Endpoints: SQL templates with typed parameters and validation rules; draft → publish with versions and rollback; static checks; pagination (offset and keyset cursor); output mapping; result caching; Groovy fragment scripts in a sandbox; saved test cases.
- Datasources: PostgreSQL, MySQL/MariaDB, SQL Server, Oracle and more over JDBC, with pooling, read-only mode and a host allow-list; schema browser.
- Access: workspaces isolated with PostgreSQL row-level security; members and roles; local, LDAP and OIDC sign-in; service accounts with OAuth2 client credentials, grants and attributes; optional HMAC request signing and response encryption; IP and rate-limit policies.
- Data policies: column masking and row filters by caller attributes.
- Secrets managed by OpenDBAPI (
secret:NAME), sealed with the master key. - Operations: access log and activity charts, alerts to Slack/webhooks, audit log, Prometheus metrics, tracing, OpenAPI per workspace, Try-it console.
- Transfer: YAML export; import from DBAPI exports.
- UI in English and Vietnamese.
- Scaling: N identical pods on one PostgreSQL. Sessions, HMAC nonces and cache invalidation are shared through it.
Known limits
- Rate limits, cached results and alert de-duplication are counted per pod.
- External secret stores (Vault) are not supported yet.