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.
Change the weekly schedule
Maintenance windows use UTC. The dashboard also shows the corresponding time
in your configured local time zone.
From the PlanetScale dashboard, select your Neki database.
Open Settings, then select Maintenance.
Find the production branch and select Change schedule.
Choose the day of the week and hour in UTC.
The schedule card shows the previous maintenance window and the next scheduled
window. Only database administrators can change maintenance schedules.
Run maintenance immediately
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:
Development branches
Development branches do not have configurable maintenance windows. Scheduled
maintenance uses PlanetScale’s maintenance schedule for these branches.
Need help?
Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.