Command reference#

PGDコマンドラインインターフェイスのコマンド名はpgd です。

概要#

EDB Postgres分散コマンドラインインターフェイスPGD CLIは、 EDB Postgres分散クラスターを管理するツールです。 EDB Postgres分散クラスターに対してコマンドを実行できます。これを使用して、クラスターリソースを検査および管理できます。

コマンド#

ユーザーロール#

各pgd コマンドは、特定のPostgresロールとして接続するか、いくつかのノード管理コマンドの場合、OSレベルのアクセスのみを必要とします。すべてのコマンドページには、必要なロールを記載したセクションが含まれています。

これらのロールは、 BDR拡張機能のインストール時に自動的に作成されるため、自分で作成する必要はなく、CLIに接続しているユーザにのみ付与します。各権限の背後にある完全な特権リストについては、 PGD predefined roles を参照してください。

Role

Description

bdr_superuser

完全なPGD管理。 `bdr`スキーマおよび`pg_read_all_stats`のすべてのテーブルとファンクションに`ALL`特権を直接付与します。これは、正式なロール継承ではありませんが、他のすべてのロールが付与するもののスーパーセットです。

bdr_monitor

読み取り専用のクラスターモニタリング。 bdr_read_all_stats`および`pg_read_all_stats`は`pg_read_all_settings`ではありませんを継承します。多くの`show/`list`コマンドは、 `bdr_monitor`に付与されていない内部機能を使用するため、引き続き`bdr_superuser`が必要です。

bdr_read_all_stats

PGD統計とカタログビューを読み取ります。 `pg_read_all_stats`を継承します。

bdr_application

コミットスコープの読み取りなど、アプリケーションレベルのアクセス。別のロール。モニタリングチェーンの一部ではありません。

Postgres superuser

ALTER SYSTEM、CREATE EXTENSION、および`pg_upgrade`に必要です。 `bdr_superuser`とは別にします。

OS user (pg_ctl)

OSレベルの操作である`pgd node start`/stop/`restart`で必要です。データベースロールはチェックされません。

グローバルオプション#

すべてのコマンドは、次のグローバルオプションを受け入れます。

Short

Long

Description

-f

--config-file

構成ファイルへの名前/パス。<br/>これは--dsnフラグが存在する場合、無視されます<br/>デフォルト "/etc/edb/pgd-cli/pgd-cli-config.yml"

--dsn

データベース接続文字列<br/>例「host=bdr-a1 port=5432 dbname=pgddb user=postgres」<br/>`PGD_CLI_DSN`環境変数によっても設定されます。

-h

--help

Help for pgd - 使用されるコマンドの特定のヘルプを表示します

-o

--output

出力フォーマット json、psql、modern、markdown、simple 出力フォーマット を参照してください。

追加オプション#

pgd -V を実行して、pgd CLIのバージョン情報を確認します。

出力フォーマット#

-o /--output オプションとともに使用します。

Format

Description

simple

単純なフォーマット-単純なASCIIテーブルとして出力しますデフォルト。

json

JSON形式 - JSONドキュメントとして出力します、非表形式

psql

PSQLフォーマット-PSQLのスタイルのASCIIテーブルとして出力

modern

最新のフォーマット-ボックスキャラクターを使用して表として出力

markdown

マークダウンテーブルフォーマット - マークダウン互換のASCIIテーブルとして出力