Create Source v2 (new syntax) docs for MySQL#36164
Open
patrickwwbutler wants to merge 4 commits intoMaterializeInc:mainfrom
Open
Create Source v2 (new syntax) docs for MySQL#36164patrickwwbutler wants to merge 4 commits intoMaterializeInc:mainfrom
patrickwwbutler wants to merge 4 commits intoMaterializeInc:mainfrom
Conversation
bosconi
reviewed
Apr 21, 2026
Member
bosconi
left a comment
bosconi
left a comment
There was a problem hiding this comment.
Here's what /mz-doc-edit came up with on its first time out of the garage.
|
|
||
| See [`CREATE TABLE FROM SOURCE`](/sql/create-table/) for details. | ||
|
|
||
| #### Handling table schema changes |
Member
There was a problem hiding this comment.
rule_020 (section-split, conf 2): heading level skip — ## Ingesting data jumps to #### with no intervening ###. Promoting to ### makes this a peer of ### Change data capture and ### Monitoring source progress.
Suggested change
| #### Handling table schema changes | |
| ### Handling table schema changes |
Co-authored-by: Jon Currey <bosconi@users.noreply.github.com>
Co-authored-by: Jon Currey <bosconi@users.noreply.github.com>
bosconi
reviewed
Apr 22, 2026
Comment on lines
+137
to
+139
| [//]: # "TODO(morsapaes) Replace this section with guidance using the new | ||
| progress metrics in mz_source_statistics + console monitoring, when available | ||
| (also for PostgreSQL)." |
Member
There was a problem hiding this comment.
rule_032 (comment-removal, conf 5): TODO(morsapaes) is a contributor name, not a tracked ticket — the carve-out for tracked issues does not apply.
Suggested change
| [//]: # "TODO(morsapaes) Replace this section with guidance using the new | |
| progress metrics in mz_source_statistics + console monitoring, when available | |
| (also for PostgreSQL)." |
bosconi
reviewed
Apr 22, 2026
Comment on lines
+107
to
+109
| If you're running MySQL using a managed service, additional configuration | ||
| changes might be required. For step-by-step instructions on enabling GTID-based | ||
| binlog replication for your MySQL service, see the integration guides. |
Member
There was a problem hiding this comment.
rule_013 (tone-tightening, conf 2): shorten verbose cross-reference.
Suggested change
| If you're running MySQL using a managed service, additional configuration | |
| changes might be required. For step-by-step instructions on enabling GTID-based | |
| binlog replication for your MySQL service, see the integration guides. | |
| If you're running MySQL using a managed service, additional configuration | |
| changes might be required. To enable GTID-based binlog replication for your | |
| MySQL service, see the integration guides. |
bosconi
reviewed
Apr 22, 2026
Comment on lines
+166
to
+167
| database. For more details on monitoring source ingestion progress and debugging | ||
| related issues, see [Troubleshooting](/ops/troubleshooting/). |
Member
There was a problem hiding this comment.
rule_013 (tone-tightening, conf 2): shorten verbose cross-reference.
Suggested change
| database. For more details on monitoring source ingestion progress and debugging | |
| related issues, see [Troubleshooting](/ops/troubleshooting/). | |
| database. For more information, see [Troubleshooting](/ops/troubleshooting/). |
bosconi
reviewed
Apr 22, 2026
Comment on lines
+193
to
+195
| Once created, a connection is **reusable** across multiple `CREATE SOURCE` | ||
| statements. For more details on creating connections, check the | ||
| [`CREATE CONNECTION`](/sql/create-connection/#mysql) documentation page. |
Member
There was a problem hiding this comment.
rule_013 (tone-tightening, conf 2): shorten verbose cross-reference.
Suggested change
| Once created, a connection is **reusable** across multiple `CREATE SOURCE` | |
| statements. For more details on creating connections, check the | |
| [`CREATE CONNECTION`](/sql/create-connection/#mysql) documentation page. | |
| Once created, a connection is **reusable** across multiple `CREATE SOURCE` | |
| statements. For more information, see [`CREATE CONNECTION`](/sql/create-connection/#mysql). |
bosconi
reviewed
Apr 22, 2026
Comment on lines
+232
to
+234
| For step-by-step instructions on creating AWS PrivateLink connections and | ||
| configuring an AWS PrivateLink service to accept connections from Materialize, | ||
| check [this guide](/ops/network-security/privatelink/). |
Member
There was a problem hiding this comment.
rule_013 (tone-tightening, conf 2): shorten verbose cross-reference.
Suggested change
| For step-by-step instructions on creating AWS PrivateLink connections and | |
| configuring an AWS PrivateLink service to accept connections from Materialize, | |
| check [this guide](/ops/network-security/privatelink/). | |
| For more information, see [this guide](/ops/network-security/privatelink/). |
bosconi
reviewed
Apr 22, 2026
Comment on lines
+254
to
+256
| For step-by-step instructions on creating SSH tunnel connections and configuring | ||
| an SSH bastion server to accept connections from Materialize, check | ||
| [this guide](/ops/network-security/ssh-tunnel/). |
Member
There was a problem hiding this comment.
rule_013 (tone-tightening, conf 2): shorten verbose cross-reference.
Suggested change
| For step-by-step instructions on creating SSH tunnel connections and configuring | |
| an SSH bastion server to accept connections from Materialize, check | |
| [this guide](/ops/network-security/ssh-tunnel/). | |
| For more information, see [this guide](/ops/network-security/ssh-tunnel/). |
bosconi
reviewed
Apr 22, 2026
|
|
||
| See [`CREATE TABLE FROM SOURCE`](/sql/create-table/#handling-table-schema-changes) for details. | ||
|
|
||
| #### Supported types |
Member
There was a problem hiding this comment.
rule_020 (section-split, conf 2): heading level skip — promote to ### for consistent hierarchy.
Suggested change
| #### Supported types | |
| ### Supported types |
bosconi
reviewed
Apr 22, 2026
| For more information, including strategies for handling unsupported types, | ||
| see [`CREATE TABLE FROM SOURCE`](/sql/create-table/). | ||
|
|
||
| #### Upstream table truncation restrictions |
Member
There was a problem hiding this comment.
rule_020 (section-split, conf 2): heading level skip — promote to ### for consistent hierarchy.
Suggested change
| #### Upstream table truncation restrictions | |
| ### Upstream table truncation restrictions |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds docs outlining how to use the new
CREATE TABLE FROM SOURCEsyntax for MySQL sources to enable source versioning