出力設定ファイル(config-soql.txt)

データ出力ユーティリティでデータを出力する対象となるSOQLを定義するファイルです。
基本情報、記述形式、定義例などについて説明します。

SOQLの概要については、Salesforce ヘルプ「SOQL および SOSL の概要」を参照してください。

<目次>

ファイルの基本情報


項目

内容

項目

内容

ファイル名

任意(既定はconfig-soql.txt)

ファイル保管先

任意(既定はconfigディレクトリ)

フォーマット

TXT形式ファイル

文字コード

UTF-8(BOMなし)

改行コード

LF

ファイル反映のタイミング

データ出力ユーティリティ起動時

記述形式


  • TXT形式ファイルです。SOQLを記述します。
    SOQLの概要については、Salesforce ヘルプ「SOQL および SOSL の概要」を参照してください。

  • ファイル内で項目や句の区切り部分で改行可能。

  • SOQL内に":可変値名"を指定することで可変値として使用できます。
    可変値名は半角英数字で構成される任意の文字列。

  • SOQL内のFROM句、リレーションクエリで指定するオブジェクトは全て指定できます。
    データ出力ユーティリティでは、指定するオブジェクトに制限はありません。

定義例


例1:可変値設定なし

コマンドパラメータによる可変値の設定を行わない一般的な定義。
以下は取引先名が"Guide User"と一致するIDと取引先名を取得する。

Select Id, Name From Account Where Name = 'Guide User'

例2:可変値設定あり

コマンドパラメータによる可変値を指定することで、条件値の指定を可能となとなる定義。
可変値を指定する方法は「データ出力ユーティリティを起動する」を参照してください。
以下は取引先名がコマンドパラメータにより指定された値と一致するIDと取引先名を取得する。

Select Id, Name From Account Where Name = ':accountName'

例3:サブクエリ指定

サブクエリを指定した定義。
以下は取引先責任者の「名」の先頭が"J"の取引先IDと取引先のIDが一致するIDと取引先名を取得する。

SELECT Id, Name FROM Account WHERE Id IN(SELECT AccountId FROM Contact WHERE FirstName Like 'J%')

例4:リレーションクエリ指定

リレーションクエリを使用した定義。
以下は取引先責任者のIDと取引先責任者名を取得。さらに、取引先の取引先名を取得する。

SELECT Id, Name, Account.Name FROM Contact

注意事項


  • 定義例からのコピー&ペーストは行わないでください。文字コードが崩れ、エラーとなる場合があります。

  • SOQLにシングルクォートや改行等を検索条件にする場合、以下のサイトに従いエスケープ処理を行ってください。
    SOQLの概要については、Salesforce ヘルプ「SOQL および SOSL の概要」を参照してください。

    SOQLのエスケープについては、Salesforce ヘルプ「引用符で囲まれた文字列のエスケープシーケンス」を参照してください。