SOQL Console

Abstract

Salesforce SOQL console app with metadata-aware word completion. Works both on TTY and web UI.

Install

Running on TTY

Usage

Command Options

Interactive Commands

Type ".help" to see command help menu when you are in REPL.

Running on Web UI

Hosted Service

https://soql-console.herokuapp.com/

Building on Local Server

Build and start your local web app for soql-console.

Now you can access to http://localhost:5000 from your browser to get SOQL console web UI.

Help

Start Completion

• Tab
• Ctrl + Space

Move Cursor to Next

• ↓ (Down Arrow)
• Tab
• Ctrl + Space

Move Cursor to Previous

• ↑ (Up Arrow)
• Shift + Tab
• Ctrl + Shift + Space

Execute Completion

• Return

Cancel Completion

• Esc

Run Query

• Ctrl + Return

Credits

(The MIT License)

Copyright (c) 2012 Shinichi Tomita [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Special Note

A lot of code in this project is borrowed from SQL Parser (https://github.com/forward/sql-parser) project by Andrew Kent. Thanks.