Database

A Database Instance is essentially a snapshot of a database at a specific point in time. It represents the current state of the data stored within the database, including all the tables, records, and their corresponding values.

Database operations use the db_ prefix on the GraphQL gateway. They cover creating, updating and restoring database instances, reading them, and reading each instance's backup history and backup log. Backup plans are listed with the store's store_getProductCategoryTree and store_listProduct queries.

GraphQL Gateway

https://cloud-gateway.sabay.com/graphql

This is the same gateway used by Storage and Run App. The testing environment is at https://cloud-gateway.testing.sabay.com/graphql.

Authentication

Every request must carry both headers. See Authentication for how to get a token.

HeaderValue
service-codecloud_user
AuthorizationBearer {token}

Asynchronous lifecycle

Engines and versions

EngineVersions
MySQL5.7, 8.0
MongoDB6.0, 7.0, 8.0
PostgreSQL14, 15, 16
MariaDB10.11, 11.8

Status values

Service names

Two service codes are involved, each with its own subscription:

Service codeUsed for
cloud_dbDatabase plans / subscriptions
cloud_db_backupDatabase backup plans / subscriptions

Reference

PageOperations
Instancesdb_createDbInstance, db_listDbInstancesByUser, db_updateDbInstance, db_getUserDbInstanceById, db_restoreDbInstance, container_getDbResourceUsage
BackupsBackup flow, store_getProductCategoryTree, store_listProduct, db_listUserDbBackupHistoryByDb, db_listUserDbBackupLogByDb
TypesShared response types, pagination and enums