Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.
WorkOS Sync Engine keeps a copy of your WorkOS data, such as users and organizations, in your own database.
It runs on your own infrastructure and connects to PlanetScale Vitess over the MySQL protocol with the @workos/sync-mysql package.
For the full command and configuration reference, see the @workos/sync-mysql README.
Set up Sync Engine
Requirements
A PlanetScale Vitess database with an unsharded keyspace for the mirror
A WorkOS account and API key
Node.js 22 or later, to run the workos-sync-mysql command
Create a password
Sync Engine creates tables, views, and temporary tables, so it needs a password with the Adminrole.
In PlanetScale, navigate to your database and click the “Connect” button.
Select the branch, choose the Admin role, and click “Create password”.
Copy the username, password, and host. PlanetScale only shows the password once.
Set the connection string
Use the host PlanetScale shows with your password, and end the connection string with ?ssl={"rejectUnauthorized":true,"verifyIdentity":true}.
This turns on TLS and verifies the server’s certificate and host name:
Without the parameter, every command fails with server does not allow insecure connections, client must use SSL/TLS.Set WORKOS_SYNC_SCHEMA to your database name.
Without it, or with a name that doesn’t match your database, every command fails with VT12001: unsupported: create database by failDBDDL.
If your database has more than one keyspace, set WORKOS_SYNC_SCHEMA to an unsharded keyspace.
Check table names
Sync Engine creates its tables in your database, next to your application’s tables.
With the default streams, these are:users, organizations, organization_memberships, organization_domains, organization_roles, invitations, sessions, directories, directory_users, directory_groups, directory_group_memberships, connections, groups, group_memberships, roles, permissions, feature_flags, events, auth_attemptsIt also creates five bookkeeping tables: _sync_state, _migrations, _sync_lease, _rejected, and _columns.
--streams limits the sync to the streams you list, so list the default streams along with an added one such as webhook_endpoints.
Run npx workos-sync-mysql streams to list them.
The added stream gets a table with its name.
If your database already has a table with one of these names, such as users, init treats it as its own, tries to alter it, and fails.
To keep the mirror apart, set WORKOS_SYNC_TABLE_PREFIX to a prefix such as workos_ before the first init, and use the same value for every command.
Every table and view the mirror creates then starts with the prefix, for example workos_users and workos_users_live.
Set WORKOS_ENVIRONMENT_NAME to the name of the WorkOS environment your API key belongs to, such as staging, before you run any command.
Use the same value for every command.
Sync Engine labels every row with _env = 'production' by default, even when you use a test API key.
Changing the label later doesn’t relabel existing rows.
Sync Engine writes a second copy of each row, and the _live views return both.
Safe migrations
With safe migrations on, PlanetScale refuses direct DDL on the branch, so every command except status fails until the mirror is deployed.
Deploy the schema with two deploy requests: one for the tables, then one for the views.
One deploy request with both fails lint.
Create a development branch from your production branch, and an Admin password for it.
On the development branch, run init.
On the development branch, drop the 17 _live views:
If you added streams with --streams, add <stream>_live for each one.
If you set a table prefix, put it before each view name.
Open a deploy request, deploy it, and skip the revert period, so you can open the second deploy request right away.
On the development branch, run init --repair to create the views. Open a second deploy request, deploy it, and skip the revert period.
On the production branch, with an Admin password, run backfill, then listen.
Adding a stream with --streams changes the schema, so deploy it the same way: create a new development branch from the production branch, run init there with the new stream list, and deploy the change with a deploy request.
Until it’s deployed, every command with the new stream list fails on the production branch.
Sync overview
init creates the mirror tables and views.
backfill loads the data that already exists in WorkOS.
listen applies new WorkOS events as they happen, and keeps running until you stop it.
Query the mirror
The mirror’s tables and views are in your database, so query them without the workos. prefix.
Each mirror table except events and auth_attempts has a _live view that leaves out deleted rows.
SELECT id, email FROM users_live;
Manage the sync
Reconcile
reconcile compares the mirror with WorkOS to find missed creates and deletes.reconcile exits 1 when a stream can’t be compared, and marks it "failed": true in its output.
Branches
Each branch needs its own credentials.
A new branch has the mirror’s tables and views, but no rows.
Run init and backfill on it.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"PlanetScale","description":"PlanetScale is a relational database platform for Vitess, Neki, and Postgres that gives you scale, performance, and reliability without sacrificing developer experience.","colors":{"primary":"#0e73cc","light":"#47b7f8","dark":"#f15817"},"logo":{"light":"https://mintcdn.com/planetscale-2/xUilVHToUFALai8a/logo/light.png?fit=max\u0026auto=format\u0026n=xUilVHToUFALai8a\u0026q=85\u0026s=cccd3c9fc813c01b899ab7af15a115b1","dark":"https://mintcdn.com/planetscale-2/xUilVHToUFALai8a/logo/dark.png?fit=max\u0026auto=format\u0026n=xUilVHToUFALai8a\u0026q=85\u0026s=4153888dc0ef54ddc3464738a2d7ee6e","href":"https://planetscale.com"},"favicon":"https://mintcdn.com/planetscale-2/DJh9Bv1aUZHTVDnK/favicon.svg?fit=max\u0026auto=format\u0026n=DJh9Bv1aUZHTVDnK\u0026q=85\u0026s=cc6ec9d8d0deb3450719bb4b5b6df73a","background":{"color":{"light":"#fafafa","dark":"#111111"}},"navbar":{"links":[{"href":"https://auth.planetscale.com/sign-in","label":"Log in"},{"href":"https://auth.planetscale.com/sign-up","label":"Get started"}],"primary":{"type":"button","label":"Get in touch","href":"https://planetscale.com/contact"}},"footer":{"socials":{"x":"https://twitter.com/planetscale","github":"https://github.com/planetscale","linkedin":"https://www.linkedin.com/company/planetscale","youtube":"https://www.youtube.com/c/PlanetScale","discord":"https://pscale.link/community","facebook":"https://www.facebook.com/planetscaledata"}},"seo":{"metatags":{"canonical":"https://planetscale.com/docs"}},"fonts":{"heading":{"family":"Inter"},"body":{"family":"Inter"}},"integrations":{"segment":{"key":"9Ujczlrndco2w8fcFAakL0FT4bsJCCh3"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://planetscale.com/blog"},{"anchor":"Contact Us","icon":"headset","href":"https://planetscale.com/contact"},{"anchor":"Status","icon":"signal","href":"https://www.planetscalestatus.com/"},{"anchor":"Benchmarks","icon":"chart-line","href":"https://planetscale.com/benchmarks"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"planetscale-2","hasAudioNarration":false,"actualSubdomain":"planetscale-2","customDomains":["planetscale.com"],"gitSource":{"type":"github","owner":"planetscale","repo":"www","deployBranch":"main","contentDirectory":"content/mintlify/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00c280ae0d0b407c5fc622","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Platform","count":293},{"language":"default","tag":"API Reference","count":276},{"language":"default","tag":"Vitess","count":185},{"language":"default","tag":"Postgres","count":111},{"language":"default","tag":"General API endpoints","count":101},{"language":"default","tag":"Neki","count":61},{"language":"default","tag":"Guides","count":58},{"language":"default","tag":"Vitess API endpoints","count":57},{"language":"default","tag":"Postgres API endpoints","count":53},{"language":"default","tag":"Neki API endpoints","count":50}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","url":"https://planetscale.com/contact?initial=support"}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-container{column-gap:2rem}.nav-tabs{column-gap:0.5em}.nav-tabs-item{padding:0 8px}.nav-tabs a{color:#616161}.nav-tabs a.text-primary{color:#1a1a1a}.nav-tabs a.text-primary .bg-primary{background-color:#1a1a1a;left:0}.nav-tabs a[href=\"/docs/vitess\"i].text-primary{color:#f15817}.nav-tabs a[href=\"/docs/vitess\"i].text-primary .bg-primary{background-color:#f15817}.nav-tabs a[href=\"/docs/postgres\"i].text-primary{color:#0e73cc}.nav-tabs a[href=\"/docs/postgres\"i].text-primary .bg-primary{background-color:#0e73cc}.nav-tabs a[href=\"/docs/neki\"i].text-primary{color:#8f7200}.nav-tabs a[href=\"/docs/neki\"i].text-primary .bg-primary{background-color:#8f7200}.dark .nav-tabs a{color:#a1a1a1}.dark .nav-tabs a.text-primary{color:#fafafa}.dark .nav-tabs a.text-primary .bg-primary{background-color:#fafafa}.dark .nav-tabs a[href=\"/docs/vitess\"i].text-primary{color:#f15817}.dark .nav-tabs a[href=\"/docs/vitess\"i].text-primary .bg-primary{background-color:#f15817}.dark .nav-tabs a[href=\"/docs/postgres\"i].text-primary{color:#47b7f8}.dark .nav-tabs a[href=\"/docs/postgres\"i].text-primary .bg-primary{background-color:#47b7f8}.dark .nav-tabs a[href=\"/docs/neki\"i].text-primary{color:#fbca00}.dark .nav-tabs a[href=\"/docs/neki\"i].text-primary .bg-primary{background-color:#fbca00}.prose:is(.dark *){color:#c1c1c1}.prose :where(a):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){color:#0e73cc;font-weight:500}.dark .prose :where(a):not(:where(.not-prose,.not-prose *)){color:#47b7f8}.eyebrow{color:#616161}.dark .eyebrow{color:#a1a1a1}@media (min-width: 1024px){#content-container{padding-top:2rem;padding-right:2rem;padding-left:2.5rem}}#topbar-cta-button a>span{background-color:#fbca00}#topbar-cta-button .text-white,#topbar-cta-button svg{color:#1a1a1a}.group:hover span{opacity:1!important}#navigation-items .text-primary{color:#1a1a1a}.light #navigation-items .text-gray-700{color:#616161}.bg-primary\\/10{background-color:rgba(129, 129, 129, 0.1)}.dark #navigation-items .text-primary{color:#fafafa}.dark .bg-primary\\/10{background-color:rgba(255, 255, 255, 0.1)}body[data-current-path^=\"/vitess\"] svg.bg-primary{background-color:#f15817}body[data-current-path^=\"/vitess\"] .border-primary{border-color:#f15817}body[data-current-path^=\"/vitess\"] #table-of-contents-content .text-primary{color:#f15817}body[data-current-path^=\"/vitess\"] .eyebrow{color:#f15817}body[data-current-path^=\"/vitess\"] .card-group a:hover{border-color:#f15817!important}body[data-current-path^=\"/postgres\"] .eyebrow{color:#0e73cc}.dark body[data-current-path^=\"/postgres\"] .eyebrow{color:#47b7f8}body[data-current-path^=\"/neki\"] svg.bg-primary{background-color:#8f7200}body[data-current-path^=\"/neki\"] [data-component-part=\"card-icon\"]{background-color:#fbca00}body[data-current-path^=\"/neki\"] [data-component-part=\"card-icon\"] svg.bg-primary{background-color:#1a1a1a;transform:scale(0.7);transform-origin:center}body[data-current-path^=\"/neki\"] .border-primary{border-color:#8f7200}body[data-current-path^=\"/neki\"] #table-of-contents-content .text-primary{color:#1a1a1a;background-color:transparent;border-color:#fbca00}body[data-current-path^=\"/neki\"] .eyebrow{display:inline-flex;align-items:center;width:fit-content;height:auto;min-height:1.25rem;padding:0 0.375rem;color:#1a1a1a;background-color:#fbca00}body[data-current-path^=\"/neki\"] .eyebrow:empty,body[data-current-path^=\"/neki\"] .eyebrow[data-empty]{display:none}body[data-current-path^=\"/neki\"] .card-group .card:hover{--primary: 251 202 0;--primary-light: 251 202 0;border-color:#fbca00!important}.dark body[data-current-path^=\"/neki\"] svg.bg-primary{background-color:#fbca00}.dark body[data-current-path^=\"/neki\"] [data-component-part=\"card-icon\"]{background-color:#fbca00}.dark body[data-current-path^=\"/neki\"] [data-component-part=\"card-icon\"] svg.bg-primary{background-color:#1a1a1a}.dark body[data-current-path^=\"/neki\"] .border-primary{border-color:#fbca00}.dark body[data-current-path^=\"/neki\"] #table-of-contents-content .text-primary{color:#fafafa;background-color:transparent;border-color:#fbca00}.dark body[data-current-path^=\"/neki\"] .eyebrow{color:#1a1a1a;background-color:#fbca00}.dark body[data-current-path^=\"/neki\"] .card-group .card:hover{--primary: 251 202 0;--primary-light: 251 202 0;border-color:#fbca00!important}footer div:last-child{display:none}#pagination a,#header,[data-component-part=\"card-content-container\"]{text-wrap:balance}.step:last-of-type [data-component-part=\"step-line\"]{opacity:0}[data-component-part=\"frame-caption\"]{text-wrap:balance}"}]}
{"page":{"pagePath":"vitess/integrations/workos-sync-engine","slug":"/vitess/integrations/workos-sync-engine","pageMetadata":{"title":"WorkOS Sync Engine integration","description":"Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.","sidebarTitle":"WorkOS Sync Engine","og:image":"images/og/vitess/integrations/workos-sync-engine.png","href":"/vitess/integrations/workos-sync-engine"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const __snippet_platformLabels_3vlljw={vitess:`Vitess`,postgres:`Postgres`,neki:`Neki`};const __snippet_combinedPlatformLabels_3vlljw={both:`Vitess and Postgres`,all:`Vitess, Neki, and Postgres`,\"postgres-neki\":`Postgres and Neki`};const __snippet_platformBadgeClassName_3vlljw=`inline-flex items-center gap-1.5 whitespace-nowrap rounded-full border px-2.5 py-1 text-[13px] font-semibold leading-tight no-underline data-[engine=vitess]:data-[state=current]:border-[#ffc59b] data-[engine=vitess]:data-[state=current]:bg-[#ffe8d8] data-[engine=vitess]:data-[state=current]:text-[#672002] dark:data-[engine=vitess]:data-[state=current]:border-[#962d00] dark:data-[engine=vitess]:data-[state=current]:bg-[#3c1403] dark:data-[engine=vitess]:data-[state=current]:text-[#ffe8d8] data-[engine=vitess]:data-[state=link]:border-[#ffc59b] data-[engine=vitess]:data-[state=link]:bg-transparent data-[engine=vitess]:data-[state=link]:text-[#b83a05] dark:data-[engine=vitess]:data-[state=link]:border-[#962d00] dark:data-[engine=vitess]:data-[state=link]:bg-transparent dark:data-[engine=vitess]:data-[state=link]:text-[#ffc59b] data-[engine=postgres]:data-[state=current]:border-[#a9dffe] data-[engine=postgres]:data-[state=current]:bg-[#ddf2ff] data-[engine=postgres]:data-[state=current]:text-[#0e3682] dark:data-[engine=postgres]:data-[state=current]:border-[#144eb6] dark:data-[engine=postgres]:data-[state=current]:bg-[#08204e] dark:data-[engine=postgres]:data-[state=current]:text-[#ddf2ff] data-[engine=postgres]:data-[state=link]:border-[#a9dffe] data-[engine=postgres]:data-[state=link]:bg-transparent data-[engine=postgres]:data-[state=link]:text-[#0b6ec5] dark:data-[engine=postgres]:data-[state=link]:border-[#144eb6] dark:data-[engine=postgres]:data-[state=link]:bg-transparent dark:data-[engine=postgres]:data-[state=link]:text-[#73c7f9] data-[engine=neki]:data-[state=current]:border-[#fbca00] data-[engine=neki]:data-[state=current]:bg-[#fbca00] data-[engine=neki]:data-[state=current]:text-[#1a1a1a] dark:data-[engine=neki]:data-[state=current]:border-[#fbca00] dark:data-[engine=neki]:data-[state=current]:bg-[#fbca00] dark:data-[engine=neki]:data-[state=current]:text-[#1a1a1a] data-[engine=neki]:data-[state=link]:border-[#fbca00] data-[engine=neki]:data-[state=link]:bg-transparent data-[engine=neki]:data-[state=link]:text-[#8f7200] dark:data-[engine=neki]:data-[state=link]:border-[#fbca00] dark:data-[engine=neki]:data-[state=link]:bg-transparent dark:data-[engine=neki]:data-[state=link]:text-[#fbca00] data-[engine=both]:data-[state=current]:border-[#d4d4d4] data-[engine=both]:data-[state=current]:bg-[#f0f0f0] data-[engine=both]:data-[state=current]:text-[#3d3d3d] dark:data-[engine=both]:data-[state=current]:border-[#525252] dark:data-[engine=both]:data-[state=current]:bg-[#2a2a2a] dark:data-[engine=both]:data-[state=current]:text-[#e5e5e5]`;const __snippet_docsHref_3vlljw=path=>path.startsWith(`/`)?path:`/${path}`;const __snippet_PlatformAvailabilityBadges_3vlljw=({current,vitess,postgres,neki})=>{const _components={a:`a`,..._provideComponents()};if(__snippet_combinedPlatformLabels_3vlljw[current]){return _jsx(`div`,{className:`not-prose mint-mb-5 mint-flex mint-flex-wrap mint-items-center mint-gap-2`,role:`group`,\"aria-label\":`Platform availability`,children:_jsx(`span`,{\"data-engine\":`both`,\"data-state\":`current`,\"aria-current\":`true`,className:`mint-inline-flex mint-items-center mint-gap-1.5 mint-whitespace-nowrap mint-rounded-full mint-border mint-px-2.5 mint-py-1 mint-text-[13px] mint-font-semibold mint-leading-tight mint-no-underline data-[engine=vitess]:data-[state=current]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=current]:mint-bg-[#ffe8d8] data-[engine=vitess]:data-[state=current]:mint-text-[#672002] dark:data-[engine=vitess]:data-[state=current]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=current]:mint-bg-[#3c1403] dark:data-[engine=vitess]:data-[state=current]:mint-text-[#ffe8d8] data-[engine=vitess]:data-[state=link]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=link]:mint-bg-transparent data-[engine=vitess]:data-[state=link]:mint-text-[#b83a05] dark:data-[engine=vitess]:data-[state=link]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=link]:mint-bg-transparent dark:data-[engine=vitess]:data-[state=link]:mint-text-[#ffc59b] data-[engine=postgres]:data-[state=current]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=current]:mint-bg-[#ddf2ff] data-[engine=postgres]:data-[state=current]:mint-text-[#0e3682] dark:data-[engine=postgres]:data-[state=current]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=current]:mint-bg-[#08204e] dark:data-[engine=postgres]:data-[state=current]:mint-text-[#ddf2ff] data-[engine=postgres]:data-[state=link]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=link]:mint-bg-transparent data-[engine=postgres]:data-[state=link]:mint-text-[#0b6ec5] dark:data-[engine=postgres]:data-[state=link]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=link]:mint-bg-transparent dark:data-[engine=postgres]:data-[state=link]:mint-text-[#73c7f9] data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] dark:data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] data-[engine=neki]:data-[state=link]:mint-bg-transparent data-[engine=neki]:data-[state=link]:mint-text-[#8f7200] dark:data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=link]:mint-bg-transparent dark:data-[engine=neki]:data-[state=link]:mint-text-[#fbca00] data-[engine=both]:data-[state=current]:mint-border-[#d4d4d4] data-[engine=both]:data-[state=current]:mint-bg-[#f0f0f0] data-[engine=both]:data-[state=current]:mint-text-[#3d3d3d] dark:data-[engine=both]:data-[state=current]:mint-border-[#525252] dark:data-[engine=both]:data-[state=current]:mint-bg-[#2a2a2a] dark:data-[engine=both]:data-[state=current]:mint-text-[#e5e5e5]`,children:__snippet_combinedPlatformLabels_3vlljw[current]})})}const paths={vitess,postgres,neki};const others=[`vitess`,`neki`,`postgres`].filter(engine=>engine!==current\u0026\u0026paths[engine]);const engines=__snippet_platformLabels_3vlljw[current]?[current,...others]:others;const only=engines.length===1;return _jsx(`div`,{className:`not-prose mint-mb-5 mint-flex mint-flex-wrap mint-items-center mint-gap-2`,role:`group`,\"aria-label\":`Platform availability`,children:engines.map(engine=>{const label=only?`${__snippet_platformLabels_3vlljw[engine]} only`:__snippet_platformLabels_3vlljw[engine];if(engine===current){return _jsx(`span`,{\"data-engine\":engine,\"data-state\":`current`,\"aria-current\":`true`,className:`mint-inline-flex mint-items-center mint-gap-1.5 mint-whitespace-nowrap mint-rounded-full mint-border mint-px-2.5 mint-py-1 mint-text-[13px] mint-font-semibold mint-leading-tight mint-no-underline data-[engine=vitess]:data-[state=current]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=current]:mint-bg-[#ffe8d8] data-[engine=vitess]:data-[state=current]:mint-text-[#672002] dark:data-[engine=vitess]:data-[state=current]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=current]:mint-bg-[#3c1403] dark:data-[engine=vitess]:data-[state=current]:mint-text-[#ffe8d8] data-[engine=vitess]:data-[state=link]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=link]:mint-bg-transparent data-[engine=vitess]:data-[state=link]:mint-text-[#b83a05] dark:data-[engine=vitess]:data-[state=link]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=link]:mint-bg-transparent dark:data-[engine=vitess]:data-[state=link]:mint-text-[#ffc59b] data-[engine=postgres]:data-[state=current]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=current]:mint-bg-[#ddf2ff] data-[engine=postgres]:data-[state=current]:mint-text-[#0e3682] dark:data-[engine=postgres]:data-[state=current]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=current]:mint-bg-[#08204e] dark:data-[engine=postgres]:data-[state=current]:mint-text-[#ddf2ff] data-[engine=postgres]:data-[state=link]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=link]:mint-bg-transparent data-[engine=postgres]:data-[state=link]:mint-text-[#0b6ec5] dark:data-[engine=postgres]:data-[state=link]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=link]:mint-bg-transparent dark:data-[engine=postgres]:data-[state=link]:mint-text-[#73c7f9] data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] dark:data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] data-[engine=neki]:data-[state=link]:mint-bg-transparent data-[engine=neki]:data-[state=link]:mint-text-[#8f7200] dark:data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=link]:mint-bg-transparent dark:data-[engine=neki]:data-[state=link]:mint-text-[#fbca00] data-[engine=both]:data-[state=current]:mint-border-[#d4d4d4] data-[engine=both]:data-[state=current]:mint-bg-[#f0f0f0] data-[engine=both]:data-[state=current]:mint-text-[#3d3d3d] dark:data-[engine=both]:data-[state=current]:mint-border-[#525252] dark:data-[engine=both]:data-[state=current]:mint-bg-[#2a2a2a] dark:data-[engine=both]:data-[state=current]:mint-text-[#e5e5e5]`,children:label},engine)}return _jsxs(_components.a,{href:__snippet_docsHref_3vlljw(paths[engine]),\"data-engine\":engine,\"data-state\":`link`,title:`View ${__snippet_platformLabels_3vlljw[engine]} documentation`,className:`mint-inline-flex mint-items-center mint-gap-1.5 mint-whitespace-nowrap mint-rounded-full mint-border mint-px-2.5 mint-py-1 mint-text-[13px] mint-font-semibold mint-leading-tight mint-no-underline data-[engine=vitess]:data-[state=current]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=current]:mint-bg-[#ffe8d8] data-[engine=vitess]:data-[state=current]:mint-text-[#672002] dark:data-[engine=vitess]:data-[state=current]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=current]:mint-bg-[#3c1403] dark:data-[engine=vitess]:data-[state=current]:mint-text-[#ffe8d8] data-[engine=vitess]:data-[state=link]:mint-border-[#ffc59b] data-[engine=vitess]:data-[state=link]:mint-bg-transparent data-[engine=vitess]:data-[state=link]:mint-text-[#b83a05] dark:data-[engine=vitess]:data-[state=link]:mint-border-[#962d00] dark:data-[engine=vitess]:data-[state=link]:mint-bg-transparent dark:data-[engine=vitess]:data-[state=link]:mint-text-[#ffc59b] data-[engine=postgres]:data-[state=current]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=current]:mint-bg-[#ddf2ff] data-[engine=postgres]:data-[state=current]:mint-text-[#0e3682] dark:data-[engine=postgres]:data-[state=current]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=current]:mint-bg-[#08204e] dark:data-[engine=postgres]:data-[state=current]:mint-text-[#ddf2ff] data-[engine=postgres]:data-[state=link]:mint-border-[#a9dffe] data-[engine=postgres]:data-[state=link]:mint-bg-transparent data-[engine=postgres]:data-[state=link]:mint-text-[#0b6ec5] dark:data-[engine=postgres]:data-[state=link]:mint-border-[#144eb6] dark:data-[engine=postgres]:data-[state=link]:mint-bg-transparent dark:data-[engine=postgres]:data-[state=link]:mint-text-[#73c7f9] data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] dark:data-[engine=neki]:data-[state=current]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-bg-[#fbca00] dark:data-[engine=neki]:data-[state=current]:mint-text-[#1a1a1a] data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] data-[engine=neki]:data-[state=link]:mint-bg-transparent data-[engine=neki]:data-[state=link]:mint-text-[#8f7200] dark:data-[engine=neki]:data-[state=link]:mint-border-[#fbca00] dark:data-[engine=neki]:data-[state=link]:mint-bg-transparent dark:data-[engine=neki]:data-[state=link]:mint-text-[#fbca00] data-[engine=both]:data-[state=current]:mint-border-[#d4d4d4] data-[engine=both]:data-[state=current]:mint-bg-[#f0f0f0] data-[engine=both]:data-[state=current]:mint-text-[#3d3d3d] dark:data-[engine=both]:data-[state=current]:mint-border-[#525252] dark:data-[engine=both]:data-[state=current]:mint-bg-[#2a2a2a] dark:data-[engine=both]:data-[state=current]:mint-text-[#e5e5e5]`,children:[label,_jsx(`svg`,{\"aria-hidden\":`true`,width:`12`,height:`12`,viewBox:`0 0 12 12`,fill:`none`,className:`mint-shrink-0`,children:_jsx(`path`,{d:`M2.5 6h7M6.5 3l3 3-3 3`,stroke:`currentColor`,strokeWidth:`1.5`,strokeLinecap:`round`,strokeLinejoin:`round`})})]},engine)})})};const __snippet_PlatformAvailabilityText_3vlljw=({current,vitess,postgres,neki})=>{const _components={a:`a`,..._provideComponents()};return __snippet_combinedPlatformLabels_3vlljw[current]?_jsxs(`p`,{children:[`Available for `,__snippet_combinedPlatformLabels_3vlljw[current],`.`]}):_jsxs(_Fragment,{children:[_jsxs(`p`,{children:[`This page covers `,__snippet_platformLabels_3vlljw[current],`.`]}),vitess\u0026\u0026current!==`vitess`?_jsxs(`p`,{children:[`Vitess version: `,_jsx(_components.a,{href:vitess.startsWith(`/`)?vitess:`/`+vitess,children:__snippet_platformLabels_3vlljw.vitess})]}):null,postgres\u0026\u0026current!==`postgres`?_jsxs(`p`,{children:[`Postgres version: `,_jsx(_components.a,{href:postgres.startsWith(`/`)?postgres:`/`+postgres,children:__snippet_platformLabels_3vlljw.postgres})]}):null,neki\u0026\u0026current!==`neki`?_jsxs(`p`,{children:[`Neki version: `,_jsx(_components.a,{href:neki.startsWith(`/`)?neki:`/`+neki,children:__snippet_platformLabels_3vlljw.neki})]}):null]})};const PlatformAvailability=props=>{const{Visibility}=_provideComponents()||{};if(!Visibility)_missingMdxReference(`Visibility`,true);return _jsxs(_Fragment,{children:[_jsx(Visibility,{for:`humans`,children:_jsx(__snippet_PlatformAvailabilityBadges_3vlljw,{...props})}),_jsx(Visibility,{for:`agents`,children:_jsx(__snippet_PlatformAvailabilityText_3vlljw,{...props})})]})};function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning,_MdxComponentBoundary}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`PlatformAvailability`,children:_jsx(PlatformAvailability,{current:`vitess`,postgres:`/postgres/integrations/workos-sync-engine`})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`https://workos.com/docs/events/data-syncing/database`,children:`WorkOS Sync Engine`}),` keeps a copy of your WorkOS data, such as users and organizations, in your own database.\nIt runs on your own infrastructure and connects to PlanetScale Vitess over the MySQL protocol with the `,_jsx(_components.code,{children:`@workos/sync-mysql`}),` package.\nFor the full command and configuration reference, see the `,_jsxs(_components.a,{href:`https://github.com/workos/sync-engine/tree/main/packages/sync-mysql`,children:[_jsx(_components.code,{children:`@workos/sync-mysql`}),` README`]}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`set-up-sync-engine`,children:`Set up Sync Engine`}),`\n`,_jsx(Heading,{level:`3`,id:`requirements`,children:`Requirements`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`A PlanetScale Vitess database with an unsharded keyspace for the mirror`}),`\n`,_jsx(_components.li,{children:`A WorkOS account and API key`}),`\n`,_jsxs(_components.li,{children:[`Node.js 22 or later, to run the `,_jsx(_components.code,{children:`workos-sync-mysql`}),` command`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`create-a-password`,children:`Create a password`}),`\n`,_jsxs(_components.p,{children:[`Sync Engine creates tables, views, and temporary tables, so it needs a password with the `,_jsx(_components.strong,{children:`Admin`}),` `,_jsx(_components.a,{href:`/vitess/security/password-roles`,children:`role`}),`.`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`In PlanetScale, navigate to your database and click the “`,_jsx(_components.strong,{children:`Connect`}),`” button.`]}),`\n`,_jsxs(_components.li,{children:[`Select the branch, choose the `,_jsx(_components.strong,{children:`Admin`}),` role, and click “`,_jsx(_components.strong,{children:`Create password`}),`”.`]}),`\n`,_jsx(_components.li,{children:`Copy the username, password, and host. PlanetScale only shows the password once.`}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`set-the-connection-string`,children:`Set the connection string`}),`\n`,_jsxs(_components.p,{children:[`Use the host PlanetScale shows with your password, and end the connection string with `,_jsx(_components.code,{children:`?ssl={\"rejectUnauthorized\":true,\"verifyIdentity\":true}`}),`.\nThis turns on TLS and verifies the server’s certificate and host name:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`mysql://\u003cusername>:\u003cpassword>@\u003chost>/\u003cdatabase>?ssl={\"rejectUnauthorized\":true,\"verifyIdentity\":true}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Without the parameter, every command fails with `,_jsx(_components.code,{children:`server does not allow insecure connections, client must use SSL/TLS`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`WORKOS_SYNC_SCHEMA`}),` to your database name.\nWithout it, or with a name that doesn’t match your database, every command fails with `,_jsx(_components.code,{children:`VT12001: unsupported: create database by failDBDDL`}),`.\nIf your database has more than one keyspace, set `,_jsx(_components.code,{children:`WORKOS_SYNC_SCHEMA`}),` to an unsharded `,_jsx(_components.a,{href:`/vitess/sharding/keyspaces`,children:`keyspace`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`check-table-names`,children:`Check table names`}),`\n`,_jsx(_components.p,{children:`Sync Engine creates its tables in your database, next to your application’s tables.\nWith the default streams, these are:`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`users`}),`, `,_jsx(_components.code,{children:`organizations`}),`, `,_jsx(_components.code,{children:`organization_memberships`}),`, `,_jsx(_components.code,{children:`organization_domains`}),`, `,_jsx(_components.code,{children:`organization_roles`}),`, `,_jsx(_components.code,{children:`invitations`}),`, `,_jsx(_components.code,{children:`sessions`}),`, `,_jsx(_components.code,{children:`directories`}),`, `,_jsx(_components.code,{children:`directory_users`}),`, `,_jsx(_components.code,{children:`directory_groups`}),`, `,_jsx(_components.code,{children:`directory_group_memberships`}),`, `,_jsx(_components.code,{children:`connections`}),`, `,_jsx(_components.code,{children:`groups`}),`, `,_jsx(_components.code,{children:`group_memberships`}),`, `,_jsx(_components.code,{children:`roles`}),`, `,_jsx(_components.code,{children:`permissions`}),`, `,_jsx(_components.code,{children:`feature_flags`}),`, `,_jsx(_components.code,{children:`events`}),`, `,_jsx(_components.code,{children:`auth_attempts`})]}),`\n`,_jsxs(_components.p,{children:[`It also creates five bookkeeping tables: `,_jsx(_components.code,{children:`_sync_state`}),`, `,_jsx(_components.code,{children:`_migrations`}),`, `,_jsx(_components.code,{children:`_sync_lease`}),`, `,_jsx(_components.code,{children:`_rejected`}),`, and `,_jsx(_components.code,{children:`_columns`}),`.\n`,_jsx(_components.code,{children:`--streams`}),` limits the sync to the streams you list, so list the default streams along with an added one such as `,_jsx(_components.code,{children:`webhook_endpoints`}),`.\nRun `,_jsx(_components.code,{children:`npx workos-sync-mysql streams`}),` to list them.\nThe added stream gets a table with its name.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`If your database already has a table with one of these names, such as `,_jsx(_components.code,{children:`users`}),`, `,_jsx(_components.code,{children:`init`}),` treats it as its own, tries to alter it, and fails.\nTo keep the mirror apart, set `,_jsx(_components.code,{children:`WORKOS_SYNC_TABLE_PREFIX`}),` to a prefix such as `,_jsx(_components.code,{children:`workos_`}),` before the first `,_jsx(_components.code,{children:`init`}),`, and use the same value for every command.\nEvery table and view the mirror creates then starts with the prefix, for example `,_jsx(_components.code,{children:`workos_users`}),` and `,_jsx(_components.code,{children:`workos_users_live`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`run-the-sync`,children:`Run the sync`}),`\n`,_jsxs(_components.p,{children:[`If your production branch has `,_jsx(_components.a,{href:`/vitess/schema-changes/safe-migrations`,children:`safe migrations`}),` on, follow `,_jsx(_components.a,{href:`#safe-migrations`,children:`Safe migrations`}),` instead of running `,_jsx(_components.code,{children:`init`}),` there.`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`Install the package:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @workos/sync-mysql`})]}),`\n`]})})}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`Set your environment variables:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` DATABASE_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'mysql://\u003cusername>:\u003cpassword>@\u003chost>/\u003cdatabase>?ssl={\"rejectUnauthorized\":true,\"verifyIdentity\":true}'`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` WORKOS_SYNC_SCHEMA`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'\u003cdatabase>'`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` WORKOS_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'sk_...'`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` WORKOS_ENVIRONMENT_NAME`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'\u003cenvironment-name>'`})]}),`\n`]})})}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[`Run `,_jsx(_components.code,{children:`init`}),`, `,_jsx(_components.code,{children:`backfill`}),`, and `,_jsx(_components.code,{children:`listen`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npx`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` workos-sync-mysql`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` init`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npx`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` workos-sync-mysql`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` backfill`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npx`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` workos-sync-mysql`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` listen`})]}),`\n`]})})}),`\n`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`WORKOS_ENVIRONMENT_NAME`}),` to the name of the WorkOS environment your API key belongs to, such as `,_jsx(_components.code,{children:`staging`}),`, before you run any command.\nUse the same value for every command.\nSync Engine labels every row with `,_jsx(_components.code,{children:`_env = 'production'`}),` by default, even when you use a test API key.\nChanging the label later doesn’t relabel existing rows.\nSync Engine writes a second copy of each row, and the `,_jsx(_components.code,{children:`_live`}),` views return both.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`safe-migrations`,children:`Safe migrations`}),`\n`,_jsxs(_components.p,{children:[`With `,_jsx(_components.a,{href:`/vitess/schema-changes/safe-migrations`,children:`safe migrations`}),` on, PlanetScale refuses direct DDL on the branch, so every command except `,_jsx(_components.code,{children:`status`}),` fails until the mirror is deployed.\nDeploy the schema with two `,_jsx(_components.a,{href:`/vitess/schema-changes/deploy-requests`,children:`deploy requests`}),`: one for the tables, then one for the views.\nOne deploy request with both fails lint.`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[`Create a `,_jsx(_components.a,{href:`/vitess/schema-changes/branching#create-a-development-branch`,children:`development branch`}),` from your production branch, and an Admin password for it.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[`On the development branch, run `,_jsx(_components.code,{children:`init`}),`.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[`On the development branch, drop the 17 `,_jsx(_components.code,{children:`_live`}),` views:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`sql`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`sql`,children:_jsxs(_components.code,{language:`sql`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`DROP`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` VIEW`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` IF`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` EXISTS`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` users_live, organizations_live, organization_memberships_live, organization_domains_live,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` organization_roles_live, invitations_live, sessions_live, directories_live, directory_users_live,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` directory_groups_live, directory_group_memberships_live, connections_live, groups_live,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` group_memberships_live, roles_live, permissions_live, feature_flags_live;`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`If you added streams with `,_jsx(_components.code,{children:`--streams`}),`, add `,_jsx(_components.code,{children:`\u003cstream>_live`}),` for each one.\nIf you set a table prefix, put it before each view name.\nOpen a deploy request, deploy it, and skip the `,_jsx(_components.a,{href:`/vitess/schema-changes/deploy-requests#revert-a-schema-change`,children:`revert period`}),`, so you can open the second deploy request right away.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[`On the development branch, run `,_jsx(_components.code,{children:`init --repair`}),` to create the views. Open a second deploy request, deploy it, and skip the revert period.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[`On the production branch, with an Admin password, run `,_jsx(_components.code,{children:`backfill`}),`, then `,_jsx(_components.code,{children:`listen`}),`.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Adding a stream with `,_jsx(_components.code,{children:`--streams`}),` changes the schema, so deploy it the same way: create a new development branch from the production branch, run `,_jsx(_components.code,{children:`init`}),` there with the new stream list, and deploy the change with a deploy request.\nUntil it’s deployed, every command with the new stream list fails on the production branch.`]}),`\n`,_jsx(Heading,{level:`2`,id:`sync-overview`,children:`Sync overview`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`init`}),` creates the mirror tables and views.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`backfill`}),` loads the data that already exists in WorkOS.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`listen`}),` applies new WorkOS events as they happen, and keeps running until you stop it.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`query-the-mirror`,children:`Query the mirror`}),`\n`,_jsxs(_components.p,{children:[`The mirror’s tables and views are in your database, so query them without the `,_jsx(_components.code,{children:`workos.`}),` prefix.\nEach mirror table except `,_jsx(_components.code,{children:`events`}),` and `,_jsx(_components.code,{children:`auth_attempts`}),` has a `,_jsx(_components.code,{children:`_live`}),` view that leaves out deleted rows.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`sql`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`sql`,children:_jsxs(_components.code,{language:`sql`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`SELECT`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` id, email `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`FROM`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` users_live;`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`manage-the-sync`,children:`Manage the sync`}),`\n`,_jsx(Heading,{level:`3`,id:`reconcile`,children:`Reconcile`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`reconcile`}),` compares the mirror with WorkOS to find missed creates and deletes.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`reconcile`}),` exits `,_jsx(_components.code,{children:`1`}),` when a stream can’t be compared, and marks it `,_jsx(_components.code,{children:`\"failed\": true`}),` in its output.`]}),`\n`,_jsx(Heading,{level:`3`,id:`branches`,children:`Branches`}),`\n`,_jsxs(_components.p,{children:[`Each `,_jsx(_components.a,{href:`/vitess/schema-changes/branching`,children:`branch`}),` needs its own credentials.\nA new branch has the mirror’s tables and views, but no rows.\nRun `,_jsx(_components.code,{children:`init`}),` and `,_jsx(_components.code,{children:`backfill`}),` on it.`]}),`\n`,_jsx(Heading,{level:`2`,id:`need-help`,children:`Need help?`}),`\n`,_jsxs(_components.p,{children:[`Get help from `,_jsx(_components.a,{href:`https://planetscale.com/contact?initial=support`,children:`the PlanetScale Support team`}),`, or join our\\xA0`,_jsx(_components.a,{href:`https://pscale.link/community`,children:`Discord community`}),` to see how others are using PlanetScale.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{__snippet_platformLabels_3vlljw,__snippet_combinedPlatformLabels_3vlljw,__snippet_platformBadgeClassName_3vlljw,__snippet_docsHref_3vlljw,__snippet_PlatformAvailabilityBadges_3vlljw,__snippet_PlatformAvailabilityText_3vlljw,PlatformAvailability,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"WorkOS Sync Engine integration","description":"Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.","sidebarTitle":"WorkOS Sync Engine","og:image":"images/og/vitess/integrations/workos-sync-engine.png","href":"/vitess/integrations/workos-sync-engine"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[166,14628,"undefined;const __snippet_combinedPlatformLabels_3vlljw=undefined;const __snippet_platformBadgeClassName_3vlljw=undefined;const __snippet_docsHref_3vlljw=()=>null;const __snippet_PlatformAvailabilityBadges_3vlljw=()=>null;const __snippet_PlatformAvailabilityText_3vlljw=()=>null;const PlatformAvailability=()=>null;funct"]]},"mdxExtracts":{"tableOfContents":[{"title":"Set up Sync Engine","slug":"set-up-sync-engine","depth":2,"children":[{"title":"Requirements","slug":"requirements","depth":3,"children":[]},{"title":"Create a password","slug":"create-a-password","depth":3,"children":[]},{"title":"Set the connection string","slug":"set-the-connection-string","depth":3,"children":[]},{"title":"Check table names","slug":"check-table-names","depth":3,"children":[]},{"title":"Run the sync","slug":"run-the-sync","depth":3,"children":[]},{"title":"Safe migrations","slug":"safe-migrations","depth":3,"children":[]}]},{"title":"Sync overview","slug":"sync-overview","depth":2,"children":[]},{"title":"Query the mirror","slug":"query-the-mirror","depth":2,"children":[]},{"title":"Manage the sync","slug":"manage-the-sync","depth":2,"children":[{"title":"Reconcile","slug":"reconcile","depth":3,"children":[]},{"title":"Branches","slug":"branches","depth":3,"children":[]}]},{"title":"Need help?","slug":"need-help","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/planetscale-2/b155242ec3c4945e/custom.js"],"dynamicCss":".mint-mb-5 {\n margin-bottom: 1.25rem\n}\n.mint-flex {\n display: flex\n}\n.mint-inline-flex {\n display: inline-flex\n}\n.mint-shrink-0 {\n flex-shrink: 0\n}\n.mint-flex-wrap {\n flex-wrap: wrap\n}\n.mint-items-center {\n align-items: center\n}\n.mint-gap-1\\.5 {\n gap: 0.375rem\n}\n.mint-gap-2 {\n gap: 0.5rem\n}\n.mint-whitespace-nowrap {\n white-space: nowrap\n}\n.mint-rounded-full {\n border-radius: 9999px\n}\n.mint-border {\n border-width: 1px\n}\n.mint-px-2\\.5 {\n padding-left: 0.625rem;\n padding-right: 0.625rem\n}\n.mint-py-1 {\n padding-top: 0.25rem;\n padding-bottom: 0.25rem\n}\n.mint-text-\\[13px\\] {\n font-size: 13px\n}\n.mint-font-semibold {\n font-weight: 600\n}\n.mint-leading-tight {\n line-height: 1.25\n}\n.mint-no-underline {\n text-decoration-line: none\n}\n.data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#d4d4d4\\][data-state=\"current\"][data-engine=\"both\"] {\n --tw-border-opacity: 1;\n border-color: rgb(212 212 212 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#fbca00\\][data-state=\"current\"][data-engine=\"neki\"] {\n --tw-border-opacity: 1;\n border-color: rgb(251 202 0 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#fbca00\\][data-state=\"link\"][data-engine=\"neki\"] {\n --tw-border-opacity: 1;\n border-color: rgb(251 202 0 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#a9dffe\\][data-state=\"current\"][data-engine=\"postgres\"] {\n --tw-border-opacity: 1;\n border-color: rgb(169 223 254 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#a9dffe\\][data-state=\"link\"][data-engine=\"postgres\"] {\n --tw-border-opacity: 1;\n border-color: rgb(169 223 254 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#ffc59b\\][data-state=\"current\"][data-engine=\"vitess\"] {\n --tw-border-opacity: 1;\n border-color: rgb(255 197 155 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#ffc59b\\][data-state=\"link\"][data-engine=\"vitess\"] {\n --tw-border-opacity: 1;\n border-color: rgb(255 197 155 / var(--tw-border-opacity, 1))\n}\n.data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#f0f0f0\\][data-state=\"current\"][data-engine=\"both\"] {\n --tw-bg-opacity: 1;\n background-color: rgb(240 240 240 / var(--tw-bg-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#fbca00\\][data-state=\"current\"][data-engine=\"neki\"] {\n --tw-bg-opacity: 1;\n background-color: rgb(251 202 0 / var(--tw-bg-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"neki\"] {\n background-color: transparent\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#ddf2ff\\][data-state=\"current\"][data-engine=\"postgres\"] {\n --tw-bg-opacity: 1;\n background-color: rgb(221 242 255 / var(--tw-bg-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"postgres\"] {\n background-color: transparent\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#ffe8d8\\][data-state=\"current\"][data-engine=\"vitess\"] {\n --tw-bg-opacity: 1;\n background-color: rgb(255 232 216 / var(--tw-bg-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"vitess\"] {\n background-color: transparent\n}\n.data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#3d3d3d\\][data-state=\"current\"][data-engine=\"both\"] {\n --tw-text-opacity: 1;\n color: rgb(61 61 61 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#1a1a1a\\][data-state=\"current\"][data-engine=\"neki\"] {\n --tw-text-opacity: 1;\n color: rgb(26 26 26 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#8f7200\\][data-state=\"link\"][data-engine=\"neki\"] {\n --tw-text-opacity: 1;\n color: rgb(143 114 0 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#0e3682\\][data-state=\"current\"][data-engine=\"postgres\"] {\n --tw-text-opacity: 1;\n color: rgb(14 54 130 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#0b6ec5\\][data-state=\"link\"][data-engine=\"postgres\"] {\n --tw-text-opacity: 1;\n color: rgb(11 110 197 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#672002\\][data-state=\"current\"][data-engine=\"vitess\"] {\n --tw-text-opacity: 1;\n color: rgb(103 32 2 / var(--tw-text-opacity, 1))\n}\n.data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#b83a05\\][data-state=\"link\"][data-engine=\"vitess\"] {\n --tw-text-opacity: 1;\n color: rgb(184 58 5 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#525252\\][data-state=\"current\"][data-engine=\"both\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(82 82 82 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#fbca00\\][data-state=\"current\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(251 202 0 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#fbca00\\][data-state=\"link\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(251 202 0 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#144eb6\\][data-state=\"current\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(20 78 182 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#144eb6\\][data-state=\"link\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(20 78 182 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-border-\\[\\#962d00\\][data-state=\"current\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(150 45 0 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-border-\\[\\#962d00\\][data-state=\"link\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(150 45 0 / var(--tw-border-opacity, 1))\n}\n.dark\\:data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#2a2a2a\\][data-state=\"current\"][data-engine=\"both\"]:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(42 42 42 / var(--tw-bg-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#fbca00\\][data-state=\"current\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(251 202 0 / var(--tw-bg-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"neki\"]:is(.dark *) {\n background-color: transparent\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#08204e\\][data-state=\"current\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(8 32 78 / var(--tw-bg-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"postgres\"]:is(.dark *) {\n background-color: transparent\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-bg-\\[\\#3c1403\\][data-state=\"current\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(60 20 3 / var(--tw-bg-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-bg-transparent[data-state=\"link\"][data-engine=\"vitess\"]:is(.dark *) {\n background-color: transparent\n}\n.dark\\:data-\\[engine\\=both\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#e5e5e5\\][data-state=\"current\"][data-engine=\"both\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(229 229 229 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#1a1a1a\\][data-state=\"current\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(26 26 26 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=neki\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#fbca00\\][data-state=\"link\"][data-engine=\"neki\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(251 202 0 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#ddf2ff\\][data-state=\"current\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(221 242 255 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=postgres\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#73c7f9\\][data-state=\"link\"][data-engine=\"postgres\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(115 199 249 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=current\\]\\:mint-text-\\[\\#ffe8d8\\][data-state=\"current\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(255 232 216 / var(--tw-text-opacity, 1))\n}\n.dark\\:data-\\[engine\\=vitess\\]\\:data-\\[state\\=link\\]\\:mint-text-\\[\\#ffc59b\\][data-state=\"link\"][data-engine=\"vitess\"]:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(255 197 155 / var(--tw-text-opacity, 1))\n}","subdomain":"planetscale-2","siteName":"PlanetScale","title":"WorkOS Sync Engine integration - PlanetScale","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T17:48:23.621Z","originalFileLocation":"vitess/integrations/workos-sync-engine.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PlanetScale\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"WorkOS Sync Engine integration - PlanetScale\">\u003cmeta data-mint-head property=\"og:description\" content=\"Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PlanetScale\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://planetscale-2.mintlify.site/docs/images/og/vitess/integrations/workos-sync-engine.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"WorkOS Sync Engine integration - PlanetScale\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://planetscale-2.mintlify.site/docs/images/og/vitess/integrations/workos-sync-engine.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/planetscale-2/_bFyi8IG4CeLblEd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PlanetScale\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0e73cc\">\u003clink data-mint-head rel=\"canonical\" href=\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/vitess/integrations/workos-sync-engine.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://planetscale.com/#organization\",\"name\":\"PlanetScale\",\"url\":\"https://planetscale.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/planetscale-2/xUilVHToUFALai8a/logo/light.png?fit=max\u0026auto=format\u0026n=xUilVHToUFALai8a\u0026q=85\u0026s=cccd3c9fc813c01b899ab7af15a115b1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://planetscale.com/docs#website\",\"name\":\"PlanetScale\",\"url\":\"https://planetscale.com/docs\",\"publisher\":{\"@id\":\"https://planetscale.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine#webpage\",\"url\":\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine\",\"name\":\"WorkOS Sync Engine integration\",\"description\":\"Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.\",\"dateModified\":\"2026-11-19T17:48:23.621Z\",\"isPartOf\":{\"@id\":\"https://planetscale.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Integrations\",\"item\":\"https://planetscale.com/docs/vitess/integrations/cloudflare-workers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Development\",\"item\":\"https://planetscale.com/docs/vitess/integrations/cloudflare-workers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"WorkOS Sync Engine integration\",\"item\":\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine#article\",\"headline\":\"WorkOS Sync Engine integration\",\"name\":\"WorkOS Sync Engine integration\",\"description\":\"Mirror WorkOS data into PlanetScale Vitess with the @workos/sync-mysql package and query it with SQL.\",\"url\":\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine\",\"mainEntityOfPage\":{\"@id\":\"https://planetscale.com/docs/vitess/integrations/workos-sync-engine#webpage\"},\"image\":\"https://planetscale.com/docs/images/og/vitess/integrations/workos-sync-engine.png\",\"dateModified\":\"2026-11-19T17:48:23.621Z\",\"publisher\":{\"@id\":\"https://planetscale.com/#organization\"},\"isPartOf\":{\"@id\":\"https://planetscale.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PlanetScale\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PlanetScale\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/vitess/integrations/workos-sync-engine.md","siteName":"PlanetScale","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://planetscale.com/blog"},{"anchor":"Contact Us","icon":"headset","href":"https://planetscale.com/contact"},{"anchor":"Status","icon":"signal","href":"https://www.planetscalestatus.com/"},{"anchor":"Benchmarks","icon":"chart-line","href":"https://planetscale.com/benchmarks"}]},"tabs":[{"tab":"Platform","pages":[{"title":"Platform","href":""}]},{"tab":"Vitess","groups":[{"group":" ","pages":[{"title":"PlanetScale for Vitess","sidebarTitle":"Vitess","href":"/vitess"}]},{"group":"Pricing","pages":[{"title":"Pricing","href":"/vitess/pricing"}]},{"group":"Platform","pages":[{"group":"Getting Started","pages":[{"title":"PlanetScale Vitess architecture","sidebarTitle":"Vitess architecture","href":"/vitess/architecture"},{"title":"PlanetScale workflow for Vitess","sidebarTitle":"Vitess workflow","href":"/vitess/best-practices"},{"title":"PlanetScale Vitess quickstart guide","sidebarTitle":"Step-by-step guide","href":"/vitess/tutorials/planetscale-quick-start-guide"},{"title":"Cluster sizing","sidebarTitle":"Cluster sizing","href":"/plans/cluster-sizing"},{"title":"Cluster configuration","href":"/vitess/cluster-configuration"},{"title":"Disk autoscaling","href":"/vitess/cluster-configuration/disk-autoscaling"},{"title":"Cluster configuration parameters","sidebarTitle":"Parameters","href":"/vitess/cluster-configuration/parameters"},{"title":"Per-shard sizing","href":"/vitess/cluster-configuration/per-shard-sizing"},{"title":"Database replicas","sidebarTitle":"Replicas","href":"/vitess/replicas"},{"title":"Foreign key constraints","sidebarTitle":"Foreign key constraints support","href":"/vitess/foreign-key-constraints"},{"title":"Web console","sidebarTitle":"Web console","href":"/vitess/web-console"},{"title":"PlanetScale terminology","sidebarTitle":"Terminology","href":"/vitess/terminology"},{"title":"MySQL compatibility","sidebarTitle":"MySQL compatibility","href":"/vitess/mysql-compatibility"}]},{"group":"Imports","pages":[{"title":"Discovery Tool","sidebarTitle":"Discovery tool","href":"/vitess/imports/discovery-tool"},{"title":"What are workflows?","sidebarTitle":"Workflows","href":"/vitess/scaling/workflows"},{"group":"Database imports","pages":[{"title":"Database imports","href":"/vitess/imports/database-imports"},{"title":"Import public IP addresses","href":"/vitess/imports/import-tool-migration-addresses"},{"title":"Import user permissions","href":"/vitess/imports/import-tool-user-requirements"},{"title":"Import troubleshooting","href":"/vitess/imports/import-troubleshooting"}]},{"group":"MySQL to PlanetScale Vitess migration","pages":[{"title":"Amazon Aurora migration guide","sidebarTitle":"Amazon Aurora","href":"/vitess/imports/amazon-aurora-migration-guide"},{"title":"AWS RDS migration guide","sidebarTitle":"Amazon RDS","href":"/vitess/imports/aws-rds-migration-guide"},{"title":"Azure Database for MySQL migration guide","sidebarTitle":"Azure","href":"/vitess/imports/azure-database-for-mysql-migration-guide"},{"title":"DigitalOcean database migration guide","sidebarTitle":"DigitalOcean","href":"/vitess/imports/digitalocean-database-migration-guide"},{"title":"GCP Cloud SQL Migration Guide","sidebarTitle":"GCP Cloud SQL","href":"/vitess/imports/gcp-cloudsql-migration-guide"},{"title":"MariaDB migration guide","sidebarTitle":"MariaDB","href":"/vitess/imports/mariadb-migration-guide"}]},{"group":"Postgres to PlanetScale Vitess migration","pages":[{"title":"Postgres to Vitess imports","sidebarTitle":"Postgres to Vitess overview","href":"/vitess/imports/postgres"},{"title":"Postgres to PlanetScale for Vitess migration guide","sidebarTitle":"Postgres to Vitess directly","href":"/vitess/imports/postgres-planetscale-migration-guide"},{"title":"Postgres to MySQL to PlanetScale migration guide","sidebarTitle":"Postgres to Vitess with intermediate MySQL","href":"/vitess/imports/postgres-mysql-planetscale-migration-guide"}]}]},{"group":"Connecting","pages":[{"title":"Connect any application to PlanetScale","sidebarTitle":"Connect any app","href":"/vitess/tutorials/connect-any-application"},{"title":"Connect a MySQL GUI to PlanetScale","sidebarTitle":"Connect a MySQL GUI","href":"/vitess/tutorials/connect-mysql-gui"},{"title":"Connection strings","href":"/vitess/connecting/connection-strings"},{"title":"Network latency","href":"/vitess/connecting/network-latency"},{"group":"MCP","pages":[{"title":"PlanetScale Model Context Protocol (MCP)","sidebarTitle":"Overview","href":"/mcp-server"},{"title":"Authenticate the MCP server with a service token","sidebarTitle":"Service tokens","href":"/mcp/service-token"}]},{"title":"Self-improving database","sidebarTitle":"Self-improving database","href":"/self-improving-database"},{"title":"PlanetScale Terraform provider","sidebarTitle":"Terraform provider","href":"/terraform"},{"group":"Private connections","pages":[{"title":"Connecting to PlanetScale privately on AWS","sidebarTitle":"AWS PrivateLink","href":"/vitess/connecting/private-connections"},{"title":"Connecting to PlanetScale privately on GCP","sidebarTitle":"GCP Private Service Connect","href":"/vitess/connecting/private-connections-gcp"}]}]},{"group":"Schema changes","pages":[{"title":"Non-blocking schema changes","href":"/vitess/schema-changes"},{"title":"Safe migrations","href":"/vitess/schema-changes/safe-migrations"},{"group":"Branching","pages":[{"title":"Branching","sidebarTitle":"Using branches","href":"/vitess/schema-changes/branching"},{"title":"Data Branching®","href":"/vitess/schema-changes/data-branching"}]},{"group":"Deploy requests","pages":[{"title":"Deploy requests","sidebarTitle":"Using deploy requests","href":"/vitess/schema-changes/deploy-requests"},{"title":"Throttling deploy requests","href":"/vitess/schema-changes/throttling-deploy-requests"},{"title":"Aggressive deploy request cutover","sidebarTitle":"Aggressive cutover","href":"/vitess/schema-changes/aggressive-cutover"},{"title":"Long-running transactions","sidebarTitle":"Long-running transactions","href":"/vitess/schema-changes/long-running-transactions"},{"title":"Column cannot be null","sidebarTitle":"Column cannot be null","href":"/vitess/schema-changes/column-cannot-be-null"},{"title":"Column has no default value","sidebarTitle":"Column has no default value","href":"/vitess/schema-changes/column-has-no-default"},{"title":"Duplicate entry for unique key","sidebarTitle":"Duplicate entry","href":"/vitess/schema-changes/duplicate-entry"},{"title":"Value does not fit the new column","sidebarTitle":"Value does not fit column","href":"/vitess/schema-changes/value-does-not-fit-column"},{"title":"Constraint not found","sidebarTitle":"Constraint not found","href":"/vitess/schema-changes/constraint-not-found"},{"title":"Foreign key missing unique key","sidebarTitle":"Foreign key missing unique key","href":"/vitess/schema-changes/foreign-key-missing-unique-key"},{"title":"Earlier migration failed","sidebarTitle":"Earlier migration failed","href":"/vitess/schema-changes/earlier-migration-failed"}]},{"group":"Schema lint errors","pages":[{"title":"Schema lint errors","sidebarTitle":"Schema lint errors","href":"/vitess/schema-changes/schema-lint-errors"},{"title":"UNSPECIFIED schema lint error","sidebarTitle":"UNSPECIFIED","href":"/vitess/schema-changes/schema-lint-errors/unspecified"},{"title":"NO_UNIQUE_KEY schema lint error","sidebarTitle":"NO_UNIQUE_KEY","href":"/vitess/schema-changes/schema-lint-errors/no-unique-key"},{"title":"FOREIGN_KEYS_DISALLOWED schema lint error","sidebarTitle":"FOREIGN_KEYS_DISALLOWED","href":"/vitess/schema-changes/schema-lint-errors/foreign-keys-disallowed"},{"title":"INVALID_CHARSET schema lint error","sidebarTitle":"INVALID_CHARSET","href":"/vitess/schema-changes/schema-lint-errors/invalid-charset"},{"title":"UNSUPPORTED_FEATURE schema lint error","sidebarTitle":"UNSUPPORTED_FEATURE","href":"/vitess/schema-changes/schema-lint-errors/unsupported-feature"},{"title":"UNSUPPORTED_SHARDED_FEATURE schema lint error","sidebarTitle":"UNSUPPORTED_SHARDED_FEATURE","href":"/vitess/schema-changes/schema-lint-errors/unsupported-sharded-feature"},{"title":"INVALID_VSCHEMA schema lint error","sidebarTitle":"INVALID_VSCHEMA","href":"/vitess/schema-changes/schema-lint-errors/invalid-vschema"},{"title":"DUPLICATE_ENUM_VALUE schema lint error","sidebarTitle":"DUPLICATE_ENUM_VALUE","href":"/vitess/schema-changes/schema-lint-errors/duplicate-enum-value"},{"title":"UNSUPPORTED_PARTITIONING_FEATURE schema lint error","sidebarTitle":"UNSUPPORTED_PARTITIONING_FEATURE","href":"/vitess/schema-changes/schema-lint-errors/unsupported-partitioning-feature"},{"title":"INVALID_TABLE_REFERENCED_IN_VIEW schema lint error","sidebarTitle":"INVALID_TABLE_REFERENCED_IN_VIEW","href":"/vitess/schema-changes/schema-lint-errors/invalid-table-referenced-in-view"},{"title":"INVALID_COLUMN_REFERENCED_IN_VIEW schema lint error","sidebarTitle":"INVALID_COLUMN_REFERENCED_IN_VIEW","href":"/vitess/schema-changes/schema-lint-errors/invalid-column-referenced-in-view"},{"title":"BLOB_IN_UNIQUE_KEY schema lint error","sidebarTitle":"BLOB_IN_UNIQUE_KEY","href":"/vitess/schema-changes/schema-lint-errors/blob-in-unique-key"},{"title":"PARTIAL_KEY_IN_UNIQUE_KEY schema lint error","sidebarTitle":"PARTIAL_KEY_IN_UNIQUE_KEY","href":"/vitess/schema-changes/schema-lint-errors/partial-key-in-unique-key"},{"title":"FOREIGN_KEYS_CIRCULAR_DEPENDENCY schema lint error","sidebarTitle":"FOREIGN_KEYS_CIRCULAR_DEPENDENCY","href":"/vitess/schema-changes/schema-lint-errors/foreign-keys-circular-dependency"},{"title":"FOREIGN_KEYS_NONEXISTENT_TABLE schema lint error","sidebarTitle":"FOREIGN_KEYS_NONEXISTENT_TABLE","href":"/vitess/schema-changes/schema-lint-errors/foreign-keys-nonexistent-table"},{"title":"FOREIGN_KEYS_REFERENCED_VIEW schema lint error","sidebarTitle":"FOREIGN_KEYS_REFERENCED_VIEW","href":"/vitess/schema-changes/schema-lint-errors/foreign-keys-referenced-view"},{"title":"FOREIGN_KEYS_UNRESOLVED schema lint error","sidebarTitle":"FOREIGN_KEYS_UNRESOLVED","href":"/vitess/schema-changes/schema-lint-errors/foreign-keys-unresolved"},{"title":"INVALID_ROUTING_RULES schema lint error","sidebarTitle":"INVALID_ROUTING_RULES","href":"/vitess/schema-changes/schema-lint-errors/invalid-routing-rules"}]},{"group":"Schema changes","pages":[{"title":"How to make different types of schema changes","href":"/vitess/schema-changes/how-to-make-different-types-of-schema-changes"},{"title":"PlanetScale GitHub Actions","sidebarTitle":"Automating with GitHub Actions","href":"/vitess/integrations/github-actions"},{"title":"Handling table and column renames","href":"/vitess/schema-changes/handling-table-and-column-renames"},{"title":"Online DDL change unique keys","sidebarTitle":"Changing primary and unique keys","href":"/vitess/schema-changes/onlineddl-change-unique-keys"}]}]},{"group":"Monitoring","pages":[{"group":"PlanetScale Insights","pages":[{"title":"Query Insights","href":"/vitess/monitoring/query-insights"},{"title":"Inspect live Vitess connections","sidebarTitle":"Connections","href":"/vitess/monitoring/connections"},{"title":"Tags","href":"/vitess/monitoring/query-tags"},{"title":"Anomalies","sidebarTitle":"Anomalies","href":"/vitess/monitoring/anomalies"},{"title":"Errors","sidebarTitle":"Errors","href":"/vitess/monitoring/errors"},{"title":"Schema recommendations","sidebarTitle":"Schema recommendations","href":"/vitess/monitoring/schema-recommendations"},{"title":"Insights Agent","sidebarTitle":"Insights Agent","href":"/insights-agent"}]},{"group":"Prometheus","pages":[{"title":"Prometheus","sidebarTitle":"Connecting Prometheus","href":"/vitess/integrations/prometheus"},{"title":"Grafana Dashboard for PlanetScale Branches","sidebarTitle":"Visualizing in Grafana","href":"/vitess/tutorials/prometheus-metrics-grafana"},{"title":"Sending Prometheus Metrics to Datadog","sidebarTitle":"Collecting in the Datadog Agent","href":"/vitess/tutorials/prometheus-metrics-datadog"},{"title":"Sending Prometheus Metrics to New Relic","sidebarTitle":"Forwarding metrics to New Relic","href":"/vitess/tutorials/prometheus-metrics-newrelic"},{"title":"Prometheus metrics","sidebarTitle":"Metrics List","href":"/vitess/integrations/prometheus-metrics"}]},{"group":"Integrations","pages":[{"title":"Datadog integration","sidebarTitle":"Datadog (legacy)","href":"/vitess/integrations/datadog"}]},{"group":"Database auditing","pages":[{"title":"Audit log","href":"/vitess/audit-log"}]}]},{"group":"Backups","pages":[{"title":"Back up and restore","href":"/vitess/backups"}]},{"group":"Scaling","pages":[{"title":"Cluster sizing","sidebarTitle":"Cluster sizing","href":"/vitess/scaling/cluster-sizing"},{"title":"Cluster configuration","href":"/vitess/scaling/cluster-configuration"},{"title":"Per-shard sizing","href":"/vitess/cluster-configuration/per-shard-sizing"},{"title":"Database replicas","sidebarTitle":"Replicas","href":"/vitess/scaling/replicas"},{"title":"Read-only regions","href":"/vitess/scaling/read-only-regions"},{"title":"Vitess system limits","href":"/vitess/scaling/planetscale-system-limits"},{"title":"VTGates","href":"/vitess/scaling/vtgates"},{"title":"Deleting a database","sidebarTitle":"Deleting a database","href":"/vitess/delete-a-database"}]},{"group":"Sharding","pages":[{"group":"Overview","pages":[{"title":"Sharding with PlanetScale","href":"/vitess/sharding"},{"title":"What are workflows?","sidebarTitle":"Workflows","href":"/vitess/scaling/workflows"}]},{"group":"Guides","pages":[{"title":"Shard existing tables with MoveTables","sidebarTitle":"Sharding quickstart","href":"/vitess/sharding/sharding-quickstart"},{"title":"Change the number of shards with MoveTables","sidebarTitle":"Modifying the number of shards","href":"/vitess/sharding/sharding-a-sharded-keyspace"},{"title":"Sharding new tables","sidebarTitle":"Sharding new tables","href":"/vitess/sharding/sharding-new-tables"},{"title":"Avoiding cross-shard queries","href":"/vitess/sharding/avoiding-cross-shard-queries"},{"title":"Targeting the correct keyspace","sidebarTitle":"Keyspace targeting for ORMs and frameworks","href":"/vitess/sharding/targeting-correct-keyspace"},{"title":"Sequence Tables","sidebarTitle":"Creating sequence tables","href":"/vitess/sharding/sequence-tables"},{"title":"Pre-sharding checklist","sidebarTitle":"Pre-sharding checklist","href":"/vitess/sharding/pre-sharding-checklist"}]},{"group":"Concepts","pages":[{"title":"VSchema","sidebarTitle":"VSchema","href":"/vitess/sharding/vschema"},{"title":"ALTER VSCHEMA syntax reference","sidebarTitle":"ALTER VSCHEMA syntax","href":"/vitess/sharding/alter-vschema"},{"title":"Vindexes","sidebarTitle":"Vindexes","href":"/vitess/sharding/vindexes"},{"title":"What is a keyspace","sidebarTitle":"Keyspace","href":"/vitess/sharding/keyspaces"},{"title":"Sharding workflow state reference","sidebarTitle":"Sharding workflow state reference","href":"/vitess/sharding/sharding-workflow-state-reference"}]}]},{"group":"Vectors","pages":[{"title":"Vector search and storage","sidebarTitle":"Vectors overview","href":"/vitess/vectors"},{"title":"Vector database terminology and concepts","sidebarTitle":"Concepts and terminology","href":"/vitess/vectors/terminology-and-concepts"},{"title":"Common use cases for Vector search","sidebarTitle":"Use cases","href":"/vitess/vectors/use-cases"},{"title":"Vectors with an ORM","sidebarTitle":"Using with an ORM","href":"/vitess/vectors/using-with-an-orm"},{"title":"Vector type and index reference","sidebarTitle":"Reference","href":"/vitess/vectors/reference"}]},{"group":"Security","pages":[{"title":"Security and compliance","sidebarTitle":"Overview","href":"/security"},{"title":"Vulnerability disclosure","href":"/security/vulnerability-disclosure"},{"group":"Database security","pages":[{"title":"Connection strings","href":"/vitess/security/connection-strings"},{"title":"Connecting to PlanetScale securely","sidebarTitle":"Secure connections","href":"/vitess/connecting/secure-connections"},{"title":"Password roles","href":"/vitess/security/password-roles"}]},{"group":"Account access","pages":[{"title":"Authentication methods","href":"/security/authentication-methods"},{"title":"Multi-factor authentication","href":"/security/multi-factor-authentication"},{"title":"Account password security","href":"/security/account-password-security"},{"title":"Security log","href":"/security/security-log"}]},{"group":"Organization access","pages":[{"title":"Access control","href":"/security/access-control"},{"title":"Audit log","href":"/security/audit-log"},{"title":"Teams","sidebarTitle":"Teams","href":"/security/teams"},{"title":"Single sign-on","href":"/security/sso"}]},{"group":"Database protection","pages":[{"title":"Deletion protection","sidebarTitle":"Deletion protection","href":"/security/deletion-protection"},{"title":"Require multiple administrators for deletion","sidebarTitle":"Multiple admins for deletion","href":"/security/multiple-admins-required-for-deletion"}]}]},{"group":"Troubleshooting","pages":[{"title":"MySQL compatibility","sidebarTitle":"MySQL compatibility","href":"/vitess/troubleshooting/mysql-compatibility"},{"title":"Vitess system limits","href":"/vitess/troubleshooting/planetscale-system-limits"},{"title":"PlanetScale database error reference","sidebarTitle":"Errors reference","href":"/vitess/troubleshooting/errors"},{"title":"Out of memory (OOM)","href":"/vitess/troubleshooting/out-of-memory"}]}]},{"group":"Integrations","pages":[{"group":"Development","pages":[{"title":"Cloudflare Workers database integration","sidebarTitle":"Cloudflare Workers","href":"/vitess/integrations/cloudflare-workers"},{"title":"Netlify","url":"https://docs.netlify.com/extend/install-and-use/setup-guides/planetscale-integration/","href":"/vitess/integrations/netlify"},{"title":"Deploy to Vercel","sidebarTitle":"Vercel","href":"/vitess/tutorials/deploy-to-vercel"},{"title":"AWS Lambda connection strings","description":"In this guide, you'll learn how to properly store and use PlanetScale MySQL connection strings for use in AWS Lambda Functions.","sidebarTitle":"AWS Lambda","href":"/vitess/tutorials/aws-lambda-connection-strings"},{"title":"WorkOS Sync Engine integration","sidebarTitle":"WorkOS Sync Engine","href":"/vitess/integrations/workos-sync-engine"}]},{"group":"ETL","pages":[{"title":"PlanetScale Connect","description":"PlanetScale Connect is one of the underlying mechanisms we use to transfer data between parties.","sidebarTitle":"Overview","href":"/vitess/etl"},{"title":"Airbyte integration","sidebarTitle":"Airbyte","href":"/vitess/integrations/airbyte"},{"title":"Artie integration","sidebarTitle":"Artie","href":"/vitess/integrations/artie"},{"title":"Fivetran integration","sidebarTitle":"Fivetran","href":"/vitess/integrations/fivetran"},{"title":"Hightouch integration","sidebarTitle":"Hightouch","href":"/vitess/integrations/hightouch"},{"title":"Stitch integration","sidebarTitle":"Stitch","href":"/vitess/integrations/stitch"},{"group":"Debezium","pages":[{"title":"Debezium connector for PlanetScale","sidebarTitle":"Debezium","href":"/vitess/integrations/debezium"},{"title":"Debezium connector on Confluent Cloud","sidebarTitle":"Confluent Cloud","href":"/vitess/integrations/debezium-confluent"}]}]},{"group":"Monitoring","pages":[{"title":"Prometheus","sidebarTitle":"Prometheus","href":"/vitess/tutorials/prometheus"},{"title":"Grafana Dashboard for PlanetScale Branches","sidebarTitle":"Grafana","href":"/vitess/monitoring/prometheus-metrics-grafana"},{"title":"Sending Prometheus Metrics to Datadog","sidebarTitle":"Datadog Agent","href":"/vitess/monitoring/prometheus-metrics-datadog"},{"title":"Sending Prometheus Metrics to New Relic","sidebarTitle":"New Relic","href":"/vitess/monitoring/prometheus-metrics-newrelic"},{"title":"Datadog integration","sidebarTitle":"Datadog (legacy)","href":"/vitess/monitoring/datadog"}]},{"group":"Billing","pages":[{"title":"Vantage integration","sidebarTitle":"Vantage","href":"/vitess/integrations/vantage"}]}]},{"group":"Guides","pages":[{"group":"Frameworks and ORMs","pages":[{"title":"Connect a Django application to PlanetScale","sidebarTitle":"Django","href":"/vitess/tutorials/connect-django-app"},{"group":"Golang","pages":[{"title":"Connect a Go application to PlanetScale","sidebarTitle":"Go quickstart","href":"/vitess/tutorials/connect-go-app"},{"title":"Connect a Go application using GORM to PlanetScale","sidebarTitle":"Gorm","href":"/vitess/tutorials/connect-go-gorm-app"}]},{"group":"Next.js","pages":[{"title":"Connect a Next.js application to PlanetScale","sidebarTitle":"Next.js quickstart","href":"/vitess/tutorials/connect-nextjs-app"},{"title":"Next.js and PlanetScale Netlify template tutorial","sidebarTitle":"Next.js and Netlify template","href":"/vitess/tutorials/nextjs-planetscale-netlify-template"},{"title":"Deploy to Vercel","sidebarTitle":"Deploy to Vercel","href":"/vitess/tutorials/nextjs-deploy-to-vercel"},{"title":"Deploy to Netlify","sidebarTitle":"Deploy to Netlify","href":"/vitess/tutorials/deploy-to-netlify"}]},{"title":"Connect a Node.js application to PlanetScale","sidebarTitle":"Node.js","href":"/vitess/tutorials/connect-nodejs-app"},{"group":"PHP","pages":[{"title":"Connect a PHP application to PlanetScale","sidebarTitle":"PHP quickstart","href":"/vitess/tutorials/connect-php-app"},{"title":"Connect a Laravel application to PlanetScale","sidebarTitle":"Laravel quickstart","href":"/vitess/tutorials/connect-laravel-app"},{"title":"Connect a Symfony application to PlanetScale","sidebarTitle":"Symfony quickstart","href":"/vitess/tutorials/connect-symfony-app"}]},{"group":"Prisma","pages":[{"title":"Using PlanetScale with Prisma","sidebarTitle":"Prisma guide","href":"/vitess/tutorials/using-planetscale-with-prisma"},{"title":"Automatic Prisma migrations","sidebarTitle":"Automatic Prisma migrations","href":"/vitess/tutorials/automatic-prisma-migrations"},{"title":"Using the PlanetScale serverless driver with Prisma","sidebarTitle":"Serverless driver with Prisma","href":"/vitess/tutorials/planetscale-serverless-driver-prisma-example"},{"title":"Prisma best practices","href":"/vitess/tutorials/prisma-best-practices"}]},{"group":"Ruby on Rails","pages":[{"title":"Connect a Rails application to PlanetScale","sidebarTitle":"Ruby on Rails quickstart","href":"/vitess/tutorials/connect-rails-app"},{"title":"Automatic Rails migrations","sidebarTitle":"Automatic Rails migrations","href":"/vitess/tutorials/automatic-rails-migrations"}]}]},{"group":"Deployments","pages":[{"title":"Deploy to Netlify","sidebarTitle":"Deploy to Netlify","href":"/vitess/tutorials/deployments/deploy-to-netlify"},{"title":"Deploy to Vercel","href":"/vitess/tutorials/deployments/deploy-to-vercel"},{"title":"Next.js and PlanetScale Netlify template tutorial","sidebarTitle":"Next.js and Netlify template","href":"/vitess/tutorials/deployments/nextjs-planetscale-netlify-template"},{"title":"Deploy a Django app to Heroku","href":"/vitess/tutorials/deploy-a-django-app-to-heroku"}]},{"group":"Monitoring","pages":[{"title":"Grafana Dashboard for PlanetScale Branches","sidebarTitle":"Visualizing in Grafana","href":"/vitess/guides/prometheus-metrics-grafana"},{"title":"Sending Prometheus Metrics to Datadog","sidebarTitle":"Sending Prometheus Metrics to Datadog","href":"/vitess/guides/prometheus-metrics-datadog"},{"title":"Sending Prometheus Metrics to New Relic","sidebarTitle":"Sending Prometheus Metrics to New Relic","href":"/vitess/guides/prometheus-metrics-newrelic"}]},{"group":"Serverless JavaScript driver","pages":[{"title":"PlanetScale serverless driver for JavaScript","sidebarTitle":"Using the serverless driver","href":"/vitess/tutorials/planetscale-serverless-driver"},{"title":"Node.js example using the PlanetScale serverless driver","sidebarTitle":"Node.js example","href":"/vitess/tutorials/planetscale-serverless-driver-node-example"},{"title":"Using the PlanetScale serverless driver with Prisma","sidebarTitle":"Prisma example","href":"/vitess/tutorials/prisma-example"}]},{"group":"MySQL","pages":[{"title":"Operating without foreign key constraints","sidebarTitle":"Operating without foreign key constraints","href":"/vitess/operating-without-foreign-key-constraints"},{"title":"How to make different types of schema changes","sidebarTitle":"Performing different types of schema changes","href":"/vitess/how-to-make-different-types-of-schema-changes"},{"title":"How Online Schema Change tools work","sidebarTitle":"How online schema change tools work","href":"/vitess/schema-changes/how-online-schema-change-tools-work"},{"title":"Online DDL change unique keys","sidebarTitle":"OnlineDDL","href":"/vitess/onlineddl-change-unique-keys"},{"title":"Strategies for maintaining referential integrity","sidebarTitle":"Changing unique keys","href":"/vitess/strategies-for-maintaining-referential-integrity"},{"title":"Handling table and column renames","sidebarTitle":"Renaming columns and tables","href":"/vitess/handling-table-and-column-renames"},{"title":"Comparison of Online Schema Change tools","sidebarTitle":"Online schema change tool comparison","href":"/vitess/schema-changes/online-schema-change-tools-comparison"}]}]}]},{"tab":"Neki","pages":[{"title":"Neki","href":"/neki"}]},{"tab":"Postgres","pages":[{"title":"Postgres","href":"/postgres"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api/reference/getting-started-with-planetscale-api"}]},{"tab":"CLI Reference","pages":[{"title":"CLI Reference","href":"/cli"}]}]},"basePath":"","title":"WorkOS Sync Engine integration - PlanetScale","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":[],"chunks":[]}