SelectQueryFluentBuilder Class

Provides methods that can be chained within a single statement specifying a SelectQuery.

Namespace: DevExpress.DataAccess.Sql

Assembly: DevExpress.DataAccess.v20.2.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.WindowsDesktop.DataAccess

Declaration

C#

public sealed class SelectQueryFluentBuilder

VB.NET

Public NotInheritable Class SelectQueryFluentBuilder

Related API Members

The following members return SelectQueryFluentBuilder objects:

Show 39 links

• SelectQueryFluentBuilder.AddTable(String, String)
• SelectQueryFluentBuilder.AddTable(String)
• SelectQueryFluentBuilder.Distinct()
• SelectQueryFluentBuilder.Filter(String)
• SelectQueryFluentBuilder.GroupBy(String)
• SelectQueryFluentBuilder.GroupBy(String[])
• SelectQueryFluentBuilder.GroupFilter(String)
• SelectQueryFluentBuilder.Join(String, JoinType, RelationColumnInfo[])
• SelectQueryFluentBuilder.Join(String, JoinType, String, String, ConditionType)
• SelectQueryFluentBuilder.Join(String, JoinType, String, String, String, ConditionType)
• SelectQueryFluentBuilder.Join(String, JoinType, String, String)
• SelectQueryFluentBuilder.Join(String, JoinType, String)
• SelectQueryFluentBuilder.Join(String, RelationColumnInfo[])
• SelectQueryFluentBuilder.Join(String, String, JoinType, RelationColumnInfo[])
• SelectQueryFluentBuilder.Join(String, String, JoinType, String, String)
• SelectQueryFluentBuilder.Join(String, String, JoinType, String)
• SelectQueryFluentBuilder.Join(String, String, RelationColumnInfo[])
• SelectQueryFluentBuilder.Join(String, String, String, String)
• SelectQueryFluentBuilder.Join(String, String, String)
• SelectQueryFluentBuilder.Join(String, String)
• SelectQueryFluentBuilder.SelectAllColumns()
• SelectQueryFluentBuilder.SelectAllColumnsFromTable()
• SelectQueryFluentBuilder.SelectColumn(String, AggregationType, String)
• SelectQueryFluentBuilder.SelectColumn(String, String)
• SelectQueryFluentBuilder.SelectColumn(String)
• SelectQueryFluentBuilder.SelectColumns(String[])
• SelectQueryFluentBuilder.SelectExpression(String, AggregationType, String)
• SelectQueryFluentBuilder.SelectExpression(String, String)
• SelectQueryFluentBuilder.SelectRecordsCount(String)
• SelectQueryFluentBuilder.Skip(Int32)
• SelectQueryFluentBuilder.SortBy(String, AggregationType, ListSortDirection)
• SelectQueryFluentBuilder.SortBy(String, AggregationType)
• SelectQueryFluentBuilder.SortBy(String, ListSortDirection)
• SelectQueryFluentBuilder.SortBy(String)
• SelectQueryFluentBuilder.SortBy(String[])
• SelectQueryFluentBuilder.SortByExpression(String, AggregationType, ListSortDirection)
• SelectQueryFluentBuilder.SortByExpression(String, ListSortDirection)
• SelectQueryFluentBuilder.SortByExpression(String)
• SelectQueryFluentBuilder.Top(Int32)

Remarks

A SelectQueryFluentBuilder instance is created by calling the static SelectQueryFluentBuilder.AddTable method.

The chain of methods must end with calling the SelectQueryFluentBuilder.Build method accepting the query name as a parameter.

In the following example, a query selects and orders records from a single data table.

C#

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
// ... 

private SqlDataSource BindToData() {
    // Create a data source with the required connection parameters. 
    Access97ConnectionParameters connectionParameters =
    new Access97ConnectionParameters("../../Data/nwind.mdb", "", "");
    SqlDataSource ds = new SqlDataSource(connectionParameters);

    // Return a list of categories sorted by the number of products in each category. 
    // The chain ends with calling the Build method accepting the query name as a parameter.
    SelectQuery query = SelectQueryFluentBuilder
        .AddTable("Products")
        .SelectColumn("CategoryID")
        .GroupBy("CategoryID")
        .SortBy("ProductID", AggregationType.Count, System.ComponentModel.ListSortDirection.Descending)
        .Filter("[CategoryID] != 8")
        .Build("MyQuery");

    // Add the query to the collection and return the data source. 
    ds.Queries.Add(query);
    return ds;
}

