Skip to content

Commit 95dcaea

Browse files
authored
docs: Expose ReadChangeStreamFromSpanner in Beam Spanner documentation (#36428)
* docs: Expose ReadChangeStreamFromSpanner in Beam Spanner documentation The `ReadChangeStreamFromSpanner` class was not being picked up by the automatic Python documentation (pydoc) generation used for the Apache Beam website. This change explicitly adds the class to the relevant array in the Spanner connector's documentation configuration. * Retesting * Retesting * Fixing PyDocs Indentation * Fixing line too long
1 parent 7a9a4e6 commit 95dcaea

1 file changed

Lines changed: 28 additions & 28 deletions

File tree

sdks/python/apache_beam/io/gcp/spanner.py

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@
9999
'SpannerUpdate',
100100
'TimestampBoundMode',
101101
'TimeUnit',
102+
'ReadChangeStreamFromSpanner',
102103
]
103104

104105

@@ -683,8 +684,7 @@ class ReadChangeStreamFromSpanner(ExternalTransform):
683684
Example:
684685
685686
with beam.Pipeline(options=pipeline_options) as p:
686-
p |
687-
"ReadFromSpannerChangeStream" >> beam_spanner.ReadChangeStreamFromSpanner(
687+
p | "ReadSpannerChangeStream" >> beam_spanner.ReadChangeStreamFromSpanner(
688688
project_id="spanner-project-id",
689689
instance_id="spanner-instance-id",
690690
database_id="spanner-database-id",
@@ -714,32 +714,32 @@ def __init__(
714714
expansion_service=None,
715715
):
716716
"""
717-
Reads Change Streams from Google Cloud Spanner.
718-
719-
:param project_id: (Required) Specifies the Cloud Spanner project.
720-
:param instance_id: (Required) Specifies the Cloud Spanner
721-
instance.
722-
:param database_id: (Required) Specifies the Cloud Spanner
723-
database.
724-
:param changeStreamName: (Required) The name of the Spanner
725-
change stream to read.
726-
:param metadataDatabase: (Required) The database where the
727-
change stream metadata is stored.
728-
:param metadataInstance: (Required) The instance where the
729-
change stream metadata database resides.
730-
:param inclusiveStartAt: (Required) An inclusive start timestamp
731-
for reading the change stream.
732-
:param inclusiveEndAt: (Optional) An inclusive end timestamp for
733-
reading the change stream. If not specified, the stream will be
734-
read indefinitely.
735-
:param metadataTable: (Optional) The name of the metadata table used
736-
by the change stream connector. If not specified, a default table
737-
name will be used.
738-
:param rpcPriority: (Optional) The RPC priority for Spanner operations.
739-
Can be 'HIGH', 'MEDIUM', or 'LOW'.
740-
:param watermarkRefreshRate: (Optional) The duration at which the
741-
watermark is refreshed.
742-
"""
717+
Reads Change Streams from Google Cloud Spanner.
718+
719+
:param project_id: (Required) Specifies the Cloud Spanner project.
720+
:param instance_id: (Required) Specifies the Cloud Spanner
721+
instance.
722+
:param database_id: (Required) Specifies the Cloud Spanner
723+
database.
724+
:param changeStreamName: (Required) The name of the Spanner
725+
change stream to read.
726+
:param metadataDatabase: (Required) The database where the
727+
change stream metadata is stored.
728+
:param metadataInstance: (Required) The instance where the
729+
change stream metadata database resides.
730+
:param inclusiveStartAt: (Required) An inclusive start timestamp
731+
for reading the change stream.
732+
:param inclusiveEndAt: (Optional) An inclusive end timestamp for
733+
reading the change stream. If not specified, the stream will be
734+
read indefinitely.
735+
:param metadataTable: (Optional) The name of the metadata table used
736+
by the change stream connector. If not specified, a default table
737+
name will be used.
738+
:param rpcPriority: (Optional) The RPC priority for Spanner operations.
739+
Can be 'HIGH', 'MEDIUM', or 'LOW'.
740+
:param watermarkRefreshRate: (Optional) The duration at which the
741+
watermark is refreshed.
742+
"""
743743

744744
super().__init__(
745745
self.URN,

0 commit comments

Comments
 (0)