IncludeMetadataDescription
Salesforce Metadata API からカラム、テーブル、またはその両方の説明を取得するかどうかを指定します。
Possible Values
NONE, Columns, Tables, TablesAndColumnsデータ型
string
デフォルト値
"NONE"
解説
Salesforce Metadata API は、テーブルとカラムの説明を提供し、データ検索とスキーマドキュメントに役立ちます。 デフォルトでは説明は取得されませんが、このプロパティにより必要に応じて追加のメタデータを取得できます。次に例を示します。
- このプロパティをColumns に設定すると、スキーマ内のすべてのカラムの説明を取得します。
- Tables に設定すると、カラムではなくすべてのテーブルの説明を取得します。
- TablesAndColumns に設定すると、テーブルとそれぞれのカラムの両方の説明を取得します。
パフォーマンスの考慮事項
このプロパティを有効にするとAPI コール数が増加し、特に大規模なスキーマを持つ環境でパフォーマンスに影響を与える可能性があります。 過度のAPI リクエストを避けるため、必要な場合にのみ使用することを検討してください。
このプロパティは、スキーマの探索、ドキュメント、またはレポートツールで追加のメタデータコンテキストが必要な場合に役立ちます。