Google Cloud Sql Admin V1 Client - Class SqlDatabasesServiceClient (0.8.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlDatabasesServiceClient.

Service Description: Service to manage databases.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Sql \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
options array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

delete

Deletes a database from a Cloud SQL instance.

The async variant is Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient::deleteAsync() .

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesDeleteRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Sql\V1\Operation
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient;
use Google\Cloud\Sql\V1\Operation;
use Google\Cloud\Sql\V1\SqlDatabasesDeleteRequest;

/**
 * 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 delete_sample(): void
{
    // Create a client.
    $sqlDatabasesServiceClient = new SqlDatabasesServiceClient();

    // Prepare the request message.
    $request = new SqlDatabasesDeleteRequest();

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

get

Retrieves a resource containing information about a database inside a Cloud SQL instance.

The async variant is Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient::getAsync() .

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesGetRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Sql\V1\Database
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient;
use Google\Cloud\Sql\V1\Database;
use Google\Cloud\Sql\V1\SqlDatabasesGetRequest;

/**
 * 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 get_sample(): void
{
    // Create a client.
    $sqlDatabasesServiceClient = new SqlDatabasesServiceClient();

    // Prepare the request message.
    $request = new SqlDatabasesGetRequest();

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

insert

Inserts a resource containing information about a database inside a Cloud SQL instance.

Note: You can't modify the default character set and collation.

The async variant is Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient::insertAsync() .

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesInsertRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Sql\V1\Operation
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient;
use Google\Cloud\Sql\V1\Operation;
use Google\Cloud\Sql\V1\SqlDatabasesInsertRequest;

/**
 * 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 insert_sample(): void
{
    // Create a client.
    $sqlDatabasesServiceClient = new SqlDatabasesServiceClient();

    // Prepare the request message.
    $request = new SqlDatabasesInsertRequest();

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

list

Lists databases in the specified Cloud SQL instance.

The async variant is Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient::listAsync() .

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesListRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Sql\V1\DatabasesListResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient;
use Google\Cloud\Sql\V1\DatabasesListResponse;
use Google\Cloud\Sql\V1\SqlDatabasesListRequest;

/**
 * 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 list_sample(): void
{
    // Create a client.
    $sqlDatabasesServiceClient = new SqlDatabasesServiceClient();

    // Prepare the request message.
    $request = new SqlDatabasesListRequest();

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

patch

Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.

The async variant is Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient::patchAsync() .

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesUpdateRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Sql\V1\Operation
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient;
use Google\Cloud\Sql\V1\Operation;
use Google\Cloud\Sql\V1\SqlDatabasesUpdateRequest;

/**
 * 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 patch_sample(): void
{
    // Create a client.
    $sqlDatabasesServiceClient = new SqlDatabasesServiceClient();

    // Prepare the request message.
    $request = new SqlDatabasesUpdateRequest();

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

update

Updates a resource containing information about a database inside a Cloud SQL instance.

The async variant is Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient::updateAsync() .

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesUpdateRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Sql\V1\Operation
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlDatabasesServiceClient;
use Google\Cloud\Sql\V1\Operation;
use Google\Cloud\Sql\V1\SqlDatabasesUpdateRequest;

/**
 * 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 update_sample(): void
{
    // Create a client.
    $sqlDatabasesServiceClient = new SqlDatabasesServiceClient();

    // Prepare the request message.
    $request = new SqlDatabasesUpdateRequest();

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

deleteAsync

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesDeleteRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getAsync

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesGetRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

insertAsync

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesInsertRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listAsync

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesListRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

patchAsync

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesUpdateRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateAsync

Parameters
NameDescription
request Google\Cloud\Sql\V1\SqlDatabasesUpdateRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface