Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ed7d3f9b61ac35e08a22b4995076a95451cf7c8 / . / docs / dyn / sql_v1beta4.databases.html
blob: d2390ad864397abc5b63ce131e989d01fdfbce71 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[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="sql_v1beta4.html">Cloud SQL Admin API</a> . <a href="sql_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, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a database from a Cloud SQL instance.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, instance, database, x__xgafv=None)</a></code></p>
82<p class="firstline">Retrieves a resource containing information about a database inside a Cloud</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Inserts a resource containing information about a database inside a Cloud</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, instance, x__xgafv=None)</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=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Partially updates a resource containing information about a database inside</p>
92<p class="toc_element">
93 <code><a href="#update">update(project, instance, database, body=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates a resource containing information about a database inside a Cloud</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(project, instance, database, x__xgafv=None)</code>
98 <pre>Deletes a database from a Cloud SQL instance.
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 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109Returns:
110 An object of the form:
111
112 { # An Operation resource.&amp;nbsp;For successful operations that return an
113 # Operation resource, only the fields relevant to the operation are populated
114 # in the resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]115 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
116 # identifier to retrieve the Operations resource that has information about
117 # the operation.
118 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
119 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
120 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
121 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
122 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
123 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
124 # either by using this property or by using the
125 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
126 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
127 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
128 # this database must match the one specified in the
129 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
130 &quot;A String&quot;,
131 ],
132 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
133 &quot;schemaOnly&quot;: True or False, # Export only schemas.
134 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
135 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
136 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
137 # a CHANGE MASTER TO statement with the binary log coordinates.
138 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
139 # a SQL comment, and has no effect.
140 # All other values are ignored.
141 },
142 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
143 # you specify tables, specify one and only one database. For PostgreSQL
144 # instances, you can specify only one table.
145 &quot;A String&quot;,
146 ],
147 },
148 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
149 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
150 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
151 # stored. The URI is in the form &lt;code&gt;gs:
152 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
153 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
154 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
155 # // compressed.
156 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
157 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
158 },
159 },
160 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
161 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
162 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
163 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
164 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
165 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
166 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
167 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
168 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
169 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
171 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
172 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
173 &quot;targetLink&quot;: &quot;A String&quot;,
174 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
175 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
176 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
177 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
178 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
179 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
180 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
181 # populated.
182 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
183 { # Database instance operation error.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]184 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]185 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
186 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 },
188 ],
189 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
190 },
191 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
192 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]193 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
195 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
196 # of the database table are loaded with CSV data.
197 &quot;A String&quot;,
198 ],
199 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
200 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
202 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
203 # specify a database, and is overridden by any database specification in the
204 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
205 # must be specified.
206 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
207 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
208 &quot;encryptionOptions&quot;: {
209 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
210 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
211 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
212 # write permissions to the bucket and read access to the file.
213 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
214 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
215 # write permissions to the bucket and read access to the file.
216 },
217 },
218 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
219 # &lt;code&gt;gs:
220 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
221 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
222 # // write permissions to the bucket and read access to the file.
223 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
224 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
225 },
226 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
227 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
228 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 }</pre>
230</div>
231
232<div class="method">
233 <code class="details" id="get">get(project, instance, database, x__xgafv=None)</code>
234 <pre>Retrieves a resource containing information about a database inside a Cloud
235SQL instance.
236
237Args:
238 project: string, Project ID of the project that contains the instance. (required)
239 instance: string, Database instance ID. This does not include the project ID. (required)
240 database: string, Name of the database in the instance. (required)
241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
245
246Returns:
247 An object of the form:
248
249 { # Represents a SQL database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]250 &quot;collation&quot;: &quot;A String&quot;, # The MySQL collation value.
251 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include
252 # the project ID or instance name.
253 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
254 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google
255 # apps domain is prefixed if applicable.
256 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
258 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
259 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
260 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#database&lt;/code&gt;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]262 &quot;charset&quot;: &quot;A String&quot;, # The MySQL charset value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the
264 # API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]265 }</pre>
266</div>
267
268<div class="method">
269 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
270 <pre>Inserts a resource containing information about a database inside a Cloud
271SQL instance.
272
273Args:
274 project: string, Project ID of the project that contains the instance. (required)
275 instance: string, Database instance ID. This does not include the project ID. (required)
276 body: object, The request body.
277 The object takes the form of:
278
279{ # Represents a SQL database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]280 &quot;collation&quot;: &quot;A String&quot;, # The MySQL collation value.
281 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include
282 # the project ID or instance name.
283 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
284 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google
285 # apps domain is prefixed if applicable.
286 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]287 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
288 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
289 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
290 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#database&lt;/code&gt;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]292 &quot;charset&quot;: &quot;A String&quot;, # The MySQL charset value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]293 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the
294 # API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]295}
296
297 x__xgafv: string, V1 error format.
298 Allowed values
299 1 - v1 error format
300 2 - v2 error format
301
302Returns:
303 An object of the form:
304
305 { # An Operation resource.&amp;nbsp;For successful operations that return an
306 # Operation resource, only the fields relevant to the operation are populated
307 # in the resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]308 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
309 # identifier to retrieve the Operations resource that has information about
310 # the operation.
311 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
312 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
313 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
314 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
315 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
316 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
317 # either by using this property or by using the
318 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
319 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
320 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
321 # this database must match the one specified in the
322 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
323 &quot;A String&quot;,
324 ],
325 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
326 &quot;schemaOnly&quot;: True or False, # Export only schemas.
327 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
328 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
329 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
330 # a CHANGE MASTER TO statement with the binary log coordinates.
331 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
332 # a SQL comment, and has no effect.
333 # All other values are ignored.
334 },
335 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
336 # you specify tables, specify one and only one database. For PostgreSQL
337 # instances, you can specify only one table.
338 &quot;A String&quot;,
339 ],
340 },
341 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
342 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
343 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
344 # stored. The URI is in the form &lt;code&gt;gs:
345 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
346 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
347 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
348 # // compressed.
349 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
350 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
351 },
352 },
353 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
354 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
355 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
356 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
357 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
358 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
359 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
360 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
361 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
362 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]363 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
364 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
365 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
366 &quot;targetLink&quot;: &quot;A String&quot;,
367 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
368 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
369 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
370 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
371 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
372 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
373 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
374 # populated.
375 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
376 { # Database instance operation error.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]377 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]378 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
379 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]380 },
381 ],
382 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
383 },
384 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
385 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]386 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]387 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
388 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
389 # of the database table are loaded with CSV data.
390 &quot;A String&quot;,
391 ],
392 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
393 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]394 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
395 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
396 # specify a database, and is overridden by any database specification in the
397 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
398 # must be specified.
399 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
400 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
401 &quot;encryptionOptions&quot;: {
402 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
403 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
404 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
405 # write permissions to the bucket and read access to the file.
406 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
407 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
408 # write permissions to the bucket and read access to the file.
409 },
410 },
411 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
412 # &lt;code&gt;gs:
413 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
414 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
415 # // write permissions to the bucket and read access to the file.
416 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
417 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
418 },
419 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
420 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
421 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]422 }</pre>
423</div>
424
425<div class="method">
426 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
427 <pre>Lists databases in the specified Cloud SQL instance.
428
429Args:
430 project: string, Project ID of the project that contains the instance. (required)
431 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
432 x__xgafv: string, V1 error format.
433 Allowed values
434 1 - v1 error format
435 2 - v2 error format
436
437Returns:
438 An object of the form:
439
440 { # Database list response.
441 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#databasesList&lt;/code&gt;.
442 &quot;items&quot;: [ # List of database resources in the instance.
443 { # Represents a SQL database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]444 &quot;collation&quot;: &quot;A String&quot;, # The MySQL collation value.
445 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include
446 # the project ID or instance name.
447 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
448 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google
449 # apps domain is prefixed if applicable.
450 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]451 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
452 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
453 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
454 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]455 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#database&lt;/code&gt;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]456 &quot;charset&quot;: &quot;A String&quot;, # The MySQL charset value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]457 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the
458 # API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]459 },
460 ],
461 }</pre>
462</div>
463
464<div class="method">
465 <code class="details" id="patch">patch(project, instance, database, body=None, x__xgafv=None)</code>
466 <pre>Partially updates a resource containing information about a database inside
467a Cloud SQL instance. This method supports patch semantics.
468
469Args:
470 project: string, Project ID of the project that contains the instance. (required)
471 instance: string, Database instance ID. This does not include the project ID. (required)
472 database: string, Name of the database to be updated in the instance. (required)
473 body: object, The request body.
474 The object takes the form of:
475
476{ # Represents a SQL database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]477 &quot;collation&quot;: &quot;A String&quot;, # The MySQL collation value.
478 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include
479 # the project ID or instance name.
480 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
481 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google
482 # apps domain is prefixed if applicable.
483 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]484 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
485 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
486 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
487 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]488 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#database&lt;/code&gt;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]489 &quot;charset&quot;: &quot;A String&quot;, # The MySQL charset value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]490 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the
491 # API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]492}
493
494 x__xgafv: string, V1 error format.
495 Allowed values
496 1 - v1 error format
497 2 - v2 error format
498
499Returns:
500 An object of the form:
501
502 { # An Operation resource.&amp;nbsp;For successful operations that return an
503 # Operation resource, only the fields relevant to the operation are populated
504 # in the resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]505 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
506 # identifier to retrieve the Operations resource that has information about
507 # the operation.
508 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
509 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
510 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
511 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
512 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
513 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
514 # either by using this property or by using the
515 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
516 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
517 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
518 # this database must match the one specified in the
519 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
520 &quot;A String&quot;,
521 ],
522 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
523 &quot;schemaOnly&quot;: True or False, # Export only schemas.
524 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
525 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
526 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
527 # a CHANGE MASTER TO statement with the binary log coordinates.
528 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
529 # a SQL comment, and has no effect.
530 # All other values are ignored.
531 },
532 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
533 # you specify tables, specify one and only one database. For PostgreSQL
534 # instances, you can specify only one table.
535 &quot;A String&quot;,
536 ],
537 },
538 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
539 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
540 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
541 # stored. The URI is in the form &lt;code&gt;gs:
542 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
543 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
544 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
545 # // compressed.
546 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
547 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
548 },
549 },
550 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
551 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
552 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
553 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
554 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
555 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
556 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
557 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
558 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
559 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]560 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
561 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
562 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
563 &quot;targetLink&quot;: &quot;A String&quot;,
564 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
565 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
566 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
567 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
568 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
569 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
570 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
571 # populated.
572 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
573 { # Database instance operation error.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]574 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]575 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
576 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]577 },
578 ],
579 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
580 },
581 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
582 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]583 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]584 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
585 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
586 # of the database table are loaded with CSV data.
587 &quot;A String&quot;,
588 ],
589 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
590 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]591 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
592 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
593 # specify a database, and is overridden by any database specification in the
594 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
595 # must be specified.
596 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
597 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
598 &quot;encryptionOptions&quot;: {
599 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
600 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
601 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
602 # write permissions to the bucket and read access to the file.
603 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
604 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
605 # write permissions to the bucket and read access to the file.
606 },
607 },
608 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
609 # &lt;code&gt;gs:
610 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
611 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
612 # // write permissions to the bucket and read access to the file.
613 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
614 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
615 },
616 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
617 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
618 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]619 }</pre>
620</div>
621
622<div class="method">
623 <code class="details" id="update">update(project, instance, database, body=None, x__xgafv=None)</code>
624 <pre>Updates a resource containing information about a database inside a Cloud
625SQL instance.
626
627Args:
628 project: string, Project ID of the project that contains the instance. (required)
629 instance: string, Database instance ID. This does not include the project ID. (required)
630 database: string, Name of the database to be updated in the instance. (required)
631 body: object, The request body.
632 The object takes the form of:
633
634{ # Represents a SQL database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]635 &quot;collation&quot;: &quot;A String&quot;, # The MySQL collation value.
636 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include
637 # the project ID or instance name.
638 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
639 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google
640 # apps domain is prefixed if applicable.
641 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]642 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
643 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
644 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
645 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]646 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#database&lt;/code&gt;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]647 &quot;charset&quot;: &quot;A String&quot;, # The MySQL charset value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]648 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the
649 # API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]650}
651
652 x__xgafv: string, V1 error format.
653 Allowed values
654 1 - v1 error format
655 2 - v2 error format
656
657Returns:
658 An object of the form:
659
660 { # An Operation resource.&amp;nbsp;For successful operations that return an
661 # Operation resource, only the fields relevant to the operation are populated
662 # in the resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]663 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
664 # identifier to retrieve the Operations resource that has information about
665 # the operation.
666 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
667 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
668 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
669 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
670 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
671 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
672 # either by using this property or by using the
673 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
674 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
675 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
676 # this database must match the one specified in the
677 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
678 &quot;A String&quot;,
679 ],
680 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
681 &quot;schemaOnly&quot;: True or False, # Export only schemas.
682 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
683 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
684 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
685 # a CHANGE MASTER TO statement with the binary log coordinates.
686 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
687 # a SQL comment, and has no effect.
688 # All other values are ignored.
689 },
690 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
691 # you specify tables, specify one and only one database. For PostgreSQL
692 # instances, you can specify only one table.
693 &quot;A String&quot;,
694 ],
695 },
696 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
697 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
698 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
699 # stored. The URI is in the form &lt;code&gt;gs:
700 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
701 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
702 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
703 # // compressed.
704 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
705 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
706 },
707 },
708 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
709 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
710 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
711 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
712 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
713 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
714 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
715 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
716 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
717 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]718 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
719 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
720 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
721 &quot;targetLink&quot;: &quot;A String&quot;,
722 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
723 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
724 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
725 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
726 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
727 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
728 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
729 # populated.
730 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
731 { # Database instance operation error.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]732 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]733 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
734 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]735 },
736 ],
737 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
738 },
739 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
740 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]741 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]742 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
743 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
744 # of the database table are loaded with CSV data.
745 &quot;A String&quot;,
746 ],
747 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
748 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]749 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
750 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
751 # specify a database, and is overridden by any database specification in the
752 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
753 # must be specified.
754 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
755 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
756 &quot;encryptionOptions&quot;: {
757 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
758 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
759 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
760 # write permissions to the bucket and read access to the file.
761 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
762 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
763 # write permissions to the bucket and read access to the file.
764 },
765 },
766 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
767 # &lt;code&gt;gs:
768 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
769 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
770 # // write permissions to the bucket and read access to the file.
771 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
772 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
773 },
774 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
775 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
776 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]777 }</pre>
778</div>
779
780</body></html>