dse client-tool

外部クライアントをDataStax Enterpriseノードに接続し、共通のユーティリティ・タスクを実行するdse client-toolアプリケーションに関する参考情報。

dse client-toolアプリケーションは、外部クライアントをDataStax Enterpriseノードに接続し、共通のユーティリティ・タスクを実行します。

構文

dse client-tool [connection_options]  
cassandra subcommand |
configuration byos-export options file |
configuration import file connection_options |
spark subcommand
表 1. 凡例
構文規則 説明
イタリック体 変数値。ユーザー定義値と置き換えます。
[ ] 任意。角かっこ（[]）で任意指定のコマンド引数を囲みます。角かっこは入力しないでください。
( ) グループ。丸かっこ（( )）は、選択肢を含むグループを示します。丸かっこは入力しないでください。
| または。縦棒（|）で代替要素を区切ります。要素のいずれかを入力してください。縦棒は入力しないでください。
[ -- ] コマンドライン・オプションとコマンド引数は、2つのハイフン（--）で区切ります。この構文は、引数がコマンドライン・オプションと間違われる可能性がある場合に役立ちます。
サブコマンド：
dse client-toolのコマンドライン・ヘルプを表示するには：
$ dse client-tool --help
dse client-toolサブコマンドのコマンドライン・ヘルプを表示するには：
$ dse client-tool help subcommand

dse client-toolの接続オプション

構成プロパティのさまざまなソースを使用して、外部クライアントをDSEノード、すなわちdse.yamlとcassandra.yamlのDSE構成に接続します。

認証情報はいくつかの方法で指定できます。「認証対応クラスターへの接続」を参照してください。dse client-toolサブコマンドは、dsetoolなどのJMX認証ではなく、Javaや他の言語ドライバーなどのDSE Unified Authentication（DSE統合認証）を使用します。

dse client-toolを使用するKerberos認証がサポートされています。

ネイティブ・プロトコルのRPCパーミッションでは、DSE認証とロールベースのアクセス機能を活用します。DataStax Enterpriseコマンドへの外部クライアント・アクセスを構成するには、「CQL実行のリモート・プロシージャ・コールの権限を管理する」を参照してください。

接続設定を以下のオプション・コマンド引数でオーバーライドします。
$ dse client-tool connection_options
表 2. 外部クライアントの接続オプション
接続オプション 説明
--cipher-suites ssl_cipher_suites SSLが有効になっているときにDSEに接続するためのSSL暗号化スイートのコンマ区切りリスト。
--host address DSEホストのRPCブロードキャスト・アドレス。
--kerberos-enabled true|false trueに設定すると、DSEへの接続にKerberosが有効になります。たとえば、--kerberos-enabled trueと指定します。
--keystore-password ssl_keystore_password SSLクライアント認証が有効になっているときにDSEに接続するためのキーストア・パスワード。
--keystore-path ssl_keystore_path SSLクライアント認証が有効になっているときにDSEに接続するためのキーストアへのパス。
--keystore-type ssl_keystore_type SSLクライアント認証が有効になっているときにDSEに接続するためのキーストアのタイプ。
-p password DSEアカウントのパスワード。DSE_PASSWORD環境変数を使用できます。
--port port ネイティブ・プロトコルのRPC接続ポート（Thrift）。
--sasl-protocol-name sasl_protocol_name SASLプロトコル名はDSEサービス・プリンシパル名です。
--ssl-enabled true|false trueに設定すると、DSEへの接続にSSLが有効になります。
--ssl-protocol ssl_protocol SSLが有効になっているときにDSEに接続するためのSSLプロトコル。たとえば、--ssl-protocol=ssl4と指定します。
-t delegation_token Kerberosが使用されている場合、ログインに使用されるデリゲーション・トークン。DSE_TOKEN環境変数を使用できます。
--truststore-password ssl_truststore_password SSLが有効になっているときにDSEに接続するためのトラストストア・プロトコル。
--truststore-path ssl_truststore_path SSLが有効になっているときにDSEに接続するためのトラストストアへのパス。
--truststore-type ssl_truststore_type SSLが有効になっているときにDSEに接続するためのトラストストア・タイプ。
-u username DSE認証アカウントのユーザー名。DSE_USERNAME環境変数を使用できます。
--use-server-config 他の構成ファイルから読み取る代わりにサーバーYAMLファイル（dse.yamlおよびcassandra.yaml）から接続構成を読み取ります。コマンドが実行されるDSEインストールの対象が実行中のノードである場合にのみ使用します。

操作サブコマンド

一般的な操作の任意のサブコマンド：
$ dse client-tool cassandra subcommand
サブコマンド 説明
generate-token 現在のユーザーをトークンの更新者としてデリゲーション・トークンを生成します。更新者は指定されず、DSEプロセスによってのみトークンを更新できます。非KerberosクラスターからKerberos DSEにアクセスするために使用します。Kerberos認証モードが必要です。
generate-token --token-renewer username 指定したユーザーをトークンの更新者としてデリゲーション・トークンを生成します。指定されたユーザーは、トークンを更新および取り消すことができます。Kerberos認証モードが必要です。
パーティショナー ノードによって使用されているパーティショナーを返します。
renew-token token 指定したトークンを更新します。
cancel-token token 指定したダイジェスト認証トークンを取り消します。Kerberos認証モードが必要です。

構成サブコマンド

構成サブコマンドは、DSEクライアント・ノードの外部構成を管理します。
dse client-tool configuration subcommand [options]
サブコマンド 説明
export file リモート・ノードで、ノード構成をJARファイルにエクスポートします。構成設定は、実行中のDSEノードから取得されます。「リモート・クラスターに対してSparkコマンドを実行する」を参照してください。
byos-export [options] file DSEクラスター構成を取得して、Sparkプロパティ・ファイルにエクスポートします。「DSEクラスター構成のエクスポート」を参照してください。
import file [options] 外部の実行中のDSEクラスターに接続するように、統合されたクライアント・アプリケーションのDSEインストールを設定します。「DSEクラスター構成のインポート」を参照してください。

