Version 1.3 release.
Updates CHANGELOG, version, docs.
diff --git a/docs/dyn/sqladmin_v1beta3.instances.html b/docs/dyn/sqladmin_v1beta3.instances.html
index 90bcb6e..b69db8f 100644
--- a/docs/dyn/sqladmin_v1beta3.instances.html
+++ b/docs/dyn/sqladmin_v1beta3.instances.html
@@ -76,7 +76,7 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#clone">clone(project, body)</a></code></p>
-<p class="firstline">Creates a Cloud SQL instance as a clone of the source instance.</p>
+<p class="firstline">Creates a Cloud SQL instance as a clone of a source instance.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, instance)</a></code></p>
<p class="firstline">Deletes a Cloud SQL instance.</p>
@@ -85,25 +85,28 @@
<p class="firstline">Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.</p>
<p class="toc_element">
<code><a href="#get">get(project, instance)</a></code></p>
-<p class="firstline">Retrieves a resource containing information about a Cloud SQL instance.</p>
+<p class="firstline">Retrieves information about a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#import_">import_(project, instance, body)</a></code></p>
-<p class="firstline">Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage.</p>
+<p class="firstline">Imports data into a Cloud SQL instance from a MySQL dump file stored in a Google Cloud Storage bucket.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a new Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists instances under a given project in the alphabetical order of the instance name.</p>
+<p class="firstline">Lists instances for a given project, in alphabetical order by instance name.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, instance, body)</a></code></p>
-<p class="firstline">Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics.</p>
+<p class="firstline">Updates the settings of a Cloud SQL instance. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#promoteReplica">promoteReplica(project, instance)</a></code></p>
+<p class="firstline">Promotes the read replica instance to be a stand-alone Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#resetSslConfig">resetSslConfig(project, instance)</a></code></p>
-<p class="firstline">Deletes all client certificates and generates a new server SSL certificate for the instance. The changes will not take effect until the instance is restarted. Existing instances without a server certificate will need to call this once to set a server certificate.</p>
+<p class="firstline">Deletes all client certificates and generates a new server SSL certificate for a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#restart">restart(project, instance)</a></code></p>
<p class="firstline">Restarts a Cloud SQL instance.</p>
@@ -112,14 +115,14 @@
<p class="firstline">Restores a backup of a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#setRootPassword">setRootPassword(project, instance, body)</a></code></p>
-<p class="firstline">Sets the password for the root user.</p>
+<p class="firstline">Sets the password for the root user of the specified Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#update">update(project, instance, body)</a></code></p>
-<p class="firstline">Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.</p>
+<p class="firstline">Updates the settings of a Cloud SQL instance.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="clone">clone(project, body)</code>
- <pre>Creates a Cloud SQL instance as a clone of the source instance.
+ <pre>Creates a Cloud SQL instance as a clone of a source instance.
Args:
project: string, Project ID of the source as well as the clone Cloud SQL instance. (required)
@@ -129,7 +132,7 @@
{ # Database instance clone request.
"cloneContext": { # Database instance clone context. # Contains details about the clone operation.
"sourceInstanceName": "A String", # Name of the Cloud SQL instance to be cloned.
- "binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, indentify the the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordintes.
+ "binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, indentify the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
"binLogPosition": "A String", # Position (offset) within the binary log file.
"kind": "sql#binLogCoordinates", # This is always sql#binLogCoordinates.
"binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.
@@ -201,7 +204,7 @@
<div class="method">
<code class="details" id="get">get(project, instance)</code>
- <pre>Retrieves a resource containing information about a Cloud SQL instance.
+ <pre>Retrieves information about a Cloud SQL instance.
Args:
project: string, Project ID of the project that contains the instance. (required)
@@ -224,16 +227,19 @@
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
},
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
"region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS.) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported. log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off wait_timeout 1..31536000
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
"value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
"A String",
],
"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
@@ -256,16 +262,18 @@
"A String",
],
},
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an AppEngine app or GCE zone for better perfomance.
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
"kind": "sql#locationPreference", # This is always sql#locationPreference.
"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
- "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
@@ -281,13 +289,16 @@
"ipAddress": "A String", # The IP address assigned.
},
],
- "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion can not be changed after instance creation.
+ "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
+ # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
}</pre>
</div>
<div class="method">
<code class="details" id="import_">import_(project, instance, body)</code>
- <pre>Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage.
+ <pre>Imports data into a Cloud SQL instance from a MySQL dump file stored in a Google Cloud Storage bucket.
Args:
project: string, Project ID of the project that contains the instance. (required)
@@ -338,16 +349,19 @@
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
},
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
"region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS.) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported. log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off wait_timeout 1..31536000
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
"value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
"A String",
],
"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
@@ -370,16 +384,18 @@
"A String",
],
},
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an AppEngine app or GCE zone for better perfomance.
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
"kind": "sql#locationPreference", # This is always sql#locationPreference.
"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
- "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
@@ -395,7 +411,10 @@
"ipAddress": "A String", # The IP address assigned.
},
],
- "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion can not be changed after instance creation.
+ "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
+ # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
}
@@ -410,7 +429,7 @@
<div class="method">
<code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
- <pre>Lists instances under a given project in the alphabetical order of the instance name.
+ <pre>Lists instances for a given project, in alphabetical order by instance name.
Args:
project: string, Project ID of the project for which to list Cloud SQL instances. (required)
@@ -437,16 +456,19 @@
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
},
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
"region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS.) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported. log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off wait_timeout 1..31536000
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
"value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
"A String",
],
"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
@@ -469,16 +491,18 @@
"A String",
],
},
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an AppEngine app or GCE zone for better perfomance.
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
"kind": "sql#locationPreference", # This is always sql#locationPreference.
"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
- "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
@@ -494,7 +518,10 @@
"ipAddress": "A String", # The IP address assigned.
},
],
- "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion can not be changed after instance creation.
+ "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
+ # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
},
],
"kind": "sql#instancesList", # This is always sql#instancesList.
@@ -517,7 +544,7 @@
<div class="method">
<code class="details" id="patch">patch(project, instance, body)</code>
- <pre>Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics.
+ <pre>Updates the settings of a Cloud SQL instance. This method supports patch semantics.
Args:
project: string, Project ID of the project that contains the instance. (required)
@@ -539,16 +566,19 @@
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
},
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
"region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS.) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported. log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off wait_timeout 1..31536000
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
"value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
"A String",
],
"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
@@ -571,16 +601,18 @@
"A String",
],
},
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an AppEngine app or GCE zone for better perfomance.
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
"kind": "sql#locationPreference", # This is always sql#locationPreference.
"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
- "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
@@ -596,7 +628,10 @@
"ipAddress": "A String", # The IP address assigned.
},
],
- "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion can not be changed after instance creation.
+ "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
+ # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
}
@@ -610,8 +645,25 @@
</div>
<div class="method">
+ <code class="details" id="promoteReplica">promoteReplica(project, instance)</code>
+ <pre>Promotes the read replica instance to be a stand-alone Cloud SQL instance.
+
+Args:
+ project: string, ID of the project that contains the read replica. (required)
+ instance: string, Cloud SQL read replica instance name. (required)
+
+Returns:
+ An object of the form:
+
+ { # Database promote read replica response.
+ "kind": "sql#instancesPromoteReplica", # This is always sql#instancesPromoteReplica.
+ "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="resetSslConfig">resetSslConfig(project, instance)</code>
- <pre>Deletes all client certificates and generates a new server SSL certificate for the instance. The changes will not take effect until the instance is restarted. Existing instances without a server certificate will need to call this once to set a server certificate.
+ <pre>Deletes all client certificates and generates a new server SSL certificate for a Cloud SQL instance.
Args:
project: string, Project ID of the project that contains the instance. (required)
@@ -664,7 +716,7 @@
<div class="method">
<code class="details" id="setRootPassword">setRootPassword(project, instance, body)</code>
- <pre>Sets the password for the root user.
+ <pre>Sets the password for the root user of the specified Cloud SQL instance.
Args:
project: string, Project ID of the project that contains the instance. (required)
@@ -691,7 +743,7 @@
<div class="method">
<code class="details" id="update">update(project, instance, body)</code>
- <pre>Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.
+ <pre>Updates the settings of a Cloud SQL instance.
Args:
project: string, Project ID of the project that contains the instance. (required)
@@ -713,16 +765,19 @@
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
},
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
"region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS.) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported. log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off wait_timeout 1..31536000
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
"value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance.
"A String",
],
"activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
@@ -745,16 +800,18 @@
"A String",
],
},
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instance. Indicates whether replication is enabled or not.
"replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
"tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
"settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
- "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an AppEngine app or GCE zone for better perfomance.
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.
"kind": "sql#locationPreference", # This is always sql#locationPreference.
"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).
- "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
+ "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance.
},
},
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
"currentDiskSize": "A String", # The current disk usage of the instance in bytes.
"instance": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
"state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following.
@@ -770,7 +827,10 @@
"ipAddress": "A String", # The IP address assigned.
},
],
- "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion can not be changed after instance creation.
+ "databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
+ # READ_REPLICA_INSTANCE: Cloud SQL instance acting as a read-replica.
}