Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / sqladmin_v1beta4.databases.html
blob: 1cf37dabe246740a7a5c36a60e38a1926020fdcf [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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 Administration 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="#delete">delete(project, instance, database)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Deletes a database from a Cloud SQL instance.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(project, instance, database)</a></code></p>
82<p class="firstline">Retrieves a resource containing information about a database inside a Cloud SQL instance.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, instance, body)</a></code></p>
85<p class="firstline">Inserts a resource containing information about a database inside a Cloud SQL instance.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, instance)</a></code></p>
88<p class="firstline">Lists databases in the specified Cloud SQL instance.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(project, instance, database, body)</a></code></p>
91<p class="firstline">Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(project, instance, database, body)</a></code></p>
94<p class="firstline">Updates a resource containing information about a database inside a Cloud SQL instance.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(project, instance, database)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]98 <pre>Deletes a database from a Cloud SQL instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]99
100Args:
101 project: string, Project ID of the project that contains the instance. (required)
102 instance: string, Database instance ID. This does not include the project ID. (required)
103 database: string, Name of the database to be deleted in the instance. (required)
104
105Returns:
106 An object of the form:
107
108 { # An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.
109 "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
110 "importContext": { # Database instance import context. # The context for import operation, if applicable.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]111 "kind": "sql#importContext", # This is always sql#importContext.
112 "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]113 "fileType": "A String", # The file type for the specified uri.
114 # SQL: The file contains SQL statements.
115 # CSV: The file contains CSV data.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]116 "uri": "A String", # A path to the file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]117 "importUser": "A String", # The PostgreSQL user to use for this import operation. Defaults to cloudsqlsuperuser. Does not apply to MySQL instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]118 "csvImportOptions": { # Options for importing data as CSV.
119 "table": "A String", # The table to which CSV data is imported.
120 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
121 "A String",
122 ],
123 },
124 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]125 "kind": "sql#operation", # This is always sql#operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]126 "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.
127 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
128 "kind": "sql#exportContext", # This is always sql#exportContext.
129 "fileType": "A String", # The file type for the specified uri.
130 # SQL: The file contains SQL statements.
131 # CSV: The file contains CSV data.
132 "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 operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
133 "csvExportOptions": { # Options for exporting data as CSV.
134 "selectQuery": "A String", # The select query used to extract the data.
135 },
136 "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
137 "A String",
138 ],
139 "sqlExportOptions": { # Options for exporting data as SQL statements.
140 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
141 "A String",
142 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]143 "schemaOnly": True or False, # Export only schemas.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]144 },
145 },
146 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
147 "targetProject": "A String", # The project ID of the target instance related to this operation.
148 "targetId": "A String", # Name of the database instance related to this operation.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]149 "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 .
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]150 "targetLink": "A String",
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]151 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]152 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
153 "kind": "sql#operationErrors", # This is always sql#operationErrors.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]154 "errors": [ # The list of errors encountered while processing this operation.
155 { # Database instance operation error.
156 "kind": "sql#operationError", # This is always sql#operationError.
157 "code": "A String", # Identifies the specific error that occurred.
158 "message": "A String", # Additional information about the error encountered.
159 },
160 ],
161 },
162 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
163 "selfLink": "A String", # The URI of this resource.
164 "user": "A String", # The email address of the user who initiated this operation.
165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="get">get(project, instance, database)</code>
170 <pre>Retrieves a resource containing information about a database inside a Cloud SQL instance.
171
172Args:
173 project: string, Project ID of the project that contains the instance. (required)
174 instance: string, Database instance ID. This does not include the project ID. (required)
175 database: string, Name of the database in the instance. (required)
176
177Returns:
178 An object of the form:
179
180 { # A database resource inside a Cloud SQL instance.
181 "kind": "sql#database", # This is always sql#database.
182 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
183 "charset": "A String", # The MySQL charset value.
184 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
185 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
186 "etag": "A String", # HTTP 1.1 Entity tag for the resource.
187 "collation": "A String", # The MySQL collation value.
188 "selfLink": "A String", # The URI of this resource.
189 }</pre>
190</div>
191
192<div class="method">
193 <code class="details" id="insert">insert(project, instance, body)</code>
194 <pre>Inserts a resource containing information about a database inside a Cloud SQL instance.
195
196Args:
197 project: string, Project ID of the project that contains the instance. (required)
198 instance: string, Database instance ID. This does not include the project ID. (required)
199 body: object, The request body. (required)
200 The object takes the form of:
201
202{ # A database resource inside a Cloud SQL instance.
203 "kind": "sql#database", # This is always sql#database.
204 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
205 "charset": "A String", # The MySQL charset value.
206 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
207 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
208 "etag": "A String", # HTTP 1.1 Entity tag for the resource.
209 "collation": "A String", # The MySQL collation value.
210 "selfLink": "A String", # The URI of this resource.
211 }
212
213
214Returns:
215 An object of the form:
216
217 { # An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.
218 "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
219 "importContext": { # Database instance import context. # The context for import operation, if applicable.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]220 "kind": "sql#importContext", # This is always sql#importContext.
221 "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]222 "fileType": "A String", # The file type for the specified uri.
223 # SQL: The file contains SQL statements.
224 # CSV: The file contains CSV data.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]225 "uri": "A String", # A path to the file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]226 "importUser": "A String", # The PostgreSQL user to use for this import operation. Defaults to cloudsqlsuperuser. Does not apply to MySQL instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]227 "csvImportOptions": { # Options for importing data as CSV.
228 "table": "A String", # The table to which CSV data is imported.
229 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
230 "A String",
231 ],
232 },
233 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]234 "kind": "sql#operation", # This is always sql#operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]235 "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.
236 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
237 "kind": "sql#exportContext", # This is always sql#exportContext.
238 "fileType": "A String", # The file type for the specified uri.
239 # SQL: The file contains SQL statements.
240 # CSV: The file contains CSV data.
241 "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 operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
242 "csvExportOptions": { # Options for exporting data as CSV.
243 "selectQuery": "A String", # The select query used to extract the data.
244 },
245 "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
246 "A String",
247 ],
248 "sqlExportOptions": { # Options for exporting data as SQL statements.
249 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
250 "A String",
251 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]252 "schemaOnly": True or False, # Export only schemas.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]253 },
254 },
255 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
256 "targetProject": "A String", # The project ID of the target instance related to this operation.
257 "targetId": "A String", # Name of the database instance related to this operation.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]258 "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 .
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]259 "targetLink": "A String",
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]260 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]261 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
262 "kind": "sql#operationErrors", # This is always sql#operationErrors.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]263 "errors": [ # The list of errors encountered while processing this operation.
264 { # Database instance operation error.
265 "kind": "sql#operationError", # This is always sql#operationError.
266 "code": "A String", # Identifies the specific error that occurred.
267 "message": "A String", # Additional information about the error encountered.
268 },
269 ],
270 },
271 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
272 "selfLink": "A String", # The URI of this resource.
273 "user": "A String", # The email address of the user who initiated this operation.
274 }</pre>
275</div>
276
277<div class="method">
278 <code class="details" id="list">list(project, instance)</code>
279 <pre>Lists databases in the specified Cloud SQL instance.
280
281Args:
282 project: string, Project ID of the project for which to list Cloud SQL instances. (required)
283 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
284
285Returns:
286 An object of the form:
287
288 { # Database list response.
289 "items": [ # List of database resources in the instance.
290 { # A database resource inside a Cloud SQL instance.
291 "kind": "sql#database", # This is always sql#database.
292 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
293 "charset": "A String", # The MySQL charset value.
294 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
295 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
296 "etag": "A String", # HTTP 1.1 Entity tag for the resource.
297 "collation": "A String", # The MySQL collation value.
298 "selfLink": "A String", # The URI of this resource.
299 },
300 ],
301 "kind": "sql#databasesList", # This is always sql#databasesList.
302 }</pre>
303</div>
304
305<div class="method">
306 <code class="details" id="patch">patch(project, instance, database, body)</code>
307 <pre>Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.
308
309Args:
310 project: string, Project ID of the project that contains the instance. (required)
311 instance: string, Database instance ID. This does not include the project ID. (required)
312 database: string, Name of the database to be updated in the instance. (required)
313 body: object, The request body. (required)
314 The object takes the form of:
315
316{ # A database resource inside a Cloud SQL instance.
317 "kind": "sql#database", # This is always sql#database.
318 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
319 "charset": "A String", # The MySQL charset value.
320 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
321 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
322 "etag": "A String", # HTTP 1.1 Entity tag for the resource.
323 "collation": "A String", # The MySQL collation value.
324 "selfLink": "A String", # The URI of this resource.
325 }
326
327
328Returns:
329 An object of the form:
330
331 { # An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.
332 "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
333 "importContext": { # Database instance import context. # The context for import operation, if applicable.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]334 "kind": "sql#importContext", # This is always sql#importContext.
335 "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]336 "fileType": "A String", # The file type for the specified uri.
337 # SQL: The file contains SQL statements.
338 # CSV: The file contains CSV data.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]339 "uri": "A String", # A path to the file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]340 "importUser": "A String", # The PostgreSQL user to use for this import operation. Defaults to cloudsqlsuperuser. Does not apply to MySQL instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]341 "csvImportOptions": { # Options for importing data as CSV.
342 "table": "A String", # The table to which CSV data is imported.
343 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
344 "A String",
345 ],
346 },
347 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]348 "kind": "sql#operation", # This is always sql#operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]349 "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.
350 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
351 "kind": "sql#exportContext", # This is always sql#exportContext.
352 "fileType": "A String", # The file type for the specified uri.
353 # SQL: The file contains SQL statements.
354 # CSV: The file contains CSV data.
355 "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 operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
356 "csvExportOptions": { # Options for exporting data as CSV.
357 "selectQuery": "A String", # The select query used to extract the data.
358 },
359 "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
360 "A String",
361 ],
362 "sqlExportOptions": { # Options for exporting data as SQL statements.
363 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
364 "A String",
365 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]366 "schemaOnly": True or False, # Export only schemas.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]367 },
368 },
369 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
370 "targetProject": "A String", # The project ID of the target instance related to this operation.
371 "targetId": "A String", # Name of the database instance related to this operation.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]372 "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 .
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]373 "targetLink": "A String",
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]374 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]375 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
376 "kind": "sql#operationErrors", # This is always sql#operationErrors.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]377 "errors": [ # The list of errors encountered while processing this operation.
378 { # Database instance operation error.
379 "kind": "sql#operationError", # This is always sql#operationError.
380 "code": "A String", # Identifies the specific error that occurred.
381 "message": "A String", # Additional information about the error encountered.
382 },
383 ],
384 },
385 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
386 "selfLink": "A String", # The URI of this resource.
387 "user": "A String", # The email address of the user who initiated this operation.
388 }</pre>
389</div>
390
391<div class="method">
392 <code class="details" id="update">update(project, instance, database, body)</code>
393 <pre>Updates a resource containing information about a database inside a Cloud SQL instance.
394
395Args:
396 project: string, Project ID of the project that contains the instance. (required)
397 instance: string, Database instance ID. This does not include the project ID. (required)
398 database: string, Name of the database to be updated in the instance. (required)
399 body: object, The request body. (required)
400 The object takes the form of:
401
402{ # A database resource inside a Cloud SQL instance.
403 "kind": "sql#database", # This is always sql#database.
404 "name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
405 "charset": "A String", # The MySQL charset value.
406 "project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
407 "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.
408 "etag": "A String", # HTTP 1.1 Entity tag for the resource.
409 "collation": "A String", # The MySQL collation value.
410 "selfLink": "A String", # The URI of this resource.
411 }
412
413
414Returns:
415 An object of the form:
416
417 { # An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.
418 "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
419 "importContext": { # Database instance import context. # The context for import operation, if applicable.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]420 "kind": "sql#importContext", # This is always sql#importContext.
421 "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]422 "fileType": "A String", # The file type for the specified uri.
423 # SQL: The file contains SQL statements.
424 # CSV: The file contains CSV data.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]425 "uri": "A String", # A path to the file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]426 "importUser": "A String", # The PostgreSQL user to use for this import operation. Defaults to cloudsqlsuperuser. Does not apply to MySQL instances.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]427 "csvImportOptions": { # Options for importing data as CSV.
428 "table": "A String", # The table to which CSV data is imported.
429 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
430 "A String",
431 ],
432 },
433 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]434 "kind": "sql#operation", # This is always sql#operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]435 "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.
436 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
437 "kind": "sql#exportContext", # This is always sql#exportContext.
438 "fileType": "A String", # The file type for the specified uri.
439 # SQL: The file contains SQL statements.
440 # CSV: The file contains CSV data.
441 "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 operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
442 "csvExportOptions": { # Options for exporting data as CSV.
443 "selectQuery": "A String", # The select query used to extract the data.
444 },
445 "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
446 "A String",
447 ],
448 "sqlExportOptions": { # Options for exporting data as SQL statements.
449 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
450 "A String",
451 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]452 "schemaOnly": True or False, # Export only schemas.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]453 },
454 },
455 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
456 "targetProject": "A String", # The project ID of the target instance related to this operation.
457 "targetId": "A String", # Name of the database instance related to this operation.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]458 "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 .
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]459 "targetLink": "A String",
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]460 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]461 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
462 "kind": "sql#operationErrors", # This is always sql#operationErrors.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]463 "errors": [ # The list of errors encountered while processing this operation.
464 { # Database instance operation error.
465 "kind": "sql#operationError", # This is always sql#operationError.
466 "code": "A String", # Identifies the specific error that occurred.
467 "message": "A String", # Additional information about the error encountered.
468 },
469 ],
470 },
471 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
472 "selfLink": "A String", # The URI of this resource.
473 "user": "A String", # The email address of the user who initiated this operation.
474 }</pre>
475</div>
476
477</body></html>