Skip to content
This repository has been archived by the owner on Nov 12, 2024. It is now read-only.

Commit

Permalink
docs: upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
planetscale-actions-bot committed Sep 23, 2024
1 parent 3d66f85 commit 3fcd915
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 45 deletions.
59 changes: 30 additions & 29 deletions docs/concepts/planetscale-plans.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'PlanetScale plans'
subtitle: 'Learn about the different products and plans we offer: Scaler Pro and Enterprise'
date: '2024-09-11'
date: '2024-09-23'
---

## Overview
Expand Down Expand Up @@ -43,29 +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 |
| | **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** | [Supported for _new_ tables](/docs/concepts/cluster-configuration) |
| [**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).

Expand Down Expand Up @@ -150,7 +150,9 @@ When you choose to change cluster size, we upgrade each of your replicas one by

## PlanetScale Enterprise plan

PlanetScale's Enterprise Plan is great for users that want to scale farther, shard horizontally, and run PlanetScale in a dedicated AWS/GCP account. We offer many different deployment options, all of which come with the same set of standard features. The table below covers those shared features, as well as the different options that vary depending on your chosen deployment.
PlanetScale's Enterprise Plan is great for large-scale businesses who require the enterprise-level SLAs, want expert assistance through enterprise support, and would prefer to run in your own AWS or GCP account.

We offer many different deployment options, all of which come with the same set of standard features. The table below covers those shared features, as well as the different options that vary depending on your chosen deployment.

| | PlanetScale Enterprise | **[PlanetScale Managed](/docs/enterprise/managed/overview)** |
| ------------------------------------------------------ | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -168,13 +170,12 @@ If you’re not sure whether your use case requires an Enterprise plan, we’re

In general, if you need any of the following, Enterprise may be the best solution for you:

