Tableau データ抽出コマンド ライン ユーティリティ
Tableau データ抽出コマンド ライン ユーティリティを使用すると、抽出更新タスクを自動化できます。これは Tableau Desktop に付属のコマンド ライン ユーティリティです。これを使用することで、パブリッシュされた抽出データ ソースを更新したり、データをファイルからデータ ソースに追加したりできます。
Tableau データ抽出コマンドライン ユーティリティの使用要件には、次のような条件が含まれています。
Windows に搭載されている Tableau Desktop で使用可能であり、Windows システムでのみ実行可能です。
Tableau Desktop のトライアル版では使用できません。
OAuth を使用しない抽出データ ソースに使用できます。
単一接続データ ソースの更新にのみ使用できます。マルチ接続データ ソースには使用できません。
2022 年 10 月に非推奨: このユーティリティは、Tableau Cloud の 多要素認証(新しいウィンドウでリンクが開く)要件により、以降のリリースでは使用できません。Tableau Cloud から直接アクセスできないデータ ソースまたは仮想接続データを更新するには、代わりに Tableau Bridge を使用します。詳細については、「Bridge 更新スケジュールの設定」(新しいウィンドウでリンクが開く)を参照してください。
スクリプトを使用して更新ジョブを開始するには、tabcmd refreshextracts(新しいウィンドウでリンクが開く) または REST API 抽出更新タスクの実行(新しいウィンドウでリンクが開く)を使用します。
ユーティリティの実行
管理者としてコマンド プロンプトを開き、Tableau Desktop の bin ディレクトリに変更します。例:
cd C:\Program Files\Tableau\Tableau 2022.4\bin以下の表で説明するパラメーターを追加して、次のいずれかのコマンドを使用します。
tableau refreshextracttableau addfiletoextract
注: ユーティリティを実行する場合は、コマンド ラインまたはスクリプトで、tableau.exeではなく、必ず tableau を指定します。
注: トラブルシューティングを行うには、\マイ Tableau リポジトリ\Logs フォルダー内にある tableaucom.txt ファイルでログを確認します。
注: マルチサイト環境では、コマンドを適用するサイトを指定します。
tableau refreshextract コマンドの構文およびパラメーター
Tableau Server または Tableau Cloud の抽出を更新するには、tableau refreshextract を使用します。抽出を更新すると、前の更新以降、データ ソースに加えられた変更によって既存の抽出が更新されます。
このコマンドのヘルプを参照するには、Windows コマンド プロンプトで次のコマンドを入力します。
tableau help refreshextract
パラメーターの使用
すべてのオプションにはダブル ハイフンを使用する完全形式があります (
--serverなど)。また、シングル ハイフンを使用する短い形式を持つオプションもあります (
-sなど)。オプションの値に空白が含まれる場合は、引用符で囲みます。
更新されるソースは、抽出 (
.hyper) ではなく元のデータ ソースである必要があります。
tableau refreshextract コマンド オプション
| 短い形式 | 完全形式 | 説明 |
--source-username <user name> | データ ソース接続に対する有効なユーザー名。 このオプションは
注: データ ソースが埋め込み認証資格情報を使用してパブリッシュされた場合あっても、パブリッシュされた抽出を更新する時にユーザー名とパスワードを提供する必要があります。 | |
--source-password "<password>" | データ ソース ユーザーのパスワード。 | |
または
| サーバー上でリフレッシュされるデータ ソースのパスおよびファイル名。例: マルチファイル データ ソースを更新するには、データ ファイルを含むフォルダーへのパスを渡します。例: ファイルがネットワーク共有上にある場合は、パスに UNC 形式を使用します。 | |
--force-full-refresh | データ ソースが増分更新されるよう設定されている場合、このオプションを使用して完全な抽出の更新を強制的に実行します。このオプションを含ませない場合は、増分更新が実行されます。増分更新をサポートしていないデータ ソースもあります。 | |
-s <server http address> | --server <URL> | データがパブリッシュされる Tableau Server の URL。 Tableau Cloud の場合、 |
-t <site id> | --site <siteid> | 複数サイト環境では、コマンドが適用されるサイトを指定します。Tableau Cloud では、ユーザー名が複数のサイトに関係している場合にこの引数を使用します。Tableau Server では、サイトを指定しない場合、既定サイトが使用されます。 サイト ID はサイト名とは無関係であり、ブラウザーでサイトを表示する際に URL に表示されます。たとえば、Tableau Cloud にサインインした後に表示されるページの URL が次の場合、 https://online.tableau.com/t/vernazza/views サイト ID はvernazza です。 |
--datasource <datasource> | Tableau Server または Tableau Cloud にパブリッシュされているデータ ソースの名前。 | |
--project <projectname> | データ ソースが属するプロジェクト。このオプションを含めない場合、既定のプロジェクトが使用されます。 指定するプロジェクトがプロジェクト階層内でネストされている子プロジェクトの場合、このパラメーターを | |
--parent-project-path path/to/project | データ ソースのパブリッシュ先のプロジェクトがプロジェクト階層の最上位レベルにない場合、このパラメーターを 階層でプロジェクト レベルを区切るには、フォワード スラッシュ文字 ( たとえば、最上位レベルのマーケティングで、プロジェクト Social、プロジェクト名が Sandbox の場合は次のとおりです。
| |
-u <user name> | --username <username> | Tableau Server または Tableau Cloud の有効なユーザー。 |
-p "<password>" | --password "<password>" | Tableau Server または Tableau Cloud の特定のユーザーのパスワード。 |
--proxy-username <username> | プロキシ サーバー用のユーザー名。 | |
--proxy-password "<password>" | プロキシ サーバーのパスワード。 | |
-c "<path and file name>" | --config-file "<path and file name>" | コマンドの構成オプションを含むファイルのパスとファイル名情報。パスは常に二重引用符で囲みます。詳細については、後述の構成ファイルの使用を参照してください。 |
tableau refreshextract コマンドの例
次のコマンドは、オンプレミスの Tableau Server へパブリッシュされた CurrentYrOverYrStats という名前の抽出を更新します。このコマンドは次を指定します。
- Tableau Server の名前。
- サーバー ユーザー名およびパスワード。
- プロジェクト名。
- 更新するデータ ソースの名前およびデータ ソース ユーザー名とパスワード。
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --server https://our_server_name --username OurServerSignIn --password "OurServerPwd" --project "New Animations" --datasource "CurrentYrOverYrStats" --source-username OurDatabaseSignIn --source-password "OurDatabasePassword"
次のコマンドは、Tableau Cloud へパブリッシュされた CurrentYrOverYrStats という名前の抽出を更新します。このコマンドは次を指定します。
- Tableau Cloud ユーザーおよびパスワード。
- Tableau Cloud サイトおよびプロジェクト名。
- ホストされているデータ ソースへサインインするためのデータ ソース、ユーザー名およびパスワード。この場合データ ソースは、クラウドベースのデータ ソース プロバイダー (たとえば、Salesforce.com など) によってホストされているデータ ソースです。
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --source-username database_user@hosted_datasource_provider.com --source-password "db_password"
ファイルベースのデータ ソースの抽出を更新するには、抽出を作成した元のファイルへのパスを提供します。ファイルがネットワーク共有上にある場合は、マッピングされたドライブの代わりに UNC 形式を使用します。
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --original-file "\\server\path\filename.csv"
tableau addfiletoextract の構文
Tableau Server または Tableau Cloud へパブリッシュされた抽出にファイルの内容を追加するには、tableau addfiletoextract を使用します。このコマンドを使用して 2 つのファイルを組み合わせます。
最後に行った変更が適用された既存の抽出の更新のみを行う場合は、代わりに refreshextract コマンドを使用します。既存の抽出を更新するために addfiletoextract を使用すると、代わりにデータが複製されます。
このコマンドのヘルプを参照するには、Windows コマンド プロンプトで次のコマンドを入力します。
tableau help addfiletoextract
すべてのオプションにはダブル ハイフンを使用する完全形式があります (--server など)。また、シングル ハイフンを使用する短い形式を持つオプションもあります (-s など)。オプションの値に空白が含まれる場合は、引用符で囲みます。
tableau addfiletoextract コマンド オプション
| 短い形式 | 完全形式 | 説明 |
--file <path and file name> | 追加するデータを含むデータ ファイルのパスとファイル名情報。このファイルは、Excel または Access 形式、Tableau データ抽出、または区切りテキスト ファイルの場合があります。ファイルをパスワードで保護することはできません。ファイルがネットワーク共有の場合は、UNC 形式を使用します。たとえば、 | |
-s <server http address> | --server <URL> | データがパブリッシュされる Tableau Server の URL。 Tableau Cloud の場合、 |
-t <site id> | --site <site id> | 複数サイト環境では、コマンドが適用されるサイトを指定します。Tableau Cloud では、ユーザー名が複数のサイトに関係している場合、この引数を含める必要があります。Tableau Server では、サイトを指定しない場合、既定サイトが使用されます。 |
--datasource <datasource> | Tableau Server または Tableau Cloud にパブリッシュされているデータ ソースの名前。 | |
--project <projectname> | データ ソースが属するプロジェクト。このオプションを含めない場合、既定のプロジェクトが使用されます。 指定するプロジェクトがプロジェクト階層内でネストされている子プロジェクトの場合、このパラメーターを | |
--parent-project-path path/to/project | データ ソースのパブリッシュ先のプロジェクトがプロジェクト階層の最上位レベルにない場合、このパラメーターを 階層でプロジェクト レベルを区切るには、フォワード スラッシュ文字 ( たとえば、最上位レベルのマーケティングで、プロジェクト Social、プロジェクト名が Sandbox の場合は次のとおりです。
| |
-u <username> | --username <username> | Tableau Server または Tableau Cloud の有効なユーザー。 |
-p "<password>" | --password "<password>" | Tableau Server または Tableau Cloud の特定のユーザーのパスワード。 |
--proxy-username <username> | プロキシ サーバー用のユーザー名。 | |
--proxy-password "<password>" | プロキシ サーバーのパスワード。 | |
-c "<path and filename>" | --config-file "<path and filename>" | コマンドの構成オプションを含むファイルのパスとファイル名情報。パスは常に二重引用符で囲みます。詳細については、後述の構成ファイルの使用を参照してください。 |
tableau addfiletoextract コマンドの例
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau addfiletoextract --server https://our_server_name --username OurServerSignIn --password "OurServerPwd" --project "New Animations" --datasource "CurrentYrOverYrStats" --file "C:\Users\user1\Documents\DataUploadFiles\AprMay.csv"
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau addfiletoextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --file "C:\Users\user2\Documents\DataUploadFiles\AprMay.csv"
構成ファイルの使用
tableau refreshextract または tableau addfiletoextract のいずれかで使用することができる config (構成) ファイルを作成するために、ノートパッドや Text Edit などのプレーン テキスト エディターを使用することができます。構成ファイルは、同じデータ ソースを長時間定期的に更新することが予想される場合に役立ちます。コマンドを実行するたびに同じオプションを入力する代わりに、構成ファイルを指定します。構成ファイルは、コマンド ラインにユーザー名とパスワードを表示しないという利点もあります。
構成ファイルの作成
たとえば、config.txt という名前のファイルを作成し、Documents フォルダーに保存したとします。そして、ファイル内で次に示すようなパラメーター情報を含ませました。
Tableau Server にパブリッシュされた抽出の場合:
server=https://our_server_name
username=OurServerSignIn
password=OurServerPwd
project=New Animations
datasource=CurrentYrOverYrStats
ホストされているデータ ソースからの抽出で、Tableau Cloud にパブリッシュされ、サーバーが https://online.tableau.com の場合:
server=https://online.tableau.com
site=vernazza
username=email@domain.com
password=OurPassword
project=New Animations
datasource=CurrentYrOverYrStats
source-username=database_user@hosted_datasource_provider.com
source-password=db_password
コマンド ラインからの構成ファイルの参照
構成ファイルを作成後、tableau refreshextract または tableau addfiletoextract コマンドを実行します。この際、コマンド ラインで使用する唯一のオプションとして構成ファイルを指定し、構成ファイルのパスを二重引用符で囲みます。構文は、次のとおりです。
tableau refreshextract --config-file "<path>"
たとえば、構成ファイルの作成セクションのサンプル内で指定された抽出を更新するには、次のコマンドを実行します (Tableau Desktop のバージョンの bin ディレクトリで作業を行っていることを確認してください)。
C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --config-file "C:\Users\user1\Documents\config.txt"
構成ファイルの構文の違い
構成ファイル内でオプションを指定する構文は、コマンド ラインで使用する構文とは次のような点において異なります。
- オプション名はダッシュやハイフンからは始まりません。
- オプション名とオプション値を区切るには、等号 (スペースなし) を使用します。
- スペースを含んでいる場合であっても(前に示したサンプル内の
projectオプションの場合など)、値の前後に引用符は必要ありません (または許可されていません)。
Windows タスク スケジューラを使用した抽出更新
Windows タスク スケジューラを Tableau データ抽出コマンド ライン ユーティリティと共に使用すると、企業のファイアウォール内のTableau Desktopデータ ソースを自動で定期的に更新することができます。タスクが 1 日、1 週、または 1 月に 1 回、あるいは特定のシステム イベント後に発生するよう設定することができます。たとえば、コンピューター起動時にタスクを実行します。
詳細については、Microsoft TechNet ライブラリの「タスク スケジューラの操作方法」(新しいウィンドウでリンクが開く)ページを参照してください。