Skip to main content
api.databases は Square Cloud のマネージドデータベース (MongoDB、MySQL、PostgreSQL、Redis) を管理します。create と statusAll を除くすべてのメソッドは、第 1 引数にデータベース ID を取ります。データベースを一覧するには api.account.me() を使います。その databases 配列に、キーから見えるすべてのデータベースが含まれています。 データベースのホスティングには Standard、Pro、Enterprise のいずれかのプランが必要です。 サンプルでは、クライアントの作成で作成した api クライアントを使います。databaseId はあなたのデータベースの ID で、api.account.me() で一覧できます。

データベースの作成

password と certificate は create() (および resetCredentials()) でのみ返されます。この呼び出しはタイムアウトまで最低 120 秒待機します。

データベースの取得

データベースの更新

update(databaseId, { name, ram }) はデータベースの名前やサイズを変更します。少なくとも 1 つのフィールドを渡してください (渡さない場合は 400 NO_UPDATE_DATA)。

起動と停止

アプリのライフサイクル系の呼び出しと同様に最低 120 秒待機し、拒否された場合はコードと空のメッセージを持つ 409 になります: CONTAINER_ALREADY_STARTED、CONTAINER_ALREADY_STOPPED、CONTAINER_NOT_FOUND、CONTAINER_INSUFFICIENT_DISK_SPACE、CONTAINER_NETWORK_CONFLICT、ACTION_FAILED。snapshot の復元中は 403 RESTORE_IN_PROGRESS になります。

ステータスとメトリクス

status(databaseId) はフォーマット済みの値を返し、{ raw: true } を指定すると数値を返します。statusAll() はデータベースごとに 1 つのサマリーを返します。metrics(databaseId) は直近 24 時間分を、5 分ごとに 1 ポイント、新しい順で返します。
ステータスのフィールドはアプリのステータスと同じです。

認証情報

certificate(databaseId) は TLS 証明書を base64 エンコードされた PEM として返します。resetCredentials(databaseId, type) はパスワードをローテーションする (新しいパスワードを返す) か、証明書をローテーションします ("" を返す)。データベースが実行中である必要があります (400 DATABASE_NOT_RUNNING)。

データベースの削除

削除は元に戻せません。データが再び必要になる可能性がある場合は、先に snapshot を作成してください。

Snapshot

api.databases.snapshots には、アプリと同じ list、create、restore があります。Snapshot を参照してください。

次のステップ

Workspace

チームとアプリを共有します。

データベース API リファレンス

これらのメソッドが呼び出す REST endpoint。

CLI でデータベースを操作

同じ操作をターミナルから行います。