Skip to main content

ClickHouse RBAC object hooks for DBWarden.

Project description

dbwarden-ch-rbac

ClickHouse roles and access control for DBWarden.

dbwarden-ch-rbac is an official DBWarden plugin. It is discovered automatically through its dbwarden.plugins entry point and loaded without a consent prompt once installed.

What It Provides

Object handlers that bring ClickHouse role-based access control into DBWarden's schema diff pipeline:

  • ch_role: roles.
  • ch_user: users.
  • ch_grant: privilege grants.
  • ch_quota: resource quotas.
  • ch_row_policy: row policies.
  • ch_settings_profile: settings profiles.

Each handler participates in extract, canonicalize, diff, and emit, and orders itself with public anchors so profiles and roles are created before the users and grants that reference them.

Install

dbwarden plugin add dbwarden-ch-rbac

plugin add verifies the package provenance (a PyPI PEP 740 attestation from the official repository) before installing. You can also install it directly:

uv add dbwarden-ch-rbac
# or
pip install dbwarden-ch-rbac

ClickHouse only.

Use

Declare your ClickHouse roles, users, quotas, policies, and profiles in your DBWarden configuration. With the plugin loaded, dbwarden make-migrations diffs them against the live database and emits the appropriate DDL in dependency order. Confirm the plugin is loaded:

dbwarden plugin list

Development

pip install -e . pytest
pytest -q

See the object-plugin docs.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbwarden_ch_rbac-0.1.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dbwarden_ch_rbac-0.1.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file dbwarden_ch_rbac-0.1.0.tar.gz.

File metadata

  • Download URL: dbwarden_ch_rbac-0.1.0.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for dbwarden_ch_rbac-0.1.0.tar.gz
Algorithm Hash digest
SHA256 85a4dba156afcb947860bdad30d1b34c1167a92a5000b912e2cb39a2b9df280d
MD5 899e77eb17628b6b0d3e91a4bfff5dcc
BLAKE2b-256 b6c76adf2a567700602012c7f7786bf33706282b0297ebfae371d1a0163274bb

See more details on using hashes here.

File details

Details for the file dbwarden_ch_rbac-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dbwarden_ch_rbac-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad7f5e95e632881678ee025ed9526d7848a1a5b282264b98a0557d4b24a63c40
MD5 68ec7a6b210b305c1db07ffdf50332ed
BLAKE2b-256 0462764912199586add2294076c49a7499ae3879396af66f8e8ef1034b7265c8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page