VSchema User Guide: all sections done by sougou · Pull Request #643 · vitessio/website

sougou · 2020-12-20T01:01:59Z

This PR is for the vschema user guide part of #642.

netlify · 2020-12-20T01:02:58Z

Deploy preview for vitess ready!

Built with commit 5c41a9a

https://deploy-preview-643--vitess.netlify.app

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

rohit-nayak-ps

Very well explained and thorough!

Some minor typos need to be addressed.

rohit-nayak-ps · 2021-01-03T21:16:55Z

content/en/docs/user-guides/vschema-guide/overview.md

+weight: 2
+---
+
+One of the goals for vitess is to provide a unified view for a large number of mysql clusters distributed across multiple data centers and regions.


There are multiple places in this guide where vitess and mysql are used: should it be Vitess and MySQL?

rohit-nayak-ps · 2021-01-03T21:17:20Z

content/en/docs/user-guides/vschema-guide/overview.md

+
+The demo describes the VSchema JSON syntax. Many of the changes can be executed by issuing special DDL commands that Vitess understands. Wherever applicable, we have provided the equivalent DDL construct you could apply if you were running a live system. All the DDLs are also listed in the `vschema_ddls.sql` file.
+
+It is generally recommeded that you get familiar with the JSON syntax as it will be useful for troubleshooting if something does not work as intended.


typo: recommeded => recommended

rohit-nayak-ps · 2021-01-03T21:18:16Z

content/en/docs/user-guides/vschema-guide/overview.md

+
+In this logical view, a vitess keyspace is the equivalent of a mysql database. In many cases, this is a one-to-one mapping where a keyspace directly corresponds to a physical mysql server with a single database. However, a vitess keyspace can also be sharded. If so, a single keyspace would map to multiple mysql servers behind the scenes.
+
+The topology is typically spread across multiple Topo Servers: The Global Topo server contains global information, like the list of keyspaces, shards and cells. This information gets deployed into cell-specific topo servers. Each cell specific Topo Server contains additional information about vttablets and mysql servers running in that cell. With this architecture, an outage in one cell does not affect other cells.


one place says "cell specific" instead of "cell-specific"

rohit-nayak-ps · 2021-01-03T22:14:46Z

content/en/docs/user-guides/vschema-guide/unique-lookup.md

+  * The `from` and `to` fields must reference the column names of the lookup table.
+* The `owner` field indicates that `corder` is responsible for populating the lookup table and keeping it up-to-date. This means that an insert into `corder` will result in a corresponding lookup row being inserted in the lookup table, etc. Lookup vindexes can also be shared, but they can have only one owner each. We will later see an example about how to share lookup vindexes.
+
+{{ info }}


info tags should be {{< info >}} and {{< /info >}}

rohit-nayak-ps · 2021-01-03T22:33:05Z

content/en/docs/user-guides/vschema-guide/unique-lookup.md

+
+Creating a lookup vindex after the main table already contains rows does not automatically backfill the lookup table for the existing entries. Only newer inserts cause automatic population of the lookup table. This backfill can be set up using the `CreateLookupVindex` command covered below.
+
+### Check List


Check List should be one word: Checklist

rohit-nayak-ps · 2021-01-03T22:42:13Z

content/en/docs/user-guides/vschema-guide/advanced-vschema.md

+
+Please refer to [Region-based Sharding](../../configuration-advanced/region-sharding) for an example on how to use the `region_json` vindex.
+
+Currently, the Vindex gets used for assigning a `keyspace_id` at the time of insert and at the time of resharding. Additional vindexes need to be added to the table for routing quer constructs that contain WHERE clauses.


typo, quer => query

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

rohit-nayak-ps

lgtm

rohit-nayak-ps · 2021-01-12T21:03:55Z

@sougou is it ok to merge this?: you had mentioned you wanted to ask some others to review it. Maybe we can just merge this now, so that it is available, and you can create a follow-up PR.

sougou added 3 commits December 19, 2020 17:03

vschmea user guide: initial files

1b8d9cf

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

Update overview.md

4dde294

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

Update unsharded.md

e49c00c

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou force-pushed the ss-ug1-vschema branch from 28c504e to e49c00c Compare December 20, 2020 01:04

fix weights and typos

66aa8ad

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou force-pushed the ss-ug1-vschema branch from 2c0e6b9 to 1ee4fae Compare December 20, 2020 01:16

Finish unsharded vschema

09c0589

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou force-pushed the ss-ug1-vschema branch from 1ee4fae to 09c0589 Compare December 20, 2020 03:17

vschema user guide: Add Sharded Keyspace

4c28e09

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou changed the title ~~VSchema User Guide: first two sections~~ VSchema User Guide: first three sections Dec 20, 2020

VSchema user guide: sequences

9754bff

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou force-pushed the ss-ug1-vschema branch from dcc9d79 to 9754bff Compare December 21, 2020 03:08

sougou changed the title ~~VSchema User Guide: first three sections~~ VSchema User Guide: first few sections Dec 21, 2020

VSchema User guide: shared vindexes

363a4d4

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

systay requested a review from a team December 23, 2020 16:15

