Skip to content

docs: update Enterprise SHOW CREATE DATABASE behavior - #620

Open
glasstiger wants to merge 8 commits into
mainfrom
feat/show-create-database
Open

glasstiger wants to merge 8 commits into
mainfrom
feat/show-create-database

Conversation

@glasstiger

Copy link
Copy Markdown
Contributor

Summary

  • Document Enterprise ACL dump categories, replay ordering, required permissions, storage policies, and replay limitations.
  • Update schema-copy examples to use INCLUDE (SCHEMA) and remove outdated OWNED BY output guidance.
  • Document administrative-operation restrictions in views, migration guidance, and related RBAC and governance behavior.

Dependencies

@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

🚀 Build success!

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

Commit SHA: ca49513

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

Scope the Enterprise ACL dump, OWNED BY, and view compatibility changes to release 4.2.0. Update the existing changelog entries with the release boundary.

Make the schema-and-access-control recipe discoverable while preserving its existing anchor, and link the materialized/live view references to the canonical SHOW guidance.
@glasstiger

Copy link
Copy Markdown
Contributor Author

Verdict: approve-with-nits

Reviewed commit 502245dcdc01c172319f1c0c72fbd484e156030d at level 2, with all six review passes completed. No Critical or Major issue introduced by this PR was confirmed.

Blocking issues

None.

Non-blocking

Minor — Link directly to required post-replay setup
documentation/cookbook/operations/copy-schema-between-instances.md:144–148

The paragraph correctly requires restoring credentials, memory limits, resource groups, and mappings before opening the target. However, its only link is to “Replay limits,” so operators must navigate further to perform those steps.

Suggested fix: Link those terms directly to the existing authentication-management, memory-limit, and resource-group procedures:

  • /docs/security/rbac/#managing-authentication
  • /docs/security/rbac/#memory-limits
  • /docs/operations/resource-groups/

No additional tutorial is needed.

What works

  • Explicit INCLUDE (SCHEMA) keeps the copy recipe schema-only without requiring broader ACL privileges.
  • Permission checks, principal/schema/grant ordering, direct versus inherited grants, and creator permissions agree with the dependency implementation.
  • Replay omissions and best-effort consistency are clearly disclosed.
  • View restrictions correctly distinguish regular query bodies, PIVOT IN metadata evaluation, and materialized/live-view refresh.
  • Upgrade guidance, cross-links, preserved anchors, and changelog coverage are coherent. No sidebar change is needed.

Validation

  • yarn build passed, with broken links and anchors configured to fail the build.
  • All 28 distinct SQL queries across 30 demo-tagged examples passed against the demo instance. Requests were read-only, with a 15-second client timeout and response rows capped at 1,000; identical statements reused the same result.
  • Enterprise-specific behavior was checked against the dependency source heads—Enterprise f39e3f27a0377f7f73bea8e60dc7477e5d4948a1 and OSS 9978dd9a14a496553f41e9c0ad9d372876f6f839—and relevant test assertions.
  • SQL-parser inventories and open PRs were checked; no new synchronization gap was identified.
  • Enterprise integration tests and a complete Enterprise restore were not executed.

Both product dependencies were open at review time; publication should stay coordinated with them.

Downgraded findings

1 Minor suggestion retained; 29 candidates excluded: 28 concerned pre-existing content rather than changes introduced by this PR, and one incorrectly treated explicitly stated identity/permission prerequisites as missing. The one-shot consumer’s post-replay concern was reduced from blocking to the navigation suggestion above. Excluding pre-existing concerns does not imply that those concerns are necessarily false.

@glasstiger glasstiger added the READY The PR is ready for final review and approval label Nov 6, 2026
Comment thread documentation/concepts/views.md Resolved
Comment thread documentation/operations/upgrade.md Resolved
glasstiger and others added 4 commits November 6, 2026 12:49
Follow the Upgrading to 4.1.0 pattern: the schema dump and view definition checks move from Before you upgrade to a new Upgrading to 4.2.0 section under QuestDB Enterprise. Point the changelog entry at the new anchor.
The merge from main added a second Updated heading. Move this PR's entries under the existing one.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

READY The PR is ready for final review and approval

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants