Namespace Plugins

sqldoc uses namespace plugins to transform SQL tags into additional SQL statements. Each namespace handles a specific concern -- audit trails, row-level security, validation, documentation, and more.

Tags are written as SQL comments (-- @namespace.tag(args)) and compiled into dialect-correct SQL at build time.

Available Namespaces

@anon

PostgreSQL Anonymizer security labels

3 tagsPostgres

@audit

Audit namespace plugin -- generates audit triggers for Postgres, MySQL, and SQLite. Postgres: PL/pgSQL trigger function + multi-event trigger with row_to_json. MySQL: Separate per-event triggers with inline bodies using JSON_OBJECT and explicit columns. SQLite: Separate per-event triggers with inline bodies using json_object and explicit columns.

2 tagsPostgresMysql (beta)Sqlite (beta)

@codegen

3 tagsPostgresMysql (beta)Sqlite (beta)

@comment

1 tagPostgresMysql (beta)Sqlite (beta)

@deprecated

3 tagsPostgresMysql (beta)Sqlite (beta)

@docs

3 tagsPostgresMysql (beta)Sqlite (beta)

@lint

1 tagPostgresMysql (beta)Sqlite (beta)

@pg

PostGraphile smart comments for PostgreSQL

6 tagsPostgres

@rls

Row-Level Security policies for PostgreSQL

2 tagsPostgres

@validate

5 tagsPostgresMysql (beta)

🚀

Created a plugin?

If you've built a namespace plugin for sqldoc, we'd love to list it here. Open an issue and we can add it to this page.