Adding documentation for the Debezium Spanner connector #1
Conversation
This file contains 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
markdonsky
reviewed
Dec 20, 2022
|
|
||
| A Cloud Spanner link:https://cloud.google.com/spanner/docs/change-streams[change stream] watches and streams out a Cloud Spanner database's data changes - inserts, updates, deletes - in near-real-time. The Cloud Spanner connector abstracts away the details of querying the Cloud Spanner change streams. With this connector, you don't have to manage the change streams partition lifecycle, which is necessary when you link:https://cloud.devsite.corp.google.com/spanner/docs/change-streams/details#query[use the Spanner API directly]. | ||
|
|
||
| The connector does not support the snapshot feature at the moment. The first time it connects to a Cloud Spanner database, it will start streaming changes from either the user-provided start timestamp or the current time, if the user did not provide a start timestamp. |
There was a problem hiding this comment.
I think "the connector does not support the snapshot feature at the moment" does not need to be included, does it?
Next sentence: The first time the Kafka connector connects to a Spanner database, it will stream changes from either the provided timestamp, or the current timestamp if a timestamp is not provided.
There was a problem hiding this comment.
I mentioned this, because the other Debezium documentation (Vitess) mentioned the same sentence, and I'm trying to keep close to the structure.
Agreed with the next sentence.
|
|
||
| toc::[] | ||
|
|
||
| {prodname}'s Cloud Spanner connector consumes and outputs Cloud Spanner change streams data into a Kafka topic. |
There was a problem hiding this comment.
I recommend that you refer to Spanner as "Cloud Spanner" once, and all subsequent references simply use "Spanner"
jpechane
force-pushed
the
debeziumDocumentation
branch
from
50a8d0c to
04ee85f
Compare
jpechane
force-pushed
the
debeziumDocumentation
branch
from
0e98df1 to
98ddabd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.