- Resource-based pricing
- Unlimited connections
- Elegant sharding solution
- Enhanced support — our expert team becomes an extension of your own
- Enhanced support — our expert team becomes an extension of your own. Additional options for technical account management, Slack-based support, and phone escalation.
- You need additional support to horizontally shard and migrate your database(s) to PlanetScale
- You need your database deployed in a single-tenant environment
- You need to keep your data in **your own** AWS or GCP account
- You need a PCI DSS certified service provider
- Mission-critical [response times](/docs/support/support-overview#initial-response-times) including continuous support coverage
- Any other customizations — Our Enterprise plans offer a lot of flexibility, so if you have a requirement that’s not listed here, it’s best to [reach out](/contact) and we can see how we can help

## Plan add-ons
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/what-is-planetscale.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'What is PlanetScale'
subtitle: 'Learn about what PlanetScale is, how it came to be, and how our unique features can help you scale and improve development speed.'
date: '2023-04-05'
date: '2024-09-23'
---

## What is PlanetScale
Expand Down Expand Up @@ -62,7 +62,7 @@ PlanetScale allows you to break up a monolithic database and partition the data

Another scenario that companies with massive databases often run into is connection limits due to MySQL. With PlanetScale, we can support [nearly infinite connections](/blog/one-million-connections). Vitess offers built-in [connection pooling](https://vitess.io/docs/reference/features/connection-pools/), and we've built our own [edge infrastructure](/blog/introducing-the-planetscale-serverless-driver-for-javascript) into PlanetScale to ensure connection limits are never an issue.

We generally recommend sharding when your database exceeds 250 GB of data. Sharding is offered on our [enterprise plans](/pricing). [Please reach out](/contact) for more information. If you decide you want to shard your database(s), our solutions team will work with you to come up with a sharding strategy.
We generally recommend exploring horizontal sharding when your database exceeds 250 GB of data and you are beginning to feel some of the [pains associated with large scale](/blog/how-to-scale-your-database-and-when-to-shard-mysql). [Sharding](/docs/concepts/cluster-configuration) is offered on our Scaler Pro plan (currently only supported for new tables). If you need assistance with with setting up horizontal sharding, migrating to PlanetScale, or want enterprise-level SLAs, we offer this through our [Enterprise plan](/enterprise) option. [Please reach out](/contact) for more information.

### Insights

Expand Down
4 changes: 2 additions & 2 deletions docs/devops/the-operate-phase-of-devops.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'The Operate phase of the DevOps cycle'
subtitle: 'Where the operations team performs tasks to keep the application online.'
date: '2023-03-13'
date: '2024-09-23'
---

Now that everything is deployed into production and confirmed working, the operations team's main focus is keeping everything online. Ideally, this is done with a system that will monitor application load to detect spikes in usage and automatically scale resources up to keep up with the traffic. This can be accomplished with platforms like EC2 in AWS, but also on-premise with Kubernetes.
Expand All @@ -22,7 +22,7 @@ One thing that can be overlooked is the fact that backups are pointless if the d

### Horizontal scaling

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.
PlanetScale is built in [Vitess](https://vitess.io), which is an open-source project that enables horizontal scaling for MySQL databases. [Sharding](/docs/concepts/cluster-configuration), available on our Scaler Pro plan, further reducing the load on individual nodes as well as increasing performance and resiliency.

### Read-only regions

Expand Down
4 changes: 2 additions & 2 deletions docs/enterprise/managed/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'PlanetScale Managed overview'
subtitle: 'Deploy PlanetScale in your Amazon Web Services or Google Cloud Platform account with our PlanetScale Managed plan.'
label: 'Enterprise'
date: '2023-11-08'
date: '2024-09-23'
---

## What is PlanetScale Managed?
Expand Down Expand Up @@ -30,7 +30,7 @@ Read more on how PlanetScale Managed works inside either cloud provider:

Single-tenancy is one of many benefits when it comes to PlanetScale Managed. Still, with this PlanetScale Enterprise service, you also get:

- [Database sharding](/docs/sharding/overview) available
- Assistance with [horizontal sharding](/docs/sharding/overview)
- Option to sign BAAs for [HIPAA compliance](/blog/planetscale-and-hipaa)
- Deployment to additional regions
- [PCI compliance](/blog/planetscale-managed-is-now-pci-compliant) (AWS only)
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/airbyte.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Airbyte integration'
subtitle: 'Extract, load, and transform your PlanetScale data with Airbyte.'
date: '2023-10-27'
date: '2024-09-23'
meta:
title: 'Connect with Airbyte ELT'
---
Expand Down Expand Up @@ -70,7 +70,7 @@ You're now ready to connect your PlanetScale database to Airbyte.
![Airbyte - PlanetScale source setup](/assets/docs/integrations/airbyte/db-info.png)
7. You can also provide some optional values:
- **Replicas**: Select whether or not you want to collect data from replica nodes.
- **Shards**: Sharding is only supported on our Enterprise plan. Please [reach out to us](/contact) for more information.
- **Shards**: Map your shards.
- **Starting GTIDs**: Start replication from a specific GTID per keyspace shard.
![Airbyte - PlanetScale optional setup](/assets/docs/integrations/airbyte/optional.png)
You can see the [PlanetScale airbyte-source README](https://github.com/planetscale/airbyte-source/blob/main/README.md) for more details on these options.
Expand Down
5 changes: 2 additions & 3 deletions docs/sharding/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Sharding with PlanetScale'
subtitle: 'Learn how PlanetScale can help you horizontally scale your MySQL database with our sharding solution.'
date: '2024-09-20'
date: '2024-09-23'
---

{% callout %}
Expand Down Expand Up @@ -35,8 +35,7 @@ When you're at the point where you've maxed out your vertical scaling efforts an

## How does our sharding process work?

When it comes time to shard your database, we recommend following our [sharding quickstart](/docs/sharding/sharding-quickstart) guide. You may also
contact our [Technical Solutions team](/contact) to identify the best [sharding scheme](https://vitess.io/docs/reference/features/sharding/#sharding-scheme) for your database.
When it comes time to shard your database, we recommend following our [sharding quickstart](/docs/sharding/sharding-quickstart) guide. If you need assistance identifying the best [sharding scheme](https://vitess.io/docs/reference/features/sharding/#sharding-scheme) for your database, or are interested in expert-level support, our [Enterprise plan](/enterprise) may be a better option for you. [Get in touch](/contact) for more information.

PlanetScale uses an explicit sharding system.
This means that, if you are going to horizontally shard your data, we have to tell Vitess which sharding strategy to use for each sharded table.
Expand Down
6 changes: 1 addition & 5 deletions docs/sharding/sequence-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@
title: 'Sequence Tables'
subtitle: 'Learn how to create sequence tables on a sharded PlanetScale database.'
label: 'Enterprise'
date: '2024-08-29'
date: '2024-09-23'
---

{% callout %}
This feature is only available on our [Enterprise plan](/docs/concepts/planetscale-plans#planetscale-enterprise-plan). If you'd like more information about how we can help you shard your MySQL database, [get in touch](/contact).
{% /callout %}

In MySQL, it is common to have an integer primary key that uses the `AUTO_INCREMENT` feature for assigning IDs.
However, if you have a horizontally-sharded table, you will not be able to use `AUTO_INCREMENT` for your ID.
In such a setup, the rows of the table are distributed across many instances of MySQL.
Expand Down

0 comments on commit 3fcd915

Please sign in to comment.