DSEクラスター構成のエクスポート

dse client-tool configuration byos-export options file

構成byos-exportサブコマンドは、DSEクラスター構成を取得し、Sparkプロパティ・ファイルにエクスポートします。--filesパラメーターを含むファイル分散オプションについては、Sparkのドキュメントを参照してください。

このようなoptionsを使用して、エクスポートされた構成を格納します。
サブコマンド 説明
--default-properties path_to_existing_properties_file デフォルトのSparkプロパティをDataStax Enterprise Sparkプロパティとマージします。例を次に示します。
$ dse client-tool configuration byos-export --default-properties \ /usr/lib/spark/conf/spark-defaults.conf /home/user1/.dse/byos.conf
--dsefs-as-default デフォルトのファイル・システムとしてDSEFSを設定します。
--export-credentials 構成ファイルに現在のDataStax Enterpriseユーザーとパスワードを格納します。
--generate-token 現在のユーザーをトークンの更新者としてデリゲーション・トークンを生成します。更新者は指定されず、DSEプロセスによってのみトークンを更新できます。非KerberosクラスターからKerberos DSEにアクセスするために使用します。Kerberos認証モードが必要です。
--set-keystore-path path SSLクライアント認証が有効になっている場合のSSLキーストアへのパス。すべてのノードは、同じ場所にキーストアを格納します。
--set-keystore-type type SSLクライアント認証が有効になっている場合のキーストアのタイプ。指定しない場合、デフォルトはJKSになります。
--set-keystore-password password SSLクライアント認証が有効になっているときにデータベースに接続するためのキーストア・パスワード。
--set-truststore-path path トラストストアのパス。
--set-truststore-type type トラストストアのタイプ。指定しない場合、デフォルトはJKSになります。
--set-truststore-password password トラストストアのパスワード。
--token-renewer username 指定したユーザーをトークンの更新者としてデリゲーション・トークンを生成します。指定されたユーザーは、トークンを更新および取り消すことができます。Kerberos認証モードが必要です。

DSEクラスター構成のインポート

$ dse client-tool configuration import file connection_options

エクスポートされた構成設定は外部の未構成ノードにインポートでき、これによって、DSEクライアント・アプリケーションは実行中のDSEクラスターにリモートでアクセスできるようになります。

クライアント・ノードでは、このコマンドを実行して、インポートされたファイルの設定で構成ファイルとcqlshrcファイルを生成します。構成インポート・コマンドでは、実行中の外部DSEクラスターに接続するように、統合されたクライアント・アプリケーションのDSEインストールを設定します。

これらのconnection_optionsを使用して、指定したJARファイルからノード構成をインポートします。
オプション 説明
--set-truststore-type type トラストストアのタイプ。指定しない場合、デフォルトはJKSになります。
--set-truststore-path path トラストストアのパス。
--set-truststore-password password トラストストアのパスワード。
--set-keystore-type type SSLクライアント認証が有効になっている場合のキーストアのタイプ。指定しない場合、デフォルトはJKSになります。
--set-keystore-path path SSLクライアント認証が有効になっている場合のSSLキーストアへのパス。すべてのノードは、同じ場所にキーストアを格納します。
--set-keystore-password password SSLクライアント認証が有効になっているときにデータベースに接続するためのキーストア・パスワード。
--cqlshrc file DSEクライアント・ノードのcqlshrcファイルを生成します。ファイルを指定しない場合、デフォルトのファイルは~/.cassandra/cqlshrcファイルになります。
--force 既存の構成ファイルの上書きを強制的に実行します。デフォルトでは、構成ファイルが既に存在する場合、インポート・コマンドは失敗します。

Sparkサブコマンド

dse client-tool spark subcommand
統合されたSparkの操作のサブコマンド：
サブコマンド 説明
master-address ホスト・アドレスの決定に従って、接続しているデータ・センターのSparkマスターの現在のアドレスを返します。SparkマスターのアドレスはURIで返されます。dse://ip:port?connection.local_dc=dc_name;connection.host=cs_list_contactpoints

connection.host=cs_list_contactpointsは、追加のコンタクト・ポイントのIPアドレスのコンマ区切りリストです。追加のコンタクト・ポイントは、データ・センターからランダムに選択された最大5つのノードです。
leader-address クライアント・ツールが接続するデータ・センターに対して現時点で選択されているリーダーのIPアドレスを返します。
version DataStax EnterpriseがバンドルされているSparkのバージョンを返します。
sql-schema option 以下のオプションを指定して、SQLテーブル作成クエリーをエクスポートします。

--excludeオプションは、除外されたテーブルを指定します。--keyspaceオプションは、キースペースを指定します。--tableオプションは、テーブルを指定します。--decimalオプションは、フォームの精度、スケールにおけるハイブの0.13+ decimal型のパラメーターを指定します。--allオプションは、すべてのキースペースを指定します。
dse.yamlファイルの場所は、インストールのタイプによって異なります。

パッケージ・インストールInstaller-Servicesインストール

 /etc/dse/dse.yaml

tarボール・インストールInstaller-No Servicesインストール

 installation_location/resources/dse/conf/dse.yaml
cassandra.yamlファイルの場所は、インストールのタイプによって異なります。

パッケージ・インストールInstaller-Servicesインストール

 /etc/dse/cassandra/cassandra.yaml

tarボール・インストールInstaller-No Servicesインストール

 installation_location/resources/cassandra/conf/cassandra.yaml