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.

FieldType
idID!
mysabayUserIdInt!
urlString
serviceCodeString!
subscriptionIdID
nameString!
enginedb_DbEngine!
versionString!
typedb_DatabaseType!
specificationdb_JSON
connectionString
host[String!]
adminToolUrl[String!]
statusdb_DatabaseStatus!
domainPrefixString
deployNodeString
ipWhitelistString
publicPortInt
isBackupEnabledBoolean
backupdb_DbBackupResponse
createdAtFloat!
updatedAtFloat!

db_DbBackupResponse

An instance's backup settings, in the backup field of db_DatabaseInstanceResponse.

FieldType
statusdb_DbBackupStatus!
occurrence_keyString!
occurrence_display_nameString!
occurrence_hoursFloat!
retention_keyString!
retention_display_nameString!
retention_daysFloat!
destination_pathString!
enabled_atFloat!
subscriptionIdID
planIdID

db_ModifyDbInstanceResponse

Returned by Update Instance and Restore Instance.

FieldType
statusFloat!
messageString!

db_PagerInput

Optional pager argument of every list query.

FieldTypeRequiredDefault
pageIntYes1
limitIntYes20

Both fields have defaults, so you can pass pager: {} or leave pager out.

db_Pagination

FieldType
currentPageInt!
lastPageInt!
fromInt!
toInt!
perPageInt!
totalInt!

Enums

db_DbEngine

MySQL · MongoDB · PostgreSQL · MariaDB

db_DatabaseType

Standalone · Cluster

db_DatabaseStatus

Processing · Running · Suspended · Failed · Cancelled

db_DatabaseStatusFilter

Processing · Running · Suspended · Failed

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