VSchema user guide: Unique lookup vindex

57edfc3

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou force-pushed the ss-ug1-vschema branch from bf0e155 to 57edfc3 Compare December 24, 2020 00:34

VSchema user guide: non-unique lookup

26df9f7

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou force-pushed the ss-ug1-vschema branch from 44540a3 to 26df9f7 Compare December 24, 2020 20:08

sougou added 4 commits December 24, 2020 18:39

vschema user guide: lookup as primary vindex

e3bcaa5

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

vschema user guide: advanced topics

75c933a

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

vschema user guide: DDL constructs

c60c22e

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

vschema user guide: pictures

55ae44a

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou force-pushed the ss-ug1-vschema branch from 7e615c0 to 55ae44a Compare December 27, 2020 04:12

vschema user guide: sharding guidelines

8f55a72

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

sougou force-pushed the ss-ug1-vschema branch from 6e6a086 to 8f55a72 Compare December 27, 2020 23:14

sougou changed the title ~~VSchema User Guide: first few sections~~ VSchema User Guide: all sections done Dec 28, 2020

rohit-nayak-ps requested changes Jan 3, 2021

View reviewed changes

vschema user guide: address review comments

5859eca

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

vschema user guide: mention ExternalizeVindex

5c41a9a

Signed-off-by: Sugu Sougoumarane <ssougou@gmail.com>

rohit-nayak-ps approved these changes Jan 12, 2021

View reviewed changes

sougou merged commit 5d84691 into vitessio:prod Jan 12, 2021

sougou deleted the ss-ug1-vschema branch January 12, 2021 23:17

jmoldow mentioned this pull request Jan 20, 2021

Complete the documentation for ExternalizeVindex #678

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VSchema User Guide: all sections done#643

VSchema User Guide: all sections done#643
sougou merged 17 commits intovitessio:prodfrom
planetscale:ss-ug1-vschema

sougou commented Dec 20, 2020 •

edited

Loading

Uh oh!

netlify bot commented Dec 20, 2020 •

edited

Loading

Uh oh!

rohit-nayak-ps left a comment

Uh oh!

rohit-nayak-ps Jan 3, 2021

Uh oh!

rohit-nayak-ps Jan 3, 2021

Uh oh!

rohit-nayak-ps Jan 3, 2021

Uh oh!

rohit-nayak-ps Jan 3, 2021

Uh oh!

rohit-nayak-ps Jan 3, 2021

Uh oh!

rohit-nayak-ps Jan 3, 2021

Uh oh!

rohit-nayak-ps left a comment

Uh oh!

rohit-nayak-ps commented Jan 12, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		The demo describes the VSchema JSON syntax. Many of the changes can be executed by issuing special DDL commands that Vitess understands. Wherever applicable, we have provided the equivalent DDL construct you could apply if you were running a live system. All the DDLs are also listed in the `vschema_ddls.sql` file.

		It is generally recommeded that you get familiar with the JSON syntax as it will be useful for troubleshooting if something does not work as intended.


		In this logical view, a vitess keyspace is the equivalent of a mysql database. In many cases, this is a one-to-one mapping where a keyspace directly corresponds to a physical mysql server with a single database. However, a vitess keyspace can also be sharded. If so, a single keyspace would map to multiple mysql servers behind the scenes.

		The topology is typically spread across multiple Topo Servers: The Global Topo server contains global information, like the list of keyspaces, shards and cells. This information gets deployed into cell-specific topo servers. Each cell specific Topo Server contains additional information about vttablets and mysql servers running in that cell. With this architecture, an outage in one cell does not affect other cells.


		Creating a lookup vindex after the main table already contains rows does not automatically backfill the lookup table for the existing entries. Only newer inserts cause automatic population of the lookup table. This backfill can be set up using the `CreateLookupVindex` command covered below.

		### Check List


		Please refer to [Region-based Sharding](../../configuration-advanced/region-sharding) for an example on how to use the `region_json` vindex.

		Currently, the Vindex gets used for assigning a `keyspace_id` at the time of insert and at the time of resharding. Additional vindexes need to be added to the table for routing quer constructs that contain WHERE clauses.

Conversation

sougou commented Dec 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Dec 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rohit-nayak-ps left a comment

Choose a reason for hiding this comment

Uh oh!

rohit-nayak-ps Jan 3, 2021

Choose a reason for hiding this comment

Uh oh!

rohit-nayak-ps Jan 3, 2021

Choose a reason for hiding this comment

Uh oh!

rohit-nayak-ps Jan 3, 2021

Choose a reason for hiding this comment

Uh oh!

rohit-nayak-ps Jan 3, 2021

Choose a reason for hiding this comment

Uh oh!

rohit-nayak-ps Jan 3, 2021

Choose a reason for hiding this comment

Uh oh!

rohit-nayak-ps Jan 3, 2021

Choose a reason for hiding this comment

Uh oh!

rohit-nayak-ps left a comment

Choose a reason for hiding this comment

Uh oh!

rohit-nayak-ps commented Jan 12, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sougou commented Dec 20, 2020 •

edited

Loading

netlify bot commented Dec 20, 2020 •

edited

Loading