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

Commit f3bf680

Browse files
planetscale-actions-botplanetscale-actions-bot
committed
docs: upstream
planetscale/www-2024@59a6387
1 parent 04c1cf6 commit f3bf680

20 files changed

+977
-459
lines changed

‎docs/concepts/access-control.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ The following table describes permissions assigned at the organization level for
5858
| Connect to production branches | Create passwords or use pscale shell for production branches | | ✔ |
5959
| Delete production branches | Delete a production database branch | | ✔ |
6060
| Promote branches | Promote a branch to production | | ✔ |
61+
| Modify VSchema | Edit the VSchema of a keyspace | | ✔ |
6162
| Manage databases | Delete, update settings, or import a database | | ✔ |
6263
| Manage beta features | Opt-in or opt-out of a beta feature | | ✔ |
6364
| Create production service token grants | Create a service token grant to connect or delete a production database branch | | ✔ |

‎docs/concepts/cluster-configuration.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Cluster configuration'
33
subtitle: 'Create and manage sharded and unsharded keyspaces for your database.'
4-
date: '2024-09-20'
4+
date: '2024-11-07'
55
---
66

77
{% callout type="warning" %}
@@ -23,15 +23,11 @@ These are advanced configuration settings that expose some of the underlying Vit
2323

2424
This documentation will cover how to use everything in this cluster configuration page. For a full walkthrough with an example of setting up a sharded keyspace, refer to the [Sharding quickstart](/docs/sharding/sharding-quickstart).
2525

26-
## Limitations
27-
28-
Before you adjust any cluster configuration settings, it is important that you read through the following limitations:
29-
30-
- This feature can currently only be used to shard **new** tables.
31-
- 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, and VSchema for **already sharded tables**.
32-
- Sharded keyspaces are not currently supported on databases that have foreign key constraints enabled.
26+
{% callout type="note" %}
27+
harded keyspaces are not currently supported on databases that have foreign key constraints enabled.
28+
{% /callout %}
3329

