Skip to content

Commit

Permalink
remove v3 from docs (#1541)
Browse files Browse the repository at this point in the history 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
  • Loading branch information
@harshit-gangal
harshit-gangal authored Jul 18, 2023
1 parent e1f8d26 commit 2223b0c
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 49 deletions.
28 changes: 14 additions & 14 deletions content/en/docs/18.0/get-started/vttestserver-docker-image.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,20 @@ At this point, you should have a docker image named `vitess/vttestserver:mysql57

The docker image expects some of the environment variables to be set to function properly. The following table lists all the environment variables available along with their usages.

| Environment variable | Required | Use |
| -- | -- | -- |
| *KEYSPACES* | yes | Specifies the names of the keyspaces to be created as a comma separated value. |
| *NUM_SHARDS* | yes | Specifies the number of shards in each keyspace. It is a comma separated value as well, read in conjunction with the KEYSPACES. |
| *PORT* | yes | The starting of the port addresses that vitess will use to register its components like vtgate, etc. |
| *MYSQL_MAX_CONNECTIONS* | no | Maximum number of connections that the MySQL instance will support. If unspecified, it defaults to 1000. |
| *MYSQL_BIND_HOST* | no | Which host to bind the MySQL listener to. If unspecified, it defaults to `127.0.0.1`. |
| *MYSQL_SERVER_VERSION* | no | MySQL server version to advertise. If unspecified, it defaults to `8.0.31-vitess` or `5.7.9-vitess` according to the version of vttestserver run. |
| *CHARSET* | no | Default charset to use. If unspecified, it defaults to `utf8mb4`. |
| *FOREIGN_KEY_MODE* | no | This is to provide how to handle foreign key constraint in create/alter table. Valid values are: allow (default), disallow. |
| *ENABLE_ONLINE_DDL* | no | Allow users to submit, review and control Online DDL. Valid values are: true (default), false. |
| *ENABLE_DIRECT_DDL* | no | Allow users to submit direct DDL statements. Valid values are: true (default), false. |
| *PLANNER_VERSION* | no | Sets the default planner to use when the session has not changed it. Valid values are: Gen4 (default), v3, Gen4Greedy and Gen4Fallback. Gen4Fallback tries the new gen4 planner and falls back to the V3 planner if the gen4 fails. |
| *TABLET_REFRESH_INTERVAL* | no | Interval at which vtgate refreshes tablet information from topology server. |
| Environment variable | Required | Use |
|---------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| *KEYSPACES* | yes | Specifies the names of the keyspaces to be created as a comma separated value. |
| *NUM_SHARDS* | yes | Specifies the number of shards in each keyspace. It is a comma separated value as well, read in conjunction with the KEYSPACES. |
| *PORT* | yes | The starting of the port addresses that vitess will use to register its components like vtgate, etc. |
| *MYSQL_MAX_CONNECTIONS* | no | Maximum number of connections that the MySQL instance will support. If unspecified, it defaults to 1000. |
| *MYSQL_BIND_HOST* | no | Which host to bind the MySQL listener to. If unspecified, it defaults to `127.0.0.1`. |
| *MYSQL_SERVER_VERSION* | no | MySQL server version to advertise. If unspecified, it defaults to `8.0.31-vitess` or `5.7.9-vitess` according to the version of vttestserver run. |
| *CHARSET* | no | Default charset to use. If unspecified, it defaults to `utf8mb4`. |
| *FOREIGN_KEY_MODE* | no | This is to provide how to handle foreign key constraint in create/alter table. Valid values are: allow (default), disallow. |
| *ENABLE_ONLINE_DDL* | no | Allow users to submit, review and control Online DDL. Valid values are: true (default), false. |
| *ENABLE_DIRECT_DDL* | no | Allow users to submit direct DDL statements. Valid values are: true (default), false. |
| *PLANNER_VERSION* | no | Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right. |
| *TABLET_REFRESH_INTERVAL* | no | Interval at which vtgate refreshes tablet information from topology server. |

Environment variables in docker can be specified using the `-e` aka `--env` flag.

Expand Down
13 changes: 0 additions & 13 deletions content/en/docs/18.0/reference/compatibility/gen4-and-v3-compatibility.md
View file

This file was deleted.

4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/features/topology-service.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ tasks cannot concurrently alter the data.
### VSchema data

The VSchema data contains sharding and routing information for
the [VTGate V3](https://github.com/vitessio/vitess/blob/main/doc/VTGateV3Features.md) API.
the [VTGate API](https://github.com/vitessio/vitess/blob/main/doc/design-docs/VTGateV3Features.md).

## Local data

Expand Down Expand Up @@ -360,7 +360,7 @@ others wait for files with older ModRevisions to disappear.
Leader elections also use a subdirectory, named after the election Name, and use
a similar method as the locks, with ephemeral files.

We store the proto3 binary data for each object (as the v3 API allows us to store
We store the proto3 binary data for each object (as the API allows us to store
binary data). Note that this means that if you want to interact with etcd using
the `etcdctl` tool, you will have to tell it to use the v3 API, e.g.:

Expand Down
36 changes: 18 additions & 18 deletions content/en/docs/18.0/reference/programs/vtexplain.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,24 @@ vtexplain -- -shards 128 --vschema-file vschema.json --schema-file schema.sql --

The following parameters apply to `mysqlctl`:

| Name | Type | Definition |
|:-----------------------|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|
| --dbname | string | Optional database target to override normal routing |
| --execution-mode | string | The execution mode to simulate -- must be set to multi, legacy-autocommit, or twopc (default "multi") |
| --ks-shard-map | string | JSON map of keyspace name -> shard name -> ShardReference object. The inner map is the same as the output of FindAllShardsInKeyspace |
| --ks-shard-map-file | string | File containing json blob of keyspace name -> shard name -> ShardReference object |
| --mysql_server_version | string | MySQL server version to advertise. (default "8.0.30-Vitess") |
| --normalize | boolean | Whether to enable vtgate normalization |
| --output-mode | string | Output in human-friendly text or json (default "text") |
| --planner-version | string | Sets the query planner version to use when generating the explain output. Valid values are V3 and Gen4. An empty value will use VTGate's default planner |
| --replication-mode | string | The replication mode to simulate -- must be set to either ROW or STATEMENT (default "ROW") |
| --schema | string | The SQL table schema |
| --schema-file | string | Identifies the file that contains the SQL table schema |
| --shards | int | Number of shards per keyspace. Passing --ks-shard-map/--ks-shard-map-file causes this flag to be ignored. (default 2) |
| --sql | string | A list of semicolon-delimited SQL commands to analyze |
| --sql-file | string | Identifies the file that contains the SQL commands to analyze |
| --vschema | string | Identifies the VTGate routing schema |
| --vschema-file | string | Identifies the VTGate routing schema file |
| Name | Type | Definition |
|:-----------------------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------|
| --dbname | string | Optional database target to override normal routing |
| --execution-mode | string | The execution mode to simulate -- must be set to multi, legacy-autocommit, or twopc (default "multi") |
| --ks-shard-map | string | JSON map of keyspace name -> shard name -> ShardReference object. The inner map is the same as the output of FindAllShardsInKeyspace |
| --ks-shard-map-file | string | File containing json blob of keyspace name -> shard name -> ShardReference object |
| --mysql_server_version | string | MySQL server version to advertise. (default "8.0.30-Vitess") |
| --normalize | boolean | Whether to enable vtgate normalization |
| --output-mode | string | Output in human-friendly text or json (default "text") |
| --planner-version | string | Sets the default planner to use. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right |
| --replication-mode | string | The replication mode to simulate -- must be set to either ROW or STATEMENT (default "ROW") |
| --schema | string | The SQL table schema |
| --schema-file | string | Identifies the file that contains the SQL table schema |
| --shards | int | Number of shards per keyspace. Passing --ks-shard-map/--ks-shard-map-file causes this flag to be ignored. (default 2) |
| --sql | string | A list of semicolon-delimited SQL commands to analyze |
| --sql-file | string | Identifies the file that contains the SQL commands to analyze |
| --vschema | string | Identifies the VTGate routing schema |
| --vschema-file | string | Identifies the VTGate routing schema file |

<br>

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vtgate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ The following global options apply to `vtgate`:
| --onterm_timeout | Duration | wait no more than this for OnTermSync handlers before stopping (default 10s) |
| --opentsdb_uri | String | URI of opentsdb /api/put method |
| --pid_file | String | If set, the process will write its pid to the named file, and delete it on graceful shutdown. |
| --planner-version | String | Sets the default planner to use when the session has not changed it. Valid values are: V3, Gen4, Gen4Greedy and Gen4Fallback. Gen4Fallback tries the gen4 planner and falls back to the V3 planner if the gen4 fails. |
| --planner-version | String | Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right |
| --port | Int | port for the server |
| --pprof strings | Boolean | enable profiling |
| --proxy_protocol | Boolean | Enable HAProxy PROXY protocol on MySQL listener socket |
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/user-guides/configuration-advanced/comment-directives.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Overrides the default planner to the one specified by the directive. Example que
select /*vt+ PLANNER=gen4 */ * from user;
```
Valid values are the same as for the planner flag - `v3` and `gen4`.
Valid values are the same as for the planner flag - `Gen4`, `Gen4Greedy` and `Gen4Left2Right`.
### Workload name (`WORKLOAD_NAME`)
Expand Down

0 comments on commit 2223b0c

Please sign in to comment.