BigQueryReadClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.bigquery_storage_v1beta2.services.big_query_read.transports.base.BigQueryReadTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)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.
Inheritance
builtins.object > BigQueryReadClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| BigQueryReadTransport | The transport used by the client instance. |
Methods
BigQueryReadClient
BigQueryReadClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.bigquery_storage_v1beta2.services.big_query_read.transports.base.BigQueryReadTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the big query read client.
| Name | Description |
| credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
| transport |
Union[str, BigQueryReadTransport]
The transport to use. If set to None, a transport is chosen automatically. |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
| client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_read_session
create_read_session(request: Optional[Union[google.cloud.bigquery_storage_v1beta2.types.storage.CreateReadSessionRequest, dict]] = None, *, parent: Optional[str] = None, read_session: Optional[google.cloud.bigquery_storage_v1beta2.types.stream.ReadSession] = None, max_stream_count: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new read session. A read session divides the contents of a BigQuery table into one or more streams, which can then be used to read data from the table. The read session also specifies properties of the data to be read, such as a list of columns or a push-down filter describing the rows to be returned.
A particular row can be read by at most one stream. When the caller has reached the end of each stream in the session, then all the data in the table has been read.
Data is assigned to each stream such that roughly the same number of rows can be read from each stream. Because the server-side unit for assigning data is collections of rows, the API does not guarantee that each stream will return the same number or rows. Additionally, the limits are enforced based on the number of pre-filtered rows, so some filters can lead to lopsided assignments.
Read sessions automatically expire 6 hours after they are created and do not require manual clean-up by the caller.
from google.cloud import bigquery_storage_v1beta2
def sample_create_read_session():
# Create a client
client = bigquery_storage_v1beta2.BigQueryReadClient()
# Initialize request argument(s)
request = bigquery_storage_v1beta2.CreateReadSessionRequest(
parent="parent_value",
)
# Make the request
response = client.create_read_session(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.bigquery_storage_v1beta2.types.CreateReadSessionRequest, dict]
The request object. Request message for |
| parent |
str
Required. The request project that owns the session, in the form of |
| read_session |
google.cloud.bigquery_storage_v1beta2.types.ReadSession
Required. Session to be created. This corresponds to the |
| max_stream_count |
int
Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. Error will be returned if the max count is greater than the current system max limit of 1,000. Streams must be read starting from offset 0. This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.bigquery_storage_v1beta2.types.ReadSession | Information about the ReadSession. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| BigQueryReadClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| BigQueryReadClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| BigQueryReadClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Name | Description |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_read_session_path
parse_read_session_path(path: str)Parses a read_session path into its component segments.
parse_read_stream_path
parse_read_stream_path(path: str)Parses a read_stream path into its component segments.
parse_table_path
parse_table_path(path: str)Parses a table path into its component segments.
read_rows
read_rows(request: Optional[Union[google.cloud.bigquery_storage_v1beta2.types.storage.ReadRowsRequest, dict]] = None, *, read_stream: Optional[str] = None, offset: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Reads rows from the stream in the format prescribed by the ReadSession. Each response contains one or more table rows, up to a maximum of 100 MiB per response; read requests which attempt to read individual rows larger than 100 MiB will fail.
Each request also returns a set of stream statistics reflecting the current state of the stream.
from google.cloud import bigquery_storage_v1beta2
def sample_read_rows():
# Create a client
client = bigquery_storage_v1beta2.BigQueryReadClient()
# Initialize request argument(s)
request = bigquery_storage_v1beta2.ReadRowsRequest(
read_stream="read_stream_value",
)
# Make the request
stream = client.read_rows(request=request)
# Handle the response
for response in stream:
print(response)
| Name | Description |
| request |
Union[google.cloud.bigquery_storage_v1beta2.types.ReadRowsRequest, dict]
The request object. Request message for |
| read_stream |
str
Required. Stream to read rows from. This corresponds to the |
| offset |
int
The offset requested must be less than the last row read from Read. Requesting a larger offset is undefined. If not specified, start reading from offset zero. This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| Iterable[google.cloud.bigquery_storage_v1beta2.types.ReadRowsResponse] | Response from calling ReadRows may include row data, progress and throttling information. |
read_session_path
read_session_path(project: str, location: str, session: str)Returns a fully-qualified read_session string.
read_stream_path
read_stream_path(project: str, location: str, session: str, stream: str)Returns a fully-qualified read_stream string.
split_read_stream
split_read_stream(request: Optional[Union[google.cloud.bigquery_storage_v1beta2.types.storage.SplitReadStreamRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Splits a given ReadStream into two ReadStream objects.
These ReadStream objects are referred to as the primary and
the residual streams of the split. The original ReadStream
can still be read from in the same manner as before. Both of the
returned ReadStream objects can also be read from, and the
rows returned by both child streams will be the same as the rows
read from the original stream.
Moreover, the two child streams will be allocated back-to-back
in the original ReadStream. Concretely, it is guaranteed
that for streams original, primary, and residual, that
original[0-j] = primary[0-j] and original[j-n] = residual[0-m]
once the streams have been read to completion.
from google.cloud import bigquery_storage_v1beta2
def sample_split_read_stream():
# Create a client
client = bigquery_storage_v1beta2.BigQueryReadClient()
# Initialize request argument(s)
request = bigquery_storage_v1beta2.SplitReadStreamRequest(
name="name_value",
)
# Make the request
response = client.split_read_stream(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.bigquery_storage_v1beta2.types.SplitReadStreamRequest, dict]
The request object. Request message for |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
table_path
table_path(project: str, dataset: str, table: str)Returns a fully-qualified table string.