[Linux] Exploring the Integration of Sisense Details with SQL Queries
Summary: Felipe Carneiro discusses how Sisense, as of version 2026.3.1, lacks a built-in feature to inject identifiers into SQL queries. However, a connector plugin is introduced to address this issue by injecting information such as user and dashboard IDs into SQL queries. The post details the setup process, including steps for plugin installation and configuration. It notes that the solution is specific to certain Sisense versions and should be tested in individual environments. The information is provided for those looking to enhance Sisense query capabilities using the plugin.
As of 2026.3.1, Sisense does not have a native option to inject Sisense identifiers into the Sisense-generated SQL query. The only exception are connections to the Redshift data source, which include a SQL comment with a query GUID of the Sisense query.
This connector plugin looks to solve this by injecting additional information into the SQL query sent to the Live data source.
Due to the structure of connector hooks, the Query GUID can not be injected into the SQL query. Instead, the plugin adds the following information:
Hook and Logs
The plugin relies on the beforeExecuteQuery hook.
For the logs, after the plugin is installed, in the query logs of your data source, you will see the following messages:
Steps
1. Upload the attached folder from this zip file
Extract and copy the folder to the
/opt/sisense/storage/datapathIt will be stored as
/opt/sisense/storage/data/context-comment-plugin
2. Create a context-comment-plugin/lib subfolder.
3. Populate the lib with the required JARs:
a. connectors-sdk-*.jar: identify the connectors SDK version and copy it:
b. lombok.jar:
c. slf4j-api.jar:
4. Make the script executable.
5. Execute the shell script
6. List the connectors using sisense cli
If you are not able to run this, you might not have Sisense CLI installed, run the following commands (the user needs to have permission).
7. Install the plugin using, replacing the {CONNECTOR} with your data source.
Some examples
#Snowflake
si connectors plugins install -connector-id SnowflakeJDBC -file /opt/sisense/storage/data/context-comment-plugin/dist/ContextCommentPlugin.tar.gz
#PostgreSQL
si connectors plugins install -connector-id PostgreSQL -file /opt/sisense/storage/data/context-comment-plugin/dist/ContextCommentPlugin.tar.gz
#Databricks
si connectors plugins install -connector-id Databricks -file /opt/sisense/storage/data/context-comment-plugin/dist/ContextCommentPlugin.tar.gz8. You should be receiving Sisense details on your query logs on your database logs.
NOTE: If you just refreshed your widgets, you might wait up to 10min due to cache.
Caveats
The plugin affects Live models only. This can be adjusted in the Java code of the plugin.
The plugin is installed separately for each connector type.
Some INFO log entries are added to the
queryservice.The used JAR files were tested with a specific Sisense version (2026.3.1). You may need to adjust the JAR versions to work with a specific Sisense release.
