SQL Designer
Applies to: Kyvos Reporting
The SQL Designer in Kyvos Reporting allows you to create or modify SQL queries using a visual interface or text editor. You can either drag and drop database tables to build queries visually or manually write SQL statements.
Accessing SQL Designer
To launch the SQL Designer:
On the Query Object Editor screen, go to the Data Source step.
Click Properties > Design.
The SQL Designer screen appears.
Note
You can view the schema of the selected database connection only if metadata caching is enabled for that connection.
Key Terminology
Entities: Represent database tables or views available in the selected connection.
Attributes: Represent the columns or fields of the selected entity.
SQL Designer Tabs
The right pane of SQL Designer includes multiple tabs to assist in query creation and execution:
Tab | Description |
|---|---|
Design | Use this tab to create SQL queries visually by dragging and dropping tables and fields. Ideal for simple query design. |
Edit | View and modify the SQL statement generated from the Design tab or manually enter custom SQL. |
Result | Preview the data returned from the current SQL query. |
Procedure | Specify details of stored procedures when selected as the data source. This tab becomes active only when a procedure is selected. |
Search | Search for specific entities such as table or view names. Useful for large databases. |
Sort (Web Studio only) | Set sort preferences for fields used in the report. |
Filter (Web Studio only) | Define runtime filter criteria for the report. |
Viewing Database Objects
At the top of the SQL Designer, the current connection name is displayed. This connection is used to retrieve available database objects.
Choose one of the following object types: Table, View, Procedure, or Synonym.
A paginated list of available entities appears for the selected connection.
Use the drop-down or pagination links (Next / Prev) to browse through entities.
Note
Only a predefined number of entities are shown at a time.
Refreshing the Entity List
When the screen is refreshed, the timestamp of the last refresh is displayed at the top of the SQL Designer. This helps in validating the recency of metadata.
To learn more, refer to the chapters below.