Skip to content
This repository was archived by the owner on Nov 12, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -312,8 +312,8 @@ async def create_write_stream(
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> stream.WriteStream:
r"""Creates a write stream to the given table. Additionally, every
table has a special stream named '_default' to which data can be
written. This stream doesn't need to be created using
table has a special stream named '\_default' to which data can
be written. This stream doesn't need to be created using
CreateWriteStream. It is a stream that can be used
simultaneously by any number of clients. Data written to this
stream is considered committed as soon as an acknowledgement is
Expand Down Expand Up @@ -458,17 +458,17 @@ def append_rows(
The specifics of when successfully appended data is made visible
to the table are governed by the type of stream:

- For COMMITTED streams (which includes the default stream),
data is visible immediately upon successful append.
- For COMMITTED streams (which includes the default stream),
data is visible immediately upon successful append.

- For BUFFERED streams, data is made visible via a subsequent
``FlushRows`` rpc which advances a cursor to a newer offset
in the stream.
- For BUFFERED streams, data is made visible via a subsequent
``FlushRows`` rpc which advances a cursor to a newer offset in
the stream.

- For PENDING streams, data is not made visible until the
stream itself is finalized (via the ``FinalizeWriteStream``
rpc), and the stream is explicitly committed via the
``BatchCommitWriteStreams`` rpc.
- For PENDING streams, data is not made visible until the stream
itself is finalized (via the ``FinalizeWriteStream`` rpc), and
the stream is explicitly committed via the
``BatchCommitWriteStreams`` rpc.

.. code-block:: python

Expand Down Expand Up @@ -678,7 +678,7 @@ async def finalize_write_stream(
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> storage.FinalizeWriteStreamResponse:
r"""Finalize a write stream so that no new data can be appended to
the stream. Finalize is not supported on the '_default' stream.
the stream. Finalize is not supported on the '\_default' stream.

.. code-block:: python

Expand Down
24 changes: 12 additions & 12 deletions google/cloud/bigquery_storage_v1/services/big_query_write/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -752,8 +752,8 @@ def create_write_stream(
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> stream.WriteStream:
r"""Creates a write stream to the given table. Additionally, every
table has a special stream named '_default' to which data can be
written. This stream doesn't need to be created using
table has a special stream named '\_default' to which data can
be written. This stream doesn't need to be created using
CreateWriteStream. It is a stream that can be used
simultaneously by any number of clients. Data written to this
stream is considered committed as soon as an acknowledgement is
Expand Down Expand Up @@ -895,17 +895,17 @@ def append_rows(
The specifics of when successfully appended data is made visible
to the table are governed by the type of stream:

- For COMMITTED streams (which includes the default stream),
data is visible immediately upon successful append.
- For COMMITTED streams (which includes the default stream),
data is visible immediately upon successful append.

- For BUFFERED streams, data is made visible via a subsequent
``FlushRows`` rpc which advances a cursor to a newer offset
in the stream.
- For BUFFERED streams, data is made visible via a subsequent
``FlushRows`` rpc which advances a cursor to a newer offset in
the stream.

- For PENDING streams, data is not made visible until the
stream itself is finalized (via the ``FinalizeWriteStream``
rpc), and the stream is explicitly committed via the
``BatchCommitWriteStreams`` rpc.
- For PENDING streams, data is not made visible until the stream
itself is finalized (via the ``FinalizeWriteStream`` rpc), and
the stream is explicitly committed via the
``BatchCommitWriteStreams`` rpc.

.. code-block:: python

Expand Down Expand Up @@ -1110,7 +1110,7 @@ def finalize_write_stream(
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> storage.FinalizeWriteStreamResponse:
r"""Finalize a write stream so that no new data can be appended to
the stream. Finalize is not supported on the '_default' stream.
the stream. Finalize is not supported on the '\_default' stream.

.. code-block:: python

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -332,8 +332,8 @@ def create_write_stream(
r"""Return a callable for the create write stream method over gRPC.

Creates a write stream to the given table. Additionally, every
table has a special stream named '_default' to which data can be
written. This stream doesn't need to be created using
table has a special stream named '\_default' to which data can
be written. This stream doesn't need to be created using
CreateWriteStream. It is a stream that can be used
simultaneously by any number of clients. Data written to this
stream is considered committed as soon as an acknowledgement is
Expand Down Expand Up @@ -386,17 +386,17 @@ def append_rows(
The specifics of when successfully appended data is made visible
to the table are governed by the type of stream:

- For COMMITTED streams (which includes the default stream),
data is visible immediately upon successful append.
- For COMMITTED streams (which includes the default stream),
data is visible immediately upon successful append.

- For BUFFERED streams, data is made visible via a subsequent
``FlushRows`` rpc which advances a cursor to a newer offset
in the stream.
- For BUFFERED streams, data is made visible via a subsequent
``FlushRows`` rpc which advances a cursor to a newer offset in
the stream.

- For PENDING streams, data is not made visible until the
stream itself is finalized (via the ``FinalizeWriteStream``
rpc), and the stream is explicitly committed via the
``BatchCommitWriteStreams`` rpc.
- For PENDING streams, data is not made visible until the stream
itself is finalized (via the ``FinalizeWriteStream`` rpc), and
the stream is explicitly committed via the
``BatchCommitWriteStreams`` rpc.

Returns:
Callable[[~.AppendRowsRequest],
Expand Down Expand Up @@ -451,7 +451,7 @@ def finalize_write_stream(
r"""Return a callable for the finalize write stream method over gRPC.

Finalize a write stream so that no new data can be appended to
the stream. Finalize is not supported on the '_default' stream.
the stream. Finalize is not supported on the '\_default' stream.

Returns:
Callable[[~.FinalizeWriteStreamRequest],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,8 @@ def create_write_stream(
r"""Return a callable for the create write stream method over gRPC.

Creates a write stream to the given table. Additionally, every
table has a special stream named '_default' to which data can be
written. This stream doesn't need to be created using
table has a special stream named '\_default' to which data can
be written. This stream doesn't need to be created using
CreateWriteStream. It is a stream that can be used
simultaneously by any number of clients. Data written to this
stream is considered committed as soon as an acknowledgement is
Expand Down Expand Up @@ -394,17 +394,17 @@ def append_rows(
The specifics of when successfully appended data is made visible
to the table are governed by the type of stream:

- For COMMITTED streams (which includes the default stream),
data is visible immediately upon successful append.
- For COMMITTED streams (which includes the default stream),
data is visible immediately upon successful append.

- For BUFFERED streams, data is made visible via a subsequent
``FlushRows`` rpc which advances a cursor to a newer offset
in the stream.
- For BUFFERED streams, data is made visible via a subsequent
``FlushRows`` rpc which advances a cursor to a newer offset in
the stream.

- For PENDING streams, data is not made visible until the
stream itself is finalized (via the ``FinalizeWriteStream``
rpc), and the stream is explicitly committed via the
``BatchCommitWriteStreams`` rpc.
- For PENDING streams, data is not made visible until the stream
itself is finalized (via the ``FinalizeWriteStream`` rpc), and
the stream is explicitly committed via the
``BatchCommitWriteStreams`` rpc.

Returns:
Callable[[~.AppendRowsRequest],
Expand Down Expand Up @@ -460,7 +460,7 @@ def finalize_write_stream(
r"""Return a callable for the finalize write stream method over gRPC.

Finalize a write stream so that no new data can be appended to
the stream. Finalize is not supported on the '_default' stream.
the stream. Finalize is not supported on the '\_default' stream.

Returns:
Callable[[~.FinalizeWriteStreamRequest],
Expand Down
34 changes: 17 additions & 17 deletions google/cloud/bigquery_storage_v1/types/storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,11 +333,11 @@ class SplitReadStreamResponse(proto.Message):
Attributes:
primary_stream (google.cloud.bigquery_storage_v1.types.ReadStream):
Primary stream, which contains the beginning portion of
\|original_stream|. An empty value indicates that the
\|original_stream\|. An empty value indicates that the
original stream can no longer be split.
remainder_stream (google.cloud.bigquery_storage_v1.types.ReadStream):
Remainder stream, which contains the tail of
\|original_stream|. An empty value indicates that the
\|original_stream\|. An empty value indicates that the
original stream can no longer be split.
"""

Expand Down Expand Up @@ -401,32 +401,32 @@ class AppendRowsRequest(proto.Message):
Required. The write_stream identifies the append operation.
It must be provided in the following scenarios:

- In the first request to an AppendRows connection.
- In the first request to an AppendRows connection.

- In all subsequent requests to an AppendRows connection,
if you use the same connection to write to multiple
tables or change the input schema for default streams.
- In all subsequent requests to an AppendRows connection, if
you use the same connection to write to multiple tables or
change the input schema for default streams.

For explicitly created write streams, the format is:

- ``projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}``
- ``projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}``

For the special default stream, the format is:

- ``projects/{project}/datasets/{dataset}/tables/{table}/streams/_default``.
- ``projects/{project}/datasets/{dataset}/tables/{table}/streams/_default``.

An example of a possible sequence of requests with
write_stream fields within a single connection:

- r1: {write_stream: stream_name_1}
- r1: {write_stream: stream_name_1}

- r2: {write_stream: /*omit*/}
- r2: {write_stream: /*omit*/}

- r3: {write_stream: /*omit*/}
- r3: {write_stream: /*omit*/}

- r4: {write_stream: stream_name_2}
- r4: {write_stream: stream_name_2}

- r5: {write_stream: stream_name_2}
- r5: {write_stream: stream_name_2}

The destination changed in request_4, so the write_stream
field must be populated in all subsequent requests in this
Expand All @@ -436,7 +436,7 @@ class AppendRowsRequest(proto.Message):
offset is same as the provided value. If not present, the
write is performed at the current end of stream. Specifying
a value for this field is not allowed when calling
AppendRows for the '_default' stream.
AppendRows for the '\_default' stream.
proto_rows (google.cloud.bigquery_storage_v1.types.AppendRowsRequest.ProtoData):
Rows in proto format.

Expand Down Expand Up @@ -539,11 +539,11 @@ class ProtoData(proto.Message):
The protocol buffer schema used to serialize the data.
Provide this value whenever:

- You send the first request of an RPC connection.
- You send the first request of an RPC connection.

- You change the input schema.
- You change the input schema.

- You specify a new destination table.
- You specify a new destination table.
rows (google.cloud.bigquery_storage_v1.types.ProtoRows):
Serialized row data in protobuf message
format. Currently, the backend expects the
Expand Down
30 changes: 15 additions & 15 deletions google/cloud/bigquery_storage_v1/types/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class TableFieldSchema(proto.Message):
Attributes:
name (str):
Required. The field name. The name must contain only letters
(a-z, A-Z), numbers (0-9), or underscores (_), and must
(a-z, A-Z), numbers (0-9), or underscores (\_), and must
start with a letter or underscore. The maximum length is 128
characters.
type_ (google.cloud.bigquery_storage_v1.types.TableFieldSchema.Type):
Expand Down Expand Up @@ -97,26 +97,26 @@ class TableFieldSchema(proto.Message):
Values of this NUMERIC or BIGNUMERIC field must be in this
range when:

- Precision (P) and scale (S) are specified: [-10^(P-S) +
10^(-S), 10^(P-S) - 10^(-S)]
- Precision (P) is specified but not scale (and thus scale
is interpreted to be equal to zero): [-10^P + 1, 10^P -
1].
- Precision (P) and scale (S) are specified: [-10^(P-S) +
10^(-S), 10^(P-S) - 10^(-S)]
- Precision (P) is specified but not scale (and thus scale
is interpreted to be equal to zero): [-10^P + 1, 10^P -
1].

Acceptable values for precision and scale if both are
specified:

- If type = "NUMERIC": 1 <= precision - scale <= 29 and 0
<= scale <= 9.
- If type = "BIGNUMERIC": 1 <= precision - scale <= 38 and
0 <= scale <= 38.
- If type = "NUMERIC": 1 <= precision - scale <= 29 and 0 <=
scale <= 9.
- If type = "BIGNUMERIC": 1 <= precision - scale <= 38 and 0
<= scale <= 38.

Acceptable values for precision if only precision is
specified but not scale (and thus scale is interpreted to be
equal to zero):

- If type = "NUMERIC": 1 <= precision <= 29.
- If type = "BIGNUMERIC": 1 <= precision <= 38.
- If type = "NUMERIC": 1 <= precision <= 29.
- If type = "BIGNUMERIC": 1 <= precision <= 38.

If scale is specified but not precision, then it is invalid.
scale (int):
Expand All @@ -131,9 +131,9 @@ class TableFieldSchema(proto.Message):
required. Possible values for the field element type of a
RANGE include:

- DATE
- DATETIME
- TIMESTAMP
- DATE
- DATETIME
- TIMESTAMP
"""

class Type(proto.Enum):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,11 +267,11 @@ class ListMetastorePartitionsRequest(proto.Message):

Examples:

- "int_field > 5"
- "date_field = CAST('2014-9-27' as DATE)"
- "nullable_field is not NULL"
- "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
- "numeric_field BETWEEN 1.0 AND 5.0"
- "int_field > 5"
- "date_field = CAST('2014-9-27' as DATE)"
- "nullable_field is not NULL"
- "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
- "numeric_field BETWEEN 1.0 AND 5.0"

Restricted to a maximum length of 1 MB.
trace_id (str):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ async def create_write_stream(
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> stream.WriteStream:
r"""Creates a write stream to the given table. Additionally, every
table has a special COMMITTED stream named '_default' to which
table has a special COMMITTED stream named '\_default' to which
data can be written. This stream doesn't need to be created
using CreateWriteStream. It is a stream that can be used
simultaneously by any number of clients. Data written to this
Expand Down Expand Up @@ -670,7 +670,7 @@ async def finalize_write_stream(
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> storage.FinalizeWriteStreamResponse:
r"""Finalize a write stream so that no new data can be appended to
the stream. Finalize is not supported on the '_default' stream.
the stream. Finalize is not supported on the '\_default' stream.

.. code-block:: python

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,7 @@ def create_write_stream(
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> stream.WriteStream:
r"""Creates a write stream to the given table. Additionally, every
table has a special COMMITTED stream named '_default' to which
table has a special COMMITTED stream named '\_default' to which
data can be written. This stream doesn't need to be created
using CreateWriteStream. It is a stream that can be used
simultaneously by any number of clients. Data written to this
Expand Down Expand Up @@ -1099,7 +1099,7 @@ def finalize_write_stream(
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
) -> storage.FinalizeWriteStreamResponse:
r"""Finalize a write stream so that no new data can be appended to
the stream. Finalize is not supported on the '_default' stream.
the stream. Finalize is not supported on the '\_default' stream.

.. code-block:: python

Expand Down
Loading