Scaleway Rdb
@sntxrr/scaleway-rdbv2026.10.14.1
01README
Manage a Scaleway Managed Database (RDB) instance — sync state, create, update, and delete PostgreSQL/MySQL instances, and discover instances in a region, via the RDB API with X-Auth-Token auth.
02Release Notes
Declare SPDX license (MIT) in manifest.
03Behaviors
@sntxrr/scaleway-rdbv2026.07.19.1scaleway_rdb.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| secretKey | string | Scaleway API secret key. Wire with ${{ vault.get(scaleway, SCW_SECRET_KEY) }}. |
| projectId | string | Scaleway Project ID that owns the database instance. |
| region? | string | Region, e.g. fr-par, nl-ams, pl-waw. |
| instanceId? | string | ID of the Managed Database instance this model manages. Optional — |
| endpoint? | string | Override the API host. Defaults to https://api.scaleway.com. |
fn sync()
Fetch the database instance's current state (GetInstance).
fn create(name: string, engine: string, nodeType: string, userName: string, password: string, isHaCluster?: boolean, disableBackup?: boolean, volumeType?: string, volumeSize?: number, tags?: array)
Provision a new database instance (CreateInstance) and snapshot it.
| Argument | Type | Description |
|---|---|---|
| name | string | Name of the new database instance. |
| engine | string | Database engine version ID, e.g. PostgreSQL-15 or MySQL-8. |
| nodeType | string | Node type (commercial size), e.g. DB-DEV-S. |
| userName | string | Identifier of the default database user. |
| password | string | Password for the default user. Sent only to provision; never stored. |
| isHaCluster? | boolean | Whether to provision a High-Availability cluster. |
| disableBackup? | boolean | Whether to disable automated backups on the new instance. |
| volumeType? | string | Volume type, e.g. lssd or bssd. Optional; engine default applies. |
| volumeSize? | number | Volume size in bytes. Optional; engine default applies. |
| tags? | array | Tags to attach to the new instance. |
fn update(name?: string, tags?: array)
Mutate a database instance's mutable fields (UpdateInstance).
| Argument | Type | Description |
|---|---|---|
| name? | string | New name for the instance. |
| tags? | array | Replacement set of tags for the instance. |
fn delete()
Deprovision the database instance (DeleteInstance).
fn list()
Discover all database instances in the region (factory).
Resources
instance(infinite)— Snapshot of the Managed Database instance's state
04Previous Versions
2026.07.19.1
2026.07.18.1
05Stats
A
100 / 100
Downloads
27
Archive size
8.6 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
Repository
https://github.com/sntxrr/swamp-scaleway06Platforms
07Labels