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

Commit 5af03b8

Browse files
1 parent 4c19fa8 commit 5af03b8

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

docs/concepts/cluster-configuration.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ To create a new [keyspace](/docs/sharding/keyspaces):
4444
5. Enter the keyspace name. For example, if your existing unsharded keyspace is named `books`, you may create a sharded keyspace named `books-sharded`.
4545
6. Select whether you want to keep it unsharded, or, if not, select the number of shards you 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.
4646

47-
**Note**: 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.
47+
{% callout type="note" %}
48+
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.
49+
{% /callout %}
4850

4951
7. Choose the cluster sizes you would like to use for this keyspace. Keep in mind, if you are creating a sharded keyspace, this will spin up multiple clusters of the selected size. For example, if you are creating 4 shards and choose the `PS-80` cluster size, we will create 4 `PS-80`s, each with 1 primary and 2 replicas.
5052
8. Select the number of _additional_ replicas, if any, that you'd like to add to each cluster. Each cluster comes with 2 replicas by default, so any number you choose will be in addition to those 2.
@@ -53,7 +55,9 @@ To create a new [keyspace](/docs/sharding/keyspaces):
5355

5456
## Modify the VSchema of a keyspace via cluster configuration tab
5557

56-
**Note**: You can modify the VSchema on your development branch either in the cluster configuration tab, using the [`ALTER VSCHEMA` command](/docs/sharding/vschema#modifying-vschema), or with the pscale CLI using [`pscale keyspace vschema update`](/docs/reference/keyspace).
58+
{% callout type="note" %}
59+
You can modify the VSchema on your development branch either in the cluster configuration tab, using the [`ALTER VSCHEMA` command](/docs/sharding/vschema#modifying-vschema), or with the pscale CLI using [`pscale keyspace vschema update`](/docs/reference/keyspace).
60+
{% /callout %}
5761

5862
Once you have created your keyspace, you will see a new tab: **VSchema**. The VSchema contains information about how the keyspace is sharded, sequence tables, and other Vitess schema information. The VSchema tab allows you to configure the Vschema for your new keyspace or modify it for existing keyspaces.
5963

docs/sharding/overview.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ When you're at the point where you've maxed out your vertical scaling efforts an
3535

3636
## How does our sharding process work?
3737

38-
When it comes time to shard your database, you'll work closely with our Technical Solutions team to identify the best [sharding scheme](https://vitess.io/docs/reference/features/sharding/#sharding-scheme) for your database.
38+
When it comes time to shard your database, we recommend following our [sharding quickstart](/docs/sharding/sharding-quickstart) guide. You may also
39+
contact our [Technical Solutions team](/contact) to identify the best [sharding scheme](https://vitess.io/docs/reference/features/sharding/#sharding-scheme) for your database.
3940

4041
PlanetScale uses an explicit sharding system.
4142
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.

docs/sharding/sharding-quickstart.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ CREATE TABLE user(
8686
```sql
8787
CREATE TABLE exercise_log(
8888
log_id BIGINT UNSIGNED AUTO_INCREMENT,
89-
user_id BIGINT,
89+
user_id BIGINT UNSIGNED,
9090
reps SMALLINT,
9191
created_at DATETIME,
9292
edited_at DATETIME,
@@ -97,8 +97,9 @@ CREATE TABLE exercise_log(
9797
);
9898
```
9999

100-
However, we need to get rid of the `AUTO_INCREMENT`s in favor of [sequence tables](/docs/sharding/sequence-tables) in order to get this horizontally sharded.
100+
However, we need to replace the `AUTO_INCREMENT`s in favor of [sequence tables](/docs/sharding/sequence-tables) in order to horizontally shard the tables.
101101
To do this, we'll first create the tables in the sharded keyspace with the `AUTO_INCREMENT`s removed.
102+
102103
Connect to your PlanetScale database and run the following:
103104

104105
```sql

0 commit comments

Comments
 (0)