Specifies whether to retrieve descriptions for columns, tables, or both from the Salesforce Metadata API.

Possible Values

Data Type

string

Default Value

"NONE"

Remarks

The Salesforce Metadata API provides descriptions for tables and columns, which can be useful for data discovery and schema documentation. By default, descriptions are not retrieved, but this property allows fetching additional metadata when needed. For example:

1. Setting this property to Columns retrieves descriptions for all columns in the schema.
2. Setting it to Tables retrieves descriptions for all tables but not columns.
3. Setting it to TablesAndColumns retrieves descriptions for both tables and their respective columns.

Performance Considerations

Enabling this property increases the number of API calls, which may impact performance, especially in environments with large schemas. Consider using it only when necessary to avoid excessive API requests.

This property is useful when additional metadata context is required for schema exploration, documentation, or reporting tools.