Skip to content

docs: add cookbook recipe for copying a schema between instances - #550

Merged
javier merged 1 commit into
mainfrom
jv/recipe_import_schema
Sep 9, 2026
Merged

docs: add cookbook recipe for copying a schema between instances#550
javier merged 1 commit into
mainfrom
jv/recipe_import_schema

Conversation

@javier

@javier javier commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

New cookbook recipe under Operations covering how to recreate one instance's schema on another using SHOW CREATE DATABASE.

The dump comes back as a result set with one DDL statement per row, so the page walks from the statement itself, to fetching it as JSON over the REST API, to the two useful outcomes: writing a .sql file, or replaying it straight onto a target. Statements are sent one at a time because /execute is a GET endpoint and a whole schema in a single request would exceed the maximum request size.

Enterprise section covers INCLUDE (SCHEMA) and INCLUDE (ACL) for separating structure from permissions, since the default dump carries both.

Verified end to end: replayed the demo schema into a local OSS 10.0.1 instance, all 19 statements returned {"ddl":"OK"}, and a round-trip SHOW CREATE DATABASE off the target came back byte-identical to the source in the same order.

Also adds cross-links from the existing "Copy data between instances" recipe and the SHOW CREATE DATABASE section of the SHOW reference, plus a changelog entry.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

🚀 Build success!

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

Commit SHA: be5c540

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

@javier
javier merged commit 097f286 into main Sep 9, 2026
3 checks passed
@javier
javier deleted the jv/recipe_import_schema branch September 9, 2026 15:56
javier added a commit that referenced this pull request Sep 9, 2026
## Summary

Follow-up to #550. Adds a manual alternative to the copy-schema recipe:
the Web Console schema explorer can put the DDL for selected objects on
the clipboard with no scripting, via Select Mode → Select all → Copy
schemas to clipboard.

Includes a warning that this path is not dependency-ordered. The console
groups statements by object type and sorts alphabetically within each
group, so a materialized view built on another materialized view can be
emitted before its own base.

`SHOW CREATE DATABASE` remains the recommended path since it emits
dependency order.

Extends the existing changelog bullet rather than adding a second one,
as the page is already listed as new under September.
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