Google BigQuery Storage V1 Client - Class BigQueryReadClient (1.9.0)

Namespace

Methods

__construct

createReadSession

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryReadClient;
use Google\Cloud\BigQuery\Storage\V1\CreateReadSessionRequest;
use Google\Cloud\BigQuery\Storage\V1\ReadSession;

/**
 * @param string $formattedParent The request project that owns the session, in the form of
 *                                `projects/{project_id}`. Please see
 *                                {@see BigQueryReadClient::projectName()} for help formatting this field.
 */
function create_read_session_sample(string $formattedParent): void
{
    // Create a client.
    $bigQueryReadClient = new BigQueryReadClient();

    // Prepare the request message.
    $readSession = new ReadSession();
    $request = (new CreateReadSessionRequest())
        ->setParent($formattedParent)
        ->setReadSession($readSession);

    // Call the API and handle any network failures.
    try {
        /** @var ReadSession $response */
        $response = $bigQueryReadClient->createReadSession($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = BigQueryReadClient::projectName('[PROJECT]');

    create_read_session_sample($formattedParent);
}

readRows

use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryReadClient;
use Google\Cloud\BigQuery\Storage\V1\ReadRowsRequest;
use Google\Cloud\BigQuery\Storage\V1\ReadRowsResponse;

/**
 * @param string $formattedReadStream Stream to read rows from. Please see
 *                                    {@see BigQueryReadClient::readStreamName()} for help formatting this field.
 */
function read_rows_sample(string $formattedReadStream): void
{
    // Create a client.
    $bigQueryReadClient = new BigQueryReadClient();

    // Prepare the request message.
    $request = (new ReadRowsRequest())
        ->setReadStream($formattedReadStream);

    // Call the API and handle any network failures.
    try {
        /** @var ServerStream $stream */
        $stream = $bigQueryReadClient->readRows($request);

        /** @var ReadRowsResponse $element */
        foreach ($stream->readAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedReadStream = BigQueryReadClient::readStreamName(
        '[PROJECT]',
        '[LOCATION]',
        '[SESSION]',
        '[STREAM]'
    );

    read_rows_sample($formattedReadStream);
}

splitReadStream

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryReadClient;
use Google\Cloud\BigQuery\Storage\V1\SplitReadStreamRequest;
use Google\Cloud\BigQuery\Storage\V1\SplitReadStreamResponse;

/**
 * @param string $formattedName Name of the stream to split. Please see
 *                              {@see BigQueryReadClient::readStreamName()} for help formatting this field.
 */
function split_read_stream_sample(string $formattedName): void
{
    // Create a client.
    $bigQueryReadClient = new BigQueryReadClient();

    // Prepare the request message.
    $request = (new SplitReadStreamRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var SplitReadStreamResponse $response */
        $response = $bigQueryReadClient->splitReadStream($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = BigQueryReadClient::readStreamName(
        '[PROJECT]',
        '[LOCATION]',
        '[SESSION]',
        '[STREAM]'
    );

    split_read_stream_sample($formattedName);
}

createReadSessionAsync

splitReadStreamAsync

static::projectName

static::readSessionName

static::readStreamName

static::tableName

static::parseName