Skip to content

OpenDBAPI 0.1.0

Choose a tag to compare

@viethqb viethqb released this 17 Nov 09:23
· 28 commits to main since this release
a8e0b46

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.