Weekly maintenance scheduling for production Neki branches.
Every production Neki branch has a weekly maintenance window. PlanetScale uses
this window for maintenance that can restart cluster components, including:
Neki image updates.
Postgres minor-version updates within the configured major version.
Updates to default parameters and platform-managed configuration.
On a highly available shard, Neki performs a planned switchover before maintenance on the
primary. The switchover waits for a replica to catch up before promoting it,
which preserves commits made on the old primary. Maintenance can still close
active connections, so applications should reconnect automatically.
The maintenance window controls scheduled weekly maintenance. Configuration
changes that you request in the dashboard, API, CLI, or Terraform apply
independently of this window.
To apply available weekly maintenance without waiting for the next window,
select Run maintenance tasks now on the branch’s schedule card.Running maintenance immediately applies the same available updates as the
weekly schedule and can restart cluster components. Confirm that applications
can reconnect before starting it. Neki cannot start customer-requested
maintenance while a branch is sleeping.Run branch-wide maintenance from the CLI with:
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ae505c7cb870de49023cbd6","collectionId":"75c09c64-fefe-4ba5-8569-25281688c6cb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae505c7cb870de49023cbd6"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae50e31004f8cf1ce957135","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Platform","count":289},{"language":"default","tag":"API Reference","count":268},{"language":"default","tag":"Vitess","count":184},{"language":"default","tag":"Postgres","count":109},{"language":"default","tag":"General API endpoints","count":97},{"language":"default","tag":"Neki","count":58},{"language":"default","tag":"Guides","count":58},{"language":"default","tag":"Vitess API endpoints","count":56},{"language":"default","tag":"Postgres API endpoints","count":51},{"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":"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":"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":"llms-txt-v2","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-container{column-gap:2rem}.nav-tabs{column-gap:.5em}.nav-tabs-item{padding:0 8px}.eyebrow,.light #navigation-items .text-gray-700,.nav-tabs a{color:#616161}#navigation-items .text-primary,#topbar-cta-button .text-white,#topbar-cta-button svg,.nav-tabs a.text-primary{color:#1a1a1a}.nav-tabs a.text-primary .bg-primary{background-color:#1a1a1a;left:0}.dark .nav-tabs a[href='/docs/vitess'i].text-primary,.nav-tabs a[href='/docs/vitess'i].text-primary{color:#f15817}.dark .nav-tabs a[href='/docs/vitess'i].text-primary .bg-primary,.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 #navigation-items .text-primary,.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/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}.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}.group:hover span{opacity:1!important}.bg-primary\\/10{background-color:rgba(129,129,129,.1)}.dark .bg-primary\\/10{background-color:rgba(255,255,255,.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,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(.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 .375rem;color:#1a1a1a;background-color:#fbca00}body[data-current-path^='/neki'] .eyebrow:empty,body[data-current-path^='/neki'] .eyebrow[data-empty]{display:none}.dark body[data-current-path^='/neki'] .card-group .card:hover,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'] [data-component-part=card-icon],.dark body[data-current-path^='/neki'] svg.bg-primary{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}footer div:last-child{display:none}#header,#pagination a,[data-component-part=card-content-container],[data-component-part=frame-caption]{text-wrap:balance}.step:last-of-type [data-component-part=step-line]{opacity:0}"}],"page":{"pagePath":"neki/cluster-configuration/maintenance-windows","slug":"/neki/cluster-configuration/maintenance-windows","pageMetadata":{"title":"Configure Neki maintenance windows","sidebarTitle":"Maintenance windows","description":"Weekly maintenance scheduling for production Neki branches.","og:image":"images/og/neki/cluster-configuration/maintenance-windows.png","href":"/neki/cluster-configuration/maintenance-windows"},"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: \"Weekly maintenance scheduling for production Neki branches.\"\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];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Frame,Heading,Note,OptimizedImage,Step,Steps}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Every production Neki branch has a weekly maintenance window. PlanetScale uses\nthis window for maintenance that can restart cluster components, including:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Neki image updates.`}),`\n`,_jsx(_components.li,{children:`Postgres minor-version updates within the configured major version.`}),`\n`,_jsx(_components.li,{children:`Updates to default parameters and platform-managed configuration.`}),`\n`]}),`\n`,_jsx(_components.p,{children:`On a highly available shard, Neki performs a planned switchover before maintenance on the\nprimary. The switchover waits for a replica to catch up before promoting it,\nwhich preserves commits made on the old primary. Maintenance can still close\nactive connections, so applications should reconnect automatically.`}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The maintenance window controls scheduled weekly maintenance. Configuration\nchanges that you request in the dashboard, API, CLI, or Terraform apply\nindependently of this window.`})}),`\n`,_jsx(Heading,{level:`2`,id:`change-the-weekly-schedule`,children:`Change the weekly schedule`}),`\n`,_jsx(_components.p,{children:`Maintenance windows use UTC. The dashboard also shows the corresponding time\nin your configured local time zone.`}),`\n`,_jsxs(Frame,{children:[_jsx(OptimizedImage,{src:`https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows.png?fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=265c268fbc5ad3f5310cae26457d79da`,alt:`Settings Maintenance page showing the weekly schedule card for a production branch, with Change schedule and Run maintenance tasks now`,className:`mint-block dark:mint-hidden`,\"data-og-width\":`2118`,width:`2118`,\"data-og-height\":`1110`,height:`1110`,\"data-path\":`neki/cluster-configuration/maintenance-windows.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows.png?w=280\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=7c1c53f3f9fae80ef15addc6201ca303 280w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows.png?w=560\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=ba70fdede0410365494a35bdb57004eb 560w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows.png?w=840\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=1c3cfce480eddd9a6d053230f3ec661a 840w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows.png?w=1100\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=01feac5be438a403d5b5a009c62bfafa 1100w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows.png?w=1650\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=c290472fa0eae872f09d9fb20ea5b89f 1650w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows.png?w=2500\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=e0e7f412902b638f0d6626243f645968 2500w`}),_jsx(OptimizedImage,{src:`https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows-darkmode.png?fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=90d544144a9d8653dbc577172c106e0b`,alt:`Settings Maintenance page showing the weekly schedule card for a production branch, with Change schedule and Run maintenance tasks now`,className:`mint-hidden dark:mint-block`,\"data-og-width\":`2118`,width:`2118`,\"data-og-height\":`1110`,height:`1110`,\"data-path\":`neki/cluster-configuration/maintenance-windows-darkmode.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows-darkmode.png?w=280\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=a5ec4409d3ec8a1986dfb9bd6ba73bda 280w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows-darkmode.png?w=560\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=708a10f10b7822c56feb7e3890e28c29 560w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows-darkmode.png?w=840\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=1f8e03809f3648b48a733a794f8d13df 840w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows-darkmode.png?w=1100\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=798d51488ff84bb06baf022a52969dee 1100w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows-darkmode.png?w=1650\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=08ac51e207d7f95965fdd20614ab5fac 1650w, https://mintcdn.com/planetscale-2/6i1lJ6cNfB-VSsaH/neki/cluster-configuration/maintenance-windows-darkmode.png?w=2500\u0026fit=max\u0026auto=format\u0026n=6i1lJ6cNfB-VSsaH\u0026q=85\u0026s=76869298a3cb4921b971db9f90c3ee7d 2500w`})]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{children:`From the PlanetScale dashboard, select your Neki database.`}),_jsxs(Step,{children:[`Open `,_jsx(_components.strong,{children:`Settings`}),`, then select `,_jsx(_components.strong,{children:`Maintenance`}),`.`]}),_jsxs(Step,{children:[`Find the production branch and select `,_jsx(_components.strong,{children:`Change schedule`}),`.`]}),_jsx(Step,{children:`Choose the day of the week and hour in UTC.`}),_jsxs(Step,{children:[`Select `,_jsx(_components.strong,{children:`Save`}),`.`]})]}),`\n`,_jsx(_components.p,{children:`The schedule card shows the previous maintenance window and the next scheduled\nwindow. Only database administrators can change maintenance schedules.`}),`\n`,_jsx(Heading,{level:`2`,id:`run-maintenance-immediately`,children:`Run maintenance immediately`}),`\n`,_jsxs(_components.p,{children:[`To apply available weekly maintenance without waiting for the next window,\nselect `,_jsx(_components.strong,{children:`Run maintenance tasks now`}),` on the branch’s schedule card.`]}),`\n`,_jsx(_components.p,{children:`Running maintenance immediately applies the same available updates as the\nweekly schedule and can restart cluster components. Confirm that applications\ncan reconnect before starting it. Neki cannot start customer-requested\nmaintenance while a branch is sleeping.`}),`\n`,_jsx(_components.p,{children:`Run branch-wide maintenance from the CLI with:`}),`\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:`pscale`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` branch`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` maintenance`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`DATABAS`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`E`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`BRANC`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`H`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`development-branches`,children:`Development branches`}),`\n`,_jsx(_components.p,{children:`Development branches do not have configurable maintenance windows. Scheduled\nmaintenance uses PlanetScale’s maintenance schedule for these branches.`}),`\n`,_jsx(Heading,{level:`2`,id:`related-documentation`,children:`Related documentation`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/neki/cluster-configuration`,children:`Cluster configuration`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/neki/cluster-configuration#postgres-versions`,children:`Postgres versions`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/neki/overview#the-admin`,children:`Replication and planned switchovers`})}),`\n`]}),`\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{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":"Configure Neki maintenance windows","sidebarTitle":"Maintenance windows","description":"Weekly maintenance scheduling for production Neki branches.","og:image":"images/og/neki/cluster-configuration/maintenance-windows.png","href":"/neki/cluster-configuration/maintenance-windows"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Change the weekly schedule","slug":"change-the-weekly-schedule","depth":2,"children":[]},{"title":"Run maintenance immediately","slug":"run-maintenance-immediately","depth":2,"children":[]},{"title":"Development branches","slug":"development-branches","depth":2,"children":[]},{"title":"Related documentation","slug":"related-documentation","depth":2,"children":[]},{"title":"Need help?","slug":"need-help","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/planetscale-2/b155242ec3c4945e/custom.js"],"dynamicCss":".mint-block {\n display: block\n}\n.mint-hidden {\n display: none\n}\n.dark\\:mint-block:is(.dark *) {\n display: block\n}\n.dark\\:mint-hidden:is(.dark *) {\n display: none\n}","subdomain":"planetscale-2","siteName":"PlanetScale","title":"Configure Neki maintenance windows - PlanetScale","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-10T14:45:32.976Z","originalFileLocation":"neki/cluster-configuration/maintenance-windows.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=\"Weekly maintenance scheduling for production Neki branches.\">\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=\"Configure Neki maintenance windows - PlanetScale\">\u003cmeta data-mint-head property=\"og:description\" content=\"Weekly maintenance scheduling for production Neki branches.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PlanetScale\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://planetscale.com/docs/neki/cluster-configuration/maintenance-windows\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://planetscale-2.mintlify.app/images/og/neki/cluster-configuration/maintenance-windows.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=\"Configure Neki maintenance windows - PlanetScale\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Weekly maintenance scheduling for production Neki branches.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://planetscale-2.mintlify.app/images/og/neki/cluster-configuration/maintenance-windows.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/neki/cluster-configuration/maintenance-windows\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/neki/cluster-configuration/maintenance-windows.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/neki/cluster-configuration/maintenance-windows#webpage\",\"url\":\"https://planetscale.com/docs/neki/cluster-configuration/maintenance-windows\",\"name\":\"Configure Neki maintenance windows\",\"description\":\"Weekly maintenance scheduling for production Neki branches.\",\"dateModified\":\"2026-09-10T14:45:32.976Z\",\"isPartOf\":{\"@id\":\"https://planetscale.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://planetscale.com/docs/neki/cluster-configuration/maintenance-windows#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://planetscale.com/docs/neki/cluster-configuration/maintenance-windows#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://planetscale.com/docs/neki/neki-dashboard\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Configuration\",\"item\":\"https://planetscale.com/docs/neki/cluster-configuration/cluster-sizing\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Configure Neki maintenance windows\",\"item\":\"https://planetscale.com/docs/neki/cluster-configuration/maintenance-windows\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://planetscale.com/docs/neki/cluster-configuration/maintenance-windows#article\",\"headline\":\"Configure Neki maintenance windows\",\"name\":\"Configure Neki maintenance windows\",\"description\":\"Weekly maintenance scheduling for production Neki branches.\",\"url\":\"https://planetscale.com/docs/neki/cluster-configuration/maintenance-windows\",\"mainEntityOfPage\":{\"@id\":\"https://planetscale.com/docs/neki/cluster-configuration/maintenance-windows#webpage\"},\"image\":\"https://planetscale.com/docs/images/og/neki/cluster-configuration/maintenance-windows.png\",\"dateModified\":\"2026-09-10T14:45:32.976Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","pages":[{"title":"Vitess","href":"/vitess"}]},{"tab":"Neki","groups":[{"group":" ","pages":[{"title":"Neki","href":"/neki"}]},{"group":"Architecture","pages":[{"group":"Foundations","pages":[{"title":"Overview","href":"/neki/overview"},{"title":"When to shard","href":"/neki/when-to-shard"},{"title":"Neki vs PlanetScale Postgres","href":"/neki/coming-from-postgres"},{"title":"Neki vs Vitess","href":"/neki/vitess-and-postgres"}]},{"group":"Core concepts","pages":[{"title":"Data topology","href":"/neki/data-topology"},{"title":"Query planning","href":"/neki/query-planning"},{"title":"Shard targeting and fanout","href":"/neki/shard-targeting-fanout"},{"title":"Transactions","href":"/neki/transactions"},{"title":"Reference tables and GSIs","href":"/neki/reference-tables-and-gsis"},{"title":"Replicator workflows","sidebarTitle":"Replicator","href":"/neki/replication"}]},{"group":"Workflows","pages":[{"title":"Data migration","href":"/neki/data-migration"},{"title":"Schema changes","href":"/neki/schema-changes"}]},{"group":"Reference","pages":[{"title":"Platform preview limitations","href":"/neki/platform-preview-limitations"},{"title":"Neki terminology","sidebarTitle":"Terminology","href":"/neki/terminology"},{"title":"Neki error codes","sidebarTitle":"Error codes","href":"/neki/error-codes"},{"title":"Error hints and details","sidebarTitle":"Hints and details","href":"/neki/error-hints-and-details"},{"title":"EXPLAIN output reference","sidebarTitle":"EXPLAIN output","href":"/neki/explain-reference"},{"title":"Example schema","href":"/neki/example-schema"}]}]},{"group":"Pricing","pages":[{"title":"Neki pricing","sidebarTitle":"Pricing","href":"/neki/pricing"}]},{"group":"Platform","pages":[{"group":"Getting started","pages":[{"title":"Neki database dashboard","sidebarTitle":"Dashboard overview","href":"/neki/neki-dashboard"},{"title":"Neki quickstart","href":"/neki/tutorials/planetscale-quick-start-guide"},{"title":"Neki sharding quickstart","sidebarTitle":"Sharding quickstart","href":"/neki/tutorials/sharding-quick-start-guide"},{"title":"Neki best practices","sidebarTitle":"Best practices","href":"/neki/best-practices"}]},{"group":"Connecting","pages":[{"title":"Connect to Neki","sidebarTitle":"Overview","href":"/neki/connecting"},{"title":"Roles and credentials","href":"/neki/connecting/roles"},{"title":"PlanetScale Terraform provider","sidebarTitle":"Terraform provider","href":"/terraform"},{"group":"Private connections","pages":[{"title":"Connect privately with AWS PrivateLink","sidebarTitle":"AWS PrivateLink","href":"/neki/connecting/private-connections/aws-privatelink"},{"title":"Connect privately with GCP Private Service Connect","sidebarTitle":"GCP Private Service Connect","href":"/neki/connecting/private-connections/gcp-private-service-connect"}]},{"title":"Web console","href":"/neki/web-console"}]},{"group":"Configuration","pages":[{"title":"Cluster sizing","href":"/neki/cluster-configuration/cluster-sizing"},{"title":"Cluster configuration","description":"Configure Neki admin, routers, configuration profiles, and shards.","href":"/neki/cluster-configuration"},{"title":"Configure Neki maintenance windows","sidebarTitle":"Maintenance windows","href":"/neki/cluster-configuration/maintenance-windows"},{"title":"Configuration parameters","sidebarTitle":"Parameters","description":"Configure Postgres, connection-pool, admin, and router parameters for a Neki database.","href":"/neki/cluster-configuration/parameters"},{"title":"Database replicas","sidebarTitle":"Replicas","href":"/neki/replicas"},{"title":"Read-only replicas","sidebarTitle":"Read-only replicas","href":"/neki/read-only-replicas"}]},{"title":"Postgres extensions","sidebarTitle":"Extensions","href":"/neki/extensions"},{"group":"Migrate to Neki","pages":[{"title":"Import a Postgres database","sidebarTitle":"Import Postgres","href":"/neki/imports/postgres"},{"title":"Troubleshoot a Neki migration","sidebarTitle":"Migration troubleshooting","href":"/neki/imports/troubleshooting"}]},{"group":"Branching","pages":[{"title":"Branching","href":"/neki/branching"},{"title":"Development environments","href":"/neki/development-environments"}]},{"group":"Monitoring","pages":[{"title":"Monitor a Neki database","sidebarTitle":"Monitoring overview","href":"/neki/monitoring"},{"title":"Query Insights","href":"/neki/monitoring/query-insights"},{"title":"Anomalies","href":"/neki/monitoring/anomalies"},{"title":"Schema recommendations","href":"/neki/monitoring/schema-recommendations"},{"title":"Metrics","href":"/neki/monitoring/metrics"},{"title":"Logs","href":"/neki/monitoring/logs"},{"title":"Inspect live Neki connections","sidebarTitle":"Connections","href":"/neki/monitoring/connections"},{"title":"Prometheus metrics for PlanetScale Neki","sidebarTitle":"Prometheus metrics reference","href":"/neki/monitoring/prometheus-metrics-neki"}]},{"title":"Back up and restore","sidebarTitle":"Backups","href":"/neki/backups"}]},{"group":"Guides","pages":[{"group":"Frameworks and ORMs","pages":[{"title":"Connect a Node.js application to Neki","sidebarTitle":"Node.js","href":"/neki/guides/node"},{"title":"Connect Drizzle to Neki","sidebarTitle":"Drizzle","href":"/neki/guides/drizzle"},{"title":"Connect Kysely to Neki","sidebarTitle":"Kysely","href":"/neki/guides/kysely"},{"title":"Connect Prisma to Neki","sidebarTitle":"Prisma","href":"/neki/guides/prisma"},{"title":"Connect a Ruby on Rails application to Neki","sidebarTitle":"Ruby on Rails","href":"/neki/guides/rails"},{"title":"Connect a Django application to Neki","sidebarTitle":"Django","href":"/neki/guides/django"},{"title":"Connect a Laravel application to Neki","sidebarTitle":"Laravel","href":"/neki/guides/laravel"},{"title":"Connect a Bun application to Neki","sidebarTitle":"Bun","href":"/neki/guides/bun"},{"title":"Connect Cloudflare Workers to Neki","sidebarTitle":"Cloudflare Workers","href":"/neki/guides/cloudflare-workers"}]}]}]},{"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":"Configure Neki maintenance windows - PlanetScale","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-CSp1VigC.js","DynamicMarkdown-Dnt6YhtR.js","zoom-image-lightbox-CZTaVDTN.js","lightbox-handle-r17bVUz3.js"]}