# soql-tool

**Repository Path**: mirrors_google/soql-tool

## Basic Information

- **Project Name**: soql-tool
- **Description**: A lightweight tool that allows for permitted users to execute SOQL queries and REST endpoints directly within their Salesforce application
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-27
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SOQL Tool

The SOQL Tool is a lightweight tool that allows for permitted users to execute SOQL queries and REST endpoints directly within their Salesforce application. It allows for users who do not have access to the Developer Console to perform such queries, and has additional features beyond what the standard Developer Console provides. It's also built with native Lightning components, so users can use the tool without needing to go through third party websites or install browser extensions.

![SOQL Tool In Action](docs/images/soql_tool.png)

![REST Explorer In Action](docs/images/rest_explorer.png)

## Installation

#### [Unlocked Package Installation (Production)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04tgK0000005914QAA)

#### [Unlocked Package Installation (Sandbox)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04tgK0000005914QAA)

## Access

Users will need the `SOQL Tool - Full Access` permission set in order to access the tool. If it's desired for a user to not be able to use the REST Explorer API, assign them the `SOQL Tool - SOQL Access (No REST)` permission set instead.

The tool can be accessed by searching for `SOQL Tool` in the app launcher (or going to `https://{mysalesforcedomain}.lightning.force.com/lightning/n/SOQL_Tool`).

If preferred, there is a detached version of the tool that can be accessed from `https://{mysalesforcedomain}.lightning.force.com/c/soql.app`

## Key Features

### SOQL Explorer

Users can enter the following types of queries to search records in their instance. Note that traditional sharing rules and permissions are applied, so users will not be able to see records or fields they don't have access to:

1.  Traditional SOQL Queries - Enter any standard SOQL query or use `SELECT *` to select all fields of an object.
2.  Describe Queries - Enter `DESC ObjectName` to retrieve schema information about the specified object.
3.  Salesforce IDs - Enter the Salesforce record ID to retrieve all fields for that record.
4.  Limits - Enter `LIMITS` to retrieve the list of all org-wide limits and their current usage.

### REST Explorer

Use the REST tab to send any type of REST query (`GET/POST/PATCH/PUT/DELETE`) to the instance. This can be helpful for experimenting with the standard [Salesforce REST API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_list.htm) or for testing [custom Apex REST Web Services](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm).

## Settings

The `SOQL Tool Settings` (`SOQLTool_Settings__c`) custom setting allows configuring the following:

1.  Logging (`Is_Log_Enabled__c`): If this setting is enabled, this tool logs queries in the `SOQL_Log__c` custom object. Enabling logging provides some additional features (sharable url and recent queries).

2.  SOQL Limit Warning (`Limit_Warning_Threshold__c`): A warning message is displayed if the query specifies a limit higher than a defined threshold. The default threshold value is `100`. It can be overridden by updating this setting. Enter `0` for no warning to ever appear.

3.  Recent Queries (`Max_Recent_Queries__c`): If logging is enabled, the Recent Queries tab displays the `50` most recent queries executed using this tool by default. It allows users to select a previous query to execute again. The number of queries displayed can be overridden by updating this setting.

## Notes

This is not an officially supported Google product. This project is not
eligible for the [Google Open Source Software Vulnerability Rewards
Program](https://bughunters.google.com/open-source-security).

## Authors

- [Aayush Kaistha](https://www.linkedin.com/in/aayush-kaistha-157bb85a/)
- [Gabe Terrell](https://github.com/gabe-terrell)