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.
Namespace
Google \ Cloud \ Sql \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description | 
| options | arrayOptional. Options for configuring the service API wrapper. | 
| ↳ apiEndpoint | stringThe address of the API remote host. May optionally include the port, formatted as " 
 | 
| ↳ credentials | string|array|FetchAuthTokenInterface|CredentialsWrapperThe 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 | arrayOptions 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 | boolDetermines whether or not retries defined by the client configuration should be disabled. Defaults to  | 
| ↳ clientConfig | string|arrayClient 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|TransportInterfaceThe transport used for executing network requests. May be either the string  | 
| ↳ transportConfig | arrayConfiguration 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 | callableA 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 | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesDeleteRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry 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 | |
|---|---|
| Type | Description | 
| Google\Cloud\Sql\V1\Operation | |
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 | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesGetRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry 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 | |
|---|---|
| Type | Description | 
| Google\Cloud\Sql\V1\Database | |
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 | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesInsertRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry 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 | |
|---|---|
| Type | Description | 
| Google\Cloud\Sql\V1\Operation | |
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 | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesListRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry 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 | |
|---|---|
| Type | Description | 
| Google\Cloud\Sql\V1\DatabasesListResponse | |
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 | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesUpdateRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry 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 | |
|---|---|
| Type | Description | 
| Google\Cloud\Sql\V1\Operation | |
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 | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesUpdateRequestA request to house fields associated with the call. | 
| callOptions | arrayOptional. | 
| ↳ retrySettings | RetrySettings|arrayRetry 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 | |
|---|---|
| Type | Description | 
| Google\Cloud\Sql\V1\Operation | |
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 | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesDeleteRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
getAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesGetRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
insertAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesInsertRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
listAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesListRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
patchAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesUpdateRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |
updateAsync
| Parameters | |
|---|---|
| Name | Description | 
| request | Google\Cloud\Sql\V1\SqlDatabasesUpdateRequest | 
| optionalArgs = [] | array | 
| Returns | |
|---|---|
| Type | Description | 
| GuzzleHttp\Promise\PromiseInterface | |