SqlDataSource.RebuildResultSchema() Method

Validates and updates the result schema available on the client after query execution (it can be accessed using the SqlDataSource.Result property). This command does not affect the actual database schema on the server.

Namespace: DevExpress.DataAccess.Sql

Assembly: DevExpress.DataAccess.v23.2.dll

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

Declaration

C#

public void RebuildResultSchema()

VB.NET

Public Sub RebuildResultSchema

Remarks

If errors occur during data connection, a DatabaseConnectionException is thrown.

All queries are validated one by one. When validation errors occur, they are collected and returned by throwing a AggregateException. Use its 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 during the execution of each query, these errors are collected and returned by throwing a AggregateException. Use its InnerExceptions property to access a collection of QueryExecutionException objects (use their InnerException property to access an actual DevExpress.DataAccess.Native.Sql.SqlExecutionException).

Note

When using a SqlDataSource to bind an XtraReport to data, call the RebuildResultSchema method to make the data source structure displayed in the Field List of an End-User Report Designer. For a code sample, see Bind a Report to a Microsoft SQL Server Database (Runtime Sample).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RebuildResultSchema() 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#

reporting-wpf-create-drill-down-report-document-preview-control/CS/dxWPFApp/MainWindow.xaml.cs#L130

ds.Queries.Add(new CustomSqlQuery("Categories", "select * from Categories"));
ds.RebuildResultSchema();
return ds;

reporting-mvc-db-storage/CS/DXWebApplication_ReportDesigner/Controllers/DesignerController.cs#L52

ds.Queries.Add(new CustomSqlQuery("Categories", "SELECT * FROM [Categories]"));
ds.RebuildResultSchema();
return ds;

reporting-web-forms-report-designer-add-data-sources/CS/WebApplication1/Default.aspx.cs#L79

ds.Queries.Add(query);
ds.RebuildResultSchema();
return ds;

reporting-aspnet-webforms-customize-report-designer-toolbar/CS/DXWebApplication1/Designer.aspx.cs#L20

ds.Queries.Add(query);
ds.RebuildResultSchema();

Reporting-Bind-Report-To-Federated-Master-Detail-Data-Source/CS/Form1.cs#L83

sqlDataSource.Queries.Add(categoriesQuery);
sqlDataSource.RebuildResultSchema();
return sqlDataSource;

VB.NET

reporting-wpf-create-drill-down-report-document-preview-control/VB/dxWPFApp/MainWindow.xaml.vb#L133

ds.Queries.Add(New CustomSqlQuery("Categories", "select * from Categories"))
ds.RebuildResultSchema()
Return ds

reporting-mvc-db-storage/VB/DXWebApplication_ReportDesigner/Controllers/DesignerController.vb#L47

ds.Queries.Add(New CustomSqlQuery("Categories", "SELECT * FROM [Categories]"))
ds.RebuildResultSchema()
Return ds

reporting-web-forms-report-designer-add-data-sources/VB/WebApplication1/Default.aspx.vb#L71

ds.Queries.Add(query)
ds.RebuildResultSchema()
Return ds

reporting-winforms-group-at-runtime/VB/DataGrouping/Form1.vb#L28

ds.Queries.Add(query)
ds.RebuildResultSchema()
' Assign the data source to the report.

reporting-aspnet-webforms-customize-report-designer-toolbar/VB/DXWebApplication1/Designer.aspx.vb#L20

ds.Queries.Add(query)
ds.RebuildResultSchema()
' Add the created data source to the list of default data sources.