1. class
  2. Google
  3. \
  4. Service
  5. \
  6. BigLakeService
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCatalogsDatabases

ProjectsLocationsCatalogsDatabases

class ProjectsLocationsCatalogsDatabases extends Resource (View source)

The "databases" collection of methods.

Typical usage is:

 $biglakeService = new Google\Service\BigLakeService(...);
 $databases = $biglakeService->projects_locations_catalogs_databases;

Methods

Database
create(string $parent, Database $postBody, array $optParams = [])

Creates a new database. (databases.create)

Database
delete(string $name, array $optParams = [])

Deletes an existing database specified by the database ID. (databases.delete)

Database
get(string $name, array $optParams = [])

Gets the database specified by the resource name. (databases.get)

ListDatabasesResponse
listProjectsLocationsCatalogsDatabases(string $parent, array $optParams = [])

List all databases in a specified catalog.

Database
patch(string $name, Database $postBody, array $optParams = [])

Updates an existing database specified by the database ID. (databases.patch)

Details

at line 47
Database create(string $parent, Database $postBody, array $optParams = [])

Creates a new database. (databases.create)

Parameters

string $parent

Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
Database $postBody
array $optParams

Optional parameters.

Return Value

Database

Exceptions

Exception

at line 63
Database delete(string $name, array $optParams = [])

Deletes an existing database specified by the database ID. (databases.delete)

Parameters

string $name

Required. The name of the database to delete. Format: pro jects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/da tabases/{database_id}
array $optParams

Optional parameters.

Return Value

Database

Exceptions

Exception

at line 79
Database get(string $name, array $optParams = [])

Gets the database specified by the resource name. (databases.get)

Parameters

string $name

Required. The name of the database to retrieve. Format: p rojects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/ databases/{database_id}
array $optParams

Optional parameters.

Return Value

Database

Exceptions

Exception

at line 105
ListDatabasesResponse listProjectsLocationsCatalogsDatabases(string $parent, array $optParams = [])

List all databases in a specified catalog.

(databases.listProjectsLocationsCatalogsDatabases)

Parameters

string $parent

Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
array $optParams

Optional parameters.

Return Value

ListDatabasesResponse

Exceptions

Exception

at line 127
Database patch(string $name, Database $postBody, array $optParams = [])

Updates an existing database specified by the database ID. (databases.patch)

Parameters

string $name

Output only. The resource name. Format: projects/{project _id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{datab ase_id}
Database $postBody
array $optParams

Optional parameters.

Return Value

Database

Exceptions

Exception