Types
Types shared by several Database operations. Timestamps (createdAt,
updatedAt and so on) are Float values. The schema doesn't give their unit.
db_DatabaseInstanceResponse
A database instance. Returned by Create Instance, Get Instance and List Instances.
| Field | Type |
|---|---|
id | ID! |
mysabayUserId | Int! |
url | String |
serviceCode | String! |
subscriptionId | ID |
name | String! |
engine | db_DbEngine! |
version | String! |
type | db_DatabaseType! |
specification | db_JSON |
connection | String |
host | [String!] |
adminToolUrl | [String!] |
status | db_DatabaseStatus! |
domainPrefix | String |
deployNode | String |
ipWhitelist | String |
publicPort | Int |
isBackupEnabled | Boolean |
backup | db_DbBackupResponse |
createdAt | Float! |
updatedAt | Float! |
The create input calls the engine dbEngine. This response calls it engine.
specification is a db_JSON scalar, an arbitrary JSON value whose shape the
schema doesn't define.
db_DbBackupResponse
An instance's backup settings, in the backup field of
db_DatabaseInstanceResponse.
| Field | Type |
|---|---|
status | db_DbBackupStatus! |
occurrence_key | String! |
occurrence_display_name | String! |
occurrence_hours | Float! |
retention_key | String! |
retention_display_name | String! |
retention_days | Float! |
destination_path | String! |
enabled_at | Float! |
subscriptionId | ID |
planId | ID |
These fields use snake_case, while every other Database type uses
camelCase. This is reproduced exactly as the schema has it.
db_ModifyDbInstanceResponse
Returned by Update Instance and Restore Instance.
| Field | Type |
|---|---|
status | Float! |
message | String! |
status here is a number. It's not the
db_DatabaseStatus enum.
db_PagerInput
Optional pager argument of every list query.
| Field | Type | Required | Default |
|---|---|---|---|
page | Int | Yes | 1 |
limit | Int | Yes | 20 |
Both fields have defaults, so you can pass pager: {} or leave pager out.
db_Pagination
| Field | Type |
|---|---|
currentPage | Int! |
lastPage | Int! |
from | Int! |
to | Int! |
perPage | Int! |
total | Int! |
Enums
db_DbEngine
MySQL · MongoDB · PostgreSQL · MariaDB
db_DatabaseType
Standalone · Cluster
db_DatabaseStatus
Processing · Running · Suspended · Failed · Cancelled
db_DatabaseStatusFilter
Processing · Running · Suspended · Failed
The filter enum has no Cancelled, unlike
db_DatabaseStatus. You can't filter the instance list
by that status.
db_DbBackupStatus
PENDING · SCHEDULE_DISABLE · ENABLED · SUSPENDED · FAILED · DISABLED
db_DbBackupHistoryStatus
PROCESSING · READY · RESTORING · COMPLETED · EXPIRING · EXPIRED ·
FAILED
db_DbBackupLogActionType
BACKUP · RESTORE · EXPIRE · DELETE
db_DbBackupLogStatus
PROCESSING · SUCCESS · FAILED
db_FileSizeUnit
BYTE