Blame - docs/dyn/sqladmin_v1beta4.databases.html - platform/external/python/google-api-python-client

2015-03-02 13:40:36 -0800

[diff] [blame]

95

Dan O'Meara

2020-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 Frenkel

2020-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 Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

98

<h3>Method Details</h3>

99

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code class="details" id="delete">delete(project, instance, database, x__xgafv=None)</code>

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

106

<pre>Deletes a database from a Cloud SQL instance.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

107

108

Args:

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'Meara

2020-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 Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

116

117

Returns:

118

An object of the form:

119

Dmitry Frenkel

2020-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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

121

"importContext": { # Database instance import context. # The context for import operation, if applicable.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

122

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

123

"csvImportOptions": { # Options for importing data as CSV.

124

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

125

"A String",

126

],

127

"table": "A String", # The table to which CSV data is imported.

128

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

129

"kind": "A String", # This is always *sql#importContext*.

130

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

131

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

132

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

133

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

134

"encryptionOptions": {

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

135

"pvkPassword": "A String", # Password that encrypts the private key

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

136

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

137

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

138

},

139

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

140

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

141

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

142

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.

143

"sqlExportOptions": { # Options for exporting data as SQL statements.

144

"mysqlExportOptions": { # Options for exporting from MySQL.

145

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.

146

},

147

"schemaOnly": True or False, # Export only schemas.

148

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

"A String",

],

},

"kind": "A String", # This is always *sql#exportContext*.

153

"csvExportOptions": { # Options for exporting data as CSV.

154

"selectQuery": "A String", # The select query used to extract the data.

155

},

156

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

157

"offload": True or False, # Option for export offload.

158

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.

"A String",

],

},

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

163

"user": "A String", # The email address of the user who initiated this operation.

164

"selfLink": "A String", # The URI of this resource.

165

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

166

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

167

"targetId": "A String", # Name of the database instance related to this operation.

168

"targetProject": "A String", # The project ID of the target instance related to this operation.

169

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

170

"kind": "A String", # This is always *sql#operation*.

171

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

172

"kind": "A String", # This is always *sql#operationErrors*.

173

"errors": [ # The list of errors encountered while processing this operation.

174

{ # Database instance operation error.

175

"code": "A String", # Identifies the specific error that occurred.

176

"message": "A String", # Additional information about the error encountered.

177

"kind": "A String", # This is always *sql#operationError*.

},

],

},

"targetLink": "A String",

182

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

183

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

188

<code class="details" id="get">get(project, instance, database, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

189

<pre>Retrieves a resource containing information about a database inside a Cloud SQL instance.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

190

191

Args:

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'Meara

2020-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 Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

199

200

Returns:

201

An object of the form:

202

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

203

{ # Represents a SQL database on the Cloud SQL instance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

204

"project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.

205

"name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.

206

"charset": "A String", # The Cloud SQL charset value.

207

"instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.

208

"etag": "A String", # This field is deprecated and will be removed from a future version of the API.

209

"sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.

210

"recoveryModel": "A String", # The recovery model of a SQL Server database

211

"compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible

212

},

213

"collation": "A String", # The Cloud SQL collation value.

214

"kind": "A String", # This is always *sql#database*.

215

"selfLink": "A String", # The URI of this resource.

216

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

220

<code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

221

<pre>Inserts a resource containing information about a database inside a Cloud SQL instance.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

222

223

Args:

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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

226

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

227

The object takes the form of:

228

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

229

{ # Represents a SQL database on the Cloud SQL instance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

230

"project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.

231

"name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.

232

"charset": "A String", # The Cloud SQL charset value.

233

"instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.

234

"etag": "A String", # This field is deprecated and will be removed from a future version of the API.

235

"sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.

236

"recoveryModel": "A String", # The recovery model of a SQL Server database

237

"compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible

238

},

239

"collation": "A String", # The Cloud SQL collation value.

240

"kind": "A String", # This is always *sql#database*.

241

"selfLink": "A String", # The URI of this resource.

242

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

243

Dan O'Meara

2020-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 Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

248

249

Returns:

250

An object of the form:

251

Dmitry Frenkel

2020-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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

253

"importContext": { # Database instance import context. # The context for import operation, if applicable.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

254

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

255

"csvImportOptions": { # Options for importing data as CSV.

256

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

257

"A String",

258

],

259

"table": "A String", # The table to which CSV data is imported.

260

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

261

"kind": "A String", # This is always *sql#importContext*.

262

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

263

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

264

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

265

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

266

"encryptionOptions": {

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

267

"pvkPassword": "A String", # Password that encrypts the private key

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

268

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

269

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

270

},

271

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

272

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

273

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

274

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.

275

"sqlExportOptions": { # Options for exporting data as SQL statements.

276

"mysqlExportOptions": { # Options for exporting from MySQL.

277

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.

278

},

279

"schemaOnly": True or False, # Export only schemas.

280

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

"A String",

],

},

"kind": "A String", # This is always *sql#exportContext*.

285

"csvExportOptions": { # Options for exporting data as CSV.

286

"selectQuery": "A String", # The select query used to extract the data.

287

},

288

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

289

"offload": True or False, # Option for export offload.

290

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.

"A String",

],

},

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

