-
Notifications
You must be signed in to change notification settings - Fork 847
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.
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
Feat: implement change stream reader from GCP SpannerChangeStream #3066
Open
anicoll
wants to merge
3
commits into
redpanda-data:main
Choose a base branch
from
anicoll:feat/spanner_change_streams
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
148 changes: 148 additions & 0 deletions
148
docs/modules/components/pages/inputs/gcp_spanner_change_stream.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| = gcp_spanner_change_stream | ||
| :type: input | ||
| :status: beta | ||
| :categories: ["Services","GCP"] | ||
|
|
||
|
|
||
|
|
||
| //// | ||
| THIS FILE IS AUTOGENERATED! | ||
|
|
||
| To make changes, edit the corresponding source file under: | ||
|
|
||
| https://github.com/redpanda-data/connect/tree/main/internal/impl/<provider>. | ||
|
|
||
| And: | ||
|
|
||
| https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl | ||
| //// | ||
|
|
||
| // © 2024 Redpanda Data Inc. | ||
|
|
||
|
|
||
| component_type_dropdown::[] | ||
|
|
||
|
|
||
| Creates an input that consumes from a spanner change stream. | ||
|
|
||
| Introduced in version 3.43.0. | ||
|
|
||
|
|
||
| [tabs] | ||
| ====== | ||
| Common:: | ||
| + | ||
| -- | ||
|
|
||
| ```yml | ||
| # Common config fields, showing default values | ||
| input: | ||
| label: "" | ||
| gcp_spanner_change_stream: | ||
| stream_dsn: projects/<project_id>/instances/<instance_id>/databases/<database_id> # No default (required) | ||
| stream_id: "" | ||
| partition_dsn: projects/<project_id>/instances/<instance_id>/databases/<database_id> # No default (optional) | ||
| partition_table: "" # No default (optional) | ||
| use_in_mememory_partition: false | ||
| ``` | ||
|
|
||
| -- | ||
| Advanced:: | ||
| + | ||
| -- | ||
|
|
||
| ```yml | ||
| # All config fields, showing default values | ||
| input: | ||
| label: "" | ||
| gcp_spanner_change_stream: | ||
| stream_dsn: projects/<project_id>/instances/<instance_id>/databases/<database_id> # No default (required) | ||
| stream_id: "" | ||
| start_time_epoch: 0 | ||
| partition_dsn: projects/<project_id>/instances/<instance_id>/databases/<database_id> # No default (optional) | ||
| partition_table: "" # No default (optional) | ||
| use_in_mememory_partition: false | ||
| allowed_mod_types: | ||
| - INSERT | ||
| - UPDATE | ||
| - DELETE | ||
| ``` | ||
|
|
||
| -- | ||
| ====== | ||
|
|
||
| == Fields | ||
|
|
||
| === `stream_dsn` | ||
|
|
||
| Required field to use to connect to spanner for the change stream. | ||
|
|
||
|
|
||
| *Type*: `string` | ||
|
|
||
|
|
||
| ```yml | ||
| # Examples | ||
|
|
||
| stream_dsn: projects/<project_id>/instances/<instance_id>/databases/<database_id> | ||
| ``` | ||
|
|
||
| === `stream_id` | ||
|
|
||
| Required name of the change stream to track. | ||
|
|
||
|
|
||
| *Type*: `string` | ||
|
|
||
| *Default*: `""` | ||
|
|
||
| === `start_time_epoch` | ||
|
|
||
| Optional microsecond accurate epoch timestamp to start reading from. If empty time.Now() will be used. | ||
|
|
||
|
|
||
| *Type*: `int` | ||
|
|
||
| *Default*: `0` | ||
|
|
||
| === `partition_dsn` | ||
|
|
||
| Field used to set the DSN for the metadata partition table, can be the same as stream_dsn. | ||
|
|
||
|
|
||
| *Type*: `string` | ||
|
|
||
|
|
||
| ```yml | ||
| # Examples | ||
|
|
||
| partition_dsn: projects/<project_id>/instances/<instance_id>/databases/<database_id> | ||
| ``` | ||
|
|
||
| === `partition_table` | ||
|
|
||
| Name of the table to create/use in spanner to track change stream partition metadata. | ||
|
|
||
|
|
||
| *Type*: `string` | ||
|
|
||
|
|
||
| === `use_in_mememory_partition` | ||
|
|
||
| use an in memory partition table for tracking the partitions. | ||
|
|
||
|
|
||
| *Type*: `bool` | ||
|
|
||
| *Default*: `false` | ||
|
|
||
| === `allowed_mod_types` | ||
|
|
||
| Mod types to allow through when reading the change stream, default all. | ||
|
|
||
|
|
||
| *Type*: `array` | ||
|
|
||
| *Default*: `["INSERT","UPDATE","DELETE"]` | ||
|
|
||
|
|
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We try not to take dependencies on libraries that aren't stable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on this comment and the one below.
raised this PR.
#3083