Repository navigation
Conversation
There is no pre-flight material anywhere in the docs: the word for checklist does not appear on any page, and backup/PITR are covered by the operation guide while the pre-deployment checks are not covered at all. Add master/best_practices/production_checklist.adoc in CN and EN, plus one navigation entry per language: - an 18-row checklist: item, command, expected result, and the impact of failing it, covering version and build options, both listeners, hba rules, extension availability on both listeners, template1 inheritance, wal_level and archiving; - three worked compatibility cases: one database answering with compatible_mode=pg on 5432 and oracle on 1521 while every other ivorysql.* parameter is identical; identifier_case_switch changing only the quoted column names, not the plan or the row count; and enable_emptystring_to_NULL turning '' into NULL so that a UNIQUE index stops rejecting duplicates while NOT NULL starts rejecting ''. Every command and output on the page comes from a real 5.6 run. The material that would have required another kind of instance (promotion replay, NULLS NOT DISTINCT, container specifics) is left out rather than invented.
|
🚀 IvorySQL-Docs Preview Ready
|
Author
|
CI is green and the rendered result has been verified on the deploy preview.
Nothing else is pending on my side -- happy to adjust wording or split anything if you prefer a different shape for this section. |
qwer381
force-pushed
the
docs/production-checklist
branch
from
November 13, 2026 05:53
9304baa to
5f00aae
Compare
|
🚀 IvorySQL-Docs Preview Ready
|
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #386
What this changes
New page
CN|EN/modules/ROOT/pages/master/best_practices/production_checklist.adoc(237 lines each) plus onenav.adocline per language, inserted after the operation guide entry:nav.adoc: after** xref:master/operation_guide.adoc[运维管理指南]nav.adoc: after** xref:master/operation_guide.adoc[Operation Management]1.
== 上线检查清单/== Production readiness checklistOne
|===table with 18 data rows, each carrying check item / command / expected result / impact when it fails: version and build options,ivorysql.compatible_modeon both listeners,ivorysql.database_mode,ivorysql.portandlisten_addresses,identifier_case_switch,enable_emptystring_to_NULL,pg_hba.conftrust rules, extension availability on both listeners,template1inheritance,wal_level/archive_mode, and the two-port reachability check.2.
== 兼容性最佳实践案例/== Compatibility casesThree worked cases, each with the scenario, the SQL to reproduce it, the measured output, and the recommendation:
1521→oracle,5432→pg, whileivorysql.port,ivorysql.database_modeandlisten_addressesare identical on both;compatible_modeis the only thing that tells you which semantics a session is getting.identifier_case_switch.ABC|abc|mixed/abc|ABC|mixed/abc|abc|mixedfor the same query under the three values, with the plan and row count unchanged — a column-name comparison is what breaks, not the data.NULL. TheUNIQUEindex is bypassed (INSERT 0 1twice,total_rows = 3 null_rows = 3),NOT NULLrejects'', statistics shownull_frac = 1 n_distinct = 0; with the parameteroffthe second insert fails withduplicate key.How it was verified
Every command and output in both pages comes from a real run on IvorySQL 5.6 over both listeners; the raw
psqltranscripts were kept as evidence, and the page states which values came from the sample cluster (for example the six trust rules inpg_hba_file_rules) rather than presenting them as universal.Deliberately not written, because this batch did not measure them: the purpose of
5866/tcp, the container's defaultinitdbmode, a full promotion replay,NULLS NOT DISTINCTDDL, and the clean-install success path foruuid-ossp. Reviewers asking for those should get a measured answer, not an invented one.Rendering: both languages convert with
asciidoctor.js 4.2.1, zero warnings, CN and EN are line-for-line symmetric (237 lines each), no empty table cells.Checklist
nav.adocchange is a single inserted line per language