sfdx-extended-soql

Extension to the standard SOQL queries

• Debugging your plugin

$ npm install -g sfdx-extended-soql
$ sfdx-extended-soql COMMAND
running command...
$ sfdx-extended-soql (-v|--version|version)
sfdx-extended-soql/0.0.2 darwin-x64 node-v9.2.0
$ sfdx-extended-soql --help [COMMAND]
USAGE
  $ sfdx-extended-soql COMMAND
...

• sfdx-extended-soql gilgou:genquery
• sfdx-extended-soql gilgou:soql

sfdx-extended-soql gilgou:genquery

Generates a SOQL query with all explicit fieldnames instead of '*'

USAGE
  $ sfdx-extended-soql gilgou:genquery

OPTIONS
  -a, --fieldaccess=fieldaccess                   Field access : all, or updateable
  -q, --query=query                               Query to execute (select * from Account)
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  logging level for this command invocation

EXAMPLES
  $ sfdx gilgou:genquery --targetusername [email protected] --query "Select * From Account"
     Select Id,IsDeleted,MasterRecordId,Name,Type, ... From Account

  $ sfdx gilgou:genquery --targetusername [email protected] --fieldaccess updateable --query "Select * From Account"
     Select Name,Type,RecordTypeId,ParentId, ... From Account

See code: src/commands/gilgou/genquery.ts

sfdx-extended-soql gilgou:soql

Executes a SOQL query with all explicit fieldnames instead of '*'

USAGE
  $ sfdx-extended-soql gilgou:soql

OPTIONS
  -a, --fieldaccess=fieldaccess                   Field access : all, or updateable
  -f, --outputformat=outputformat                 Output format of the results (empty, csv, tree)
  -q, --query=query                               Query to execute (select * from Account)
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target org
  --apiversion=apiversion                         override the api version used for api requests made by this command
  --json                                          format output as json
  --loglevel=(trace|debug|info|warn|error|fatal)  logging level for this command invocation

EXAMPLES
  $ sfdx gilgou:soql --targetusername [email protected] --query "Select * From Account"
     | Id | IsDeleted | MasterRecordId | Name | Type | RecordTypeId | ...
     | 001i00000093gBiAAI | false | null | GenePoint5 | Customer - Channel | null | ...
     ...
  

  $ sfdx gilgou:soql --targetusername [email protected] --fieldaccess updateable --query "Select * From Account"
     | Name | Type | RecordTypeId | ParentId | BillingStreet | ...
     | GenePoint5 | Customer - Channel | null | null | 345 Shoreline Park
  Mountain View, CA 94043
  USA | ...
     ...
  

  $ sfdx gilgou:soql --targetusername [email protected] --fieldaccess updateable --query "Select * From Account" 
  --format csv
     "Name","Type","RecordTypeId","ParentId","BillingStreet" ...
     "GenePoint5","Customer - Channel","null","null","345 Shoreline Park
  Mountain View, CA 94043
  USA", ...
     ...
  

  $ sfdx gilgou:soql --targetusername [email protected] --fieldaccess updateable --query "Select * From Account" 
  --format tree
     {"records":[{"attributes":{"type":"Account","referenceId":"AccountRef1"},"Name":"GenePoint5","Type":"Customer - 
  Channel","RecordTypeId":null,"ParentId":null,"BillingStreet":"345 Shoreline Park
  Mountain View, CA 94043
  USA", ... }]}
     ...

See code: src/commands/gilgou/soql.ts

Debugging your plugin

We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the .vscode directory of this plugin is a launch.json config file, which allows you to attach a debugger to the node process when running your commands.

To debug the hello:org command:

1. Start the inspector

If you linked your plugin to the sfdx cli, call your command with the dev-suspend switch:

$ sfdx hello:org -u [email protected] --dev-suspend

Alternatively, to call your command using the bin/run script, set the NODE_OPTIONS environment variable to --inspect-brk when starting the debugger:

$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u [email protected]

2. Set some breakpoints in your command code
3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5). Congrats, you are debugging!