Specifies whether to use the Salesforce Tooling API for retrieving and modifying metadata and development-related objects.

Data Type

bool

Default Value

false

Remarks

When UseToolingAPI is set to true, the provider uses Salesforce’s Tooling API instead of standard data APIs. The Tooling API is designed for development, deployment, and debugging tasks, allowing access to metadata types, Apex classes, triggers, and other development-related entities.

This property is useful for developers who need to query metadata objects, inspect Apex code, or perform other administrative and development-related operations that are not available via the standard REST or SOAP APIs.

When UseToolingAPI is set to false, the driver uses the standard Salesforce APIs, which focus on business data rather than metadata and development tooling.

Using the Tooling API provides access to specialized metadata and development objects but is limited to specific entity types. It is not intended for large data operations or standard CRM records. Enabling this property has no performance impact on normal data queries, but is only relevant for metadata or tooling queries.

This property is useful for tasks like metadata inspection, Apex monitoring, and debugging deployments within Salesforce development environments.