Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / sqladmin_v1beta4.databases.html
blob: d2ac5accd82d1c8d9878a0b0b92df25d0e17e122 [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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.databases.html">databases</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#delete">delete(project, instance, database, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]82<p class="firstline">Deletes a database from a Cloud SQL instance.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#get">get(project, instance, database, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]85<p class="firstline">Retrieves a resource containing information about a database inside a Cloud SQL instance.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]88<p class="firstline">Inserts a resource containing information about a database inside a Cloud SQL instance.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]91<p class="firstline">Lists databases in the specified Cloud SQL instance.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#patch">patch(project, instance, database, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]94<p class="firstline">Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#update">update(project, instance, database, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]97<p class="firstline">Updates a resource containing information about a database inside a Cloud SQL instance.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 <code class="details" id="delete">delete(project, instance, database, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]106 <pre>Deletes a database from a Cloud SQL instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]107
108Args:
109 project: string, Project ID of the project that contains the instance. (required)
110 instance: string, Database instance ID. This does not include the project ID. (required)
111 database: string, Name of the database to be deleted in the instance. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]116
117Returns:
118 An object of the form:
119
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]120 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
121 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
122 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
123 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
124 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
126 { # Database instance operation error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]128 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]132 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]134 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
135 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
136 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]138 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
139 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
140 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]141 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
142 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
143 &quot;uri&quot;: &quot;A String&quot;, # 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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
144 &quot;databases&quot;: [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]146 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]147 &quot;offload&quot;: True or False, # Option for export offload.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]149 &quot;schemaOnly&quot;: True or False, # Export only schemas.
150 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]152 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]154 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]156 },
157 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]158 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]159 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
160 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
161 &quot;operationType&quot;: &quot;A String&quot;, # 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*
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]162 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]163 &quot;targetLink&quot;: &quot;A String&quot;,
164 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
165 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
166 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
167 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
168 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
169 &quot;A String&quot;,
170 ],
171 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
172 },
173 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
174 &quot;encryptionOptions&quot;: {
175 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
176 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
177 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
178 },
179 },
180 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
181 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.
182 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
183 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]184 }</pre>
185</div>
186
187<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]188 <code class="details" id="get">get(project, instance, database, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]189 <pre>Retrieves a resource containing information about a database inside a Cloud SQL instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]190
191Args:
192 project: string, Project ID of the project that contains the instance. (required)
193 instance: string, Database instance ID. This does not include the project ID. (required)
194 database: string, Name of the database in the instance. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]199
200Returns:
201 An object of the form:
202
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 { # Represents a SQL database on the Cloud SQL instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]204 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]205 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]206 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]207 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]208 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]209 &quot;charset&quot;: &quot;A String&quot;, # The Cloud SQL charset value.
210 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#database*.
211 &quot;collation&quot;: &quot;A String&quot;, # The Cloud SQL collation value.
212 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
213 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
214 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
215 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]216 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]217</div>
218
219<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]220 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]221 <pre>Inserts a resource containing information about a database inside a Cloud SQL instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]222
223Args:
224 project: string, Project ID of the project that contains the instance. (required)
225 instance: string, Database instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]226 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]227 The object takes the form of:
228
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229{ # Represents a SQL database on the Cloud SQL instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]230 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]231 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]232 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]233 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]234 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]235 &quot;charset&quot;: &quot;A String&quot;, # The Cloud SQL charset value.
236 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#database*.
237 &quot;collation&quot;: &quot;A String&quot;, # The Cloud SQL collation value.
238 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
239 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
240 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
241 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]242}
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]243
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]244 x__xgafv: string, V1 error format.
245 Allowed values
246 1 - v1 error format
247 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]248
249Returns:
250 An object of the form:
251
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]252 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
253 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
254 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
255 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
256 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
258 { # Database instance operation error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]259 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]260 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]262 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]264 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]265 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]266 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
267 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
268 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]269 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]270 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
271 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
272 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]273 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
274 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
275 &quot;uri&quot;: &quot;A String&quot;, # 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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
276 &quot;databases&quot;: [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]277 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]278 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]279 &quot;offload&quot;: True or False, # Option for export offload.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]280 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]281 &quot;schemaOnly&quot;: True or False, # Export only schemas.
282 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]284 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]285 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]286 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]287 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]288 },
289 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]290 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]291 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
292 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
293 &quot;operationType&quot;: &quot;A String&quot;, # 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*
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]294 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]295 &quot;targetLink&quot;: &quot;A String&quot;,
296 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
297 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
298 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
299 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
300 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
301 &quot;A String&quot;,
302 ],
303 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
304 },
305 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
306 &quot;encryptionOptions&quot;: {
307 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
308 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
309 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
310 },
311 },
312 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
313 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.
314 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
315 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]316 }</pre>
317</div>
318
319<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]320 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]321 <pre>Lists databases in the specified Cloud SQL instance.
322
323Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]325 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]326 x__xgafv: string, V1 error format.
327 Allowed values
328 1 - v1 error format
329 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]330
331Returns:
332 An object of the form:
333
334 { # Database list response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]335 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#databasesList*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]336 &quot;items&quot;: [ # List of database resources in the instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]337 { # Represents a SQL database on the Cloud SQL instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]338 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]339 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]340 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]341 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]342 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]343 &quot;charset&quot;: &quot;A String&quot;, # The Cloud SQL charset value.
344 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#database*.
345 &quot;collation&quot;: &quot;A String&quot;, # The Cloud SQL collation value.
346 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
347 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
348 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
349 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]350 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]351 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]352 }</pre>
353</div>
354
355<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]356 <code class="details" id="patch">patch(project, instance, database, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]357 <pre>Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]358
359Args:
360 project: string, Project ID of the project that contains the instance. (required)
361 instance: string, Database instance ID. This does not include the project ID. (required)
362 database: string, Name of the database to be updated in the instance. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]363 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]364 The object takes the form of:
365
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]366{ # Represents a SQL database on the Cloud SQL instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]367 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]368 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]369 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]370 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]371 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]372 &quot;charset&quot;: &quot;A String&quot;, # The Cloud SQL charset value.
373 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#database*.
374 &quot;collation&quot;: &quot;A String&quot;, # The Cloud SQL collation value.
375 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
376 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
377 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
378 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]379}
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]380
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]381 x__xgafv: string, V1 error format.
382 Allowed values
383 1 - v1 error format
384 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]385
386Returns:
387 An object of the form:
388
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]389 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
390 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
391 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
392 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
393 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]394 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
395 { # Database instance operation error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]396 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]397 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]398 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]399 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]400 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]401 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]402 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]403 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
404 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
405 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]406 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]407 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
408 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
409 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]410 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
411 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
412 &quot;uri&quot;: &quot;A String&quot;, # 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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
413 &quot;databases&quot;: [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]414 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]415 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]416 &quot;offload&quot;: True or False, # Option for export offload.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]417 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]418 &quot;schemaOnly&quot;: True or False, # Export only schemas.
419 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]420 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]421 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]422 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]423 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]425 },
426 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]427 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]428 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
429 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
430 &quot;operationType&quot;: &quot;A String&quot;, # 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*
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]431 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]432 &quot;targetLink&quot;: &quot;A String&quot;,
433 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
434 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
435 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
436 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
437 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
438 &quot;A String&quot;,
439 ],
440 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
441 },
442 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
443 &quot;encryptionOptions&quot;: {
444 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
445 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
446 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
447 },
448 },
449 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
450 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.
451 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
452 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]453 }</pre>
454</div>
455
456<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]457 <code class="details" id="update">update(project, instance, database, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]458 <pre>Updates a resource containing information about a database inside a Cloud SQL instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]459
460Args:
461 project: string, Project ID of the project that contains the instance. (required)
462 instance: string, Database instance ID. This does not include the project ID. (required)
463 database: string, Name of the database to be updated in the instance. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]464 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]465 The object takes the form of:
466
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]467{ # Represents a SQL database on the Cloud SQL instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]468 &quot;etag&quot;: &quot;A String&quot;, # This field is deprecated and will be removed from a future version of the API.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]469 &quot;sqlserverDatabaseDetails&quot;: { # Represents a Sql Server database on the Cloud SQL instance.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]470 &quot;compatibilityLevel&quot;: 42, # The version of SQL Server with which the database is to be made compatible
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]471 &quot;recoveryModel&quot;: &quot;A String&quot;, # The recovery model of a SQL Server database
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]472 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]473 &quot;charset&quot;: &quot;A String&quot;, # The Cloud SQL charset value.
474 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#database*.
475 &quot;collation&quot;: &quot;A String&quot;, # The Cloud SQL collation value.
476 &quot;project&quot;: &quot;A String&quot;, # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
477 &quot;instance&quot;: &quot;A String&quot;, # The name of the Cloud SQL instance. This does not include the project ID.
478 &quot;name&quot;: &quot;A String&quot;, # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
479 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]480}
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]481
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]482 x__xgafv: string, V1 error format.
483 Allowed values
484 1 - v1 error format
485 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]486
487Returns:
488 An object of the form:
489
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]490 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
491 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operation*.
492 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
493 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
494 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]495 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
496 { # Database instance operation error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]497 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]498 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationError*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]499 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]500 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]501 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]502 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#operationErrors*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]503 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]504 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
505 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
506 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]507 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]508 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
509 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
510 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]511 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
512 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#exportContext*.
513 &quot;uri&quot;: &quot;A String&quot;, # 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 requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
514 &quot;databases&quot;: [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]515 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]516 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]517 &quot;offload&quot;: True or False, # Option for export offload.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]518 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]519 &quot;schemaOnly&quot;: True or False, # Export only schemas.
520 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]521 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]522 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]523 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]524 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]525 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]526 },
527 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]528 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]529 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
530 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
531 &quot;operationType&quot;: &quot;A String&quot;, # 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*
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]532 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]533 &quot;targetLink&quot;: &quot;A String&quot;,
534 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
535 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
536 &quot;kind&quot;: &quot;A String&quot;, # This is always *sql#importContext*.
537 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
538 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
539 &quot;A String&quot;,
540 ],
541 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
542 },
543 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
544 &quot;encryptionOptions&quot;: {
545 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
546 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
547 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
548 },
549 },
550 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
551 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.
552 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
553 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]554 }</pre>
555</div>
556
557</body></html>