295

"user": "A String", # The email address of the user who initiated this operation.

296

"selfLink": "A String", # The URI of this resource.

297

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

298

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

299

"targetId": "A String", # Name of the database instance related to this operation.

300

"targetProject": "A String", # The project ID of the target instance related to this operation.

301

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

302

"kind": "A String", # This is always *sql#operation*.

303

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

304

"kind": "A String", # This is always *sql#operationErrors*.

305

"errors": [ # The list of errors encountered while processing this operation.

306

{ # Database instance operation error.

307

"code": "A String", # Identifies the specific error that occurred.

308

"message": "A String", # Additional information about the error encountered.

309

"kind": "A String", # This is always *sql#operationError*.

},

],

},

"targetLink": "A String",

314

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

315

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

320

<code class="details" id="list">list(project, instance, x__xgafv=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

321

<pre>Lists databases in the specified Cloud SQL instance.

322

323

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

324

project: string, Project ID of the project that contains the instance. (required)

Craig Citro

2015-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'Meara

2020-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 Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

330

331

Returns:

332

An object of the form:

333

334

{ # Database list response.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

335

"items": [ # List of database resources in the instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

336

{ # Represents a SQL database on the Cloud SQL instance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

337

"project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.

338

"name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.

339

"charset": "A String", # The Cloud SQL charset value.

340

"instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.

341

"etag": "A String", # This field is deprecated and will be removed from a future version of the API.

342

"sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.

343

"recoveryModel": "A String", # The recovery model of a SQL Server database

344

"compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible

345

},

346

"collation": "A String", # The Cloud SQL collation value.

347

"kind": "A String", # This is always *sql#database*.

348

"selfLink": "A String", # The URI of this resource.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

349

},

350

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

351

"kind": "A String", # This is always *sql#databasesList*.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-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 Frenkel

2020-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 Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

358

359

Args:

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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

363

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

364

The object takes the form of:

365

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

366

{ # Represents a SQL database on the Cloud SQL instance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

367

"project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.

368

"name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.

369

"charset": "A String", # The Cloud SQL charset value.

370

"instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.

371

"etag": "A String", # This field is deprecated and will be removed from a future version of the API.

372

"sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.

373

"recoveryModel": "A String", # The recovery model of a SQL Server database

374

"compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible

375

},

376

"collation": "A String", # The Cloud SQL collation value.

377

"kind": "A String", # This is always *sql#database*.

378

"selfLink": "A String", # The URI of this resource.

379

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

380

Dan O'Meara

2020-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 Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

385

386

Returns:

387

An object of the form:

388

Dmitry Frenkel

2020-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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

390

"importContext": { # Database instance import context. # The context for import operation, if applicable.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

391

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

392

"csvImportOptions": { # Options for importing data as CSV.

393

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

394

"A String",

395

],

396

"table": "A String", # The table to which CSV data is imported.

397

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

398

"kind": "A String", # This is always *sql#importContext*.

399

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

400

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

401

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

402

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

403

"encryptionOptions": {

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

404

"pvkPassword": "A String", # Password that encrypts the private key

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

405

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

406

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

407

},

408

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

409

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

410

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

411

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.

412

"sqlExportOptions": { # Options for exporting data as SQL statements.

413

"mysqlExportOptions": { # Options for exporting from MySQL.

414

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.

415

},

416

"schemaOnly": True or False, # Export only schemas.

417

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

"A String",

],

},

"kind": "A String", # This is always *sql#exportContext*.

422

"csvExportOptions": { # Options for exporting data as CSV.

423

"selectQuery": "A String", # The select query used to extract the data.

424

},

425

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

426

"offload": True or False, # Option for export offload.

427

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.

"A String",

],

},

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

