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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[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

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

122

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

123

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

124

{ # Database instance operation error.

125

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

126

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

127

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

128

},

129

],

130

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

131

},

132

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

133

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

134

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

135

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

136

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

137

"A String",

138

],

139

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

140

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

141

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

142

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

143

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

144

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

145

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

146

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

147

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

148

"A String",

149

],

150

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

151

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

152

},

153

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

154

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

155

"encryptionOptions": {

156

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

157

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

158

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

159

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

160

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

161

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

162

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

163

"A String",

164

],

165

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

166

},

167

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

168

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

169

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

170

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

171

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

172

},

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

"targetLink": "A String",

182

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

183

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

184

}</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]

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

},

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

},

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[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

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

254

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

255

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

256

{ # Database instance operation error.

257

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

258

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

259

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

260

},

261

],

262

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

263

},

264

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

265

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

266

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

267

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

268

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

269

"A String",

270

],

271

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

272

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

273

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

274

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

275

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

276

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

277

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

278

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

279

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

280

"A String",

281

],

282

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

283

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

284

},

285

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

286

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

287

"encryptionOptions": {

288

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

289

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

290

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

291

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

292

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

293

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

294

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

295

"A String",

296

],

297

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

298

},

299

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

300

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

301

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

302

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

303

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

304

},

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

"targetLink": "A String",

314

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

315

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

316

}</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]

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

},

},

],

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

352

}</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]

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

},

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[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

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

391

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

392

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

393

{ # Database instance operation error.

394

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

395

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

396

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

397

},

398

],

399

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

400

},

401

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

402

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

403

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

404

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

405

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

406

"A String",

407

],

408

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

409

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

410

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

411

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

412

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

413

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

414

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

415

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

416

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

417

"A String",

418

],

419

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

420

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

421

},

422

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

423

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

424

"encryptionOptions": {

425

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

426

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

427

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

428

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

429

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

430

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

431

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

432

"A String",

433

],

434

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

435

},

436

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

437

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

438

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

439

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

440

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

441

},

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

"targetLink": "A String",

451

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

452

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

453

}</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]

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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

},

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[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

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

492

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

493

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

494

{ # Database instance operation error.

495

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

496

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

497

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

498

},

499

],

500

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

501

},

502

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

503

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

504

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

505

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

506

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

507

"A String",

508

],

509

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

510

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

511

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

512

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

513

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

514

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

515

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

516

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

517

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

518

"A String",

519

],

520

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

521

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

522

},

523

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

524

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

525

"encryptionOptions": {

526

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

527

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

528

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

529

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

530

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

531

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

532

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

533

"A String",

534

],

535

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

536

},

537

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

538

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

539

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

540

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

541

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

542

},

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

"targetLink": "A String",

552

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

553

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

554

}</pre>

Craig Citro