34-
If you have existing tables that need sharding, or if you would like additional support from our expert team, our [Enterprise plan](/docs/concepts/planetscale-plans#planetscale-enterprise-plan) may be a good fit. [Get in touch](/contact) for a quick assessment.
30+
If you would like additional support from our expert team, our [Enterprise plan](/docs/concepts/planetscale-plans#planetscale-enterprise-plan) may be a good fit. [Get in touch](/contact) for a quick assessment.
3531

3632
## Create a keyspace
3733

@@ -41,8 +37,8 @@ To create a new [keyspace](/docs/sharding/keyspaces):
4137
2. Click "Cluster configuration" in the left nav.
4238
3. You should see the existing unsharded keyspace for your database here.
4339
4. Click "New keyspace".
44-
5. Enter the keyspace name. For example, if your existing unsharded keyspace is named `books`, you may create a sharded keyspace named `books-sharded`.
45-
6. Select whether you want to keep it unsharded, or, if not, select the number of shards you want to exist in this keyspace. In most cases, you will be adding a new sharded keyspace. Adding a new unsharded keyspace is not a common use case.
40+
5. Enter the keyspace name. For example, if your existing unsharded keyspace is named `metal`, you may create a sharded keyspace named `metal-sharded`.
41+
6. Select whether you want to keep it unsharded, or, if not, select the number of shards you want to exist in this keyspace. In most cases, you will be adding a new sharded keyspace. Adding a new unsharded keyspace is not a common use case, but is an option if you're looking to do [vertical sharding](/learn/courses/database-scaling/sharding/vertical-sharding).
4642

4743
{% callout type="note" %}
4844
The cost of adding this additional keyspace largely depends on the number of shards you choose, the cluster size, and if you'd like to add additional replicas.

‎docs/concepts/cluster-sizing.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,6 @@ When you choose to change cluster size, we upgrade each of your replicas one by
4242

4343
## Sharding
4444

45-
If you are an Enterprise customer, another way you can scale your database is with **sharding**.
46-
Check out our [sharding documentation](/docs/sharding/overview) for more information.
45+
You can create sharded keyspaces on any plan by adding a new sharded keyspace using the [cluster configuration page](/docs/concepts/cluster-configuration) and running an [unsharded to sharded workflow](/docs/sharding/sharding-quickstart) in your dashboard.
46+
47+
If you would like additional support from our expert team, our [Enterprise plan](/docs/concepts/planetscale-plans#planetscale-enterprise-plan) may be a good fit. [Get in touch](/contact) for a quick assessment.

‎docs/concepts/planetscale-plans.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -43,29 +43,29 @@ Cluster size options are capped at `PS-400` until you have a successfully paid $
4343

4444
On top of processing and memory, all **Scaler Pro** cluster sizes share the following:
4545

46-
| | **Scaler Pro** |
47-
| ----------------------------------------------------------- | ------------------------------------------------------------------ |
48-
| **Storage/month** | 10 GB included; $0.50 per instance per additional 1 GB\* |
49-
| **Row reads/month** | _Unmetered_ |
50-
| **Row writes/month** | _Unmetered_ |
51-
| **Available cluster sizes** | 17 |
52-
| **Availability zones** | 3 |
53-
| **Production branches** | 1 included\*\* |
54-
| **Development branches** | ~1,440 hours included (2× hours of current month) |
55-
| **Concurrent Connections** | _Unmetered_ |
56-
| **Query Insights retention** | 7 days |
57-
| **Horizontal sharding** | [Supported for _new_ tables](/docs/concepts/cluster-configuration) |
58-
| [**Deployment options**](/docs/concepts/deployment-options) | Multi-tenant |
59-
| **Read-only regions** | Available as an add-on |
60-
| **Web console** | Included |
61-
| **PlanetScale CLI** | Included |
62-
| **SSO** | Available as an add-on\*\*\* |
63-
| **Audit log retention** | 6 months |
64-
| **Private connections** | [Configurable](/docs/concepts/private-connections) |
65-
| **BAAs** | Available for an additional fee |
66-
| **Automatic backups** | Every 12 hours |
67-
| **Support** | Standard, upgrade available\*\*\* |
68-
| [**Data Branching®**](/docs/concepts/data-branching) | Included |
46+
| | **Scaler Pro** |
47+
| ----------------------------------------------------------- | -------------------------------------------------------- |
48+
| **Storage/month** | 10 GB included; $0.50 per instance per additional 1 GB\* |
49+
| **Row reads/month** | _Unmetered_ |
50+
| **Row writes/month** | _Unmetered_ |
51+
| **Available cluster sizes** | 17 |
52+
| **Availability zones** | 3 |
53+
| **Production branches** | 1 included\*\* |
54+
| **Development branches** | ~1,440 hours included (2× hours of current month) |
55+
| **Concurrent Connections** | _Unmetered_ |
56+
| **Query Insights retention** | 7 days |
57+
| **Horizontal sharding** | Included |
58+
| [**Deployment options**](/docs/concepts/deployment-options) | Multi-tenant |
59+
| **Read-only regions** | Available as an add-on |
60+
| **Web console** | Included |
61+
| **PlanetScale CLI** | Included |
62+
| **SSO** | Available as an add-on\*\*\* |
63+
| **Audit log retention** | 6 months |
64+
| **Private connections** | [Configurable](/docs/concepts/private-connections) |
65+
| **BAAs** | Available for an additional fee |
66+
| **Automatic backups** | Every 12 hours |
67+
| **Support** | Standard, upgrade available\*\*\* |
68+
| [**Data Branching®**](/docs/concepts/data-branching) | Included |
6969

7070
\* Production branch storage is billed at $1.50 (1 primary + 2 replicas) and development branch storage is billed at $0.50 (1 primary).
7171

‎docs/concepts/what-is-planetscale.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ PlanetScale allows you to break up a monolithic database and partition the data
6262

6363
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.
6464

65-
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.
65+
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. 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.
6666

6767
### Insights
6868

‎docs/concepts/workflows.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: 'What are workflows?'
3+
subtitle: 'Learn how to use PlanetScale workflows to run different sequences to move data between keyspaces.'
4+
label: 'Beta feature'
5+
date: '2024-11-07'
6+
---
7+
8+
PlanetScale workflows (currently in beta) provide pre-defined recipes that make it simple to run operations on your databases. There is currently only one workflow available — [moving tables from an unsharded to a sharded keyspace](/docs/sharding/sharding-quickstart), but we will continue to add more workflow options in the near future.
9+
10+
If you are familiar with [Vitess Workflows](https://vitess.io/docsreference/vreplication/workflow/), you will see some similarities. For example, the PlanetScale workflow that allows you to move tables from an unsharded to a sharded keyspace is similar to the [Vitess `MoveTables` workflow](https://vitess.io/docs/user-guides/migration/move-tables/).
11+
12+
## Create a workflow
13+
14+
To create a new workflow, select your database, and click "Workflows" in the left nav. Next, click "New workflow". Because we currently only have one available workflow, this will drop you straight into the page to create a new workflow to move tables from an unsharded to sharded keyspace. In the future, you will have the option to choose other workflows.
15+
16+
## View workflow history
17+
18+
To view the history of all completed or pending workflows, click on "Workflows" in the left nav. From here, you can see all previous workflows along with information such as status, duration, and the time it took to complete.

‎docs/navigation/standard.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
slug: '/docs/imports/aws-rds-migration-guide'
3535
- label: 'Azure'
3636
slug: '/docs/imports/azure-database-for-mysql-migration-guide'
37-
- label: 'Digital Ocean'
37+
- label: 'DigitalOcean'
3838
slug: '/docs/imports/digitalocean-database-migration-guide'
3939
- label: 'GCP CloudSQL'
4040
slug: '/docs/imports/gcp-cloudsql-migration-guide'
@@ -214,18 +214,36 @@
214214
- label: 'Sharding your database'
215215
icon: 'sharding'
216216
items:
217-
- label: 'Sharding with PlanetScale'
218-
slug: '/docs/sharding/overview'
219-
- label: 'Sharding quickstart'
220-
slug: '/docs/sharding/sharding-quickstart'
221-
- label: 'VSchema'
222-
slug: '/docs/sharding/vschema'
223-
- label: 'Vindexes'
224-
slug: '/docs/sharding/vindexes'
225-
- label: 'Keyspaces'
226-
slug: '/docs/sharding/keyspaces'
227-
- label: 'Creating sequence tables'
228-
slug: '/docs/sharding/sequence-tables'
217+
- label: 'Overview'
218+
items:
219+
- label: 'Sharding with PlanetScale'
220+
slug: '/docs/sharding/overview'
221+
- label: 'Workflows'
222+
slug: '/docs/concepts/workflows'
223+
- label: 'Guides'
224+
items:
225+
- label: 'Sharding quickstart'
226+
slug: '/docs/sharding/sharding-quickstart'
227+
- label: 'Sharding new tables'
228+
slug: '/docs/sharding/sharding-new-tables'
229+
- label: 'Avoiding cross-shard queries'
230+
slug: '/docs/sharding/avoiding-cross-shard-queries'
231+
- label: 'Keyspace targeting for ORMs and frameworks'
232+
slug: '/docs/sharding/targeting-correct-keyspace'
233+
- label: 'Creating sequence tables'
234+
slug: '/docs/sharding/sequence-tables'
235+
- label: 'Pre-sharding checklist'
236+
slug: '/docs/sharding/pre-sharding-checklist'
237+
- label: 'Concepts'
238+
items:
239+
- label: 'VSchema'
240+
slug: '/docs/sharding/vschema'
241+
- label: 'Vindexes'
242+
slug: '/docs/sharding/vindexes'
243+
- label: 'Keyspaces'
244+
slug: '/docs/sharding/keyspaces'
245+
- label: 'Sharding workflow state reference'
246+
slug: '/docs/sharding/sharding-workflow-state-reference'
229247

230248
- label: 'Vectors'
231249
icon: 'vectors'

0 commit comments

Comments
 (0)