Google BigQuery Storage V1 Client - Class BigQueryWriteClient (2.1.2)

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\BigQuery\Storage\V1\AppendRowsRequest;
use Google\Cloud\BigQuery\Storage\V1\AppendRowsResponse;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryWriteClient;

/**
 * @param string $formattedWriteStream The write_stream identifies the append operation. It must be
 *                                     provided in the following scenarios:
 *
 *                                     * 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.
 *
 *                                     For explicitly created write streams, the format is:
 *
 *                                     * `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`
 *
 *                                     For the special default stream, the format is:
 *
 *                                     * `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}
 *
 *                                     * r2: {write_stream: /*omit*/}
 *
 *                                     * r3: {write_stream: /*omit*/}
 *
 *                                     * r4: {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 stream. Please see
 *                                     {@see BigQueryWriteClient::writeStreamName()} for help formatting this field.
 */
function append_rows_sample(string $formattedWriteStream): void
{
    // Create a client.
    $bigQueryWriteClient = new BigQueryWriteClient();

    // Prepare the request message.
    $request = (new AppendRowsRequest())
        ->setWriteStream($formattedWriteStream);

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $bigQueryWriteClient->appendRows();
        $stream->writeAll([$request,]);

        /** @var AppendRowsResponse $element */
        foreach ($stream->closeWriteAndReadAll() 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
{
    $formattedWriteStream = BigQueryWriteClient::writeStreamName(
        '[PROJECT]',
        '[DATASET]',
        '[TABLE]',
        '[STREAM]'
    );

    append_rows_sample($formattedWriteStream);
}

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Storage\V1\BatchCommitWriteStreamsRequest;
use Google\Cloud\BigQuery\Storage\V1\BatchCommitWriteStreamsResponse;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryWriteClient;

/**
 * @param string $formattedParent     Parent table that all the streams should belong to, in the form
 *                                    of `projects/{project}/datasets/{dataset}/tables/{table}`. Please see
 *                                    {@see BigQueryWriteClient::tableName()} for help formatting this field.
 * @param string $writeStreamsElement The group of streams that will be committed atomically.
 */
function batch_commit_write_streams_sample(
    string $formattedParent,
    string $writeStreamsElement
): void {
    // Create a client.
    $bigQueryWriteClient = new BigQueryWriteClient();

    // Prepare the request message.
    $writeStreams = [$writeStreamsElement,];
    $request = (new BatchCommitWriteStreamsRequest())
        ->setParent($formattedParent)
        ->setWriteStreams($writeStreams);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCommitWriteStreamsResponse $response */
        $response = $bigQueryWriteClient->batchCommitWriteStreams($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 = BigQueryWriteClient::tableName('[PROJECT]', '[DATASET]', '[TABLE]');
    $writeStreamsElement = '[WRITE_STREAMS]';

    batch_commit_write_streams_sample($formattedParent, $writeStreamsElement);
}

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryWriteClient;
use Google\Cloud\BigQuery\Storage\V1\CreateWriteStreamRequest;
use Google\Cloud\BigQuery\Storage\V1\WriteStream;

/**
 * @param string $formattedParent Reference to the table to which the stream belongs, in the format
 *                                of `projects/{project}/datasets/{dataset}/tables/{table}`. Please see
 *                                {@see BigQueryWriteClient::tableName()} for help formatting this field.
 */
function create_write_stream_sample(string $formattedParent): void
{
    // Create a client.
    $bigQueryWriteClient = new BigQueryWriteClient();

    // Prepare the request message.
    $writeStream = new WriteStream();
    $request = (new CreateWriteStreamRequest())
        ->setParent($formattedParent)
        ->setWriteStream($writeStream);

    // Call the API and handle any network failures.
    try {
        /** @var WriteStream $response */
        $response = $bigQueryWriteClient->createWriteStream($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 = BigQueryWriteClient::tableName('[PROJECT]', '[DATASET]', '[TABLE]');

    create_write_stream_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryWriteClient;
use Google\Cloud\BigQuery\Storage\V1\FinalizeWriteStreamRequest;
use Google\Cloud\BigQuery\Storage\V1\FinalizeWriteStreamResponse;

/**
 * @param string $formattedName Name of the stream to finalize, in the form of
 *                              `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`. Please see
 *                              {@see BigQueryWriteClient::writeStreamName()} for help formatting this field.
 */
function finalize_write_stream_sample(string $formattedName): void
{
    // Create a client.
    $bigQueryWriteClient = new BigQueryWriteClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var FinalizeWriteStreamResponse $response */
        $response = $bigQueryWriteClient->finalizeWriteStream($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 = BigQueryWriteClient::writeStreamName(
        '[PROJECT]',
        '[DATASET]',
        '[TABLE]',
        '[STREAM]'
    );

    finalize_write_stream_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryWriteClient;
use Google\Cloud\BigQuery\Storage\V1\FlushRowsRequest;
use Google\Cloud\BigQuery\Storage\V1\FlushRowsResponse;

/**
 * @param string $formattedWriteStream The stream that is the target of the flush operation. Please see
 *                                     {@see BigQueryWriteClient::writeStreamName()} for help formatting this field.
 */
function flush_rows_sample(string $formattedWriteStream): void
{
    // Create a client.
    $bigQueryWriteClient = new BigQueryWriteClient();

    // Prepare the request message.
    $request = (new FlushRowsRequest())
        ->setWriteStream($formattedWriteStream);

    // Call the API and handle any network failures.
    try {
        /** @var FlushRowsResponse $response */
        $response = $bigQueryWriteClient->flushRows($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
{
    $formattedWriteStream = BigQueryWriteClient::writeStreamName(
        '[PROJECT]',
        '[DATASET]',
        '[TABLE]',
        '[STREAM]'
    );

    flush_rows_sample($formattedWriteStream);
}

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Storage\V1\Client\BigQueryWriteClient;
use Google\Cloud\BigQuery\Storage\V1\GetWriteStreamRequest;
use Google\Cloud\BigQuery\Storage\V1\WriteStream;

/**
 * @param string $formattedName Name of the stream to get, in the form of
 *                              `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`. Please see
 *                              {@see BigQueryWriteClient::writeStreamName()} for help formatting this field.
 */
function get_write_stream_sample(string $formattedName): void
{
    // Create a client.
    $bigQueryWriteClient = new BigQueryWriteClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var WriteStream $response */
        $response = $bigQueryWriteClient->getWriteStream($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 = BigQueryWriteClient::writeStreamName(
        '[PROJECT]',
        '[DATASET]',
        '[TABLE]',
        '[STREAM]'
    );

    get_write_stream_sample($formattedName);
}