Skip to content

Changelog

The latest PlanetScale features and product launches.

September 20, 2024
New feature

Cluster configuration

You can now create new sharded or unsharded keyspaces in your database using the Cluster configuration panel. To create a new keyspace, click "New keyspace", give it a name, adjust the number of shards (if applicable), choose the cluster size you'd like to use, add additional replicas (if needed), and click "Save changes".

From here, you can also modify the VSchema for your keyspaces.

Please be aware of the following limitations:

  • This feature can currently only be used to shard new tables.
  • If you are an existing PlanetScale customer with already sharded tables, you can use the Cluster configuration settings to adjust the instance size, number of replicas, routing rules, and Vschema for already sharded tables.
  • Sharded keyspaces are not currently supported on databases that have foreign key constraints enabled.

For more information, please refer to the Cluster configuration documentation.

View full documentation
September 20, 2024
Update

Service tokens: all database permissions

We've just shipped an enhancement to service tokens. You can now grant access to all databases instead of needing to set permissions one by one.

When granting access to all databases, the permissions will apply to both current and future databases. Additionally, they cannot be removed individually from any database.

This is now available to organization administrators on the service token permissions page.

View full documentation
September 17, 2024
Update

Brownout notice: legacy connection strings

As mentioned in our previous announcement, we made an upgrade to our edge infrastructure two years ago that enabled better performance and reliability for your database connections. This update impacted legacy connection strings that existed prior to this change.

We have since deprecated those legacy connection strings, but a small number of databases are still using them.

If you are affected, you will have received daily emails from us informing you about the upcoming brownouts and requirements for updating your connection strings.

Brownout timeline

As previously communicated, brownouts began on September 3rd, 2024. During these brownout periods, you will be unable to connect to your database.

Brownouts will continue Monday through Friday throughout September. The brownout duration will increase throughout the month leading up to October 1st, 2024, at which point we will completely deprecate legacy connection strings.

Complete deprecation of legacy connection strings

On October 1st, 2024, we plan to completely deprecate legacy connection strings and will stop serving connections to databases using them.

If you are affected, you will continue to receive several more emails leading up to this date. It is extremely important that you update your connection strings for your database to remain active.

How do I update my connection string?

To update your connection string, go to the PlanetScale dashboard -> your database -> settings -> passwords.

Create a new password and update the hostname, username and password in your application.

Need help?

We want this process to be simple and painless for everyone. If this causes any difficulties for you, please reach out to our support team.

View full documentation
September 4, 2024
Feature

Instant deployments

We've have added support for instant deployment of certain deploy requests using MySQL's ALGORITHM=INSTANT. This feature allows users to apply changes more quickly and efficiently.

View full documentation
Aug 29, 2024
Feature

Timezone display preferences

We’ve added a new feature to the top navigation bar that lets you choose between displaying timestamps in your local time zone or UTC. Making it easier to communicate and share graphs with your teammates in various timezones.

Your preference will be saved and persist across browser sessions.

August 28, 2024
Feature

Insights: max latency reporting

We've added a new column in the main Insights view: max_latency. This column shows the maximum response time of any individual query pattern in the selected time window. Maximum is often a useful metric for spotting extreme outliers that may not show up in p99 (99th percentile). To enable the Max latency column, visit your Insights dashboard, click on the columns menu to the right of the query filter search box, and check "Max latency".

You can also filter query patterns based on max latency by adding max_latency:>x where x is measured in miliseconds.

View full documentation
August 15, 2024
Improvement

Branching: rename and replace default branch

We've just shipped a couple improvements to branching. Now from the branches page, you can:

  • Rename any of your branches.
  • Replace your default branch with another branch (admins only).

When using "Set as default branch" you can optionally choose to have the children of the current default branch move over with it.

Permissions:

  • Database admins are able to rename any branch as well as change the default.
  • Database members may only rename development branches.

With these changes, you now have more control over the organization of your branches.

View full documentation
August 14, 2024
Feature

Insights: index usage tracking

Insights now stores index usage information for all SELECT queries. To see index usage, click on a query from your Insights dashboard, and then click on the new Indexes tab.

This view shows a time series graph of the percent of queries that use each listed index. The vertical bar chart near the bottom shows comprehensive index usage information for the entire period.

You can also search for queries based on index usage:

  • To find queries that use a given index, add index:$TABLE.$INDEX_NAME to the insights search bar
  • To find queries that don't use any indexes try indexed:false

In addition to index usage, we've also added summary statistics (total time, latencies, etc) to the query details page.

Read the blog post for more information.

View full documentation
August 9, 2024
Improvement

Insights: absolute x-axis time

We've heard your feedback and Insights graphs now show all x-axis time measurements as an absolute time (e.g. 09:31) instead of as a relative time offset (e.g. 3h ago). Absolute time offsets make it easier to correlate Insights data with information from external systems.

View full documentation
August 9, 2024
Improvement

Insights: increased graph resolution

We've increased the resolution for all Insights graphs. Graphs with periods from 12 to 24 hours now show data in 5 minute increments (down from 10 minutes) and periods under 12 hours show data in 1 minute increments (down from 5 minutes). Smaller time buckets result in less smoothing and make it easier to spot temporary fluctuations.

View full documentation
July 25, 2024
Improvement

