Use the Query Builder

Sep 02, 2022
4 minutes to read

In the Query Builder dialog, you can add data tables and views to the data source, and select which columns to include. The Query Builder automatically joins the related tables, so all you need to do is drag and drop.

Use the Query Builder

Add Tables

To add tables/views to a data source, double-click the table (or view) or drag and drop it from the Tables pane onto the Diagram pane.

Then, select the required columns.

If necessary, you can customize a database schema to display only certain database entities in the Tables/Diagram panes. For more information on how to implement a custom database schema provider, refer to the following article: Custom Database Schema Provider in WinForms.

Join Tables

Note that if at least one table has been added to the Diagram pane, the Tables pane highlights tables that have a relationship with any of the recently added tables.

To join the already added table with an another table, do one of the following.

Click the button next to the foreign key column (SupplierID and CategoryID in the image above).
Drag and drop the highlighted table from the Tables pane to Diagram pane.

The Query Builder will display a relationship between tables.

To edit this relation, select it and use its context menu.

The following commands are available.

Edit Relation - Allows you to edit the selected relation. Clicking this menu item invokes the Join Editor dialog.
Delete Relation - Removes the selected relation. Note that this action removes the joined table(s).

Edit Column Settings

After you have added the tables and selected the required columns, you can change settings for each column in the Grid pane.

The following settings are available for each column.

Use Column to select the required column from the combo box or add a new column. If necessary, you can customize a column expression. To do this, click the ellipsis button for the required column and specify the expression in the invoked Expression Editor dialog.
The Table column displays corresponding table names.
The Alias column allows you to specify the column alias.

Note

Note that aggregated columns should always have an alias.

The Output column allows you to choose whether to include specific columns to the query.
Use the Sorting type combo box to specify the sort order of column values. The Sort order column allows you to specify the order in which several columns are sorted.
The Group By statement is used in conjunction with the aggregate functions to group the result-set by one or more columns.
The Aggregate option allows you to specify the aggregate function used to aggregate column values.

Note

Note that you should apply aggregation/grouping either to all columns or to none of them.

Filter Data

To filter data in the Query Builder, click the Filter… button. This invokes the Filter Editor dialog that allows you to build filter criteria:

To learn more, see Filter Queries.

Edit Query Parameters

The Query Builder allows you to add query parameters when creating a filter criteria. To specify settings of added query parameters, click the Edit Parameters… button.

Customize SQL Query

Important

Note that the Query Builder does not allow you to use custom SQL queries. To enable the capability to specify custom SQL queries within the Data Source wizard and Query Builder, set the DashboardDesigner.DataSourceWizard.SqlWizardSettings.EnableCustomSql property to true.

After you add the tables, you can customize the automatically generated SQL query. To do this, enable the Allow Edit SQL checkbox and edit the SQL query displayed in the SQL pane.

For instance, you can add a WHERE clause to the SQL expression.

Note

Note that if you edit the automatically generated query and uncheck the Allow Edit SQL check box, your changes will be discarded, and the generated query will be restored.

Preview Data

The Query Builder allows you to preview data for the created SQL query. To do this, click the Preview Results… button.

This invokes the Data Preview window containing data returned after executing the query.