Skip to content

SchemaTracker refactor documentation #1487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GuptaManan100 merged 2 commits into from
May 31, 2023
Merged

SchemaTracker refactor documentation #1487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d18f1fa
feat: update the vitess docs for the schema tracking refactor
GuptaManan100 May 30, 2023
5771029
feat: fix the review comments
GuptaManan100 May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/17.0/reference/features/schema-tracking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ If the table ACL is enabled, then an exempted/allowed username needs to be passe

## VTTablet

Schema tracking is enabled in VTTablet with the flag `--queryserver-config-schema-change-signal`, defaults to `true`. When enabled, VTTablet sends schema changes to VTGate based on an interval that can be modified with the flag `--queryserver-config-schema-change-signal-interval` (defaults to 5 seconds).
Schema tracking is enabled in VTTablet with the flag `--queryserver-config-schema-change-signal`, defaults to `true`. When enabled, VTTablet sends schema changes to VTGate when a DDL query executes. Additionally, VTTablet regularly checks for schema changes at a specified interval, which can be adjusted using the `--queryserver-config-schema-reload-time` flag. The default interval is set to 30 minutes.
4 changes: 2 additions & 2 deletions content/en/docs/17.0/reference/programs/vttablet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,6 @@ The following global options apply to `vttablet`:
| --queryserver-config-query-pool-waiter-cap | int | query server query pool waiter limit, this is the maximum number of queries that can be queued waiting to get a connection (default 5000) |
| --queryserver-config-query-timeout | float | query server query timeout (in seconds), this is the query timeout in vttablet side. If a query takes more than this timeout, it will be killed. (default 30) |
| --queryserver-config-schema-change-signal | boolean | query server schema signal, will signal connected vtgates that schema has changed whenever this is detected. VTGates will need to have -schema_change_signal enabled for this to work (default true) |
| --queryserver-config-schema-change-signal-interval | float | query server schema change signal interval defines at which interval the query server shall send schema updates to vtgate. (default 5) |
| --queryserver-config-schema-reload-time | float | query server schema reload time, how often vttablet reloads schemas from underlying MySQL instance in seconds. vttablet keeps table schemas in its own memory and periodically refreshes it from MySQL. This config controls the reload time. (default 1800) |
| --queryserver-config-stream-buffer-size | int | query server stream buffer size, the maximum number of bytes sent from vttablet for each stream call. It's recommended to keep this value in sync with vtgate's stream_buffer_size. (default 32768) |
| --queryserver-config-stream-pool-size | int | query server stream connection pool size, stream pool is used by stream queries: queries that return results to client in a streaming fashion (default 200) |
Expand Down Expand Up @@ -318,6 +317,7 @@ The following global options apply to `vttablet`:
| --s3_backup_storage_root | string | root prefix for all backup-related object names. |
| --s3_backup_tls_skip_verify_cert | boolean | skip the 'certificate is valid' check for SSL connections. |
| --sanitize_log_messages | boolean | Remove potentially sensitive information in tablet INFO, WARNING, and ERROR log messages such as query parameters. |
| --schema-change-reload-timeout | duration | query server schema change reload timeout, this is how long to wait for the signaled schema reload operation to complete before giving up (default 30s) |
| --schema-version-max-age-seconds | int | Max age of schema version records to kept in memory by the vreplication historian |
| --security_policy | string | the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) |
| --service_map | strings | comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice |
Expand Down Expand Up @@ -403,7 +403,7 @@ The following global options apply to `vttablet`:
| --twopc_enable | boolean | if the flag is on, 2pc is enabled. Other 2pc flags must be supplied. |
| --tx-throttler-config | string | Synonym to -tx_throttler_config (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-healthcheck-cells | strings | Synonym to -tx_throttler_healthcheck_cells |
| --tx-throttler-tablet-types | strings | A comma-separated list of tablet types. Only tablets of this type are monitored for replication lag by the transaction throttler. Supported types are replica and/or rdonly. (default replica) |
| --tx-throttler-tablet-types | strings | A comma-separated list of tablet types. Only tablets of this type are monitored for replication lag by the transaction throttler. Supported types are replica and/or rdonly. (default replica) |
| --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_healthcheck_cells | strings | 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) |
Expand Down