Repository navigation
docs: Add PlanetScale and MongoDB Atlas guides - #57
Conversation
The engine ships MySQL and MongoDB destinations, but Neon was the only provider with a guide, so anyone pointing the sync at PlanetScale or Atlas rediscovered the same things: which PlanetScale role can create a schema, the libpq-only `sslrootcert=system` parameter that breaks Node's `pg`, that a Vitess branch is the database, which Atlas role the sync needs versus the one its test suite needs. These two guides record what each console actually required when the destinations were run against them on November 6, 2026, in the shape of the Neon guide. All three now live under `docs/integrations/` so the documentation has one tree. GitHub does not redirect a moved file, so anything linking to `integrations/neon.md` by path needs updating.
[Low impact] The PR changes provider documentation and guide links, not sync behavior. The Vitess upgrade instructions still need correction before merging. Findings
Fix with agent prompt### Issue 1
docs/integrations/planetscale.md:226-227
On a Vitess branch with safe migrations enabled, these steps cannot add a newly introduced column. `init --print-sql` prints complete table definitions, not changes to existing tables. The follow-up `init` executes the missing column's `ALTER TABLE` instead of reporting SQL to apply. PlanetScale rejects that change outside a deploy request, so the upgraded sync cannot start.
Document running the upgraded `init` on a development branch and deploying its schema changes before restarting production.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.SummaryAdds PlanetScale and MongoDB Atlas setup guides and moves the Neon guide into
Reviews (2) · Last reviewed commit: "docs: Keep the Vitess examples from clea..." · Reviewed by Greptile |
| with no DDL of its own. A later release that adds a column needs the same | ||
| round trip, and `init` reports the missing column and the DDL for it. |
There was a problem hiding this comment.
On a Vitess branch with safe migrations enabled, these steps cannot add a newly introduced column. init --print-sql prints complete table definitions, not changes to existing tables. The follow-up init executes the missing column's ALTER TABLE instead of reporting SQL to apply. PlanetScale rejects that change outside a deploy request, so the upgraded sync cannot start.
Document running the upgraded init on a development branch and deploying its schema changes before restarting production.
Knowledge Base Used: MySQL storage destination
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/integrations/planetscale.md
Line: 222-223
Comment:
**Vitess upgrades cannot finish**
On a Vitess branch with safe migrations enabled, these steps cannot add a newly introduced column. `init --print-sql` prints complete table definitions, not changes to existing tables. The follow-up `init` executes the missing column's `ALTER TABLE` instead of reporting SQL to apply. PlanetScale rejects that change outside a deploy request, so the upgraded sync cannot start.
Document running the upgraded `init` on a development branch and deploying its schema changes before restarting production.
**Knowledge Base Used:** [MySQL storage destination](https://app.greptile.com/-/switch-tenant?tenant=workos&next=%2Fcustom-context%2Fknowledge-base%2Fworkos%2Fsync-engine%2F-%2Fdocs%2Fmysql-storage.md)
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Both complete examples re-exported the macOS bundle path. On a Linux host that file does not exist, `$(cat ...)` expands to nothing, the command treats the empty value as unset and leaves TLS off, and PlanetScale refuses the connection. The examples now lean on the export the TLS section already asks for, and that section names the failure.
Summary
docs/integrations/planetscale.md(Postgres and Vitess) anddocs/integrations/mongodb-atlas.md, in the shape of the Neon guide: create the database, pick a role or password, choose a connection, TLS, verify the endpoint, run the sync, query it.CREATE SCHEMA(the suggested one cannot), the libpq-onlysslrootcert=systemparameter that makes Node'spgfail withENOENT, that a Vitess branch is the database soWORKOS_SYNC_SCHEMAmust name it, PlanetScale's proxy-terminated TLS, and which Atlas role the sync needs (readWrite, plusdbAdminonly forinit --repair) versus the one the test suite needs (Atlas admin, because it drops databases).docs/integrations/so the documentation has one tree, and the README's integration list points there.