@scaleway/sdk-rdb 1.2.0 → 2.1.1
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/README.md +96 -0
- package/dist/v1/api.gen.d.ts +3 -2
- package/dist/v1/api.gen.js +73 -99
- package/dist/v1/content.gen.js +6 -2
- package/dist/v1/index.gen.d.ts +1 -1
- package/dist/v1/marshalling.gen.js +50 -73
- package/dist/v1/types.gen.d.ts +1 -1
- package/package.json +6 -9
- package/dist/index.gen.cjs +0 -4
- package/dist/v1/api.gen.cjs +0 -1060
- package/dist/v1/content.gen.cjs +0 -38
- package/dist/v1/index.gen.cjs +0 -71
- package/dist/v1/marshalling.gen.cjs +0 -923
- package/dist/v1/validation-rules.gen.cjs +0 -8
package/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# @scaleway/sdk-rdb
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@scaleway/sdk-rdb)
|
|
4
|
+
[](https://www.npmjs.com/package/@scaleway/sdk-rdb)
|
|
5
|
+
[](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
|
|
6
|
+
|
|
7
|
+
Scaleway SDK for Rdb API.
|
|
8
|
+
|
|
9
|
+
> **Note**
|
|
10
|
+
> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install @scaleway/sdk-rdb @scaleway/sdk-client
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
or with pnpm:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
pnpm add @scaleway/sdk-rdb @scaleway/sdk-client
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
or with yarn:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
yarn add @scaleway/sdk-rdb @scaleway/sdk-client
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Getting Started
|
|
31
|
+
|
|
32
|
+
You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
|
|
33
|
+
|
|
34
|
+
### Basic Usage
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import { createClient } from '@scaleway/sdk-client'
|
|
38
|
+
import { Rdb } from '@scaleway/sdk-rdb'
|
|
39
|
+
|
|
40
|
+
const client = createClient({
|
|
41
|
+
accessKey: 'SCWXXXXXXXXXXXXXXXXX',
|
|
42
|
+
secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
43
|
+
defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
|
44
|
+
defaultRegion: 'fr-par',
|
|
45
|
+
defaultZone: 'fr-par-1',
|
|
46
|
+
})
|
|
47
|
+
|
|
48
|
+
const api = new Rdb.v1.API(client)
|
|
49
|
+
|
|
50
|
+
// Use the API
|
|
51
|
+
// Example: await api.listServers()
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Using Configuration Loader
|
|
55
|
+
|
|
56
|
+
For a simpler setup, you can load credentials from the configuration file or environment variables:
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { createClient } from '@scaleway/sdk-client'
|
|
60
|
+
import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
|
|
61
|
+
import { Rdb } from '@scaleway/sdk-rdb'
|
|
62
|
+
|
|
63
|
+
const profile = loadProfileFromConfigurationFile()
|
|
64
|
+
const client = createClient(profile)
|
|
65
|
+
const api = new Rdb.v1.API(client)
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Documentation
|
|
69
|
+
|
|
70
|
+
- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
|
|
71
|
+
- 🌐 [Scaleway Rdb API Documentation](https://www.scaleway.com/en/developers/api/rdb/)
|
|
72
|
+
- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
|
|
73
|
+
- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
|
|
74
|
+
|
|
75
|
+
## Features
|
|
76
|
+
|
|
77
|
+
- ✅ Full TypeScript support with complete type definitions
|
|
78
|
+
- ✅ Promise-based API
|
|
79
|
+
- ✅ Automatic pagination helpers
|
|
80
|
+
- ✅ Built-in error handling
|
|
81
|
+
- ✅ Compatible with Node.js ≥ 20
|
|
82
|
+
|
|
83
|
+
## Support
|
|
84
|
+
|
|
85
|
+
We love feedback! Feel free to reach us on:
|
|
86
|
+
- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
|
|
87
|
+
- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
|
|
88
|
+
|
|
89
|
+
## Contributing
|
|
90
|
+
|
|
91
|
+
This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
|
|
96
|
+
|
package/dist/v1/api.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
2
1
|
import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
|
|
2
|
+
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
3
3
|
import type { AddInstanceACLRulesRequest, AddInstanceACLRulesResponse, AddInstanceSettingsRequest, AddInstanceSettingsResponse, ApplyInstanceMaintenanceRequest, CloneInstanceRequest, CreateDatabaseBackupRequest, CreateDatabaseRequest, CreateEndpointRequest, CreateInstanceFromSnapshotRequest, CreateInstanceRequest, CreateReadReplicaEndpointRequest, CreateReadReplicaRequest, CreateSnapshotRequest, CreateUserRequest, Database, DatabaseBackup, DeleteDatabaseBackupRequest, DeleteDatabaseRequest, DeleteEndpointRequest, DeleteInstanceACLRulesRequest, DeleteInstanceACLRulesResponse, DeleteInstanceRequest, DeleteInstanceSettingsRequest, DeleteInstanceSettingsResponse, DeleteReadReplicaRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, ExportDatabaseBackupRequest, GetDatabaseBackupRequest, GetEndpointRequest, GetInstanceCertificateRequest, GetInstanceLogRequest, GetInstanceMetricsRequest, GetInstanceRequest, GetReadReplicaRequest, GetSnapshotRequest, Instance, InstanceLog, InstanceMetrics, ListDatabaseBackupsRequest, ListDatabaseBackupsResponse, ListDatabaseEnginesRequest, ListDatabaseEnginesResponse, ListDatabasesRequest, ListDatabasesResponse, ListInstanceACLRulesRequest, ListInstanceACLRulesResponse, ListInstanceLogsDetailsRequest, ListInstanceLogsDetailsResponse, ListInstanceLogsRequest, ListInstanceLogsResponse, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListPrivilegesRequest, ListPrivilegesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, Maintenance, MigrateEndpointRequest, PrepareInstanceLogsRequest, PrepareInstanceLogsResponse, Privilege, PromoteReadReplicaRequest, PurgeInstanceLogsRequest, ReadReplica, RenewInstanceCertificateRequest, ResetReadReplicaRequest, RestartInstanceRequest, RestoreDatabaseBackupRequest, SetInstanceACLRulesRequest, SetInstanceACLRulesResponse, SetInstanceSettingsRequest, SetInstanceSettingsResponse, SetPrivilegeRequest, Snapshot, UpdateDatabaseBackupRequest, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen.js';
|
|
4
4
|
/**
|
|
5
5
|
* Managed Database for PostgreSQL and MySQL API.
|
|
@@ -177,8 +177,9 @@ export declare class API extends ParentAPI {
|
|
|
177
177
|
*/
|
|
178
178
|
renewInstanceCertificate: (request: Readonly<RenewInstanceCertificateRequest>) => Promise<void>;
|
|
179
179
|
/**
|
|
180
|
-
* Get Database Instance metrics. Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`.
|
|
180
|
+
* [deprecated] Get Database Instance metrics. Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`. This method is deprecated and will be removed in a future version.
|
|
181
181
|
*
|
|
182
|
+
* @deprecated
|
|
182
183
|
* @param request - The request {@link GetInstanceMetricsRequest}
|
|
183
184
|
* @returns A Promise of InstanceMetrics
|
|
184
185
|
*/
|
package/dist/v1/api.gen.js
CHANGED
|
@@ -10,7 +10,11 @@ class API extends API$1 {
|
|
|
10
10
|
* type ∈ {'zone','region','global','unspecified'}
|
|
11
11
|
*/
|
|
12
12
|
static LOCALITY = toApiLocality({
|
|
13
|
-
regions: [
|
|
13
|
+
regions: [
|
|
14
|
+
"fr-par",
|
|
15
|
+
"nl-ams",
|
|
16
|
+
"pl-waw"
|
|
17
|
+
]
|
|
14
18
|
});
|
|
15
19
|
pageOfListDatabaseEngines = (request = {}) => this.client.fetch(
|
|
16
20
|
{
|
|
@@ -19,10 +23,7 @@ class API extends API$1 {
|
|
|
19
23
|
urlParams: urlParams(
|
|
20
24
|
["name", request.name],
|
|
21
25
|
["page", request.page],
|
|
22
|
-
[
|
|
23
|
-
"page_size",
|
|
24
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
25
|
-
],
|
|
26
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
26
27
|
["version", request.version]
|
|
27
28
|
)
|
|
28
29
|
},
|
|
@@ -42,10 +43,7 @@ class API extends API$1 {
|
|
|
42
43
|
urlParams: urlParams(
|
|
43
44
|
["include_disabled_types", request.includeDisabledTypes],
|
|
44
45
|
["page", request.page],
|
|
45
|
-
[
|
|
46
|
-
"page_size",
|
|
47
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
48
|
-
]
|
|
46
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
49
47
|
)
|
|
50
48
|
},
|
|
51
49
|
unmarshalListNodeTypesResponse
|
|
@@ -67,10 +65,7 @@ class API extends API$1 {
|
|
|
67
65
|
["order_by", request.orderBy],
|
|
68
66
|
["organization_id", request.organizationId],
|
|
69
67
|
["page", request.page],
|
|
70
|
-
[
|
|
71
|
-
"page_size",
|
|
72
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
73
|
-
],
|
|
68
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
74
69
|
["project_id", request.projectId]
|
|
75
70
|
)
|
|
76
71
|
},
|
|
@@ -82,11 +77,7 @@ class API extends API$1 {
|
|
|
82
77
|
* @param request - The request {@link ListDatabaseBackupsRequest}
|
|
83
78
|
* @returns A Promise of ListDatabaseBackupsResponse
|
|
84
79
|
*/
|
|
85
|
-
listDatabaseBackups = (request = {}) => enrichForPagination(
|
|
86
|
-
"databaseBackups",
|
|
87
|
-
this.pageOfListDatabaseBackups,
|
|
88
|
-
request
|
|
89
|
-
);
|
|
80
|
+
listDatabaseBackups = (request = {}) => enrichForPagination("databaseBackups", this.pageOfListDatabaseBackups, request);
|
|
90
81
|
/**
|
|
91
82
|
* Create a database backup. Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters.
|
|
92
83
|
*
|
|
@@ -125,9 +116,7 @@ class API extends API$1 {
|
|
|
125
116
|
* @returns A Promise of DatabaseBackup
|
|
126
117
|
*/
|
|
127
118
|
waitForDatabaseBackup = (request, options) => waitForResource(
|
|
128
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
129
|
-
!DATABASE_BACKUP_TRANSIENT_STATUSES.includes(res.status)
|
|
130
|
-
)),
|
|
119
|
+
options?.stop ?? ((res) => Promise.resolve(!DATABASE_BACKUP_TRANSIENT_STATUSES.includes(res.status))),
|
|
131
120
|
this.getDatabaseBackup,
|
|
132
121
|
request,
|
|
133
122
|
options
|
|
@@ -221,10 +210,7 @@ class API extends API$1 {
|
|
|
221
210
|
["order_by", request.orderBy],
|
|
222
211
|
["organization_id", request.organizationId],
|
|
223
212
|
["page", request.page],
|
|
224
|
-
[
|
|
225
|
-
"page_size",
|
|
226
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
227
|
-
],
|
|
213
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
228
214
|
["project_id", request.projectId],
|
|
229
215
|
["tags", request.tags]
|
|
230
216
|
)
|
|
@@ -259,9 +245,7 @@ class API extends API$1 {
|
|
|
259
245
|
* @returns A Promise of Instance
|
|
260
246
|
*/
|
|
261
247
|
waitForInstance = (request, options) => waitForResource(
|
|
262
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
263
|
-
!INSTANCE_TRANSIENT_STATUSES.includes(res.status)
|
|
264
|
-
)),
|
|
248
|
+
options?.stop ?? ((res) => Promise.resolve(!INSTANCE_TRANSIENT_STATUSES.includes(res.status))),
|
|
265
249
|
this.getInstance,
|
|
266
250
|
request,
|
|
267
251
|
options
|
|
@@ -351,26 +335,33 @@ class API extends API$1 {
|
|
|
351
335
|
* @param request - The request {@link GetInstanceCertificateRequest}
|
|
352
336
|
* @returns A Promise of Blob
|
|
353
337
|
*/
|
|
354
|
-
getInstanceCertificate = (request) => this.client.fetch(
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
338
|
+
getInstanceCertificate = (request) => this.client.fetch(
|
|
339
|
+
{
|
|
340
|
+
method: "GET",
|
|
341
|
+
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/certificate`,
|
|
342
|
+
urlParams: urlParams(
|
|
343
|
+
["dl", 1]
|
|
344
|
+
),
|
|
345
|
+
responseType: "blob"
|
|
346
|
+
}
|
|
347
|
+
);
|
|
360
348
|
/**
|
|
361
349
|
* Renew the TLS certificate of a Database Instance. Renew a TLS for a Database Instance. Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients.
|
|
362
350
|
*
|
|
363
351
|
* @param request - The request {@link RenewInstanceCertificateRequest}
|
|
364
352
|
*/
|
|
365
|
-
renewInstanceCertificate = (request) => this.client.fetch(
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
353
|
+
renewInstanceCertificate = (request) => this.client.fetch(
|
|
354
|
+
{
|
|
355
|
+
body: "{}",
|
|
356
|
+
headers: jsonContentHeaders,
|
|
357
|
+
method: "POST",
|
|
358
|
+
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/renew-certificate`
|
|
359
|
+
}
|
|
360
|
+
);
|
|
371
361
|
/**
|
|
372
|
-
* Get Database Instance metrics. Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`.
|
|
362
|
+
* [deprecated] Get Database Instance metrics. Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`. This method is deprecated and will be removed in a future version.
|
|
373
363
|
*
|
|
364
|
+
* @deprecated
|
|
374
365
|
* @param request - The request {@link GetInstanceMetricsRequest}
|
|
375
366
|
* @returns A Promise of InstanceMetrics
|
|
376
367
|
*/
|
|
@@ -424,9 +415,7 @@ class API extends API$1 {
|
|
|
424
415
|
* @returns A Promise of ReadReplica
|
|
425
416
|
*/
|
|
426
417
|
waitForReadReplica = (request, options) => waitForResource(
|
|
427
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
428
|
-
!READ_REPLICA_TRANSIENT_STATUSES.includes(res.status)
|
|
429
|
-
)),
|
|
418
|
+
options?.stop ?? ((res) => Promise.resolve(!READ_REPLICA_TRANSIENT_STATUSES.includes(res.status))),
|
|
430
419
|
this.getReadReplica,
|
|
431
420
|
request,
|
|
432
421
|
options
|
|
@@ -484,10 +473,7 @@ class API extends API$1 {
|
|
|
484
473
|
createReadReplicaEndpoint = (request) => this.client.fetch(
|
|
485
474
|
{
|
|
486
475
|
body: JSON.stringify(
|
|
487
|
-
marshalCreateReadReplicaEndpointRequest(
|
|
488
|
-
request,
|
|
489
|
-
this.client.settings
|
|
490
|
-
)
|
|
476
|
+
marshalCreateReadReplicaEndpointRequest(request, this.client.settings)
|
|
491
477
|
),
|
|
492
478
|
headers: jsonContentHeaders,
|
|
493
479
|
method: "POST",
|
|
@@ -522,7 +508,9 @@ class API extends API$1 {
|
|
|
522
508
|
{
|
|
523
509
|
method: "GET",
|
|
524
510
|
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/logs`,
|
|
525
|
-
urlParams: urlParams(
|
|
511
|
+
urlParams: urlParams(
|
|
512
|
+
["order_by", request.orderBy]
|
|
513
|
+
)
|
|
526
514
|
},
|
|
527
515
|
unmarshalListInstanceLogsResponse
|
|
528
516
|
);
|
|
@@ -547,9 +535,7 @@ class API extends API$1 {
|
|
|
547
535
|
* @returns A Promise of InstanceLog
|
|
548
536
|
*/
|
|
549
537
|
waitForInstanceLog = (request, options) => waitForResource(
|
|
550
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
551
|
-
!INSTANCE_LOG_TRANSIENT_STATUSES.includes(res.status)
|
|
552
|
-
)),
|
|
538
|
+
options?.stop ?? ((res) => Promise.resolve(!INSTANCE_LOG_TRANSIENT_STATUSES.includes(res.status))),
|
|
553
539
|
this.getInstanceLog,
|
|
554
540
|
request,
|
|
555
541
|
options
|
|
@@ -559,14 +545,16 @@ class API extends API$1 {
|
|
|
559
545
|
*
|
|
560
546
|
* @param request - The request {@link PurgeInstanceLogsRequest}
|
|
561
547
|
*/
|
|
562
|
-
purgeInstanceLogs = (request) => this.client.fetch(
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
548
|
+
purgeInstanceLogs = (request) => this.client.fetch(
|
|
549
|
+
{
|
|
550
|
+
body: JSON.stringify(
|
|
551
|
+
marshalPurgeInstanceLogsRequest(request, this.client.settings)
|
|
552
|
+
),
|
|
553
|
+
headers: jsonContentHeaders,
|
|
554
|
+
method: "POST",
|
|
555
|
+
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/purge-logs`
|
|
556
|
+
}
|
|
557
|
+
);
|
|
570
558
|
/**
|
|
571
559
|
* List remote Database Instance logs details. List remote log details. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
|
|
572
560
|
*
|
|
@@ -637,10 +625,7 @@ class API extends API$1 {
|
|
|
637
625
|
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/acls`,
|
|
638
626
|
urlParams: urlParams(
|
|
639
627
|
["page", request.page],
|
|
640
|
-
[
|
|
641
|
-
"page_size",
|
|
642
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
643
|
-
]
|
|
628
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
644
629
|
)
|
|
645
630
|
},
|
|
646
631
|
unmarshalListInstanceACLRulesResponse
|
|
@@ -711,10 +696,7 @@ class API extends API$1 {
|
|
|
711
696
|
["name", request.name],
|
|
712
697
|
["order_by", request.orderBy],
|
|
713
698
|
["page", request.page],
|
|
714
|
-
[
|
|
715
|
-
"page_size",
|
|
716
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
717
|
-
]
|
|
699
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
718
700
|
)
|
|
719
701
|
},
|
|
720
702
|
unmarshalListUsersResponse
|
|
@@ -765,10 +747,12 @@ class API extends API$1 {
|
|
|
765
747
|
*
|
|
766
748
|
* @param request - The request {@link DeleteUserRequest}
|
|
767
749
|
*/
|
|
768
|
-
deleteUser = (request) => this.client.fetch(
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
750
|
+
deleteUser = (request) => this.client.fetch(
|
|
751
|
+
{
|
|
752
|
+
method: "DELETE",
|
|
753
|
+
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/users/${validatePathParam("name", request.name)}`
|
|
754
|
+
}
|
|
755
|
+
);
|
|
772
756
|
pageOfListDatabases = (request) => this.client.fetch(
|
|
773
757
|
{
|
|
774
758
|
method: "GET",
|
|
@@ -779,10 +763,7 @@ class API extends API$1 {
|
|
|
779
763
|
["order_by", request.orderBy],
|
|
780
764
|
["owner", request.owner],
|
|
781
765
|
["page", request.page],
|
|
782
|
-
[
|
|
783
|
-
"page_size",
|
|
784
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
785
|
-
],
|
|
766
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
786
767
|
["skip_size_retrieval", request.skipSizeRetrieval]
|
|
787
768
|
)
|
|
788
769
|
},
|
|
@@ -817,10 +798,12 @@ class API extends API$1 {
|
|
|
817
798
|
*
|
|
818
799
|
* @param request - The request {@link DeleteDatabaseRequest}
|
|
819
800
|
*/
|
|
820
|
-
deleteDatabase = (request) => this.client.fetch(
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
801
|
+
deleteDatabase = (request) => this.client.fetch(
|
|
802
|
+
{
|
|
803
|
+
method: "DELETE",
|
|
804
|
+
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/databases/${validatePathParam("name", request.name)}`
|
|
805
|
+
}
|
|
806
|
+
);
|
|
824
807
|
pageOfListPrivileges = (request) => this.client.fetch(
|
|
825
808
|
{
|
|
826
809
|
method: "GET",
|
|
@@ -829,10 +812,7 @@ class API extends API$1 {
|
|
|
829
812
|
["database_name", request.databaseName],
|
|
830
813
|
["order_by", request.orderBy],
|
|
831
814
|
["page", request.page],
|
|
832
|
-
[
|
|
833
|
-
"page_size",
|
|
834
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
835
|
-
],
|
|
815
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
836
816
|
["user_name", request.userName]
|
|
837
817
|
)
|
|
838
818
|
},
|
|
@@ -872,10 +852,7 @@ class API extends API$1 {
|
|
|
872
852
|
["order_by", request.orderBy],
|
|
873
853
|
["organization_id", request.organizationId],
|
|
874
854
|
["page", request.page],
|
|
875
|
-
[
|
|
876
|
-
"page_size",
|
|
877
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
878
|
-
],
|
|
855
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
879
856
|
["project_id", request.projectId]
|
|
880
857
|
)
|
|
881
858
|
},
|
|
@@ -909,9 +886,7 @@ class API extends API$1 {
|
|
|
909
886
|
* @returns A Promise of Snapshot
|
|
910
887
|
*/
|
|
911
888
|
waitForSnapshot = (request, options) => waitForResource(
|
|
912
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
913
|
-
!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status)
|
|
914
|
-
)),
|
|
889
|
+
options?.stop ?? ((res) => Promise.resolve(!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status))),
|
|
915
890
|
this.getSnapshot,
|
|
916
891
|
request,
|
|
917
892
|
options
|
|
@@ -972,10 +947,7 @@ class API extends API$1 {
|
|
|
972
947
|
createInstanceFromSnapshot = (request) => this.client.fetch(
|
|
973
948
|
{
|
|
974
949
|
body: JSON.stringify(
|
|
975
|
-
marshalCreateInstanceFromSnapshotRequest(
|
|
976
|
-
request,
|
|
977
|
-
this.client.settings
|
|
978
|
-
)
|
|
950
|
+
marshalCreateInstanceFromSnapshotRequest(request, this.client.settings)
|
|
979
951
|
),
|
|
980
952
|
headers: jsonContentHeaders,
|
|
981
953
|
method: "POST",
|
|
@@ -1005,10 +977,12 @@ class API extends API$1 {
|
|
|
1005
977
|
*
|
|
1006
978
|
* @param request - The request {@link DeleteEndpointRequest}
|
|
1007
979
|
*/
|
|
1008
|
-
deleteEndpoint = (request) => this.client.fetch(
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
980
|
+
deleteEndpoint = (request) => this.client.fetch(
|
|
981
|
+
{
|
|
982
|
+
method: "DELETE",
|
|
983
|
+
path: `/rdb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam("endpointId", request.endpointId)}`
|
|
984
|
+
}
|
|
985
|
+
);
|
|
1012
986
|
/**
|
|
1013
987
|
* Get a Database Instance endpoint. Retrieve information about a Database Instance endpoint. Full details about the endpoint, like `ip`, `port`, `private_network` and `load_balancer` specifications are returned in the response.
|
|
1014
988
|
*
|
package/dist/v1/content.gen.js
CHANGED
|
@@ -4,7 +4,9 @@ const DATABASE_BACKUP_TRANSIENT_STATUSES = [
|
|
|
4
4
|
"deleting",
|
|
5
5
|
"exporting"
|
|
6
6
|
];
|
|
7
|
-
const INSTANCE_LOG_TRANSIENT_STATUSES = [
|
|
7
|
+
const INSTANCE_LOG_TRANSIENT_STATUSES = [
|
|
8
|
+
"creating"
|
|
9
|
+
];
|
|
8
10
|
const INSTANCE_TRANSIENT_STATUSES = [
|
|
9
11
|
"provisioning",
|
|
10
12
|
"configuring",
|
|
@@ -15,7 +17,9 @@ const INSTANCE_TRANSIENT_STATUSES = [
|
|
|
15
17
|
"snapshotting",
|
|
16
18
|
"restarting"
|
|
17
19
|
];
|
|
18
|
-
const MAINTENANCE_TRANSIENT_STATUSES = [
|
|
20
|
+
const MAINTENANCE_TRANSIENT_STATUSES = [
|
|
21
|
+
"ongoing"
|
|
22
|
+
];
|
|
19
23
|
const READ_REPLICA_TRANSIENT_STATUSES = [
|
|
20
24
|
"provisioning",
|
|
21
25
|
"initializing",
|
package/dist/v1/index.gen.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { API } from './api.gen.js';
|
|
1
|
+
export { API, } from './api.gen.js';
|
|
2
2
|
export * from './content.gen.js';
|
|
3
3
|
export * from './marshalling.gen.js';
|
|
4
4
|
export type { ACLRule, ACLRuleAction, ACLRuleDirection, ACLRuleProtocol, ACLRuleRequest, AddInstanceACLRulesRequest, AddInstanceACLRulesResponse, AddInstanceSettingsRequest, AddInstanceSettingsResponse, ApplyInstanceMaintenanceRequest, BackupSchedule, CloneInstanceRequest, CreateDatabaseBackupRequest, CreateDatabaseRequest, CreateEndpointRequest, CreateInstanceFromSnapshotRequest, CreateInstanceRequest, CreateReadReplicaEndpointRequest, CreateReadReplicaRequest, CreateSnapshotRequest, CreateUserRequest, Database, DatabaseBackup, DatabaseBackupStatus, DatabaseEngine, DeleteDatabaseBackupRequest, DeleteDatabaseRequest, DeleteEndpointRequest, DeleteInstanceACLRulesRequest, DeleteInstanceACLRulesResponse, DeleteInstanceRequest, DeleteInstanceSettingsRequest, DeleteInstanceSettingsResponse, DeleteReadReplicaRequest, DeleteSnapshotRequest, DeleteUserRequest, EncryptionAtRest, Endpoint, EndpointDirectAccessDetails, EndpointLoadBalancerDetails, EndpointPrivateNetworkDetails, EndpointPrivateNetworkDetailsProvisioningMode, EndpointSpec, EndpointSpecLoadBalancer, EndpointSpecPrivateNetwork, EndpointSpecPrivateNetworkIpamConfig, EngineSetting, EngineSettingPropertyType, EngineVersion, ExportDatabaseBackupRequest, GetDatabaseBackupRequest, GetEndpointRequest, GetInstanceCertificateRequest, GetInstanceLogRequest, GetInstanceMetricsRequest, GetInstanceRequest, GetReadReplicaRequest, GetSnapshotRequest, Instance, InstanceLog, InstanceLogStatus, InstanceMetrics, InstanceSetting, InstanceStatus, ListDatabaseBackupsRequest, ListDatabaseBackupsRequestOrderBy, ListDatabaseBackupsResponse, ListDatabaseEnginesRequest, ListDatabaseEnginesResponse, ListDatabasesRequest, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListInstanceACLRulesRequest, ListInstanceACLRulesResponse, ListInstanceLogsDetailsRequest, ListInstanceLogsDetailsResponse, ListInstanceLogsDetailsResponseInstanceLogDetail, ListInstanceLogsRequest, ListInstanceLogsRequestOrderBy, ListInstanceLogsResponse, ListInstancesRequest, ListInstancesRequestOrderBy, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListPrivilegesRequest, ListPrivilegesRequestOrderBy, ListPrivilegesResponse, ListSnapshotsRequest, ListSnapshotsRequestOrderBy, ListSnapshotsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, LogsPolicy, Maintenance, MaintenanceStatus, MigrateEndpointRequest, NodeType, NodeTypeGeneration, NodeTypeStock, NodeTypeVolumeConstraintSizes, NodeTypeVolumeType, Permission, PrepareInstanceLogsRequest, PrepareInstanceLogsResponse, Privilege, PromoteReadReplicaRequest, PurgeInstanceLogsRequest, ReadReplica, ReadReplicaEndpointSpec, ReadReplicaEndpointSpecDirectAccess, ReadReplicaEndpointSpecPrivateNetwork, ReadReplicaEndpointSpecPrivateNetworkIpamConfig, ReadReplicaStatus, RenewInstanceCertificateRequest, ResetReadReplicaRequest, RestartInstanceRequest, RestoreDatabaseBackupRequest, SetInstanceACLRulesRequest, SetInstanceACLRulesResponse, SetInstanceSettingsRequest, SetInstanceSettingsResponse, SetPrivilegeRequest, Snapshot, SnapshotStatus, SnapshotVolumeType, StorageClass, UpdateDatabaseBackupRequest, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradableVersion, UpgradeInstanceRequest, UpgradeInstanceRequestMajorUpgradeWorkflow, User, Volume, VolumeType, } from './types.gen.js';
|