Webhooks: New pending_cutover event for deploy requests

We have shipped a new webhook event: deploy_request.pending_cutover.

This event will trigger when a deploy request is ready to apply the schema and is waiting on the user to confirm.

For deploy requests that have "auto_cutover" or "Auto apply" enabled, this webhook will not be sent.

This new event is now available in your webhook settings.

View full documentation
July 17, 2024
Feature

Deploy requests: auto-delete branch

We just shipped an improvement to deploy requests. Now, you can optionally set your deploy requests to delete the development branch once fully complete.

You can do this by toggling a checkbox while the deploy request is running. This new setting is also available via the CLI and API.

It is disabled by default and must be enabled for each deploy request. The branch will only be deleted if the deployment is successful and the revert period is complete.

CLI

As of pscale version 0.205.0, you can create a deploy request with pscale deploy-request create db branch --auto-delete-branch and the setting will be enabled.

API

The create deploy request endpoint now has auto_delete_branch available. Set this parameter to true to enable the setting.

View full documentation
July 12, 2024
Update

Deprecation: legacy connection strings

Two years ago we made an upgrade to our edge infrastructure that enabled better performance and reliability for your database connections.

A small number of databases are still using connection strings from before this change. In the coming weeks we are working on deprecating the usage of these strings and getting everyone upgraded.

Does this impact my database?

We are sending emails to all account admins for databases which are still connecting via legacy strings.

You may also check the hostname for your connection string. If it shows the ID for the database branch, then it is a legacy string.

Examples:

  • Legacy host name: abcdeabc1234.us-east-1.psdb.cloud
  • New infrastructure host name: aws.connect.psdb.cloud

How to update my connection string?

To update your connection string, go to the PlanetScale dashboard -> your database -> settings -> passwords.

Create a new password and update the hostname, username and password in your application.

What happens if I do not upgrade?

We will be performing multiple brownout periods starting September 3rd, 2024. During these, connections to your database will stop working.

The purpose of the brownout periods is to help alert anyone who is still unintentionally using a legacy connection string.

After several brownout periods, we will re-evaluate usage again and send final notices to anyone still using a legacy connection string before fully deprecating.

pscale CLI

If you are using an old version of the pscale CLI, you may see the following message when trying to use pscale shell or pscale connect.

Your version of pscale is too old and is using a deprecated connection method. Please update your CLI version.

If this impacts you, please update pscale to the latest version.

Need help?

We want this process to be simple and painless for everyone. If this causes any difficulties for you, please reach out to our support team.

View full documentation
July 11, 2024
Improvement

Deploy requests: solo admins may now self-approve

We've shipped a small update to the "Require administrator approval for deploy requests" setting. Now, if your database only has a single administrator, they can self-approve their own deploy requests.

If there is more than one administator, then self-approval is not allowed.

View full documentation
June 27, 2024
Improvement

Webhook payload update

We have updated all webhook payloads to include the database and organization names.

Diff
{
"timestamp": 1698252879,
"event": "branch.ready",
+ "organization": "my-org",
+ "database": "example_database",
"resource": { ... }
}
View full documentation
June 24, 2024
Update

New audit logs API endpoint

We have released a new API endpoint for retrieving your organization's audit logs.

  • /v1/organizations/:name/audit-log

A new service token scope read_audit_logs has also been added. You may add this to your service token by visiting your service token settings.

View full documentation
June 17, 2024
Update

Deprecating old versions of the PlanetScale CLI

We are removing support for versions of the PlanetScale CLI older than v0.182.0 (February 2, 2024). On July 1st, they will no longer be able to use the following commands:

  • pscale connect
  • pscale shell
  • pscale database dump
  • pscale database restore-dump

Please update your CLI to version v0.182.0 or later to continue using these commands.

June 6, 2024
Update

New side navigation layout

We’ve just shipped a change to the layout of the PlanetScale app. The top-level navigation links are now along the left-hand side.

Why make this change? We needed to make room for new features. We were starting to be limited by the space available along the top navigation bar. The new side navigation allows for more space and keeps everything easily discoverable.

May 24, 2024
Improvement

VTGate errors are now in DataDog

We are now publishing the rate of errors encountered by each database branch's VTGate to Datadog. You can graph these metrics by using the planetscale.vtgate.errors metric name within your Datadog widget and notebooks.

View full documentation
May 22, 2024
New feature

Pin frequently used databases

We've shipped an improvement to make navigating to your most frequently used databases easier. Starting today, you can pin the databases you use most frequently. To do this, open the database switcher at the top of the page, you'll see a new pin icon next to each database.

The organization switcher has been improved as well. It will show all of your pinned databases across all of your organizations.

May 2, 2024
New feature

Connecting to PlanetScale privately on AWS

Previously only available to Single-tenant and Managed customers, PlanetScale now provides private connection endpoints to AWS regions via AWS PrivateLink for customers on Scaler Pro.

This is helpful in cases where your compliance mandates that your connections do not route through the public Internet, or for customers looking to save costs on their NAT Gateways.

View full documentation
April 30, 2024
Improvement

Insights query latency percentile filtering

Insights now supports filtering query patterns by 50th and 99th percentile query execution time. To find all query patterns that have a 50th percentile execution time above 250 milliseconds, for example, enter p50:>250 in the insights search box.

View full documentation