SqlDataSource.FillAsync() Method

Populates the SqlDataSource in an asynchronous manner.

Namespace: DevExpress.DataAccess.Sql

Assembly: DevExpress.DataAccess.v24.1.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap

Declaration

C#

public Task FillAsync()

VB.NET

Public Function FillAsync As Task

Returns

Type	Description
Task	A task that populates the data source.

Remarks

Use this method to populate an SQL data source in an individual task asynchronously. Unlike the Fill() method call, FillAsync does not lock other actions performed concurrently. For instance, the user interface remains operational while the data source is populated.

Call the FillAsync method with the await operator.

All queries are validated one by one. If any validation errors occur, an AggregateException is thrown with these errors. Use the exception’s InnerExceptions property to access a collection of QueryExecutionException objects (use their InnerException property to access an actual ValidationException).

If the validation succeeds, all queries are executed one by one. If any errors occur, an AggregateException is thrown with these errors. Use the exception’s InnerExceptions property to access a collection of QueryExecutionException objects (use their InnerException property to access an actual DevExpress.DataAccess.Native.Sql.SqlExecutionException).

To validate and execute only specific queries, use a FillAsync method overload that accepts the queriesToFill parameter.

Example

The code sample below creates an SqlDataSource and populates it in an asynchronous manner.

C#

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
SqlDataSource DataSource { get; set; }
public void CreateSqlDataSource()
{
    MsSqlConnectionParameters connectionParameters = new MsSqlConnectionParameters(
        ".", "NorthWind", null, null, MsSqlAuthorizationType.Windows);
    var sqlDataSource = new SqlDataSource(connectionParameters) { Name = "Sql_Categories" };
    var categoriesQuery = SelectQueryFluentBuilder
        .AddTable("Categories")
        .SelectAllColumnsFromTable()
        .Build("Categories");
    categoriesQuery.Name = "queryCategoriesAllFields";
    sqlDataSource.Queries.Add(categoriesQuery);
    sqlDataSource.RebuildResultSchema();
    DataSource = sqlDataSource;
}
async void FillDataSourceAsyncAllQueries()
{
    await DataSource.FillAsync();
}

VB.NET

Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Private Property DataSource() As SqlDataSource
Public Sub CreateSqlDataSource()
    Dim connectionParameters As New MsSqlConnectionParameters(
        ".", "NorthWind", Nothing, Nothing, MsSqlAuthorizationType.Windows)
    Dim sqlDataSource = New SqlDataSource(connectionParameters) With {.Name = "Sql_Categories"}
    Dim categoriesQuery = SelectQueryFluentBuilder.
        AddTable("Categories").
        SelectAllColumnsFromTable().
        Build("Categories")
    categoriesQuery.Name = "queryCategoriesAllFields"
    sqlDataSource.Queries.Add(categoriesQuery)
    sqlDataSource.RebuildResultSchema()
    DataSource = sqlDataSource
End Sub
Async Sub FillDataSourceAsyncAllQueries()
    Await DataSource.FillAsync()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FillAsync() method.

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#

winforms-grid-bind-to-azure-sql-database/CS/DXApplication1/DataAccess/DataProvider.cs#L64

var source = CreateSqlDataSource();
await source.FillAsync();
return source;

winforms-reporting-create-grid-based-report/CS/ConvertGridToReportExample/Form1.cs#L16

    // Fill the SqlDataSource asynchronously
    sqlDataSource1.FillAsync();
}

winforms-visualize-pivot-grid-data-in-chart/CS/XtraPivotGrid_ChartsIntegration/Form1.cs#L10

    // Fill the SqlDataSource asynchronously
    sqlDataSource1.FillAsync();
}

pivot-grid-for-winforms-layout-upgrade/CS/WinPivotUpgradeLayout/Form1.cs#L17

// Fill the SqlDataSource asynchronously
sqlDataSource1.FillAsync();
pivotGridControlNew.OptionsLayout.Columns.AddNewColumns = true;

VB.NET

winforms-grid-bind-to-azure-sql-database/VB/DXApplication1/DataAccess/DataProvider.vb#L73

Dim source = CreateSqlDataSource()
Await source.FillAsync()
Return source

winforms-reporting-create-grid-based-report/VB/ConvertGridToReportExample/Form1.vb#L15

    ' Fill the SqlDataSource asynchronously
    sqlDataSource1.FillAsync()
End Sub

winforms-visualize-pivot-grid-data-in-chart/VB/XtraPivotGrid_ChartsIntegration/Form1.vb#L12

    ' Fill the SqlDataSource asynchronously
    SqlDataSource1.FillAsync()
End Sub

pivot-grid-for-winforms-layout-upgrade/VB/WinPivotUpgradeLayout/Form1.vb#L20

' Fill the SqlDataSource asynchronously
sqlDataSource1.FillAsync()
pivotGridControlNew.OptionsLayout.Columns.AddNewColumns = True