Materialize workflow support for reference tables

[rohit-nayak-ps]

Description

This PR adds support for materializing reference tables by adding options to the Materialize workflow. Currently the user needs to specify the target table info along with the materialize query using the --table_settings flag which takes a json spec.

Two new flags --reference (bool) and --tables (csv list) have been added. Reference table materialization cannot be combined with regular Materialize workflows. It is one or the other. Reference table materializing just requires setting up a copy of the tables into all target shards.

Example:
Materialize --target-keyspace ks2 --workflow wf1 create --source-keyspace ks1 --reference --tables ref1,ref2

Doc PR: vitessio/website#1849

Related Issue(s)

• Fixes: Add support for materializing reference tables #16792

Checklist

• "Backport to:" labels have been added if this change should be back-ported to release branches
• If this change is to be back-ported to previous releases, a justification is included in the PR description
• Tests were added or are not required
• Did the new or modified tests pass consistently locally and on CI?
• Documentation: Document reference tables website#1849

[vitess-bot]

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

• Ensure that the Pull Request has a descriptive title.
• Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

• Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

• Apply the release notes (needs details) label if users need to know about this change.
• New features should be documented.
• There should be some code comments as to why things are implemented the way they are.
• There should be a comment at the top of each new or modified test to explain what the test does.

New flags

• Is this flag really necessary?
• Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

• Each item in Jobs should be named in order to mark it as required.
• If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

• Protobuf changes should be wire-compatible.
• Changes to _vt tables and RPCs need to be backward compatible.
• RPC changes should be compatible with vitess-operator
• If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
• vtctl command output order should be stable and awk-able.

[codecov]

Codecov Report

Attention: Patch coverage is 23.07692% with 10 lines in your changes missing coverage. Please review.

Project coverage is 69.50%. Comparing base (95f2e3e) to head (8af9387).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
go/vt/vtctl/workflow/server.go	18.18%	9 Missing ⚠️
...dclient/command/vreplication/materialize/create.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #16787      +/-   ##
==========================================
- Coverage   69.51%   69.50%   -0.02%     
==========================================
  Files        1569     1569              
  Lines      202517   202529      +12     
==========================================
- Hits       140780   140761      -19     
- Misses      61737    61768      +31     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mattlord]

❤️

[deepthi]

We might want to mention this in the release notes as well, once the CLI options are final.

[deepthi]

If both options are required, why not replace them with a single --reference-tables option? It will still be mutually exclusive with --table-settings.

[rohit-nayak-ps]

I had kept them as two options as

• --tables felt more consistent as we have a simlar MoveTables option
• In case we would have other use cases similar to --reference where we would materialize a list of special tables.

But I don't really have a clear scenario in mind. Will switch to the single option.

[rohit-nayak-ps]

Modified to use single option. Added to release notes.

[mattlord]

Suggested change

	There is a new option in `Materialize` workflows to keep a synced copy of reference tables from the unsharded keyspace
	which holds the source of truth for the reference table, to all shards in a sharded keyspace.
	There is a new option in [`Materialize` workflows](https://vitess.io/docs/reference/vreplication/materialize/) to keep a synced copy of [reference or lookup tables](https://vitess.io/docs/reference/vreplication/reference_tables/) (countries, states, zip_codes, etc) from an unsharded keyspace which holds the source of truth for the reference table, to all shards in a sharded keyspace.