Skip to content

docs: add plugin system documentation#386

Open
nwoolmer wants to merge 3 commits intomainfrom
plugin-docs
Open

docs: add plugin system documentation#386
nwoolmer wants to merge 3 commits intomainfrom
plugin-docs

Conversation

@nwoolmer
Copy link
Contributor

@nwoolmer nwoolmer commented Mar 7, 2026

Summary

  • Adds operations/plugins.md: full guide covering setup, SQL commands, BYOF (Bring Your Own Function) custom SQL functions, lifecycle hooks, plugin configuration, permissions, dependency ordering, and a worked JSONL ingestion example
  • Adds SQL reference pages for LOAD PLUGIN, UNLOAD PLUGIN, RELOAD PLUGIN, SCAN PLUGINS
  • Adds SHOW PLUGINS section to show.md
  • Adds cairo.plugin.root config key to cairo config
  • Updates sidebars.js with all new pages

Plugins are enterprise-only at runtime but developed against the OSS questdb library. BYOF (Bring Your Own Function) is introduced as the term for plugin-defined Griffin SQL functions.

Test plan

  • Verify all new pages render correctly in local dev (yarn start)
  • Check sidebar navigation includes all new pages in correct positions
  • Confirm cross-links between pages resolve correctly
  • Review code examples against nw_plugin branch source

🤖 Generated with Claude Code

Documents the QuestDB Enterprise plugin system including:
- operations/plugins.md: full guide covering setup, SQL commands, BYOF
  custom SQL functions, lifecycle hooks, plugin configuration, permissions,
  dependency ordering, and a worked JSONL ingestion example
- SQL reference pages for LOAD PLUGIN, UNLOAD PLUGIN, RELOAD PLUGIN,
  SCAN PLUGINS
- SHOW PLUGINS section added to show.md
- cairo.plugin.root config key added to cairo config
- sidebars.js updated with all new pages

Plugins are enterprise-only at runtime but developed against the OSS
questdb library. BYOF (Bring Your Own Function) is introduced as the
term for plugin-defined Griffin SQL functions.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link

github-actions bot commented Mar 7, 2026

🚀 Build success!

Latest successful preview: https://preview-386--questdb-documentation.netlify.app/docs/

Commit SHA: 4640515

📦 Build generates a preview & updates link on each commit.

nwoolmer and others added 2 commits March 7, 2026 17:04
- Replace :::note admonitions with EnterpriseNote component across all
  plugin docs, consistent with other enterprise feature pages
- Change SYSTEM_ADMIN to DATABASE ADMIN in permission references

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant