@maxim_mazurok/gapi.client.sqladmin-v1 0.0.20250717 → 0.1.20250807
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +138 -4
- package/package.json +1 -1
- package/readme.md +10 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://sqladmin.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250807
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -231,12 +231,22 @@ declare namespace gapi.client {
|
|
|
231
231
|
preferredSecondaryZone?: string;
|
|
232
232
|
/** Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types. */
|
|
233
233
|
preferredZone?: string;
|
|
234
|
+
/** The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp. */
|
|
235
|
+
sourceInstanceDeletionTime?: string;
|
|
236
|
+
}
|
|
237
|
+
interface Column {
|
|
238
|
+
/** Name of the column. */
|
|
239
|
+
name?: string;
|
|
240
|
+
/** Datatype of the column. */
|
|
241
|
+
type?: string;
|
|
234
242
|
}
|
|
235
243
|
interface ConnectionPoolConfig {
|
|
236
244
|
/** Whether managed connection pooling is enabled. */
|
|
237
245
|
connectionPoolingEnabled?: boolean;
|
|
238
246
|
/** Optional. List of connection pool configuration flags. */
|
|
239
247
|
flags?: ConnectionPoolFlags[];
|
|
248
|
+
/** Output only. Number of connection poolers. */
|
|
249
|
+
poolerCount?: number;
|
|
240
250
|
}
|
|
241
251
|
interface ConnectionPoolFlags {
|
|
242
252
|
/** Required. The name of the flag. */
|
|
@@ -269,6 +279,8 @@ declare namespace gapi.client {
|
|
|
269
279
|
ipAddresses?: IpMapping[];
|
|
270
280
|
/** This is always `sql#connectSettings`. */
|
|
271
281
|
kind?: string;
|
|
282
|
+
/** Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty. */
|
|
283
|
+
mdxProtocolSupport?: string[];
|
|
272
284
|
/** The number of read pool nodes in a read pool. */
|
|
273
285
|
nodeCount?: number;
|
|
274
286
|
/** Output only. Entries containing information about each read pool node of the read pool. */
|
|
@@ -312,8 +324,6 @@ declare namespace gapi.client {
|
|
|
312
324
|
availableMaintenanceVersions?: string[];
|
|
313
325
|
/** The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. */
|
|
314
326
|
backendType?: string;
|
|
315
|
-
/** Clears private network settings when the instance is restored. */
|
|
316
|
-
clearNetwork?: boolean;
|
|
317
327
|
/** Connection name of the Cloud SQL instance used in connection strings. */
|
|
318
328
|
connectionName?: string;
|
|
319
329
|
/** Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. */
|
|
@@ -494,6 +504,16 @@ declare namespace gapi.client {
|
|
|
494
504
|
name?: string;
|
|
495
505
|
}
|
|
496
506
|
interface Empty {}
|
|
507
|
+
interface ExecuteSqlPayload {
|
|
508
|
+
/** Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database. */
|
|
509
|
+
autoIamAuthn?: boolean;
|
|
510
|
+
/** Optional. Name of the database on which the statement will be executed. */
|
|
511
|
+
database?: string;
|
|
512
|
+
/** Optional. The maximum number of rows returned per SQL statement. */
|
|
513
|
+
rowLimit?: string;
|
|
514
|
+
/** Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons. */
|
|
515
|
+
sqlStatement?: string;
|
|
516
|
+
}
|
|
497
517
|
interface ExportContext {
|
|
498
518
|
/** Options for exporting BAK files (SQL Server-only) */
|
|
499
519
|
bakExportOptions?: {
|
|
@@ -580,6 +600,12 @@ declare namespace gapi.client {
|
|
|
580
600
|
/** The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. */
|
|
581
601
|
settingsVersion?: string;
|
|
582
602
|
}
|
|
603
|
+
interface FinalBackupConfig {
|
|
604
|
+
/** Whether the final backup is enabled for the instance. */
|
|
605
|
+
enabled?: boolean;
|
|
606
|
+
/** The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). */
|
|
607
|
+
retentionDays?: number;
|
|
608
|
+
}
|
|
583
609
|
interface Flag {
|
|
584
610
|
/** Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values. */
|
|
585
611
|
allowedIntValues?: string[];
|
|
@@ -805,6 +831,8 @@ declare namespace gapi.client {
|
|
|
805
831
|
backupdrBackup?: string;
|
|
806
832
|
/** Parameters required to perform the restore backup operation. */
|
|
807
833
|
restoreBackupContext?: RestoreBackupContext;
|
|
834
|
+
/** Optional. This field has the same purpose as restore_instance_settings, changes any instance settings stored in the backup you are restoring from. With the difference that these fields are cleared in the settings. */
|
|
835
|
+
restoreInstanceClearOverridesFieldNames?: string[];
|
|
808
836
|
/** Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances. */
|
|
809
837
|
restoreInstanceSettings?: DatabaseInstance;
|
|
810
838
|
}
|
|
@@ -886,6 +914,10 @@ declare namespace gapi.client {
|
|
|
886
914
|
/** Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). */
|
|
887
915
|
updateTrack?: string;
|
|
888
916
|
}
|
|
917
|
+
interface Metadata {
|
|
918
|
+
/** The time taken to execute the SQL statements. */
|
|
919
|
+
sqlStatementExecutionTime?: string;
|
|
920
|
+
}
|
|
889
921
|
interface MySqlReplicaConfiguration {
|
|
890
922
|
/** PEM representation of the trusted CA's x509 certificate. */
|
|
891
923
|
caCertificate?: string;
|
|
@@ -1042,7 +1074,7 @@ declare namespace gapi.client {
|
|
|
1042
1074
|
targetSizeGb?: string;
|
|
1043
1075
|
}
|
|
1044
1076
|
interface PointInTimeRestoreContext {
|
|
1045
|
-
/** Optional. The name of the allocated IP range for the internal IP Cloud SQL instance. For example: "google-managed-services-default". If you set this, then Cloud SQL creates the IP address for the cloned instance in the allocated range. This range must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035) standards. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use.
|
|
1077
|
+
/** Optional. The name of the allocated IP range for the internal IP Cloud SQL instance. For example: "google-managed-services-default". If you set this, then Cloud SQL creates the IP address for the cloned instance in the allocated range. This range must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035) standards. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use. */
|
|
1046
1078
|
allocatedIpRange?: string;
|
|
1047
1079
|
/** The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
|
|
1048
1080
|
datasource?: string;
|
|
@@ -1093,6 +1125,16 @@ declare namespace gapi.client {
|
|
|
1093
1125
|
/** Whether PSC connectivity is enabled for this instance. */
|
|
1094
1126
|
pscEnabled?: boolean;
|
|
1095
1127
|
}
|
|
1128
|
+
interface QueryResult {
|
|
1129
|
+
/** List of columns included in the result. This also includes the data type of the column. */
|
|
1130
|
+
columns?: Column[];
|
|
1131
|
+
/** Message related to the SQL execution result. */
|
|
1132
|
+
message?: string;
|
|
1133
|
+
/** Set to true if the SQL execution's result is truncated due to size limits. */
|
|
1134
|
+
partialResult?: boolean;
|
|
1135
|
+
/** Rows returned by the SQL statement. */
|
|
1136
|
+
rows?: Row[];
|
|
1137
|
+
}
|
|
1096
1138
|
interface ReplicaConfiguration {
|
|
1097
1139
|
/** Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it. */
|
|
1098
1140
|
cascadableReplica?: boolean;
|
|
@@ -1139,6 +1181,10 @@ declare namespace gapi.client {
|
|
|
1139
1181
|
/** The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version. */
|
|
1140
1182
|
nextVersion?: string;
|
|
1141
1183
|
}
|
|
1184
|
+
interface Row {
|
|
1185
|
+
/** The values for the row. */
|
|
1186
|
+
values?: Value[];
|
|
1187
|
+
}
|
|
1142
1188
|
interface SelectedObjects {
|
|
1143
1189
|
/** Required. The name of the database to migrate. */
|
|
1144
1190
|
database?: string;
|
|
@@ -1188,6 +1234,8 @@ declare namespace gapi.client {
|
|
|
1188
1234
|
enableDataplexIntegration?: boolean;
|
|
1189
1235
|
/** Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances. */
|
|
1190
1236
|
enableGoogleMlIntegration?: boolean;
|
|
1237
|
+
/** Optional. The final backup configuration for the instance. */
|
|
1238
|
+
finalBackupConfig?: FinalBackupConfig;
|
|
1191
1239
|
/** Insights configuration, for now relevant only for Postgres. */
|
|
1192
1240
|
insightsConfig?: InsightsConfig;
|
|
1193
1241
|
/** The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. */
|
|
@@ -1224,10 +1272,18 @@ declare namespace gapi.client {
|
|
|
1224
1272
|
userLabels?: {[P in string]: string};
|
|
1225
1273
|
}
|
|
1226
1274
|
interface SqlActiveDirectoryConfig {
|
|
1275
|
+
/** Optional. The secret manager key storing the administrator credential. (e.g., projects/{project}/secrets/{secret}). */
|
|
1276
|
+
adminCredentialSecretName?: string;
|
|
1277
|
+
/** Optional. Domain controller IPv4 addresses used to bootstrap Active Directory. */
|
|
1278
|
+
dnsServers?: string[];
|
|
1227
1279
|
/** The name of the domain (e.g., mydomain.com). */
|
|
1228
1280
|
domain?: string;
|
|
1229
1281
|
/** This is always sql#activeDirectoryConfig. */
|
|
1230
1282
|
kind?: string;
|
|
1283
|
+
/** Optional. The mode of the Active Directory configuration. */
|
|
1284
|
+
mode?: string;
|
|
1285
|
+
/** Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit. */
|
|
1286
|
+
organizationalUnit?: string;
|
|
1231
1287
|
}
|
|
1232
1288
|
interface SqlExternalSyncSettingError {
|
|
1233
1289
|
/** Additional information about the error encountered. */
|
|
@@ -1241,6 +1297,12 @@ declare namespace gapi.client {
|
|
|
1241
1297
|
/** The unique identifier for this operation. */
|
|
1242
1298
|
operationId?: string;
|
|
1243
1299
|
}
|
|
1300
|
+
interface SqlInstancesExecuteSqlResponse {
|
|
1301
|
+
/** The additional metadata information regarding the execution of the SQL statements. */
|
|
1302
|
+
metadata?: Metadata;
|
|
1303
|
+
/** The list of results after executing all the SQL statements. */
|
|
1304
|
+
results?: QueryResult[];
|
|
1305
|
+
}
|
|
1244
1306
|
interface SqlInstancesGetDiskShrinkConfigResponse {
|
|
1245
1307
|
/** This is always `sql#getDiskShrinkConfig`. */
|
|
1246
1308
|
kind?: string;
|
|
@@ -1269,6 +1331,8 @@ declare namespace gapi.client {
|
|
|
1269
1331
|
migrationType?: string;
|
|
1270
1332
|
/** MySQL-specific settings for start external sync. */
|
|
1271
1333
|
mysqlSyncConfig?: MySqlSyncConfig;
|
|
1334
|
+
/** Optional. MySQL only. True if end-user has confirmed that this SES call will wipe replica databases overlapping with the proposed selected_objects. If this field is not set and there are both overlapping and additional databases proposed, an error will be returned. */
|
|
1335
|
+
replicaOverwriteEnabled?: boolean;
|
|
1272
1336
|
/** Whether to skip the verification step (VESS). */
|
|
1273
1337
|
skipVerification?: boolean;
|
|
1274
1338
|
/** External sync mode. */
|
|
@@ -1466,6 +1530,12 @@ declare namespace gapi.client {
|
|
|
1466
1530
|
/** Unused. */
|
|
1467
1531
|
nextPageToken?: string;
|
|
1468
1532
|
}
|
|
1533
|
+
interface Value {
|
|
1534
|
+
/** If cell value is null, then this flag will be set to true. */
|
|
1535
|
+
nullValue?: boolean;
|
|
1536
|
+
/** The cell value in string format. */
|
|
1537
|
+
value?: string;
|
|
1538
|
+
}
|
|
1469
1539
|
interface BackupRunsResource {
|
|
1470
1540
|
/** Deletes the backup taken by a backup run. */
|
|
1471
1541
|
delete(request?: {
|
|
@@ -2591,6 +2661,68 @@ declare namespace gapi.client {
|
|
|
2591
2661
|
},
|
|
2592
2662
|
body: InstancesDemoteMasterRequest,
|
|
2593
2663
|
): Request<Operation>;
|
|
2664
|
+
/** Execute SQL statements. */
|
|
2665
|
+
executeSql(request: {
|
|
2666
|
+
/** V1 error format. */
|
|
2667
|
+
'$.xgafv'?: string;
|
|
2668
|
+
/** OAuth access token. */
|
|
2669
|
+
access_token?: string;
|
|
2670
|
+
/** Data format for response. */
|
|
2671
|
+
alt?: string;
|
|
2672
|
+
/** JSONP */
|
|
2673
|
+
callback?: string;
|
|
2674
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2675
|
+
fields?: string;
|
|
2676
|
+
/** Required. Database instance ID. This does not include the project ID. */
|
|
2677
|
+
instance: string;
|
|
2678
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2679
|
+
key?: string;
|
|
2680
|
+
/** OAuth 2.0 token for the current user. */
|
|
2681
|
+
oauth_token?: string;
|
|
2682
|
+
/** Returns response with indentations and line breaks. */
|
|
2683
|
+
prettyPrint?: boolean;
|
|
2684
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
2685
|
+
project: string;
|
|
2686
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2687
|
+
quotaUser?: string;
|
|
2688
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2689
|
+
upload_protocol?: string;
|
|
2690
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2691
|
+
uploadType?: string;
|
|
2692
|
+
/** Request body */
|
|
2693
|
+
resource: ExecuteSqlPayload;
|
|
2694
|
+
}): Request<SqlInstancesExecuteSqlResponse>;
|
|
2695
|
+
executeSql(
|
|
2696
|
+
request: {
|
|
2697
|
+
/** V1 error format. */
|
|
2698
|
+
'$.xgafv'?: string;
|
|
2699
|
+
/** OAuth access token. */
|
|
2700
|
+
access_token?: string;
|
|
2701
|
+
/** Data format for response. */
|
|
2702
|
+
alt?: string;
|
|
2703
|
+
/** JSONP */
|
|
2704
|
+
callback?: string;
|
|
2705
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2706
|
+
fields?: string;
|
|
2707
|
+
/** Required. Database instance ID. This does not include the project ID. */
|
|
2708
|
+
instance: string;
|
|
2709
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2710
|
+
key?: string;
|
|
2711
|
+
/** OAuth 2.0 token for the current user. */
|
|
2712
|
+
oauth_token?: string;
|
|
2713
|
+
/** Returns response with indentations and line breaks. */
|
|
2714
|
+
prettyPrint?: boolean;
|
|
2715
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
2716
|
+
project: string;
|
|
2717
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2718
|
+
quotaUser?: string;
|
|
2719
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2720
|
+
upload_protocol?: string;
|
|
2721
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2722
|
+
uploadType?: string;
|
|
2723
|
+
},
|
|
2724
|
+
body: ExecuteSqlPayload,
|
|
2725
|
+
): Request<SqlInstancesExecuteSqlResponse>;
|
|
2594
2726
|
/** Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. */
|
|
2595
2727
|
export(request: {
|
|
2596
2728
|
/** V1 error format. */
|
|
@@ -3802,6 +3934,8 @@ declare namespace gapi.client {
|
|
|
3802
3934
|
project: string;
|
|
3803
3935
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3804
3936
|
quotaUser?: string;
|
|
3937
|
+
/** The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp. */
|
|
3938
|
+
sourceInstanceDeletionTime?: string;
|
|
3805
3939
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3806
3940
|
upload_protocol?: string;
|
|
3807
3941
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -257,6 +257,14 @@ await gapi.client.sql.instances.demoteMaster({
|
|
|
257
257
|
project: 'project',
|
|
258
258
|
});
|
|
259
259
|
|
|
260
|
+
/*
|
|
261
|
+
Execute SQL statements.
|
|
262
|
+
*/
|
|
263
|
+
await gapi.client.sql.instances.executeSql({
|
|
264
|
+
instance: 'instance',
|
|
265
|
+
project: 'project',
|
|
266
|
+
});
|
|
267
|
+
|
|
260
268
|
/*
|
|
261
269
|
Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
|
|
262
270
|
*/
|
|
@@ -523,3 +531,5 @@ Updates an existing user in a Cloud SQL instance.
|
|
|
523
531
|
*/
|
|
524
532
|
await gapi.client.sql.users.update({instance: 'instance', project: 'project'});
|
|
525
533
|
```
|
|
534
|
+
|
|
535
|
+
For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.sqladmin-v1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)
|