Skip to content
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

docs: Minor formatting #646

Merged
merged 3 commits into from
Sep 19, 2023
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
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@

class BigQueryReadAsyncClient:
"""BigQuery Read API.

The Read API can be used to read data from BigQuery.
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ def get_transport_class(

class BigQueryReadClient(metaclass=BigQueryReadClientMeta):
"""BigQuery Read API.

The Read API can be used to read data from BigQuery.
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class BigQueryReadGrpcTransport(BigQueryReadTransport):
"""gRPC backend transport for BigQueryRead.
BigQuery Read API.
The Read API can be used to read data from BigQuery.
This class defines the same methods as the primary client, so the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ class BigQueryReadGrpcAsyncIOTransport(BigQueryReadTransport):
"""gRPC AsyncIO backend transport for BigQueryRead.

BigQuery Read API.

The Read API can be used to read data from BigQuery.

This class defines the same methods as the primary client, so the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@

class BigQueryWriteAsyncClient:
"""BigQuery Write API.
The Write API can be used to write data to BigQuery.
For supplementary information about the Write API, see:
https://cloud.google.com/bigquery/docs/write-api
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ def get_transport_class(

class BigQueryWriteClient(metaclass=BigQueryWriteClientMeta):
"""BigQuery Write API.
The Write API can be used to write data to BigQuery.
For supplementary information about the Write API, see:
https://cloud.google.com/bigquery/docs/write-api
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ class BigQueryWriteGrpcTransport(BigQueryWriteTransport):
"""gRPC backend transport for BigQueryWrite.
BigQuery Write API.
The Write API can be used to write data to BigQuery.
For supplementary information about the Write API, see:
https://cloud.google.com/bigquery/docs/write-api
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ class BigQueryWriteGrpcAsyncIOTransport(BigQueryWriteTransport):
"""gRPC AsyncIO backend transport for BigQueryWrite.
BigQuery Write API.
The Write API can be used to write data to BigQuery.
For supplementary information about the Write API, see:
https://cloud.google.com/bigquery/docs/write-api
Expand Down
1 change: 1 addition & 0 deletions google/cloud/bigquery_storage_v1/types/arrow.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class ArrowSchema(proto.Message):
serialized to bytes using IPC:

https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc

See code samples on how this message can be deserialized.

Attributes:
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/bigquery_storage_v1/types/avro.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,14 @@ class AvroSerializationOptions(proto.Message):
Attributes:
enable_display_name_attribute (bool):
Enable displayName attribute in Avro schema.

The Avro specification requires field names to
be alphanumeric. By default, in cases when
column names do not conform to these
requirements (e.g. non-ascii unicode codepoints)
and Avro is requested as an output format, the
CreateReadSession call will fail.

Setting this field to true, populates avro field
names with a placeholder value and populates a
"displayName" attribute for every avro field
Expand Down
1 change: 1 addition & 0 deletions google/cloud/bigquery_storage_v1/types/stream.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ class ReadSession(proto.Message):
(e.g. All using the same ID for all sessions
needed to complete a Spark SQL query is
reasonable).

Maximum length is 256 bytes.
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@

class BigQueryReadAsyncClient:
"""BigQuery Read API.

The Read API can be used to read data from BigQuery.

New code should use the v1 Read API going forward, if they don't
use Write API at the same time.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ def get_transport_class(

class BigQueryReadClient(metaclass=BigQueryReadClientMeta):
"""BigQuery Read API.
The Read API can be used to read data from BigQuery.
New code should use the v1 Read API going forward, if they don't
use Write API at the same time.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ class BigQueryReadGrpcTransport(BigQueryReadTransport):
"""gRPC backend transport for BigQueryRead.
BigQuery Read API.
The Read API can be used to read data from BigQuery.
New code should use the v1 Read API going forward, if they don't
use Write API at the same time.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ class BigQueryReadGrpcAsyncIOTransport(BigQueryReadTransport):
"""gRPC AsyncIO backend transport for BigQueryRead.
BigQuery Read API.
The Read API can be used to read data from BigQuery.
New code should use the v1 Read API going forward, if they don't
use Write API at the same time.
Expand Down
1 change: 1 addition & 0 deletions google/cloud/bigquery_storage_v1beta2/types/arrow.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class ArrowSchema(proto.Message):
serialized to bytes using IPC:

https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc

See code samples on how this message can be deserialized.

Attributes:
Expand Down