はじめに
先日私は、様々なRDBMSやDWHからテーブル定義やER図のドキュメントを生成するコマンドラインツールであるtblsのSalesforceソース形式メタデータ用「外部データベースドライバー」をリリースしました。
Salesforce CLIやVS CodeのSalesforce機能拡張から取得したメタデータをデータソースとして扱うためのものです。
これまでの開発でのオブジェクト定義ドキュメント
オブジェクト定義書の作成・メンテナンスは手間が掛かるため、環境の定義から自動生成することが多いと思います。Chromeの機能拡張としてサードパーティーからフリーで提供されている「Salesforce DevTools」を使っている方が多いのではないかと思います。もちろん、私も大変便利に使わせていただいています。
このツールは様々な機能を持っていますが、オブジェクト定義書の生成では毎回手動で含めたいオブジェクトに✓を入れExcel形式でダウンロードするようになっています。✓を入れるにはオブジェクト名の一部を入力して検索し一覧に出さなければならず、毎回必要なオブジェクトを揃えるのが手間でした。
また、Chromeの機能拡張であるということは、CIからの自動的な最新化も出来ないということです。
さらに言えばExcelで出力されるということは、LLMにそのまま読ませるのが難しいということであり(もちろん、専用のMCPを作ればその限りではありませんが)、将来ドキュメントと会話することの妨げになっていくでしょう。
※Salesforce公式のAgentforce dev assistantで接続している組織の全てのメタデータと会話できるようになれば文句は無いんですがね……。将来もし出来るようになってもライセンス高そう。
tblsを使おう
そこで、tblsの登場です。tblsはDBのスキーマ、テーブル定義とER図を複数のフォーマットで生成することができるコマンドラインツールです。Markdown+Mermaidを選ぶことで、全てテキストベースで管理できます。
tblsはSalesforceのドライバーを標準では持っていませんので、今回、ソース形式メタデータ用の外部データベースドライバーを作成した次第です。
導入については以下の記事を参照してください。
セットアップ後、プロジェクトのルートで以下のコマンドを実行すると、このようなMarkdown+Mermaidのドキュメントが生成されます。
flows・globalValueSets・restrictionRules・triggers・objects(fields・validationRules)を読み込んでいます。
オブジェクト定義の表では、一般的なDBには持っていないSalesforce固有の情報をExtra DefinitionやComment列に表示しています。項目のカスタム表示ラベルはComment列に表示します。
tbls doc
より綺麗なER図が欲しいときは、上記で一緒に出力されるschema.jsonを入力としてLiam ERDを使うこともできます。
Excelへの出力もできるので安心?
検討段階初期では、まだサンドボックス組織に項目追加せず、事前にレビューを受けるということもあるかと思います。その場合はやはりExcelに出力したいですね。
また、顧客に出す場合もExcelの方が都合か良いかもしれません。
以下のコマンドでExcel形式にエクスポートできます。
tbls out -t xlsx -o schema.xlsx
CIで使おう
tbls自体のGitHub Actionsはこちらを参照してください。
外部データベースドライバーのCIでのGitHub Actionsは現時点ではありません。actions/setup-goを使用してGoをインストールし、以下のコマンドでインストールすることによって利用可能です。
go install github.com/shellyln/tbls-driver-sf-cli-meta@latest
実際の設定方法についてはこちらを参考にしてください。
さいごに
ドキュメントのCIでの最新化は、これから更に重要になっていくと思います。
本外部データベースドライバーがその一助になれば幸いです。
(2025-04-30追記)
以下の記事で、Salesforce + tbls 活用のtipsを記載しています。
併せてご一読ください。