function salesforce_api_drush_help in Salesforce Suite 7.2

Same name and namespace in other branches

1. 6.2 salesforce_api/salesforce_api.drush.inc \salesforce_api_drush_help()
2. 7 salesforce_api/salesforce_api.drush.inc \salesforce_api_drush_help()

Implements hook_drush_help().

File

salesforce_api/salesforce_api.drush.inc, line 13

Drush integration for Salesforce. Provides commands to examine and query Salesforce data.

Code

function salesforce_api_drush_help($section) {
  switch ($section) {
    case 'drush:soql-show-tables':
      return dt("List tables in salesforce.");
    case 'drush:soql-describe':
      $output = dt("Examine table metadata in salesforce.") . "\n\n";
      $output .= dt("Arguments:\n  Salesforce Object    The path of the salesforce object to examine.") . "\n\n";
      $output .= dt("Examples:\n  drush soql describe Contact.fields    Display the fields on the Contact table.");
      return $output;
    case 'drush:soql':
      $output = dt("Execute a SOQL query. Note that you may need to escape quotes in your query: SELECT Email FROM Contact WHERE Email != \\'\\'") . "\n\n";
      $output .= dt("Arguments:\n  SOQL Query    A salesforce soql query to execute against salesforce.") . "\n\n";
      $output .= dt("Examples:\n  drush soql select Id, Name from Contact    Query the Contact table.");
      return $output;
  }
}