Repository navigation
docs: choosing and changing the system database - #140
Draft
nicdavidson wants to merge 1 commit into
Draft
nicdavidson wants to merge 1 commit into
nicdavidson wants to merge 1 commit into
Conversation
✅ Deploy Preview for dreamfactory-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This branch has not been 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.
Refs #131
What
DB_CONNECTIONvalues, default ports and PHP drivers. It gives.envsettings and database/user creation per engine, the apply steps (config:clear,df:setup,optimize:clear, restart), and a rollback. It also gives the steps for moving an existing SQLite install to another engine with a secured package export and import. It recommends SQLite for trials and development only.basic-configuration.md,linux-installation.mdandupgrading-migrating-dreamfactory.md. The upgrade page also gets a note that a database dump only restores into the same engine.Behavior change
Documentation only. DreamFactory behavior does not change. The docs now state that SQLite is for trials and development, and that production installs should use MySQL/MariaDB, PostgreSQL or SQL Server. They also give a documented way to move from SQLite to one of those engines. No existing page, flow or link is removed or rerouted.
Tests
yarn build):OK docs build. 0 failures on the base branch (known-failures.txt), so nothing is newly broken.onBrokenLinksis set towarn, so a broken link would not fail it. A reviewer checked every new link target and the SQL Server anchor by hand, and they all exist.df:env,df:setup,df:import-pkg --password), default ports, optional keys and the list of what a package carries were checked by review againstconfig/database.phpand the df-core source (Setup.php,Env.php,ImportPackage.php,Exporter.php,Importer.php,Package.php).Scope
docs/getting-started/dreamfactory-configuration/system-database.md(new), plus small edits tobasic-configuration.md,linux-installation.mdandupgrading-migrating-dreamfactory.md.df:env), a cross-engine dump tool, a Docker compose rewrite, and fixes for the issues listed below.basic-configuration.md) and Upgrade guide: restore licensed composer files on commercial installs #127 (upgrading-migrating-dreamfactory.md).df:setupcreates.Related issues (not fixed here)
cache_enabledis NULL. This affects the SQL Server recommendation. The page does not mention it.DATE_FORMATin usage and dashboard endpoints breaks them on non-MySQL system databases.Existing bugs found but not fixed
docusaurus.configsetsonBrokenLinks: "warn", so broken internal links do not fail the docs build.config/database.phphas no env key fortrust_server_certificate. Self-signed certificates need a manual code edit, which the page documents as a workaround.Factory gate
Open review notes (not blocking, from the factory's final review)
system-database.md:142(move step 5): the temporary admin created bydf:setupstays on the instance after the import. Add a step 8: "Sign in as an imported admin and delete the temporary admin."system-database.md:72: the SQL Server note says "on a new install". Moving to SQL Server hits the same three problems on its empty database, so say "on a new or freshly created system database" so readers following the move procedure don't skip it.