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

<p class="firstline">Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.</p>

95

96

<code><a href="#update">update(project, instance, database, body=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Updates a resource containing information about a database inside a Cloud SQL instance.</p>

98

<h3>Method Details</h3>

99

100

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

101

<pre>Close httplib2 connections.</pre>

</div>

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

106

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

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)

112

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

119

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

"backupContext": { # Backup context. # The context for backup operation, if applicable.

122

"backupId": "A String", # The identifier of the backup.

123

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

124

},

125

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

126

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

127

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

128

{ # Database instance operation error.

129

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

130

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

131

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

132

},

133

],

134

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

135

},

136

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

137

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

138

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

139

},

140

"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. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**.

141

"A String",

142

],

143

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

144

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

145

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

146

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

147

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

148

"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, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF.

149

},

150

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

151

"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",

],

},

"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 request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed.

156

},

157

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

158

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

159

"encryptionOptions": {

160

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

161

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

162

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

163

},

164

},

165

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

166

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

167

"A String",

168

],

169

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

170

},

171

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

172

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

173

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

174

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

175

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

176

},

177

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

178

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

179

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

180

"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**

181

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

182

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

183

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

184

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

185

"targetLink": "A String",

186

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

187

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

}</pre>

</div>

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

193

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

194

195

Args:

196

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

197

instance: string, Database instance ID. This does not include the project ID. (required)

198

database: string, Name of the database in the instance. (required)

199

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

206

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

},

}</pre>

</div>

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

225

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

226

227

Args:

228

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

229

instance: string, Database instance ID. This does not include the project ID. (required)

230

body: object, The request body.

231

The object takes the form of:

232

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

255

256

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

257

"backupContext": { # Backup context. # The context for backup operation, if applicable.

258

"backupId": "A String", # The identifier of the backup.

259

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

260

},

261

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

262

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

263

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

264

{ # Database instance operation error.

265

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

266

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

267

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

268

},

269

],

270

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

271

},

272

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

273

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

274

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

275

},

276

"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. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**.

277

"A String",

278

],

279

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

280

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

281

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

282

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

283

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

284

"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, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF.

285

},

286

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

287

"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",

],

},

"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 request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed.

292

},

293

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

294

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

295

"encryptionOptions": {

296

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

297

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

298

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

299

},

300

},

301

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

302

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

303

"A String",

304

],

305

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

306

},

307

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

308

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

309

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

310

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

311

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

312

},

313

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

314

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

315

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

316

"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**

317

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

318

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

319

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

320

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

321

"targetLink": "A String",

322

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

323

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

}</pre>

</div>

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

329

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

330

331

Args:

332

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

333

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

334

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

341

342

{ # Database list response.

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

},

},

],

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

}</pre>

</div>

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

365

<pre>Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.

366

367

Args:

368

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

369

instance: string, Database instance ID. This does not include the project ID. (required)

370

database: string, Name of the database to be updated in the instance. (required)

371

body: object, The request body.

372

The object takes the form of:

373

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

396

397

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

398

"backupContext": { # Backup context. # The context for backup operation, if applicable.

399

"backupId": "A String", # The identifier of the backup.

400

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

401

},

402

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

403

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

404

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

405

{ # Database instance operation error.

406

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

407

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

408

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

409

},

410

],

411

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

412

},

413

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

414

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

415

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

416

},

417

"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. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**.

418

"A String",

419

],

420

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

421

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

422

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

423

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

424

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

425

"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, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF.

426

},

427

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

428

"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",

],

},

"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 request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed.

433

},

434

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

435

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

436

"encryptionOptions": {

437

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

438

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

439

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

440

},

441

},

442

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

443

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

444

"A String",

445

],

446

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

447

},

448

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

449

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

450

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

451

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

452

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

453

},

454

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

455

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

456

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

457

"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**

458

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

459

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

460

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

461

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

462

"targetLink": "A String",

463

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

464

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

}</pre>

</div>

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

470

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

471

472

Args:

473

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

474

instance: string, Database instance ID. This does not include the project ID. (required)

475

database: string, Name of the database to be updated in the instance. (required)

476

body: object, The request body.

477

The object takes the form of:

478

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

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

490

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

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

501

502

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

503

"backupContext": { # Backup context. # The context for backup operation, if applicable.

504

"backupId": "A String", # The identifier of the backup.

505

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

506

},

507

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

508

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

509

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

510

{ # Database instance operation error.

511

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

512

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

513

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

514

},

515

],

516

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

517

},

518

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

519

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

520

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

521

},

522

"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. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**.

523

"A String",

524

],

525

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

526

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

527

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

528

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

529

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

530

"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, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF.

531

},

532

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

533

"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",

],

},

"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 request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed.

538

},

539

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

540

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

541

"encryptionOptions": {

542

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

543

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

544

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

545

},

546

},

547

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

548

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

549

"A String",

550

],

551

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

552

},

553

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

554

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

555

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

556

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

557

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

558

},

559

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

560

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

561

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

562

"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**

563

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

564

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

565

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

566

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

567

"targetLink": "A String",

568

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

569

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

}</pre>

</div>

</body></html>