前書き

仕事で、TeamSpiritのAPIでデータを取得して社内で持っているデータと突き合わせ、
なんやかんやする機会がありました。

その時、初めてSalesforceのAPIを使用しようとして、なかなか手こずったので
同じような人の参考になればと思います。

Salesforceから提供されているデータの具体的な内容をSalesforce Object Query Language (SOQL)で確認する手段としてWorkbenchがありますが、
そのWorkbenchで「VS CodeにSOQL Builderがあるから試して！」的なことが書いてあったので、
そちらを試すことにしました。

試した環境

Windows 10 Pro

準備（前提）

VSCodeはインストール済
TeamSpiritのSandboxが使えるようになっている

VSCodeの拡張機能をインストール

Salesforce CLI Integration
Salesforce Extension Pack
SOQL

SQOL用のプロジェクトを作る

Ctrl + Shift + Pでコマンドパレットを表示。

「SFDX: マニフェストファイルを使用してプロジェクトを作成」を実行。
「標準標準のプロジェクトテンプレート」を実行。
プロジェクト名を入力して、「参加」を選択。

認証

「SFDX: 組織を認証」を実行。
Sandboxを選択。
組織のエイリアスを入力。（エイリアスはSandboxにログインすると確認できます）
ブラウザが起動しアカウント認証画面が表示されるので、ユーザー名とパスワードを入力してSandboxにログイン。
成功したらブラウザを閉じる。
VSCodeに成功メッセージが表示されていることを確認する。

SOQLファイルを作る

scripts > soql に適当な名前のsoqlファイルを作る

ビルダーを起動

エディタ右上のアイコンからビルダーを起動します。

テーブルやカラムを選択して、Run QueryボタンでSOQLを実行し、実行結果を表で確認することができます。

カラム定義は、Sandboxの設定→オブジェクトマネージャーから確認することができます。