1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.databases.html">databases</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, instance, database, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a database from a Cloud SQL instance.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, instance, database, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a resource containing information about a database inside a Cloud SQL instance.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Inserts a resource containing information about a database inside a Cloud SQL instance.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists databases in the specified Cloud SQL instance.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(project, instance, database, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(project, instance, database, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a resource containing information about a database inside a Cloud SQL instance.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="delete">delete(project, instance, database, x__xgafv=None)</code> 106 <pre>Deletes a database from a Cloud SQL instance. 107 108Args: 109 project: string, Project ID of the project that contains the instance. (required) 110 instance: string, Database instance ID. This does not include the project ID. (required) 111 database: string, Name of the database to be deleted in the instance. (required) 112 x__xgafv: string, V1 error format. 113 Allowed values 114 1 - v1 error format 115 2 - v2 error format 116 117Returns: 118 An object of the form: 119 120 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 121 "backupContext": { # Backup context. # The context for backup operation, if applicable. 122 "backupId": "A String", # The identifier of the backup. 123 "kind": "A String", # This is always **sql#backupContext**. 124 }, 125 "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 126 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 127 "errors": [ # The list of errors encountered while processing this operation. 128 { # Database instance operation error. 129 "code": "A String", # Identifies the specific error that occurred. 130 "kind": "A String", # This is always **sql#operationError**. 131 "message": "A String", # Additional information about the error encountered. 132 }, 133 ], 134 "kind": "A String", # This is always **sql#operationErrors**. 135 }, 136 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 137 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 138 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 139 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 140 "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. 141 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 142 "selectQuery": "A String", # The select query used to extract the data. 143 }, 144 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 145 "A String", 146 ], 147 "fileType": "A String", # The file type for the specified uri. 148 "kind": "A String", # This is always **sql#exportContext**. 149 "offload": True or False, # Option for export offload. 150 "sqlExportOptions": { # Options for exporting data as SQL statements. 151 "mysqlExportOptions": { # Options for exporting from MySQL. 152 "masterData": 42, # Option to include SQL statement required to set up replication. If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF. 153 }, 154 "schemaOnly": True or False, # Export only schemas. 155 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table. 156 "A String", 157 ], 158 }, 159 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 160 }, 161 "importContext": { # Database instance import context. # The context for import operation, if applicable. 162 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 163 "encryptionOptions": { 164 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 165 "pvkPassword": "A String", # Password that encrypts the private key 166 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 167 }, 168 }, 169 "csvImportOptions": { # Options for importing data as CSV. 170 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 171 "A String", 172 ], 173 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 174 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 175 "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. 176 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 177 "table": "A String", # The table to which CSV data is imported. 178 }, 179 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 180 "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. 181 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 182 "kind": "A String", # This is always **sql#importContext**. 183 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 184 }, 185 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 186 "kind": "A String", # This is always **sql#operation**. 187 "name": "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. 188 "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** 189 "selfLink": "A String", # The URI of this resource. 190 "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 191 "status": "A String", # The status of an operation. 192 "targetId": "A String", # Name of the database instance related to this operation. 193 "targetLink": "A String", 194 "targetProject": "A String", # The project ID of the target instance related to this operation. 195 "user": "A String", # The email address of the user who initiated this operation. 196}</pre> 197</div> 198 199<div class="method"> 200 <code class="details" id="get">get(project, instance, database, x__xgafv=None)</code> 201 <pre>Retrieves a resource containing information about a database inside a Cloud SQL instance. 202 203Args: 204 project: string, Project ID of the project that contains the instance. (required) 205 instance: string, Database instance ID. This does not include the project ID. (required) 206 database: string, Name of the database in the instance. (required) 207 x__xgafv: string, V1 error format. 208 Allowed values 209 1 - v1 error format 210 2 - v2 error format 211 212Returns: 213 An object of the form: 214 215 { # Represents a SQL database on the Cloud SQL instance. 216 "charset": "A String", # The Cloud SQL charset value. 217 "collation": "A String", # The Cloud SQL collation value. 218 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. 219 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. 220 "kind": "A String", # This is always **sql#database**. 221 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. 222 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. 223 "selfLink": "A String", # The URI of this resource. 224 "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance. 225 "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible 226 "recoveryModel": "A String", # The recovery model of a SQL Server database 227 }, 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code> 233 <pre>Inserts a resource containing information about a database inside a Cloud SQL instance. 234 235Args: 236 project: string, Project ID of the project that contains the instance. (required) 237 instance: string, Database instance ID. This does not include the project ID. (required) 238 body: object, The request body. 239 The object takes the form of: 240 241{ # Represents a SQL database on the Cloud SQL instance. 242 "charset": "A String", # The Cloud SQL charset value. 243 "collation": "A String", # The Cloud SQL collation value. 244 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. 245 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. 246 "kind": "A String", # This is always **sql#database**. 247 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. 248 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. 249 "selfLink": "A String", # The URI of this resource. 250 "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance. 251 "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible 252 "recoveryModel": "A String", # The recovery model of a SQL Server database 253 }, 254} 255 256 x__xgafv: string, V1 error format. 257 Allowed values 258 1 - v1 error format 259 2 - v2 error format 260 261Returns: 262 An object of the form: 263 264 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 265 "backupContext": { # Backup context. # The context for backup operation, if applicable. 266 "backupId": "A String", # The identifier of the backup. 267 "kind": "A String", # This is always **sql#backupContext**. 268 }, 269 "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 270 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 271 "errors": [ # The list of errors encountered while processing this operation. 272 { # Database instance operation error. 273 "code": "A String", # Identifies the specific error that occurred. 274 "kind": "A String", # This is always **sql#operationError**. 275 "message": "A String", # Additional information about the error encountered. 276 }, 277 ], 278 "kind": "A String", # This is always **sql#operationErrors**. 279 }, 280 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 281 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 282 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 283 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 284 "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. 285 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 286 "selectQuery": "A String", # The select query used to extract the data. 287 }, 288 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 289 "A String", 290 ], 291 "fileType": "A String", # The file type for the specified uri. 292 "kind": "A String", # This is always **sql#exportContext**. 293 "offload": True or False, # Option for export offload. 294 "sqlExportOptions": { # Options for exporting data as SQL statements. 295 "mysqlExportOptions": { # Options for exporting from MySQL. 296 "masterData": 42, # Option to include SQL statement required to set up replication. If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF. 297 }, 298 "schemaOnly": True or False, # Export only schemas. 299 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table. 300 "A String", 301 ], 302 }, 303 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 304 }, 305 "importContext": { # Database instance import context. # The context for import operation, if applicable. 306 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 307 "encryptionOptions": { 308 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 309 "pvkPassword": "A String", # Password that encrypts the private key 310 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 311 }, 312 }, 313 "csvImportOptions": { # Options for importing data as CSV. 314 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 315 "A String", 316 ], 317 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 318 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 319 "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. 320 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 321 "table": "A String", # The table to which CSV data is imported. 322 }, 323 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 324 "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. 325 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 326 "kind": "A String", # This is always **sql#importContext**. 327 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 328 }, 329 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 330 "kind": "A String", # This is always **sql#operation**. 331 "name": "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. 332 "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** 333 "selfLink": "A String", # The URI of this resource. 334 "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 335 "status": "A String", # The status of an operation. 336 "targetId": "A String", # Name of the database instance related to this operation. 337 "targetLink": "A String", 338 "targetProject": "A String", # The project ID of the target instance related to this operation. 339 "user": "A String", # The email address of the user who initiated this operation. 340}</pre> 341</div> 342 343<div class="method"> 344 <code class="details" id="list">list(project, instance, x__xgafv=None)</code> 345 <pre>Lists databases in the specified Cloud SQL instance. 346 347Args: 348 project: string, Project ID of the project that contains the instance. (required) 349 instance: string, Cloud SQL instance ID. This does not include the project ID. (required) 350 x__xgafv: string, V1 error format. 351 Allowed values 352 1 - v1 error format 353 2 - v2 error format 354 355Returns: 356 An object of the form: 357 358 { # Database list response. 359 "items": [ # List of database resources in the instance. 360 { # Represents a SQL database on the Cloud SQL instance. 361 "charset": "A String", # The Cloud SQL charset value. 362 "collation": "A String", # The Cloud SQL collation value. 363 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. 364 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. 365 "kind": "A String", # This is always **sql#database**. 366 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. 367 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. 368 "selfLink": "A String", # The URI of this resource. 369 "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance. 370 "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible 371 "recoveryModel": "A String", # The recovery model of a SQL Server database 372 }, 373 }, 374 ], 375 "kind": "A String", # This is always **sql#databasesList**. 376}</pre> 377</div> 378 379<div class="method"> 380 <code class="details" id="patch">patch(project, instance, database, body=None, x__xgafv=None)</code> 381 <pre>Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics. 382 383Args: 384 project: string, Project ID of the project that contains the instance. (required) 385 instance: string, Database instance ID. This does not include the project ID. (required) 386 database: string, Name of the database to be updated in the instance. (required) 387 body: object, The request body. 388 The object takes the form of: 389 390{ # Represents a SQL database on the Cloud SQL instance. 391 "charset": "A String", # The Cloud SQL charset value. 392 "collation": "A String", # The Cloud SQL collation value. 393 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. 394 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. 395 "kind": "A String", # This is always **sql#database**. 396 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. 397 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. 398 "selfLink": "A String", # The URI of this resource. 399 "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance. 400 "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible 401 "recoveryModel": "A String", # The recovery model of a SQL Server database 402 }, 403} 404 405 x__xgafv: string, V1 error format. 406 Allowed values 407 1 - v1 error format 408 2 - v2 error format 409 410Returns: 411 An object of the form: 412 413 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 414 "backupContext": { # Backup context. # The context for backup operation, if applicable. 415 "backupId": "A String", # The identifier of the backup. 416 "kind": "A String", # This is always **sql#backupContext**. 417 }, 418 "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 419 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 420 "errors": [ # The list of errors encountered while processing this operation. 421 { # Database instance operation error. 422 "code": "A String", # Identifies the specific error that occurred. 423 "kind": "A String", # This is always **sql#operationError**. 424 "message": "A String", # Additional information about the error encountered. 425 }, 426 ], 427 "kind": "A String", # This is always **sql#operationErrors**. 428 }, 429 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 430 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 431 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 432 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 433 "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. 434 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 435 "selectQuery": "A String", # The select query used to extract the data. 436 }, 437 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 438 "A String", 439 ], 440 "fileType": "A String", # The file type for the specified uri. 441 "kind": "A String", # This is always **sql#exportContext**. 442 "offload": True or False, # Option for export offload. 443 "sqlExportOptions": { # Options for exporting data as SQL statements. 444 "mysqlExportOptions": { # Options for exporting from MySQL. 445 "masterData": 42, # Option to include SQL statement required to set up replication. If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF. 446 }, 447 "schemaOnly": True or False, # Export only schemas. 448 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table. 449 "A String", 450 ], 451 }, 452 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 453 }, 454 "importContext": { # Database instance import context. # The context for import operation, if applicable. 455 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 456 "encryptionOptions": { 457 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 458 "pvkPassword": "A String", # Password that encrypts the private key 459 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 460 }, 461 }, 462 "csvImportOptions": { # Options for importing data as CSV. 463 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 464 "A String", 465 ], 466 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 467 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 468 "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. 469 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 470 "table": "A String", # The table to which CSV data is imported. 471 }, 472 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 473 "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. 474 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 475 "kind": "A String", # This is always **sql#importContext**. 476 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 477 }, 478 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 479 "kind": "A String", # This is always **sql#operation**. 480 "name": "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. 481 "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** 482 "selfLink": "A String", # The URI of this resource. 483 "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 484 "status": "A String", # The status of an operation. 485 "targetId": "A String", # Name of the database instance related to this operation. 486 "targetLink": "A String", 487 "targetProject": "A String", # The project ID of the target instance related to this operation. 488 "user": "A String", # The email address of the user who initiated this operation. 489}</pre> 490</div> 491 492<div class="method"> 493 <code class="details" id="update">update(project, instance, database, body=None, x__xgafv=None)</code> 494 <pre>Updates a resource containing information about a database inside a Cloud SQL instance. 495 496Args: 497 project: string, Project ID of the project that contains the instance. (required) 498 instance: string, Database instance ID. This does not include the project ID. (required) 499 database: string, Name of the database to be updated in the instance. (required) 500 body: object, The request body. 501 The object takes the form of: 502 503{ # Represents a SQL database on the Cloud SQL instance. 504 "charset": "A String", # The Cloud SQL charset value. 505 "collation": "A String", # The Cloud SQL collation value. 506 "etag": "A String", # This field is deprecated and will be removed from a future version of the API. 507 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. 508 "kind": "A String", # This is always **sql#database**. 509 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. 510 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. 511 "selfLink": "A String", # The URI of this resource. 512 "sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance. 513 "compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible 514 "recoveryModel": "A String", # The recovery model of a SQL Server database 515 }, 516} 517 518 x__xgafv: string, V1 error format. 519 Allowed values 520 1 - v1 error format 521 2 - v2 error format 522 523Returns: 524 An object of the form: 525 526 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. 527 "backupContext": { # Backup context. # The context for backup operation, if applicable. 528 "backupId": "A String", # The identifier of the backup. 529 "kind": "A String", # This is always **sql#backupContext**. 530 }, 531 "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 532 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. 533 "errors": [ # The list of errors encountered while processing this operation. 534 { # Database instance operation error. 535 "code": "A String", # Identifies the specific error that occurred. 536 "kind": "A String", # This is always **sql#operationError**. 537 "message": "A String", # Additional information about the error encountered. 538 }, 539 ], 540 "kind": "A String", # This is always **sql#operationErrors**. 541 }, 542 "exportContext": { # Database instance export context. # The context for export operation, if applicable. 543 "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. 544 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 545 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 546 "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. 547 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 548 "selectQuery": "A String", # The select query used to extract the data. 549 }, 550 "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. 551 "A String", 552 ], 553 "fileType": "A String", # The file type for the specified uri. 554 "kind": "A String", # This is always **sql#exportContext**. 555 "offload": True or False, # Option for export offload. 556 "sqlExportOptions": { # Options for exporting data as SQL statements. 557 "mysqlExportOptions": { # Options for exporting from MySQL. 558 "masterData": 42, # Option to include SQL statement required to set up replication. If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF. 559 }, 560 "schemaOnly": True or False, # Export only schemas. 561 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table. 562 "A String", 563 ], 564 }, 565 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. 566 }, 567 "importContext": { # Database instance import context. # The context for import operation, if applicable. 568 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files 569 "encryptionOptions": { 570 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 571 "pvkPassword": "A String", # Password that encrypts the private key 572 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. 573 }, 574 }, 575 "csvImportOptions": { # Options for importing data as CSV. 576 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. 577 "A String", 578 ], 579 "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. 580 "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. 581 "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. 582 "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. 583 "table": "A String", # The table to which CSV data is imported. 584 }, 585 "database": "A String", # The target database for the import. If **fileType** is **SQL**, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If **fileType** is **CSV**, one database must be specified. 586 "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. 587 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. 588 "kind": "A String", # This is always **sql#importContext**. 589 "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. 590 }, 591 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 592 "kind": "A String", # This is always **sql#operation**. 593 "name": "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. 594 "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** 595 "selfLink": "A String", # The URI of this resource. 596 "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. 597 "status": "A String", # The status of an operation. 598 "targetId": "A String", # Name of the database instance related to this operation. 599 "targetLink": "A String", 600 "targetProject": "A String", # The project ID of the target instance related to this operation. 601 "user": "A String", # The email address of the user who initiated this operation. 602}</pre> 603</div> 604 605</body></html>