Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the driver beyond simple SELECT/INSERT/UPDATE/DELETE operations with Salesforce.
Stored procedures accept a list of parameters, perform their intended function, and then return, if applicable, any relevant response data from Salesforce, along with an indication of whether the procedure succeeded or failed.
CData JDBC Driver for Salesforce Stored Procedures
| Name | Description |
| AbortJob | Aborts a Salesforce job. |
| CloseJob | Closes a Salesforce job. |
| CloseJobV2 | Closes or aborts a Salesforce job. |
| ConvertLead | Converts a Lead into an Account, Contact, or (optionally) an Opportunity. |
| CreateBatch | Creates a Salesforce batch. |
| CreateJob | Add a Salesforce object entry. |
| CreateJobV2 | Creates a job, which represents a bulk operation (and associated data) that is sent to Salesforce for asynchronous processing. Provide job data via an Upload Job Data request, or as part of a multipart create job request. |
| CreateReportSchema | Creates a schema file based on the specified report. |
| CreateSchema | Creates a schema file for the specified table. |
| DeleteJobV2 | Deletes a job. To be deleted, a job must have a state of UploadComplete, JobComplete, Aborted, or Failed. |
| DownloadAttachment | Downloads the attachment or attachments associated with a specific entity in Salesforce. |
| DownloadContentDocument | Downloads the content document or documents in Salesforce. |
| DownloadDocument | Downloads the document or documents in Salesforce. |
| GetBatch | Gets information about a Salesforce batch. |
| GetBatchResults | Gets the results of a Salesforce batch. |
| GetCustomReport | Get the custom report by report Id. |
| GetDeleted | Retrieves the list of individual records that have been deleted within the given timespan for the specified object. |
| GetJob | Gets information about a Salesforce job. |
| GetJobBatchIds | Get batch id for all batches in a Job. |
| GetLimitInfo | Retrieves limit information for the organization. Use this stored procedure to monitor your SOAP API limits as you make calls against the organization. |
| GetOAuthAccessToken | If using a Windows application, set Authmode to App. If using a Web app, set Authmode to Web and specify the Verifier obtained by GetOAuthAuthorizationUrl. |
| GetOAuthAuthorizationUrl | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. |
| GetUpdated | Retrieves the list of individual records that have been updated within the given timespan for the specified object. |
| GetUserInformation | Retrieves personal information for the user associated with the current session. |
| Merge | Combines up to 3 records of the same type into 1 record. |
| MetadataDeploy | Deploys file representations of components into an org by creating, updating or deleting the components they represent. To be used after executing MetadataRetrieve Stored Procedure. |
| MetadataDeployDetails | Used to retrieve additional details about MetadataDeploy job. Can be used after executing MetadataDeploy Stored Procedure. |
| MetadataRetrieve | Retrieve file representations of components in an organization. |
| QueryBatch | Get data from Salesforce using query batch. Only batches created with content type CSV can be queried with this stored procedure. |
| RefreshOAuthAccessToken | Refreshes the OAuth token or session id after the session has expired. Your OAuth application must have the refresh_token scope enabled. |
| Undelete | Restores from Salesforce's RecycleBin a deleted record. |
| UploadAttachment | Uploads an attachment and associates it with an entity in Salesforce. |
| UploadContentDocument | Uploads a content document in Salesforce. |
| UploadDocument | Uploads a document in Salesforce. |
| UploadJobDataV2 | Upload the CSV file to Salesforce. |