CLI でデータベースを管理する

squarecloud db は、アカウントの MongoDB、MySQL、PostgreSQL、Redis データベースを管理します。squarecloud database としても使えます。データベースには設定ファイルがないため、[dbID] は渡した ID になるか、ターミナルで省略した場合はデータベースの選択画面になります。ID は squarecloud db list で確認できます。

`squarecloud db create`

使い方

squarecloud db create --name <name> --memory <MB> --type <engine> --version <version> [--json]

フラグ	説明
`--name <name>`	データベース名。1 から 32 文字。
`--memory <MB>`	割り当てるメモリ（MB）。
`--type <engine>`	`mongo`、`mysql`、`redis`、`postgres` のいずれか。
`--version <version>`	エンジンのバージョン。PostgreSQL の `17` や MongoDB の `8` のようなメジャーバージョン、または完全なバージョン。

4 つのフラグはすべて必須で、指定しない場合はコマンドのヘルプが表示されます。データベースの作成には Standard、Pro、Enterprise のいずれかのプランが必要です。

squarecloud db create --name my-db --memory 1024 --type postgres --version 17

出力

✓ Database my-db (<dbID>) created successfully
Save the password now: it is shown only once and cannot be recovered.
  PASSWORD: <password>
  URL: <connection URL>

パスワードが表示されるのは 1 回だけです。db info では再表示されません。紛失した場合は db credentials reset password でローテーションしてください。

--json を付けると、パスワードと接続 URL を含む作成されたデータベースが JSON で出力されます。

`squarecloud db list`

使い方

squarecloud db list [--json]

アカウント内のすべてのデータベースの名前、ID、エンジン、メモリ、クラスターを表示します。

`squarecloud db info`

使い方

squarecloud db info [dbID] [--json]

データベースの ID、名前、エンジン、メモリ、ポート、クラスター、所有者、作成日を表示します。

`squarecloud db update`

使い方

squarecloud db update [dbID] [--name <name>] [--memory <MB>]

フラグ	説明
`--name <name>`	新しいデータベース名。
`--memory <MB>`	新しく割り当てるメモリ（MB）。

データベースの名前を変更するか、メモリを変更します。2 つのフラグのうち少なくとも 1 つを指定してください。指定しない場合はコマンドのヘルプが表示されます。

squarecloud db update <dbID> --memory 2048

`squarecloud db start`

使い方

squarecloud db start [dbID]

停止しているデータベースを起動します。すでに実行中の場合、CLI はその旨（It is already running.）を表示し、終了コード 0 で終了します。

`squarecloud db stop`

使い方

squarecloud db stop [dbID]

実行中のデータベースを停止します。すでに停止している場合、CLI はその旨（It is already stopped.）を表示し、終了コード 0 で終了します。

`squarecloud db status`

使い方

squarecloud db status [dbID] [--all] [--raw] [--json]

フラグ	説明
`--all`	1 つではなくすべてのデータベースについて、データベース ID、実行中かどうか、CPU、メモリを表示します。
`--raw`	表の代わりに、数値そのままの統計を JSON で出力します。

データベース ID、CPU 使用率、メモリ、ディスク、ステータスを表示します。

`squarecloud db metrics`

使い方

squarecloud db metrics [dbID] [--json]

データベースの過去 24 時間の CPU 使用率、RAM 使用量、ネットワークトラフィックを、5 分ごとのデータポイント 1 つにつき 1 行で表示します。

`squarecloud db credentials certificate`

使い方

squarecloud db credentials certificate [dbID]

データベースの TLS 証明書を表示します。クライアントは TLS で接続する際にこの証明書を使います。

squarecloud db credentials certificate <dbID> > certificate.pem
# Saves the certificate to a file.

`squarecloud db credentials reset`

使い方

squarecloud db credentials reset <password|certificate> [dbID] [-y]

フラグ	説明
`-y`、`--yes`	確認プロンプトをスキップします。

y/N の確認のあと、パスワードまたは TLS 証明書をローテーションします。古いものはすぐに使えなくなるため、それを使っているすべてのクライアントを更新してください。新しいパスワードは 1 回だけ表示されます。証明書をローテーションした後は、db credentials certificate で新しい証明書を取得してください。

squarecloud db credentials reset password <dbID>

`squarecloud db delete`

使い方

squarecloud db delete [dbID] [-y]

フラグ	説明
`-y`、`--yes`	確認プロンプトをスキップします。

データベースの削除は取り消せません。データのコピーを残すには、先に squarecloud db snapshot create --download を実行してください。

削除する前に Delete the database <dbID>? This action is irreversible [y/N] と確認します。

コマンド	API	JavaScript SDK	VS Code
`create`	`POST /v2/databases`	`api.databases.create()`	データベースを作成
`list`	`GET /v2/users/me`	`api.account.me()`	「データベース」セクション
`info`	`GET .../{database_id}`	`api.databases.get()`
`update`	`PATCH .../{database_id}`	`api.databases.update()`
`start`	`POST .../start`	`api.databases.start()`	データベースを起動
`stop`	`POST .../stop`	`api.databases.stop()`	データベースを停止
`status`	`GET .../status`	`api.databases.status()`
`status --all`	`GET /v2/databases/status`	`api.databases.statusAll()`
`metrics`	`GET .../metrics`	`api.databases.metrics()`
`credentials certificate`	`GET .../credentials/certificate`	`api.databases.certificate()`	TLS 証明書をダウンロード
`credentials reset`	`POST .../credentials/reset`	`api.databases.resetCredentials()`
`delete`	`DELETE .../{database_id}`	`api.databases.delete()`	データベースを削除

CLI

VS Code

SDKs

CLI でデータベースを管理する

`squarecloud db create`

`squarecloud db list`

`squarecloud db info`

`squarecloud db update`

`squarecloud db start`

`squarecloud db stop`

`squarecloud db status`

`squarecloud db metrics`

`squarecloud db credentials certificate`

`squarecloud db credentials reset`

`squarecloud db delete`

関連項目

​squarecloud db create

​squarecloud db list

​squarecloud db info

​squarecloud db update

​squarecloud db start

​squarecloud db stop

​squarecloud db status

​squarecloud db metrics

​squarecloud db credentials certificate

​squarecloud db credentials reset

​squarecloud db delete

​関連項目

`squarecloud db create`

`squarecloud db list`

`squarecloud db info`

`squarecloud db update`

`squarecloud db start`

`squarecloud db stop`

`squarecloud db status`

`squarecloud db metrics`

`squarecloud db credentials certificate`

`squarecloud db credentials reset`

`squarecloud db delete`

関連項目