run migration docs (#114)

* run migration docs * mentioned DB_ENGINE related stuff for migration * minor changes * added upgrade guide for v1.14.0 --------- Co-authored-by: Deepak Prabhakara <[email protected]>
boxyhq · Oct 14, 2023 · 8fd9633 · 8fd9633
1 parent 9d19e80
commit 8fd9633
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/docs/jackson/deploy/env-variables.md b/docs/jackson/deploy/env-variables.md
@@ -197,6 +197,17 @@ If you are using a self-signed certificate then set this to `false`, otherwise i
 
 Default: `true`
 
+### **DB_MANUAL_MIGRATION**
+
+Set this to true to trigger execution of migration scripts when you use our Jackson docker image.
+
+Optionally you can run the npm scripts present in `./npm/package.json` to run db specific migrations.
+
+Make sure you have set the correct value for `DB_ENGINE` environment variable as the migration script checks that to run correct command and migration file.
+
+NPM library option: `db.manualMigration`
+Default: `false`
+
 ### **DB_TTL**
 
 TTL for the code, session and token stores (in seconds)

diff --git a/docs/jackson/upgrade.md b/docs/jackson/upgrade.md
@@ -1,8 +1,12 @@
 # Upgrade Guide
 
+## Upgrading to v1.14.0
+
+We have changed the schema bit to introduce a new column called `namespace` to speed up scans. You will have to run the migration scripts if you are manually managing migrations. For example PlanetScale where auto migrations are not supported due to a difference between MySQL and PlanetScale.
+
 ## Upgrading to v1.11.0
 
-We have patched the SSO connection (`/api/v1/connections`) DELETE handler to accept payload (client/Secret or tenant/product/strategy) as part of query parameters. Earlier, the payload was expected to be part of the body which is non-standard and is no longer supported in Next.js. 
+We have patched the SSO connection (`/api/v1/connections`) DELETE handler to accept payload (client/Secret or tenant/product/strategy) as part of query parameters. Earlier, the payload was expected to be part of the body which is non-standard and is no longer supported in Next.js.
 
 ## Upgrading to v1.9.7