mcpField
P
platform-soql-query

platform-soql-query

github.com/forcedotcomデータ・データベース1.1k6.9k 回インストール1 日前に更新
リポジトリ

platform-soql-query について

Salesforce の SOQL/SOSL クエリを作成、確認、最適化するスキルです。クエリ構成や選択性、安全性、Apex での利用を考慮した設計を支援します。

主な機能

  1. 01自然言語からのクエリ生成
  2. 02リレーション・集計クエリ
  3. 03選択性とクエリプランの分析
  4. 04SOQL/SOSL 構文のガイダンス
  5. 05性能とセキュリティの確認

活用シーン

  1. 01データ要件からのクエリ作成
  2. 02親子リレーションのクエリ選択
  3. 03クエリ選択性の改善
  4. 04Apex 内クエリの安全性確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/forcedotcom/sf-skills --skill platform-soql-query

インストール後、Claude Code で/platform-soql-queryを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

README.md
assets/
aggregate-queries.soql
basic-queries.soql
bulkified-query-pattern.cls
optimization-patterns.soql
relationship-queries.soql
selector-class.cls
references/
anti-patterns.md
cli-commands.md
field-coverage-rules.md
query-optimization.md
selector-patterns.md
soql-reference.md
soql-syntax-reference.md
scripts/
post-tool-validate.py

詳細

platform-soql-query：Salesforce SOQL クエリのエキスパート

ユーザーが SOQL/SOSL の作成または最適化 を必要としている場合に、このスキルを使用します。対象には、自然言語からのクエリ生成、リレーションクエリ、集計、クエリプランの分析、Salesforce クエリのパフォーマンスや安全性の改善が含まれます。

このスキルが担当するタスク

次の作業には platform-soql-query を使用します。

  • .soql ファイル
  • 自然言語からのクエリ生成
  • リレーションクエリおよび集計クエリ
  • クエリの最適化と選択性の分析
  • SOQL/SOSL の構文とガバナ制限を考慮した設計

次の場合は、別のスキルに委任します。

最初に収集する必須コンテキスト

次の情報を確認するか、推測します。

  • 対象オブジェクト
  • 必要な項目
  • 絞り込み条件
  • 並べ替え／上限の要件
  • クエリが表示、自動化、レポートに類似した分析、Apex のどの用途に使われるか
  • パフォーマンス／選択性がすでに懸念事項かどうか

推奨ワークフロー

1. 最もシンプルで正確なクエリを生成する

次を優先します。

  • 必要な項目のみを指定する
  • 明確な WHERE 条件を指定する
  • 適切な場合は妥当な LIMIT を設定する
  • 必要な範囲にとどめたリレーションの深さにする
2. 適切なクエリの形を選ぶ
必要なものデフォルトのパターン
子から親のデータ子から親へのたどり
親から子のレコードサブクエリ
件数／集計値集計クエリ
関連レコードがある／ないレコードセミジョイン／アンチジョイン
オブジェクトをまたぐテキスト検索SOSL
3. 選択性と安全性を最適化する

次を確認します。

  • インデックス付き／選択性の高い絞り込み条件
  • 不要な項目がないこと
  • 回避可能なワイルドカードやスキャン負荷の高いパターンがないこと
  • セキュリティ適用要件
4. 必要に応じて実行パスを検証する

ユーザーが実行時の検証を希望する場合は、実行を次に引き継ぎます。

重要度の高いルール

  • SELECT * のような考え方は決して使わず、必要な項目のみをクエリする
  • Apex のコンテキストではループ内でクエリを実行しない
  • Apex で後から絞り込むのではなく、SOQL での絞り込みを優先する
  • 不要なレコードを読み込む代わりに、件数やグループ化した集計には集計クエリを使う
  • ワイルドカードの使用を慎重に評価する。先頭のワイルドカードはインデックスの効果を損なうことがよくあります
  • クエリを Apex に組み込む場合は、セキュリティモード／項目アクセス要件を考慮する

出力形式

完了時には、次の順序で報告します。

  1. クエリの目的
  2. 最終的な SOQL/SOSL
  3. この形を選んだ理由
  4. 最適化またはセキュリティに関する注意点
  5. 必要に応じた実行の提案

推奨形式 — 正確な構文には references/soql-syntax-reference.md を使用します。

Query goal: <summary>
Query: <soql or sosl>
Design: <relationship / aggregate / filter choices>
Notes: <selectivity, limits, security, governor awareness>
Next step: <run in platform-data-manage or embed in Apex>

スキル間の連携

必要なもの委任先理由
組織に対してクエリを実行するplatform-data-manage実行とエクスポート
サービス／セレクターにクエリを組み込むplatform-apex-generate実装のコンテキスト
ログから遅いクエリの兆候を分析するplatform-apex-logs-debug実行時の証拠
クエリを利用する UI を接続するexperience-lwc-generateフロントエンドとの連携
テストでクエリの動作を検証するplatform-apex-test-runクエリロジックのテストカバレッジ

スコアガイド

スコア意味
90+本番環境向けに最適化されたクエリ
80–89良好なクエリ。軽微な改善の余地あり
70–79機能するものの、パフォーマンス上の懸念が残る
< 70本番環境で使用する前に修正が必要

参考ファイル一覧

ファイル読むタイミング
references/soql-syntax-reference.md構文、演算子、日付リテラル、リレーションクエリのパターン
references/query-optimization.md選択性のルール、インデックス戦略、ガバナ制限、セキュリティパターン
references/soql-reference.mdクイックリファレンス — 演算子、日付関数、集計関数、WITH 句
references/anti-patterns.mdよくある SOQL の間違いと修正方法 — クエリを確定する前に必ず読んでください
references/selector-patterns.mdApex セレクターレイヤーのパターン — Apex クラスにクエリを埋め込む場合に読んでください
references/field-coverage-rules.mdフィールドカバレッジの検証 — Apex コード内で使用する SOQL を生成する場合に読んでください
references/cli-commands.mdsf CLI によるクエリ実行、一括エクスポート、クエリプランのコマンド
assets/basic-queries.soqlよく使用されるオブジェクト向けの基本的なクエリ例
assets/relationship-queries.soql親から子および子から親へのリレーションクエリのパターン
assets/aggregate-queries.soqlCOUNT、SUM、GROUP BY、ROLLUP クエリのパターン
assets/optimization-patterns.soql選択的なフィルターとインデックスを考慮したクエリのパターン
assets/bulkified-query-pattern.clsトリガーコンテキスト向けの Apex Map ベースの一括クエリパターン
assets/selector-class.clsセレクタークラスの完全な実装テンプレート
scripts/post-tool-validate.py書き込み後のフック — .soql ファイルの編集後に静的 SOQL 検証とライブクエリプラン分析を実行します

コメント

Markdown 対応