432

"user": "A String", # The email address of the user who initiated this operation.

433

"selfLink": "A String", # The URI of this resource.

434

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

435

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

436

"targetId": "A String", # Name of the database instance related to this operation.

437

"targetProject": "A String", # The project ID of the target instance related to this operation.

438

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

439

"kind": "A String", # This is always *sql#operation*.

440

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

441

"kind": "A String", # This is always *sql#operationErrors*.

442

"errors": [ # The list of errors encountered while processing this operation.

443

{ # Database instance operation error.

444

"code": "A String", # Identifies the specific error that occurred.

445

"message": "A String", # Additional information about the error encountered.

446

"kind": "A String", # This is always *sql#operationError*.

},

],

},

"targetLink": "A String",

451

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

452

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-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 Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

458

<pre>Updates a resource containing information about a database inside a Cloud SQL instance.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

459

460

Args:

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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

464

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

465

The object takes the form of:

466

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

467

{ # Represents a SQL database on the Cloud SQL instance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

468

"project": "A String", # The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.

469

"name": "A String", # The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.

470

"charset": "A String", # The Cloud SQL charset value.

471

"instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID.

472

"etag": "A String", # This field is deprecated and will be removed from a future version of the API.

473

"sqlserverDatabaseDetails": { # Represents a Sql Server database on the Cloud SQL instance.

474

"recoveryModel": "A String", # The recovery model of a SQL Server database

475

"compatibilityLevel": 42, # The version of SQL Server with which the database is to be made compatible

476

},

477

"collation": "A String", # The Cloud SQL collation value.

478

"kind": "A String", # This is always *sql#database*.

479

"selfLink": "A String", # The URI of this resource.

480

}

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

481

Dan O'Meara

2020-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 Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

486

487

Returns:

488

An object of the form:

489

Dmitry Frenkel

2020-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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

491

"importContext": { # Database instance import context. # The context for import operation, if applicable.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

492

"database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

493

"csvImportOptions": { # Options for importing data as CSV.

494

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

495

"A String",

496

],

497

"table": "A String", # The table to which CSV data is imported.

498

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

499

"kind": "A String", # This is always *sql#importContext*.

500

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

501

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

502

"uri": "A String", # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

503

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

504

"encryptionOptions": {

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

505

"pvkPassword": "A String", # Password that encrypts the private key

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

506

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

507

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

508

},

509

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

510

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

511

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

512

"uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.

513

"sqlExportOptions": { # Options for exporting data as SQL statements.

514

"mysqlExportOptions": { # Options for exporting from MySQL.

515

"masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.

516

},

517

"schemaOnly": True or False, # Export only schemas.

518

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.

"A String",

],

},

"kind": "A String", # This is always *sql#exportContext*.

523

"csvExportOptions": { # Options for exporting data as CSV.

524

"selectQuery": "A String", # The select query used to extract the data.

525

},

526

"fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.

527

"offload": True or False, # Option for export offload.

528

"databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.

"A String",

],

},

"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

533

"user": "A String", # The email address of the user who initiated this operation.

534

"selfLink": "A String", # The URI of this resource.

535

"status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*

536

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

537

"targetId": "A String", # Name of the database instance related to this operation.

538

"targetProject": "A String", # The project ID of the target instance related to this operation.

539

"operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*

540

"kind": "A String", # This is always *sql#operation*.

541

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

542

"kind": "A String", # This is always *sql#operationErrors*.

543

"errors": [ # The list of errors encountered while processing this operation.

544

{ # Database instance operation error.

545

"code": "A String", # Identifies the specific error that occurred.

546

"message": "A String", # Additional information about the error encountered.

547

"kind": "A String", # This is always *sql#operationError*.

},

],

},

"targetLink": "A String",

552

"name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

553

"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.

Craig Citro