SQL Tool Module
Page/Section: Module-SQLTool-Overview
The SQL Tool enables users to create and manage database connections, execute SQL queries, browse schemas, and export query results. It supports multiple database engines such as MySQL, Oracle, and OTM, providing a unified interface for development, testing, and data operations.
The module is designed for ease of use, connection security, collaborative usage, and optimized execution performance.
Landing Dashboard
Page/Section: Module-SQLTool-Landing
Upon opening the SQL Tool, users are presented with a welcome dashboard that includes:
- How to Use SQL Tool steps
- Quick access to documentation, tutorials, and API reference
- Feature overview panels (Fast & Secure, Multi-DB Support, Rich Results, Team Collaboration)
This acts as the workspace home before selecting or creating a new database connection.
Saved Connections Panel
Page/Section: Module-SQLTool-SavedConnections
The left side of the interface contains the Saved Connections panel, showing previously stored connections grouped into categories:
- MySQL Connections
- Oracle Connections
- OTM Connections
Actions available in Saved Connections
| Action | Description |
|---|---|
| + Add New Connection | Opens the database connection form to create a new connection. |
| Test Connection | Tests connectivity without saving. |
| Refresh | Reloads connection list. |
| Group / Collapse All | Structurally organizes or collapses folders. |
Once a connection is saved, it appears under its respective group. Selecting a saved connection opens a new SQL editor tab.
Add New Database Connection
Page/Section: Module-SQLTool-AddConnection
Clicking the + icon opens the New / Select Database Connection form.
| Field | Description |
|---|---|
| Name | Label for reference. |
| Database Type | Type of DB (e.g., MySQL, Oracle, etc.). |
| Hostname | Host server name or IP. |
| Port | Port number required for connection. |
| Username | Database username. |
| Password | Database password. |
Action Buttons
| Action | Description |
|---|---|
| Test | Tests the database connectivity without saving. |
| Clear | Resets all entered fields. |
| Save | Saves this connection to Saved Connections. |
| Connect | Establishes a live connection to begin executing SQL queries. |
| Cancel | Closes the form without saving. |
Note: Testing a connection does not save it into the Saved Connections list—only clicking Save adds it.
SQL Editor Workspace
Page/Section: Module-SQLTool-Editor
After connecting to a saved connection, a new tab opens displaying:
- Query writing area
- Action toolbar above the query editor
- Left panel showing DB schema objects such as tables, procedures, and views
SQL Editor Action Menu
| Action | Description |
|---|---|
| Run | Executes the current query. |
| Save | Saves the written query. |
| Copy | Copies SQL text. |
| History | Displays previously executed query history. |
| Clear | Clears editor area. |
| Undo / Redo | Revert or repeat modifications. |
| Format / Uppercase | Convert SQL to formatted or uppercase structure. |
Output Results
Page/Section: Module-SQLTool-Results
When a query is executed, results are shown in a data table below the query area. The UI supports:
- Sorting, filtering, and pagination controls
- Column-level search filters
- Export options
Export Options
| Format | Description |
|---|---|
| Export Excel | Downloads the result set as .xlsx. |
| Export CSV | Downloads the result set in .csv format. |
This enables users to analyze and share query results easily.
SQL Tool Workflow
Page/Section: Module-SQLTool-Workflow
- Open SQL Tool from dashboard
- Click + to create a new database connection
- Enter connection details and select Test or Save
- Choose the saved connection from the panel
- Write SQL in editor and use Run
- Review output table and export if needed
- Save frequently used queries and view query history when required
Key Features Summary
- Multi-DB support with categorized saved connections
- Test, connect, and save database credentials
- Complete SQL editor with productivity tools
- Schema explorer for understanding database objects
- Download results using CSV or Excel exports
- Query history and saved SQL library
- Format and uppercase SQL options