Google BigQuery Storage V1 Client - Class BigQueryReadClient (1.2.12)

Reference documentation and code samples for the Google BigQuery Storage V1 Client class BigQueryReadClient.

Service Description: BigQuery Read API.

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$bigQueryReadClient = new BigQueryReadClient();
try {
    $formattedParent = $bigQueryReadClient->projectName('[PROJECT]');
    $readSession = new ReadSession();
    $response = $bigQueryReadClient->createReadSession($formattedParent, $readSession);
} finally {
    $bigQueryReadClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Formats a string containing the fully-qualified path to represent a project resource.

Formats a string containing the fully-qualified path to represent a read_session resource.

Formats a string containing the fully-qualified path to represent a read_stream resource.

Formats a string containing the fully-qualified path to represent a table resource.

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• project: projects/{project}
• readSession: projects/{project}/locations/{location}/sessions/{session}
• readStream: projects/{project}/locations/{location}/sessions/{session}/streams/{stream}
• table: projects/{project}/datasets/{dataset}/tables/{table}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Constructor.

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 24 hours after they are created and do not require manual clean-up by the caller.

Sample code:

$bigQueryReadClient = new BigQueryReadClient();
try {
    $formattedParent = $bigQueryReadClient->projectName('[PROJECT]');
    $readSession = new ReadSession();
    $response = $bigQueryReadClient->createReadSession($formattedParent, $readSession);
} finally {
    $bigQueryReadClient->close();
}

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.

Sample code:

$bigQueryReadClient = new BigQueryReadClient();
try {
    $formattedReadStream = $bigQueryReadClient->readStreamName('[PROJECT]', '[LOCATION]', '[SESSION]', '[STREAM]');
    // Read all responses until the stream is complete
    $stream = $bigQueryReadClient->readRows($formattedReadStream);
    foreach ($stream->readAll() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $bigQueryReadClient->close();
}

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.

Sample code:

$bigQueryReadClient = new BigQueryReadClient();
try {
    $formattedName = $bigQueryReadClient->readStreamName('[PROJECT]', '[LOCATION]', '[SESSION]', '[STREAM]');
    $response = $bigQueryReadClient->splitReadStream($formattedName);
} finally {
    $bigQueryReadClient->close();
}

The name of the service.

The default address of the service.

The default port of the service.

The name of the code generator, to be included in the agent header.