From a50d64a0359eeb5c9af30b6b7bf2a3070fd61263 Mon Sep 17 00:00:00 2001 From: PlanetScale Actions Bot Date: Wed, 11 Sep 2024 21:04:30 +0000 Subject: [PATCH] docs: upstream https://github.com/planetscale/www/commit/3200cef3108b9a2ab023e0830aa54f9783ed3ea4 --- docs/concepts/planetscale-plans.md | 49 +++++++++++----------- docs/concepts/query-insights.md | 2 +- docs/concepts/scaler-pro-upgrade-faq.md | 7 +--- docs/concepts/what-is-planetscale.md | 6 --- docs/devops/the-monitor-phase-of-devops.md | 4 -- docs/devops/the-operate-phase-of-devops.md | 4 -- docs/navigation/standard.md | 26 ------------ docs/onboarding/create-a-database.md | 1 - 8 files changed, 26 insertions(+), 73 deletions(-) diff --git a/docs/concepts/planetscale-plans.md b/docs/concepts/planetscale-plans.md index a1ab07c5..940d81b9 100644 --- a/docs/concepts/planetscale-plans.md +++ b/docs/concepts/planetscale-plans.md @@ -1,7 +1,7 @@ --- title: 'PlanetScale plans' subtitle: 'Learn about the different products and plans we offer: Scaler Pro and Enterprise' -date: '2024-08-14' +date: '2024-09-11' --- ## Overview @@ -43,30 +43,29 @@ Cluster size options are capped at `PS-400` until you have a successfully paid $ On top of processing and memory, all **Scaler Pro** cluster sizes share the following: -| | **Scaler Pro** | -| ---------------------------------------------------------------------------- | -------------------------------------------------------- | -| **Storage/month** | 10 GB included; $0.50 per instance per additional 1 GB\* | -| **Row reads/month** | _Unmetered_ | -| **Row writes/month** | _Unmetered_ | -| **Available cluster sizes** | 17 | -| **Availability zones** | 3 | -| **Production branches** | 1 included\*\* | -| **Development branches** | ~1,440 hours included (2× hours of current month) | -| **Concurrent Connections** | _Unmetered_ | -| **Query Insights retention** | 7 days | -| **Horizontal sharding** | Not included | -| [**Deployment options**](/docs/concepts/deployment-options) | Multi-tenant | -| **Read-only regions** | Available as an add-on | -| **Web console** | Included | -| **PlanetScale CLI** | Included | -| **SSO** | Available as an add-on\*\*\* | -| **Audit log retention** | 6 months | -| **Private connections** | [Configurable](/docs/concepts/private-connections) | -| **BAAs** | Available for an additional fee | -| **Automatic backups** | Every 12 hours | -| **Support** | Standard, upgrade available\*\*\* | -| [**Data Branching®**](/docs/concepts/data-branching) | Included | -| [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Available as an add-on | +| | **Scaler Pro** | +| ----------------------------------------------------------- | -------------------------------------------------------- | +| **Storage/month** | 10 GB included; $0.50 per instance per additional 1 GB\* | +| **Row reads/month** | _Unmetered_ | +| **Row writes/month** | _Unmetered_ | +| **Available cluster sizes** | 17 | +| **Availability zones** | 3 | +| **Production branches** | 1 included\*\* | +| **Development branches** | ~1,440 hours included (2× hours of current month) | +| **Concurrent Connections** | _Unmetered_ | +| **Query Insights retention** | 7 days | +| **Horizontal sharding** | Not included | +| [**Deployment options**](/docs/concepts/deployment-options) | Multi-tenant | +| **Read-only regions** | Available as an add-on | +| **Web console** | Included | +| **PlanetScale CLI** | Included | +| **SSO** | Available as an add-on\*\*\* | +| **Audit log retention** | 6 months | +| **Private connections** | [Configurable](/docs/concepts/private-connections) | +| **BAAs** | Available for an additional fee | +| **Automatic backups** | Every 12 hours | +| **Support** | Standard, upgrade available\*\*\* | +| [**Data Branching®**](/docs/concepts/data-branching) | Included | \* Production branch storage is billed at $1.50 (1 primary + 2 replicas) and development branch storage is billed at $0.50 (1 primary). diff --git a/docs/concepts/query-insights.md b/docs/concepts/query-insights.md index 6beebb0e..69f39831 100644 --- a/docs/concepts/query-insights.md +++ b/docs/concepts/query-insights.md @@ -121,7 +121,7 @@ You can also sort the columns for quick analysis by clicking on the title at the ### Query filtering -The search bar above the table allows you to filter queries as needed. You can filter for query SQL, table name, tag name, tag value, user name, query count, query latency, multisharded queries, index name, if the query was indexed, and [Boosted](/docs/concepts/query-caching-with-planetscale-boost) queries. Click on the `?` next to the search bar for the full list of search syntax. +The search bar above the table allows you to filter queries as needed. You can filter for query SQL, table name, tag name, tag value, user name, query count, query latency, multisharded queries, index name, and if the query was indexed. Click on the `?` next to the search bar for the full list of search syntax. ### Query deep dive diff --git a/docs/concepts/scaler-pro-upgrade-faq.md b/docs/concepts/scaler-pro-upgrade-faq.md index 54a9f3d2..e9776c71 100644 --- a/docs/concepts/scaler-pro-upgrade-faq.md +++ b/docs/concepts/scaler-pro-upgrade-faq.md @@ -1,7 +1,7 @@ --- title: 'Upgrading to Scaler Pro - FAQ' subtitle: 'Frequently asked questions about upgrading to Scaler Pro.' -date: '2024-04-12' +date: '2024-09-11' --- ## Overview @@ -19,7 +19,6 @@ All existing Scaler plan customers who did not upgrade their database or migrate - [What changes with read-only regions?](#what-changes-with-read-only-regions-) - [How do I know when to scale up my cluster size?](#how-do-i-know-when-to-scale-up-my-cluster-size-) - [How do development branches work on Scaler Pro?](#how-do-development-branches-work-on-scaler-pro-) -- [What changes with PlanetScale Boost?](#what-changes-with-planetscale-boost-) ## How do I select a Scaler Pro cluster size? @@ -105,7 +104,3 @@ On the Scaler plan, each database had a limit of 5 development branches at a tim With Scaler Pro, each database has 1,440 hours of development branch time included. Anything over that time is billed at ~$0.014 per hour. All branches are only billed for the time that they are used, prorated to the second. [Learn more about development branch billing](/docs/concepts/planetscale-plans#development-branches). - -## What changes with PlanetScale Boost? - -There are no billing changes for PlanetScale Boost when upgrading to Scaler Pro. diff --git a/docs/concepts/what-is-planetscale.md b/docs/concepts/what-is-planetscale.md index 08ebf46b..4769c79b 100644 --- a/docs/concepts/what-is-planetscale.md +++ b/docs/concepts/what-is-planetscale.md @@ -79,12 +79,6 @@ If you notice your application is running slower than it should or you want to d - time per query - rows read, affected, and returned -### PlanetScale Boost - -[PlanetScale Boost](/docs/concepts/query-caching-with-planetscale-boost) (beta) is our solution to improve the implementation of often cumbersome query caching. With PlanetScale Boost, you can add query caching to your application simply by choosing which queries you want to speed up, allocating a certain amount of storage to them, and clicking a button to implement. All with minimal application changes. - -In most caching systems, you would still have to deal with cache invalidation. With PlanetScale Boost, cache invalidation is a thing of the past. We will automatically update the store with any incoming changes to data, so you won't see your cached queries slow down while they repopulate. - ### No downtime import tool We understand changing database providers can be a pain, from dealing with downtime to complicated dumps and restores and endless compatibility issues. diff --git a/docs/devops/the-monitor-phase-of-devops.md b/docs/devops/the-monitor-phase-of-devops.md index d7c832da..fe571554 100644 --- a/docs/devops/the-monitor-phase-of-devops.md +++ b/docs/devops/the-monitor-phase-of-devops.md @@ -16,10 +16,6 @@ PlanetScale offers [Insights](/docs/concepts/query-insights) with every database If your database is enrolled in the schema-revert feature, the metrics gathered by Insights could help in making a data-driven decision on if the schema you just deployed to production is experiencing issues and needs to be rolled back. While having your own logging and monitoring platform to analyze errors in your code is definitely a best-practice, this would act as an additional layer of analytics and may help in reducing downtime overall. -**Insights + PlanetScale Boost** - -While not directly related to monitoring, it's worth mentioning that Insights integrates directly with [PlanetScale Boost](/docs/concepts/query-caching-with-planetscale-boost), an optional feature that can be used with databases on our platform to exponentially improve query performance by adding a query cache in front of your database to serve the most requested data from in-memory data. - ### PlanetScale Connect PlanetScale Connect is a feature provided to our databases that allows you to extract data from the database and safely load it into remote destinations for analytics or ETL purposes. Using Connect with our supported destinations can enable you to further process the data in any way your organization may need. This can help provide detail as to how users are using your application based on the data that's written to your database and assist in driving decisions in the next planning cycle. diff --git a/docs/devops/the-operate-phase-of-devops.md b/docs/devops/the-operate-phase-of-devops.md index aa861a91..925ce398 100644 --- a/docs/devops/the-operate-phase-of-devops.md +++ b/docs/devops/the-operate-phase-of-devops.md @@ -24,10 +24,6 @@ One thing that can be overlooked is the fact that backups are pointless if the d PlanetScale is built in [Vitess](https://vitess.io), which is an open-source project that enables horizontal scaling for MySQL databases. If you are in the Enterprise tier, you have additional configuration options available to horizontally scale your database, further reducing the load on individual nodes as well as increasing performance and resiliency. -### Query data caching - -As this phase is predominantly about infrastructure and making sure the application stays healthy, its worth mentioning [PlanetScale Boost](/docs/concepts/query-caching-with-planetscale-boost), a fully integrated database query cacheing service that can be added to any database in PlanetScale to optimize the performance of queries that are executed frequently. When PlanetScale Boost is enabled for an organization, an additional server is added internally that provides an in-memory data structure where the results of common queries can be returned much quicker than if they were being read by the MySQL database engine. This can significantly reduce the complexity of managing similar infrastructure components by operations teams. - ### Read-only regions When creating databases or branches, you'll be presented with the option to select which [region](/docs/concepts/regions) you'd like your database created in. After creation, you'll also have the option to create [read-only regions](/docs/concepts/read-only-regions). This adds a replica of your database in a specific geographical location to more quickly serve queries by users in that area. Traditionally this would require operations teams to set up additional data centers linked by VPN tunnels or private ISP networks to securely synchronize data, but this is all handled by PlanetScale without such complexity. diff --git a/docs/navigation/standard.md b/docs/navigation/standard.md index 5ba1e089..d43f0def 100644 --- a/docs/navigation/standard.md +++ b/docs/navigation/standard.md @@ -219,32 +219,6 @@ - label: 'Creating sequence tables' slug: '/docs/sharding/sequence-tables' -- label: 'Caching queries' - icon: 'cache' - items: - - label: 'PlanetScale Boost' - items: - - label: 'Query caching with PlanetScale Boost' - slug: '/docs/concepts/query-caching-with-planetscale-boost' - - label: 'How to use PlanetScale Boost' - slug: '/docs/concepts/how-to-use-planetscale-boost' - - label: 'When to use PlanetScale Boost' - slug: '/docs/concepts/when-to-use-planetscale-boost' - - label: 'Language-specific guides' - items: - - label: 'Laravel guide' - slug: '/docs/tutorials/laravel-boost-guide' - - label: 'Ruby on Rails guide' - slug: '/docs/tutorials/rails-boost-guide' - - label: 'Go guide' - slug: '/docs/tutorials/go-boost-guide' - - label: 'Prisma guide' - slug: '/docs/tutorials/prisma-boost-guide' - - label: 'Node.js guide' - slug: '/docs/tutorials/node-boost-guide' - - label: 'Serverless JavaScript driver guide' - slug: '/docs/tutorials/serverless-driver-boost-guide' - - label: 'Security and access' icon: 'security' items: diff --git a/docs/onboarding/create-a-database.md b/docs/onboarding/create-a-database.md index 24afe225..beaf2ff9 100644 --- a/docs/onboarding/create-a-database.md +++ b/docs/onboarding/create-a-database.md @@ -42,7 +42,6 @@ The tabs from left to right are: - **Deploy requests** — How you apply changes to your database schema. More on that in the next article. - **Branches** — View the different branches of your database. Again, more on that in the next article. - **Insights** — Provides statistics on database operations that may be affecting performance. -- **Boost** — PlanetScale Boost is a real-time query cache that automatically handles cache invalidation for you with one line of code. - **Console** — Lets you run MySQL commands against branches. - **Backups** — Shows you backup schedule and all backups for this database across production and development branches. - **Settings** — Lets you tweak various aspects of your database like who has access to it, beta feature opt-ins, and plan management.