diff --git a/content/en/docs/overview/whatisvitess.md b/content/en/docs/overview/whatisvitess.md index cd9b33734..ddb26659c 100644 --- a/content/en/docs/overview/whatisvitess.md +++ b/content/en/docs/overview/whatisvitess.md @@ -48,8 +48,8 @@ The following sections compare Vitess to two common alternatives, a vanilla MySQ Vitess improves a vanilla MySQL implementation in several ways: -| Vanilla MySQL | Vitess | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Vanilla MySQL | Vitess | +|:--|:--| | Every MySQL connection has a memory overhead that ranges between 256KB and almost 3MB, depending on which MySQL release you're using. As your user base grows, you need to add RAM to support additional connections, but the RAM does not contribute to faster queries. In addition, there is a significant CPU cost associated with obtaining the connections. | Vitess creates very lightweight connections. Vitess' connection pooling feature uses Go's concurrency support to map these lightweight connections to a small pool of MySQL connections. As such, Vitess can easily handle thousands of connections. | | Poorly written queries, such as those that don't set a LIMIT, can negatively impact database performance for all users. | Vitess employs a SQL parser that uses a configurable set of rules to rewrite queries that might hurt database performance. | | Sharding is a process of partitioning your data to improve scalability and performance. MySQL lacks native sharding support, requiring you to write sharding code and embed sharding logic in your application. | Vitess supports a variety of sharding schemes. It can also migrate tables into different databases and scale up or down the number of shards. These functions are performed non-intrusively, completing most data transitions with just a few seconds of read-only downtime. | @@ -61,8 +61,8 @@ Vitess improves a vanilla MySQL implementation in several ways: If you're considering a NoSQL solution primarily because of concerns about the scalability of MySQL, Vitess might be a more appropriate choice for your application. While NoSQL provides great support for unstructured data, Vitess still offers several benefits not available in NoSQL datastores: -| NoSQL | Vitess | -|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| NoSQL | Vitess | +|:--|:--| | NoSQL databases do not define relationships between database tables, and only support a subset of the SQL language. | Vitess is not a simple key-value store. It supports complex query semantics such as where clauses, JOINS, aggregation functions, and more. | | NoSQL datastores do not usually support transactions. | Vitess supports transactions. | | NoSQL solutions have custom APIs, leading to custom architectures, applications, and tools. | Vitess adds very little variance to MySQL, a database that most people are already accustomed to working with. | diff --git a/content/en/docs/reference/programs/vtctl.md b/content/en/docs/reference/programs/vtctl.md index b3e891853..a83f8bc86 100644 --- a/content/en/docs/reference/programs/vtctl.md +++ b/content/en/docs/reference/programs/vtctl.md @@ -11,7 +11,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Tablets | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [InitTablet](../vtctl/tablets#inittablet) | `InitTablet [-allow_update] [-allow_different_shard] [-allow_master_override] [-parent] [-db_name_override=] [-hostname=] [-mysql_port=] [-port=] [-grpc_port=] [-tags=tag1:value1,tag2:value2] -keyspace= -shard= ` | | [GetTablet](../vtctl/tablets#gettablet) | `GetTablet ` | | [UpdateTabletAddrs](../vtctl/tablets#updatetabletaddrs) | `UpdateTabletAddrs [-hostname ] [-ip-addr ] [-mysql-port ] [-vt-port ] [-grpc-port ] ` | @@ -41,7 +41,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Shards | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [CreateShard](../vtctl/shards#createshard) | `CreateShard [-force] [-parent] ` | | [GetShard](../vtctl/shards#getshard) | `GetShard ` | | [ValidateShard](../vtctl/shards#validateshard) | `ValidateShard [-ping-tablets] ` | @@ -67,7 +67,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Keyspaces | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [CreateKeyspace](../vtctl/keyspaces#createkeyspace) | `CreateKeyspace [-sharding_column_name=name] [-sharding_column_type=type] [-served_from=tablettype1:ks1,tablettype2:ks2,...] [-force] [-keyspace_type=type] [-base_keyspace=base_keyspace] [-snapshot_time=time] ` | | [DeleteKeyspace](../vtctl/keyspaces#deletekeyspace) | `DeleteKeyspace [-recursive] ` | | [RemoveKeyspaceCell](../vtctl/keyspaces#removekeyspacesell) | `RemoveKeyspaceCell [-force] [-recursive] ` | @@ -98,7 +98,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Generic | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [Validate](../vtctl/generic#validate) | `Validate [-ping-tablets]` | | [ListAllTablets](../vtctl/generic#listalltablets) | `ListAllTablets , , ...` | | [ListTablets](../vtctl/generic#listtablets) | `ListTablets ...` | @@ -107,7 +107,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Schema, Version, Permissions | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [GetSchema](../vtctl/schema-version-permissions#getschema) | `GetSchema [-tables=,,...] [-exclude_tables=,,...] [-include-views] ` | | [ReloadSchema](../vtctl/schema-version-permissions#reloadschema) | `ReloadSchema ` | | [ReloadSchemaShard](../vtctl/schema-version-permissions#reloadschemashard) | `ReloadSchemaShard [-concurrency=10] [-include_master=false] ` | @@ -130,7 +130,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Serving Graph | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [GetSrvKeyspaceNames](../vtctl/serving-graph#getsrvkeyspacenames) | `GetSrvKeyspaceNames ` | | [GetSrvKeyspace](../vtctl/serving-graph#getsrvkeyspace) | `GetSrvKeyspace ` | | [GetSrvVSchema](../vtctl/serving-graph#getsrvsvchema) | `GetSrvVSchema ` | @@ -139,13 +139,13 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Replication Graph | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [GetShardReplication](../vtctl/replication-graph#getshardreplication) | `GetShardReplication ` | ### Cells | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [AddCellInfo](../vtctl/cells#addcellinfo) | `AddCellInfo [-server_address ] [-root ] ` | | [UpdateCellInfo](../vtctl/cells#updatecellinfo) | `UpdateCellInfo [-server_address ] [-root ] ` | | [DeleteCellInfo](../vtctl/cells#deletecellinfo) | `DeleteCellInfo [-force] ` | @@ -155,7 +155,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### CellsAliases | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [AddCellsAlias](../vtctl/cell-aliases#addcellsalias) | `AddCellsAlias [-cells ] ` | | [UpdateCellsAlias](../vtctl/cell-aliases#updatecellsalias) | `UpdateCellsAlias [-cells ] ` | | [DeleteCellsAlias](../vtctl/cell-aliases#deletecellsalias) | `DeleteCellsAlias ` | @@ -164,7 +164,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Queries | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [VtGateExecute](../vtctl/queries#vtgateexecute) | `VtGateExecute -server [-bind_variables ] [-keyspace ] [-tablet_type ] [-options ] [-json] ` | | [VtTabletExecute](../vtctl/queries#vttabletexecute) | `VtTabletExecute [-username ] [-transaction_id ] [-options ] [-json] ` | | [VtTabletBegin](../vtctl/queries#vttabletbegin) | `VtTabletBegin [-username ] ` | @@ -175,7 +175,7 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Resharding Throttler | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [ThrottlerMaxRates](../vtctl/resharding-throttler#throttlermaxrates) | `ThrottlerMaxRates -server ` | | [ThrottlerSetMaxRate](../vtctl/resharding-throttler#throttlersetmaxrate) | `ThrottlerSetMaxRate -server ` | | [GetThrottlerConfiguration](../vtctl/resharding-throttler#getthrottlerconfiguration) | `GetThrottlerConfiguration -server []` | @@ -185,14 +185,14 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ### Topo | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [TopoCat](../vtctl/topo#topocat) | `TopoCat [-cell ] [-decode_proto] [-decode_proto_json] [-long] [...]` | | [TopoCp](../vtctl/topo#topocp) | `TopoCp [-cell ] [-to_topo] ` | ### Workflows | Name | Example Usage | -| :-------- | :--------- | +| :-------- | :--------------- | | [WorkflowCreate](../vtctl/workflows#workflowcreate) | `WorkflowCreate [-skip_start] [parameters...]` | | [WorkflowStart](../vtctl/workflows#workflowstart) | `WorkflowStart ` | | [WorkflowStop](../vtctl/workflows#workflowstop) | `WorkflowStop ` | @@ -207,8 +207,8 @@ The following global options apply to `vtctl`: | Name | Type | Definition | -| :-------- | :--------- | :--------- | -| -alsologtostderr | | log to standard error as well as files| +| :------------------------------------ | :--------- | :----------------------------------------------------------------------------------------- | +| -alsologtostderr | | log to standard error as well as files | | -app_idle_timeout | duration | Idle timeout for app connections (default 1m0s) | | -app_pool_size | int | Size of the connection pool for app connections (default 40) | | -azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path) | @@ -305,7 +305,7 @@ The following global options apply to `vtctl`: | -pool_hostname_resolve_interval | duration | if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) | | -purge_logs_interval | duration | how often try to remove old logs (default 1h0m0s) | | -query-log-stream-handler | string | URL handler for streaming queries log (default "/debug/querylog") | -| -querylog-filter-tag | string | string that must be present in the query for it to be logged | +| -querylog-filter-tag | string | string that must be present in the query as a comment for the query to be logged, works for both vtgate and vttablet | | -querylog-format | string | format for query logs ("text" or "json") (default "text") | | -queryserver-config-acl-exempt-acl | string | an acl that exempt from table acl checking (this acl is free to access any vitess tables). | | -queryserver-config-enable-table-acl-dry-run | | If this flag is enabled, tabletserver will emit monitoring metrics and let the request pass regardless of table acl check results | @@ -403,7 +403,7 @@ The following global options apply to `vtctl`: | -twopc_abandon_age | float | time in seconds. Any unresolved transaction older than this time will be sent to the coordinator to be resolved. | | -twopc_coordinator_address | string | address of the (VTGate) process(es) that will be used to notify of abandoned transactions. | | -twopc_enable | | if the flag is on, 2pc is enabled. Other 2pc flags must be supplied.| -| -tx-throttler-config | string | The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default "target_replication_lag_sec: 2\nmax_replication_lag_sec: 10\ninitial_rate: 100\nmax_increase: 1\nemergency_decrease: 0.5\nmin_duration_between_increases_sec: 40\nmax_duration_between_increases_sec: 62\nmin_duration_between_decreases_sec: 20\nspread_backlog_across_sec: 20\nage_bad_rate_after_sec: 180\nbad_rate_increase: 0.1\nmax_rate_approach_threshold: 0.9\n") | +| -tx-throttler-config | string | The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default "target_replication_lag_sec: 2 max_replication_lag_sec: 10 initial_rate: 100 max_increase: 1 emergency_decrease: 0.5 min_duration_between_increases_sec: 40 max_duration_between_increases_sec: 62 min_duration_between_decreases_sec: 20 spread_backlog_across_sec: 20 age_bad_rate_after_sec: 180 bad_rate_increase: 0.1 max_rate_approach_threshold: 0.9 ") | | -tx-throttler-healthcheck-cells | value | A comma-separated list of cells. Only tabletservers running in these cells will be monitored for replication lag by the transaction throttler. | | -v | value | log level for V logs | | -version | | print binary version | diff --git a/content/en/docs/reference/programs/vtctld.md b/content/en/docs/reference/programs/vtctld.md index 1e227261c..7a853660f 100644 --- a/content/en/docs/reference/programs/vtctld.md +++ b/content/en/docs/reference/programs/vtctld.md @@ -29,7 +29,7 @@ vtctld \ ## Options | Name | Type | Definition | -| :-------- | :--------- | :--------- | +| :------------------------------------ | :--------- | :----------------------------------------------------------------------------------------- | | -action_timeout | duration | time to wait for an action before resorting to force (default 2m0s) | | -alsologtostderr | | log to standard error as well as files | | -app_idle_timeout | duration | Idle timeout for app connections (default 1m0s) | @@ -132,7 +132,7 @@ vtctld \ | -proxy_tablets | boolean | Setting this true will make vtctld proxy the tablet status instead of redirecting to them | | -purge_logs_interval | duration | how often try to remove old logs (default 1h0m0s) | | -query-log-stream-handler | string | URL handler for streaming queries log (default "/debug/querylog") | -| -querylog-filter-tag | string | string that must be present in the query for it to be logged | +| -querylog-filter-tag | string | string that must be present in the query as a comment for the query to be logged, works for both vtgate and vttablet | | -querylog-format | string | format for query logs ("text" or "json") (default "text") | | -queryserver-config-acl-exempt-acl | string | an acl that exempt from table acl checking (this acl is free to access any vitess tables). | | -queryserver-config-enable-table-acl-dry-run | boolean | If this flag is enabled, tabletserver will emit monitoring metrics and let the request pass regardless of table acl check results | @@ -238,7 +238,7 @@ vtctld \ | -twopc_abandon_age | float | time in seconds. Any unresolved transaction older than this time will be sent to the coordinator to be resolved. | | -twopc_coordinator_address | string | address of the (VTGate) process(es) that will be used to notify of abandoned transactions. | | -twopc_enable | boolean | if the flag is on, 2pc is enabled. Other 2pc flags must be supplied. | -| -tx-throttler-config | string | The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default "target_replication_lag_sec: 2\nmax_replication_lag_sec: 10\ninitial_rate: 100\nmax_increase: 1\nemergency_decrease: 0.5\nmin_duration_between_increases_sec: 40\nmax_duration_between_increases_sec: 62\nmin_duration_between_decreases_sec: 20\nspread_backlog_across_sec: 20\nage_bad_rate_after_sec: 180\nbad_rate_increase: 0.1\nmax_rate_approach_threshold: 0.9\n") | +| -tx-throttler-config | string | The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default "target_replication_lag_sec: 2 max_replication_lag_sec: 10 initial_rate: 100 max_increase: 1 emergency_decrease: 0.5 min_duration_between_increases_sec: 40 max_duration_between_increases_sec: 62 min_duration_between_decreases_sec: 20 spread_backlog_across_sec: 20 age_bad_rate_after_sec: 180 bad_rate_increase: 0.1 max_rate_approach_threshold: 0.9 ") | | -tx-throttler-healthcheck-cells | value | A comma-separated list of cells. Only tabletservers running in these cells will be monitored for replication lag by the transaction throttler. | | -v | value | log level for V logs | | -version | | print binary version | diff --git a/content/en/docs/reference/programs/vtgate.md b/content/en/docs/reference/programs/vtgate.md index 0d1526f9a..e55c06c0d 100644 --- a/content/en/docs/reference/programs/vtgate.md +++ b/content/en/docs/reference/programs/vtgate.md @@ -32,7 +32,7 @@ vtgate \ The following global options apply to `vtgate`: | Name | Type | Definition | -| :-------- | :--------- | :--------- | +| :------------------------------------ | :--------- | :----------------------------------------------------------------------------------------- | | -allowed_tablet_types | value | Specifies the tablet types this vtgate is allowed to route queries to | | -alsologtostderr | boolean | log to standard error as well as files | | -buffer_drain_concurrency | int | Maximum number of requests retried simultaneously. More concurrency will increase the load on the MASTER vttablet when draining the buffer. (default 1) | @@ -129,7 +129,7 @@ The following global options apply to `vtgate`: | -port | int | port for the server | | -proxy_protocol | boolean | Enable HAProxy PROXY protocol on MySQL listener socket | | -purge_logs_interval | duration | how often try to remove old logs (default 1h0m0s) | -| -querylog-filter-tag | string | string that must be present in the query for it to be logged | +| -querylog-filter-tag | string | string that must be present in the query as a comment for the query to be logged, works for both vtgate and vttablet | | -querylog-format | string | format for query logs ("text" or "json") (default "text") | | -redact-debug-ui-queries | boolean | redact full queries and bind variables from debug UI | | -remote_operation_timeout | duration | time to wait for a remote operation (default 30s) | diff --git a/content/en/docs/reference/programs/vttablet.md b/content/en/docs/reference/programs/vttablet.md index 317896f48..fc4730d8d 100644 --- a/content/en/docs/reference/programs/vttablet.md +++ b/content/en/docs/reference/programs/vttablet.md @@ -80,7 +80,7 @@ See [Unmanaged Tablet](../../../user-guides/configuration-advanced/unmanaged-tab The following global options apply to `vttablet`: | Name | Type | Definition | -| :-------------------------------------------------- | :--------- | :-------------------------------------------------------------------------------------- | +| :------------------------------------ | :--------- | :----------------------------------------------------------------------------------------- | | -alsologtostderr | boolean | log to standard error as well as files | | -app_idle_timeout | duration | Idle timeout for app connections (default 1m0s) | | -app_pool_size | int | Size of the connection pool for app connections (default 40) | @@ -255,7 +255,7 @@ The following global options apply to `vttablet`: | -port | int | port for the server | | -purge_logs_interval | duration | how often try to remove old logs (default 1h0m0s) | | -query-log-stream-handler | string | URL handler for streaming queries log (default "/debug/querylog") | -| -querylog-filter-tag | string | string that must be present in the query for it to be logged | +| -querylog-filter-tag | string | string that must be present in the query as a comment for the query to be logged, works for both vtgate and vttablet | | -querylog-format | string | format for query logs ("text" or "json") (default "text") | | -queryserver-config-acl-exempt-acl | string | an acl that exempt from table acl checking (this acl is free to access any vitess tables). | | -queryserver-config-enable-table-acl-dry-run | | If this flag is enabled, tabletserver will emit monitoring metrics and let the request pass regardless of table acl check results | @@ -357,7 +357,7 @@ The following global options apply to `vttablet`: | -twopc_abandon_age | float | time in seconds. Any unresolved transaction older than this time will be sent to the coordinator to be resolved. | | -twopc_coordinator_address | string | address of the (VTGate) process(es) that will be used to notify of abandoned transactions. | | -twopc_enable | | if the flag is on, 2pc is enabled. Other 2pc flags must be supplied. | -| -tx-throttler-config | string | The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default "target_replication_lag_sec: 2\nmax_replication_lag_sec: 10\ninitial_rate: 100\nmax_increase: 1\nemergency_decrease: 0.5\nmin_duration_between_increases_sec: 40\nmax_duration_between_increases_sec: 62\nmin_duration_between_decreases_sec: 20\nspread_backlog_across_sec: 20\nage_bad_rate_after_sec: 180\nbad_rate_increase: 0.1\nmax_rate_approach_threshold: 0.9\n") | +| -tx-throttler-config | string | The configuration of the transaction throttler as a text formatted throttlerdata.Configuration protocol buffer message (default "target_replication_lag_sec: 2 max_replication_lag_sec: 10 initial_rate: 100 max_increase: 1 emergency_decrease: 0.5 min_duration_between_increases_sec: 40 max_duration_between_increases_sec: 62 min_duration_between_decreases_sec: 20 spread_backlog_across_sec: 20 age_bad_rate_after_sec: 180 bad_rate_increase: 0.1 max_rate_approach_threshold: 0.9 ") | | -tx-throttler-healthcheck-cells | value | A comma-separated list of cells. Only tabletservers running in these cells will be monitored for replication lag by the transaction throttler. | | -unhealthy_threshold | duration | replication lag after which a replica is considered unhealthy (default 2h0m0s) | | -use_super_read_only | | Set super_read_only flag when performing planned failover. | diff --git a/content/en/docs/user-guides/_index.md b/content/en/docs/user-guides/_index.md index 466ca38c2..32844607d 100644 --- a/content/en/docs/user-guides/_index.md +++ b/content/en/docs/user-guides/_index.md @@ -2,7 +2,6 @@ title: User Guides description: Task-based guides for common usage scenarios weight: 4 -skip_sections: true aliases: ['/user-guide/client-libraries.html', '/docs/user-guides/'] --- diff --git a/content/en/docs/user-guides/historical/_index.md b/content/en/docs/user-guides/historical/_index.md index df2023a1f..783f93059 100644 --- a/content/en/docs/user-guides/historical/_index.md +++ b/content/en/docs/user-guides/historical/_index.md @@ -1,5 +1,5 @@ --- -title: Historical +title: Legacy description: User guides for features in older version of Vitess weight: 6 --- \ No newline at end of file diff --git a/layouts/partials/docs/landing-page.html b/layouts/partials/docs/landing-page.html index b3bf55a93..65f65ad48 100644 --- a/layouts/partials/docs/landing-page.html +++ b/layouts/partials/docs/landing-page.html @@ -1,10 +1,6 @@
- {{ $numSections := len .Sections}} - {{ $maxPages := 3 }} - {{ if le $numSections 3 }} - {{ $maxPages = 16 }} - {{ end }} + {{ $maxPages := 10 }} {{ range .Sections }} {{ $sectionUrl := .RelPermalink }} {{ $numPages := len .Pages }}