Skip to content

Query Tools

Query Tools is a special interface used to execute queries and statements against a database. This interface can be accessed manually or by running a stored query from the Queries interface (Configuration -> Databases -> Queries). The database configuration and connection information must be available in the Databases interface (Configuration -> Databases -> Databases) before those settings can be used by this interface.

Note

Not all databases can be connected to using this interface.

Refer to the Grid Details section for details on how to interact with the interface.

This user interface calls REST methods from api/database/queryTools.

The UI path for this interface is Configuration -> Databases -> Query Tools.

Warning

Exercise caution when using this interface as it is possible to:

  • Delete data with malformed queries.
  • Cause database performance issues when querying large datasets.

Please reference the following table for the language used in each schema/database.

Schema Database Language
Assure1 MariaDB SQL
Event MariaDB SQL
Graph Neo4j Cypher Query Language
Graph OrientDB Orient SQL
Historical ElasticSearch Elasticsearch SQL
Metric InfluxDB InfluxQL
Vision MariaDB SQL

Warning

Please double-check you are using the correct version of the documentation based on the versions found here External Licenses

Grid Details

  • Prev/Next - These buttons can be used to view the queries that have been executed via the interface.

  • Clear Results - This button will clear the results from previously executed queries.

  • Database - A selector for which database is to be used when executing the query.

  • Schema - A selector for which schema is to be used when executing the query.

  • SELECT Limit - A limit will be added to the query. This is also used for pagination.

  • ShardID - An identifier of which shard should be used when executing the query.

  • Query - The query to be executed.

  • Results - The results of the queries that have been executed.

Query Toolbar

  • Line Numbers - Toggles on/off the line numbers.

  • Search - Search for text in the query.

  • Previous - Previous result for current search.

  • Next - Next result for current search.

  • Replace - Search and replace text in the query.

  • Replace All - Search and replace all text in the query.