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