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 log tables and row-change triggers across supported database engines

2 tagsPostgresMysql (beta)Sqlite (beta)Mssql

@codegen

Project-level template execution for generated code and typed artifacts

3 tagsPostgresMysql (beta)Sqlite (beta)Mssql

@comment

SQL comments for Postgres tables, columns, and other schema objects

1 tagPostgres

@deprecated

Marks schema objects as deprecated in SQL comments and generated docs

3 tagsPostgresMysql (beta)Sqlite (beta)

@docs

Schema documentation metadata plus project-level HTML/Markdown rendering

3 tagsPostgresMysql (beta)Sqlite (beta)Mssql

@history

History tables and change-tracking triggers for update/delete workflows

1 tagPostgresMysql (beta)Sqlite (beta)Mssql

@lint

Tag-level lint suppressions for sqldoc rules

1 tagPostgresMysql (beta)Sqlite (beta)Mssql

@pg

PostGraphile smart comments for PostgreSQL

6 tagsPostgres

@rls

Row-level security policies for PostgreSQL tables

2 tagsPostgres

@softdelete

Soft-delete columns, active views, and optional cascade triggers

2 tagsPostgresMysql (beta)Sqlite (beta)Mssql

@temporal

Temporal tables with current-row views and versioning triggers

1 tagPostgresMysql (beta)

@validate

Column-level validation constraints plus documentation and schema linting

5 tagsPostgresMysql (beta)MssqlSqlite (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.