はじめに
Domo CLI（コマンドラインインターフェース）ツールを使用すると、テキストベースのコマンドを使用して、膨大なDataSetをアップロードする、カードの名前を変更する、ユーザーとグループを管理する、DataSetをエクスポートするなどの多くのデータ管理機能を実行できます。利用可能なその他の機能には、AWS S3でのインポート/エクスポート、DataFusionヘルパーなどがあります。大きなファイルを自動的に小さく分割することによって、より効率的にCSVファイルやGzip圧縮したCSVファイルをDomoインスタンスにアップロードできます。
重要： このツールにはJava 7以降が必要です。
この記事では、Domo CLIツールの使用について次のトピックで説明します。
CLIツールをインストールして起動する
Domo CLIツールを使用するには、次の手順に従って自分のマシンにツールをダウンロードしてインストールします。
-
ナビゲーションヘッダーで、 ［その他］ > ［管理者］ を選択します。
-
［もっと見る］ メニューで ［ツールダウンロード］ を選択します。
-
Domo CLI ツールを見つけて、 ［Domo CLIを試す］ を選択します。
ユーティリティファイルがマシンにダウンロードされます。
-
ターミナルアプリケーションを開きます（macOSのターミナル、またはWindowsのPowerShell）。
-
Java:
java -jar domoUtil.jar
を使用してCLIバイナリーファイルを実行します。
ヒント： Windowsマシンを使用している場合は、.jarファイルをC:\domo\javaなどのフォルダに置きます。その後、次のコマンドラインを使用してCLIツールを起動できます。 java -jar C:\Domo\java\domoUtil.jar
利用可能なコマンドを表示する
利用可能なコマンドのリストを表示するには、「 help 」と入力します。
そのコマンドの特定のフラグとパラメーターを表示するには、 help [command name] と入力します。
廃止されたコマンド
使用しているバージョンのツールで利用可能として一覧表示されているコマンドは、ダウンロード後には一部既に廃止されています。次の廃止されたコマンドのリストを参照してください。
| backup |
| backup-card |
| convert-sql |
| move-page |
| set-dataset-retention-window |
| restore card |
このページのトップへ
コマンドの使用事例
このセクションでは、コマンドの使用事例について説明し、コマンドの使用に必要な情報または役立つ情報を示します。次のリストをスクロールするか、目的の項目に移動します。
Domoインスタンスに接続する
Domoインスタンスに接続するには、 connect コマンドを実行して、次のパラメーターを入力します。
| -u、—username <USERNAME> | Domoログインユーザー名 |
| -p、—password <PASSWORD> | Domoログインパスワード |
| -s、—server <SERVERNAME> | Domoサーバー |
| -pp、—proxypassword <proxypassword> | プロキシパスワード |
| -ps、—proxyserver <proxyserver> | プロキシサーバー |
| -pt、—proxyport <proxyport> | プロキシポート |
| -pu、—proxyuser <proxyuser> | プロキシユーザー |
| -t、—token <TOKEN> | トークン |
例
connect -u
jim.smith@xyzcompany.com
-p abc123 -s
xyzcompany.domo.com
connect -s
xyzcompany.domo.com
-t mffde8e727f825ae23e1117070f0ad67cfeb40c607dddd
Domoインスタンスとの接続を切断する
Domoインスタンスとの接続を切断するには、パラメーターなしで disconnect コマンドを実行します。
新規DataSetを作成する
CLIツールを使用して新規にDataSetを作成するには、次の手順を実行します。
-
Domoアクセストークンを作成します。アクセストークンの作成方法と管理方法の詳細については、「
アクセストークンを管理する 」を参照してください。
-
derive-schema コマンドを実行し、DomoにアップロードするDataSetのJSONフォーマットのスキーマファイルを取得します。
注記： 既存のCSVファイルからスキーマを取得するには、次のコマンドを使用します。「filename.csv」は自分のファイル名に置き換えます。 derive-schema -d 'C:\directory\[filename.csv]' -s 'C:\directory\schemafile.json'
-
少数の行を含むクリーンで誤りのないCSVを生成し、データの事前チェックを実行します。スキーマファイルを取得し、
create-dataset コマンドを実行してアップロードが機能することを確認します。その後は、自分の判断でDomoからそのDataSetを削除できます。
ヒント： CSV内にエスケープするカンマがある場合は、二重引用符（“）で囲む必要があります。囲まない場合、カンマはCLIツールによって区切り文字として使用されます。
-
コマンドが成功すると、DataSet IDが表示されます。
-
事前チェックが成功したら、完全なファイルのスキーマファイルを使用して
create-dataset コマンドを実行します。
DataSetを削除する
DomoのDataSetを削除するには、 delete-dataset コマンドを使用します。[dataset id]は、削除するDataSetのIDに置き換えます。
delete-dataset -id [dataset id]
list-dataset コマンドを使用すると、DataSet IDのリストを取得できます。
このページのトップへ
データをDataSetにアップロードする
作成したデータをDataSetにアップロードするには、 upload-dataset コマンドを使用します。[dataset id]は、更新するDataSetのIDに置き換えます。
重要： デフォルトでは、appendパラメーターを使用せずにDataSetを更新すると、既存のDataSet全体が新しいアップロードに置き換えられます。
upload-dataset コマンドで利用可能なパラメーターは、次の通りです。
| -a、—append | 既存のデータに追加します。 |
| -c、—compressed | データファイルがGzip圧縮されます。 |
| -d、—dir <DIRECTORY> | データ（CSV）ディレクトリ。 |
| -f、—data <FILENAME> | データ（CSV）ファイル。 |
| -h、—headers | データファイルにはヘッダー行があります。 |
| -i、—id <ID> | DataSet ID。 |
| -p、—partition <arg> | パーティションタグ。 |
| -t、—temp-dir <TEMP> | 使用する一時的なパス。 |
例
upload-dataset -id [dataset id] -data "c:\directory\datafile.csv"
upload-dataset -i <dataset_id> -f <filename>
upload-dataset -i <dataset_id> -f <filename> -a
upload-dataset -i <dataset_id> -f <filename> -a -p <partition_name>
upload-dataset -i <dataset_id> -d <directory_name>
JDBCでデータをデータベースからアップロードする
JDBCドライバーJARファイルが現在の作業ディレクトリにあることを確認します。
例えば、あなたのdomoUtil.jarが~/binにあるが、からユーティリティーを起動している場合、ドライバーファイルはになければなりません。
例
upload-jdbc --dataset example_jdbc_upload --jdbcConnection jdbc:mysql://localhost:3306 --jar mysql-connector-java-8.0.18.jar --query "select * from example;" --jdbcUser root --jdbcPassword password --jdbcDriver com.mysql.cj.jdbc.Driver
ユーザーを作成する
CLIツールを使用して、メール、メール招待状を送信するかどうか、フルネーム、およびそれらのアクセス権限を指定して、ユーザーを作成します。現在、管理者、パワーユーザー、編集ユーザー、閲覧ユーザー、ソーシャルのアクセス権限を持つユーザーを作成できます。
create-user -n 'James Smith' -r Editor -i true -e jim.smith@xyzcompany.com
このページのトップへ
データをクエリ（エクスポート）する
重要： デフォルトでは、クエリは最大100万行を返します。クエリにはより高い制限を指定できますが、結果が大きすぎる場合はタイムアウトが発生する可能性があります。フルエクスポートの場合は、 export-data コマンドを使用します。
query-data コマンドは、指定されたDataSet IDからCSVファイルにデータをエクスポートします。このコマンドでは、 -q または -qf のいずれかのパラメーターを使用する必要があります。
注記： エクスポートされるファイルは、指定されたDataSetに設定されているPersonalized Data Permission（PDP）に従います。
| -i、—id <ID> | DataSet ID |
| -q、—query <QUERY> | ファイルをJSONフォーマットでクエリする |
| -qf、—queryfile <QUERYFILE> | ファイル名をクエリする |
| -xf、—exportfile <EXPORTNAME> | ファイル名をエクスポートする |
例
query-data -i [dataset id] -qf [query file in JSON format] -xf [filename]
カード画像を生成する
generate-card-image コマンドは、指定されたカードIDのPNG画像を生成します。
generate-card-image -i <card id> -f <file name>
カードデータをエクスポートする
download-card-data コマンドは、指定されたカードIDからデータをダウンロードします。
download-card-data -i <card id> -f <output_csv_file>
ダッシュボードを移動する
move-page コマンドを使用すると、階層内の最上位ページとしてページを上に移動したり、階層内のサブページにページを移動したりできます。
このコマンドで利用可能なパラメーターは、次の通りです。
| -a、—move type | ページの移動先に応じて昇格または降格を選択します。 |
| -c、—page | ページID |
| -p、—newparentpage | ページを降格する場合の親ページID。 |
このページのトップへ
ダッシュボードを降格する
move-page -a demote -c 1234567 -p 7654321
move-page -a promote -c 1234567
ダッシュボードを昇格する
ヒント： ページIDの確認方法の詳細については、「 ページIDを検索する 」を参照してください。
データを移動する
move-dataコマンドを使用すると、既存のDataSetから別の既存のDataSetにデータを移動できます。
このコマンドで利用可能なパラメーターは、次の通りです。
| -a、—append | 既存のデータに追加する |
| -d、—destination <destination> | 宛先DataSet |
| -s、—source <source> | ソースDataSet |
例
move-data -a -s [DataSet ID of where the data is coming from] -d [DataSet ID of where the data will be moved to]
注記： replaceメソッドを使用してデータを移動する場合は、コマンドラインから-aパラメーターを削除します。
DataSetのリストを表示する
list-dataset コマンドは、所有者、検索語、特定のDataSet IDにもとづいてすべてのDataSetのリストを表示します。
このコマンドで利用可能なパラメーターは、次の通りです。
| -i、—id <ID> | DataSet ID |
| -n、—name-like <NAME_PATTERN> | フィルターに名前を付ける |
| -o、—owner-id <TYPE> | DataSet所有者ID 注記 ： 現在認証されているユーザーを使用する場合は、DataSet所有者IDの代わりに「me」を使用します。 |
例
list-dataset -o me -name-like "sales"
list-dataset -name-like "marketing"
Domoを検索する
search-Domo コマンドは、エンティティータイプと検索語でDomoからリストを検索してエクスポートします。
このコマンドで利用可能なパラメーターは、次の通りです。
| -e、—entities <ENTITIES> | エンティティータイプ。有効なエンティティーには、app、buzz、buzz_channel、connector、dataflow、dataset、dojo_message、feature、knowledge_base、project、task、page、card、user、groupがあります。 |
| -f、—filename <NAME> | 情報をエクスポートするファイル名。 |
| -l、—limit <LIMIT> | 結果の上限。 |
| -o、—offset <OFFSET> | 結果のオフセット。 |
| -t、—term <TERM> | 検索語。 |
例
search-domo -e "card,dataset" -t "sales"
ログインユーザーを確認する
whoamiコマンドは、現在ログインしている個人のユーザー名とユーザーIDを返します。このコマンドにはパラメーターはありません。
> whoami
John Smith (userid: 123456789)
セッションを終了する
CLIセッションを終了するには、 disconnect と quit のコマンドを実行します。これらのコマンドにはパラメーターはありません。
スクリプティング
コマンドプロンプトで上述のコマンドを入力することもできますが、そのコマンドを含むテキストファイルを作成してスクリプトファイルとして実行することもできます。
スクリプトファイルの例
connect -t [access token id] -s xyzcompany.domo.com upload-dataset -id [dataset id] -data "c:\directory\datafile.csv" -append quit
スクリプトファイルの実行例
java -jar domoUtil-2.31.jar -script c:\directory\<uploadfile.script>
ヒント： 上述の例の<uploadfile.script>は、自分のスクリプトファイルの名前に変更してください。
一般的な問題
Java 17以降がインストールされている場合は、CLIを実行するコマンドに次のJVMパラメーターを追加する必要があります。
--add-opens java.base/java.nio=ALL-UNNAMED
java --add-opens java.base/java.nio=ALL-UNNAMED -jar domoUtil.jar