VB.NET

Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
' ... 

Private Function BindToData() As SqlDataSource
    ' Create a data source with the required connection parameters.  
    Dim connectionParameters As New Access97ConnectionParameters("../../Data/nwind.mdb", "", "")
    Dim ds As New SqlDataSource(connectionParameters)

    ' Return a list of categories sorted by the number of products in each category.  
    ' The chain ends with calling the Build method accepting the query name as a parameter. 
    Dim query As SelectQuery = SelectQueryFluentBuilder.
        AddTable("Products").
        SelectColumn("CategoryID").
        GroupBy("CategoryID").
        SortBy("ProductID", AggregationType.Count, System.ComponentModel.ListSortDirection.Descending).
        Filter("[CategoryID] != 8").
        Build("MyQuery")

    ' Add the query to the collection and return the data source.  
    ds.Queries.Add(query)
    Return ds
End Function

In the following example, a query uses an inner join to select columns from separate data tables sharing a common column key.

C#

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
using DevExpress.Xpo.DB;
// ...

private SqlDataSource BindToData() {
    // Create a data source with the required connection parameters. 
    Access97ConnectionParameters connectionParameters =
    new Access97ConnectionParameters("../../Data/nwind.mdb", "", "");
    SqlDataSource ds = new SqlDataSource(connectionParameters);

    // Join the Categories and Products table by the CategoryID column. 
    // Return the list of categories and the number of products in each category. 
    // Sort the categories by the number of products in them. 
    // The included categories must contain a specific number of products.
    SelectQuery query = SelectQueryFluentBuilder
        .AddTable("Categories")
        .SelectColumn("CategoryName")
        .GroupBy("CategoryName")
        .Join("Products", "CategoryID")
        .SelectColumn("ProductName", AggregationType.Count, "ProductCount")
        .SortBy("ProductName", AggregationType.Count, System.ComponentModel.ListSortDirection.Descending)
        .GroupFilter("[ProductCount] > 7")
        .Build("MyQuery");

    // Add the query to the collection and return the data source. 
    ds.Queries.Add(query);
    return ds;
}

VB.NET

Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Imports DevExpress.Xpo.DB
' ... 

Private Function BindToData() As SqlDataSource
    ' Create a data source with the required connection parameters. 
    Dim connectionParameters As New Access97ConnectionParameters("../../Data/nwind.mdb", "", "")
    Dim ds As New SqlDataSource(connectionParameters)

    ' Join the Categories and Products table by the CategoryID column. 
    ' Return the list of categories and the number of products in each category. 
    ' Sort the categories by the number of products in them. 
    ' The included categories must contain a specific number of products.
    Dim query As SelectQuery = SelectQueryFluentBuilder.
        AddTable("Categories").
        SelectColumn("CategoryName").
        GroupBy("CategoryName").
        Join("Products", "CategoryID").
        SelectColumn("ProductName", AggregationType.Count, "ProductCount").
        SortBy("ProductName", AggregationType.Count, System.ComponentModel.ListSortDirection.Descending).
        GroupFilter("[ProductCount] > 7").
        Build("MyQuery")

    ' Add the query to the collection and return the data source. 
    ds.Queries.Add(query)
    Return ds
End Function

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SelectQueryFluentBuilder class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-use-the-web-report-designer-in-javascript-with-reactjs-t561295/CS/ServerSide/Controllers/ReportDesignerController.cs#L39

SqlDataSource ds = new SqlDataSource("Northwind_Connection");
var query = SelectQueryFluentBuilder.AddTable("Products").SelectAllColumns().Build("Products");
ds.Queries.Add(query);

VB.NET

Reporting_how-to-use-the-web-report-designer-in-javascript-with-reactjs-t561295/VB/ServerSide/Controllers/ReportDesignerController.vb#L33

Dim ds As New SqlDataSource("Northwind_Connection")
Dim query = SelectQueryFluentBuilder.AddTable("Products").SelectAllColumns().Build("Products")
ds.Queries.Add(query)

Inheritance

Object

SelectQueryFluentBuilder