google_api_sql_admin v0.6.0 GoogleApi.SQLAdmin.V1beta4.Api.Databases View Source
API calls for all endpoints tagged Databases
.
Link to this section Summary
Functions
Deletes a database from a Cloud SQL instance.
Retrieves a resource containing information about a database inside a Cloud SQL instance.
Inserts a resource containing information about a database inside a Cloud SQL instance.
Lists databases in the specified Cloud SQL instance.
Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.
Updates a resource containing information about a database inside a Cloud SQL instance.
Link to this section Functions
sql_databases_delete(connection, project, instance, database, optional_params \\ [], opts \\ []) View Source
Deletes a database from a Cloud SQL instance.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Database instance ID. This does not include the project ID.
- database (String.t): Name of the database to be deleted in the instance.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success {:error, info} on failure
sql_databases_get(connection, project, instance, database, optional_params \\ [], opts \\ []) View Source
Retrieves a resource containing information about a database inside a Cloud SQL instance.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Database instance ID. This does not include the project ID.
- database (String.t): Name of the database in the instance.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Database{}} on success {:error, info} on failure
sql_databases_insert(connection, project, instance, optional_params \\ [], opts \\ []) View Source
Inserts a resource containing information about a database inside a Cloud SQL instance.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Database instance ID. This does not include the project ID.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (Database):
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success {:error, info} on failure
sql_databases_list(connection, project, instance, optional_params \\ [], opts \\ []) View Source
Lists databases in the specified Cloud SQL instance.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Cloud SQL instance ID. This does not include the project ID.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.DatabasesListResponse{}} on success {:error, info} on failure
sql_databases_patch(connection, project, instance, database, optional_params \\ [], opts \\ []) View Source
Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Database instance ID. This does not include the project ID.
- database (String.t): Name of the database to be updated in the instance.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (Database):
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success {:error, info} on failure
sql_databases_update(connection, project, instance, database, optional_params \\ [], opts \\ []) View Source
Updates a resource containing information about a database inside a Cloud SQL instance.
Parameters
- connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
- project (String.t): Project ID of the project that contains the instance.
- instance (String.t): Database instance ID. This does not include the project ID.
- database (String.t): Name of the database to be updated in the instance.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (Database):
Returns
{:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success {:error, info} on failure