GUI: SQL Console

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

General

GUI Reference: SQL Console

The SQL console allows direct interaction with the hub database, both reading and writing.

Navigating To
Page Properties
Contents and Usage
Performing a Query

Important Note: the CodeSonar Web GUI makes extensive use of JavaScript. Make sure JavaScript is enabled in your web browser.

Navigating To

The SQL Console can be reached in any of the following ways.

From Settings:	Select SQL Console from the Other Links tab.
By URL:	http://hub_location/sql.html

Page Properties

Output formats

CSV, JSON, XML (sql.xsd)

Visibility Filter Applied

none

RBAC Permissions Needed

Page Access	G_SQL_CONSOLE

Contents and Usage

The following annotated screenshot shows the various parts of the SQL Console page before any queries have been entered or executed.

annotated screenshot: SQL Console page before any queries have been entered or executed

Standard Header

See GUI Reference: Standard Header.

Breadcrumbs

Home > SQL Console
Where Home links to the GUI Home page.

Page Heading

SQL Console

Query Field

A text field for entering your SQL query.

Submit Query button

Click to execute the specified SQL query on the hub database.

Shortcut Buttons

Buttons for executing predefined queries, as described in the following table. Click any button to execute the corresponding query.

Button	Query/Result
Table Statistics	Basic statistics for all public database tables.
Index Statistics	Basic statistics for all indexes on public database tables.
Explain Home Page Query	For the SQL query used to generate the Home page, provides information about query execution order and resource usage under current conditions.
Current Activity	Activities currently taking place on the database.
Table Space Profile	Size statistics for all public database tables.

Eval Links

[After execution only] A set of shortcut URLs to re-execute the query and return the results in various formats.

Query Results

[After execution only] Results from the last query executed (if any):

Record count (-1 if no previous query).
Total result size, in bytes (-1 if no previous query).
Result table, if any.

Standard Footer

See GUI Reference: Standard Footer.

Performing a Query

To perform an SQL query on the hub database:

Enter your query in the text field.
Click Submit Query

CodeSonar will execute your query on the hub database and output the results on the SQL Console page, as in the following example. The page contents are expanded to include a set of eval links and the query results.

annotated screenshot: SQL Console page after query execution

To report problems with this documentation, please visit https://support.codesecure.com/.