EDB Postgres Distributed Command Line Interface¶
EDB Postgres分散コマンドラインインターフェイス（PGD CLI）は、 EDB Postgres分散クラスターを管理するツールです。 EDB Postgres分散クラスターに対してコマンドを実行できます。
- クラスターリソースに関する情報を検査、管理、および取得するために使用可能なコマンドについては、
Command reference を参照してください。
TPAexecがPGD CLIを展開する方法、スタンドアロンサーバーにPGD CLIを手動でインストールする方法、および接続文字列を指定する方法については、
Installing PGD CLI を参照してください。
要件¶
PGD CLIを実行するには、postgresのスーパーユーザー権限が必要です。
PGD CLIの使用¶
pgd
は、PGDコマンドラインインターフェイスのコマンド名です。コマンドオプションの説明については、コマンドリファレンスの PGD CLIの使用 を参照してください。サンプルのユースケースについては、以下のセクションを参照してください。
構成ファイルの指定¶
ファイルの名前を変更するか、別の場所に移動する場合は、オプションの-f
または--config-file
フラグを使用して新しい名前と場所を指定します。例：
pgd show-nodes -f /opt/my-config.yml
データベース接続文字列を渡す¶
--dsn
フラグを使用して、データベース接続文字列をコマンドに直接渡します。このフラグを使用して接続文字列を渡す場合、構成ファイルは必要ありません。構成ファイルが存在する場合、フラグが優先されます。例：
pgd show-nodes --dsn "host=bdr-a1 port=5432 dbname=bdrdb user=postgres "
``` ## 出力フォーマットの指定
PGD CLIは、次の出力形式をサポートしています。
.. csv-table::
:header: Format,Considerations
:widths: 10,30
:align: left
:class: longtable
tabular,デフォルトのフォーマット。データを表形式で表示します。
json,フォーマットなしで生データを表示します。一部のコマンドでは、json出力に、追加のフィールドや詳細なメッセージなど、表形式の出力に表示されるデータが表示される場合があります。
yaml,フィールドオーダーがアルファベット順であることを除き、jsonと同じです。実験的であり、将来のバージョンでは完全にサポートされない可能性があります。
`-o` または`--output` フラグを使用して、デフォルトの出力形式をjsonまたはyamlに変更します。例：
```sh
pgd show-nodes -o json
``` ## コマンドラインヘルプへのアクセス
サポートされているコマンドをリストするには、次のように入力します。
```sh
pgd help
特定のコマンドとそのパラメーターのヘルプを表示するには、pgd help <command_name>
と入力します。例：
pgd help show-nodes
