Getting Started with AQB 3 ASP.NET Edition in ASP.NET Core 2.1+ and client-side JavaScript rendering

Important:

This guide is only for the client-side JavaScript rendering!

Please refer to the appropriate guides for other environments:

Lots of demo projects illustrating various aspects of the functionality and different usage scenarios are shipped within the trial installation package. They can also be downloaded from the Active Query Builder 3 ASP.NET Examples GitHub repositories.

Note: if you use the previous major version in your projects, read the Migration Guide first.

Follow the steps below to embed Active Query Builder ASP.NET Edition to your project.

Add the ActiveQueryBuilder.Web.MVC NuGet package to your project OR add the references to the following assemblies from the component installation folder:

For ASP.NET Core over .NET Framework project (requires minimal .NET Framework version 4.6.2):

\assemblies\ActiveQueryBuilder.Core.dll
\assemblies\ActiveQueryBuilder.Web.Server.dll
\assemblies\ActiveQueryBuilder.Web.Core.dll

For ASP.NET Core over .NET Core project:

\assemblies_NETCore\ActiveQueryBuilder.Core.dll
\assemblies_NETCore\ActiveQueryBuilder.Web.Server.NETCore.dll
\assemblies_NETCore\ActiveQueryBuilder.Web.Core.NETCore.dll

Active Query Builder requires Newtonsoft.Json assembly version 6.0 or higher. You can get it by installing the Newtonsoft.Json NuGet package or download it directly from the Newtonsoft JSON website.

You may also need to add one or more assemblies to get connected to your database(s) to retrieve metadata from it. For example, if you work with SQLite, add the assembly containing SQLite Metadata Provider:

\assemblies\ActiveQueryBuilder.SQLiteMetadataProvider.dll

The whole list of supported database connectivity packages and appropriate connectors can be found here.

Is it necessary to set the CopyLocal property of "ActiveQueryBuilder.*" assemblies to True.

Add the following HTML markup to your web page:

@model ActiveQueryBuilder.Web.Server.QueryBuilder
@{
    ViewBag.Title = "Simple Client Rendering Demo";
}

<div class="col-md-12">
    <div id="qb"></div>
    <div class="qb-ui-layout">
        <div class="qb-ui-layout__top">
            <div class="qb-ui-layout__left">
                <div id="treeview"></div>
            </div>
            <div class="qb-ui-layout__right">
                <div id="navbar"></div>
                <div id="canvas"></div>
                <div id="statusbar"></div>
                <div id="grid"></div>
            </div>
        </div>
        <div class="qb-ui-layout__bottom">
            <div id="sql"></div>
        </div>
    </div>
</div>

@section scripts
{
    <script src="aqb_client.js"></script>

    <script>
        // identifies query builder instance in the session; must be the same on the server side
        var qbId = 'SimpleClient';

        $(function () {
            AQB.Web.UI.QueryBuilder(
                qbId,  // instance identifier
                $('#qb'),  // id or path to HTML DOM element
                { reinitUrl: // path to the session reinitialization method
                    '/QueryBuilder/CreateQueryBuilder' } 
            );
            AQB.Web.UI.ObjectTreeView(qbId, $('#treeview'));
            AQB.Web.UI.SubQueryNavigationBar(qbId, $('#navbar'));
            AQB.Web.UI.Canvas(qbId, $('#canvas'));
            AQB.Web.UI.StatusBar(qbId, $('#statusbar'));
            AQB.Web.UI.Grid(qbId, $('#grid'));
            AQB.Web.UI.SqlEditor(qbId, $('#sql'));

            AQB.Web.UI.startApplication(qbId);
        });
    </script>
}

The reinitUrl constructor parameter is needed for the case a component instance is destroyed on the server due to the client's inactivity.

Alternatives: You can initialize the component on the server-side later if the query builder UI is not shown right on the page load. In this case, you need to specify the second parameter to the startApplication method. This can be either
a) a path to the component's new instance creation method on the server (example), or
b) a function that fires a request to create the component and handles errors (example).

Modify the "Startup.cs" file by adding the following directives:

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using ActiveQueryBuilder.Web.Core;

// ...
public class Startup
{
    // ...
    
    public void ConfigureServices(IServiceCollection services)
    {
        // Active Query Builder requires support for Session HttpContext unless you use the Corporate version. 
        services.AddSession();
        services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

        // This service provides access to instances of QueryBuilder and QueryTranformer objects on the server.
        services.AddActiveQueryBuilder();
        
        // ...
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
        // Active Query Builder requires support for Session HttpContext.
        app.UseSession();
        
        // Active Query Builder server requests handler.
        app.UseActiveQueryBuilder();
        
        // ...
    }
}

Pass an instance of the IQueryBuilderService to the constructor of your controller to get or create a new instance of the QueryBuilder object.
While creating a new instance of it, initialize the MetadataProvider and SyntaxProvider properties with proper objects. Define a proper DBConnection object and pass it to the MetadataProvider.Connection property or load metadata from the XML file.

public class SimpleClientRenderingController : Controller
{
    // Professional version feature: if you want to let the user simultaneously 
    // build several queries, you must assign different instance ids to them.
    // In the Standard version, this parameter is ignored.
    private string instanceId = "SimpleClient";

    private readonly IHostingEnvironment _env;
    private readonly IQueryBuilderService _aqbs;
    private readonly IConfiguration _config;

    // Use IQueryBuilderService to get access to the server-side instances of Active Query Builder objects. 
    // See the registration of this service in the Startup.cs.
    public SimpleClientRenderingController(IQueryBuilderService aqbs, IHostingEnvironment env, IConfiguration config)
    {
        _aqbs = aqbs;
        _env = env;
        _config = config;
    }

    public ActionResult Index()
    {
        CreateQueryBuilder();
        return View();
    }
	
    // Creates and initializes new instance of the QueryBuilder object if it doesn't exist. 
    private QueryBuilder CreateQueryBuilder()
    {
        // Get an instance of the QueryBuilder object
        var qb = _aqbs.Get(instanceId);

        if (qb != null)
            return qb;

        // Create an instance of the QueryBuilder object
        qb = _aqbs.Create(instanceId);
        qb.SyntaxProvider = new SQLiteSyntaxProvider();

        // ==== The 1st way: ==================================
        // Bind Active Query Builder to a live database connection. -- comment out to use the 2nd way
        qb.MetadataProvider = new SQLiteMetadataProvider
        {
            // Assign an instance of DBConnection object to the Connection property.
            Connection = new SQLiteConnection(@"Data Source=C:\Northwind.db;Version=3;") 
        };

        // ==== The 2nd way: ==================================
        // Load MetaData from the pre-generated XML file. -- uncomment to use

        // Denies metadata loading requests during the work session.
        //qb.MetadataLoadingOptions.OfflineMode = true;

        //qb.MetadataContainer.ImportFromXML(pathToYourXMLFile);
        // ====================================================

        // Assign the initial SQL query text the user sees on the _first_ page load
        qb.SQL = @"Select o.Order_ID, c.ID As a1, c.First_Name, s.ID
          From Orders o Inner Join
            Customers c On o.Customer_ID = c.ID Inner Join
            Shippers s On s.ID = o.Shipper_ID
          Where o.Ship_City = 'A'";
    
        return qb;
    }
}

Alternative: You can automate the initialization of the QueryBuilder object (syntax and metadata providers, database connection or metadata loading from the XML file) by using the special configuration file. This way is useful when you want to run the backend in a Docker container. Learn the details in this article.

If you want to use the CriteriaBuilder control on your page, you will need an instance of the QueryTransformer object. Get it by passing an instance of the IQueryTransformerService to the constructor of your controller.

Embedding Criteria Builder in your data browsing UI

The QueryTransformer component and the accompanying CriteriaBuilder visual control let build a full-featured user interface to browse query result data. Note that Active Query Builder doesn't provide any means to display data as there are plenty of free and paid controls that can cope better with this task. Active Query Builder can be easily integrated with most of these controls providing the flexibility you need.

Please read the QueryTransformer and CriteriaBuilder guides for details.

Render the CriteriaBuilder control on the page. You can place it on the same page with the QueryBuilder control or on a separate page.

<div id="cb"></div>

@section scripts
{
    <script src="aqb_client.js"></script>

    <script>
        // identifies the query builder instance in the session; must be the same on the server side
        var qbId = 'SimpleClient';

        $(function () {
            AQB.Web.UI.CriteriaBuilder(qbId, $('#cb'));

            AQB.Web.UI.startApplication(qbId);
        });
    </script>
}

Add the following initialization code to your controller:

public class AspNetCoreDemoController : Controller
{
    private string instanceId = "SimpleClient";

    private readonly IQueryBuilderService _aqbs;
    private readonly IQueryTransformerService _aqts; 
    
    // Use the IQueryTransformerService to use the CriteriaBuilder control and take advantage of the QueryTransformer API. 
    public AspNetCoreDemoController(IQueryBuilderService aqbs, IQueryTransformerService aqts, IHostingEnvironment env)
    {
        _aqbs = aqbs;
        _aqts = aqts; 
        _env = env;
    }

    public ActionResult Index()
    {
        var qb = CreateQueryBuilder(); // see the previous code sample for the implementation

        CreateQueryTransformer(qb.SQLQuery); 

        return View();
    }

    private QueryTransformer CreateQueryTransformer(SQLQuery query)
    {
        // Get an instance of the QueryTransformer object
        var qt = _aqts.Get(instanceId)
        
        if (qt != null)
            return qt;

        // Create an instance of the QueryTransformer object
        qt = _aqts.Create(instanceId);
 
        qt.QueryProvider = query;
        qt.AlwaysExpandColumnsInQuery = true;
        
        return qt;
    }
}

Handle CriteriaBuilder events to integrate it with your data grid:

        $(function () {
            AQB.Web.onCriteriaBuilderReady(subscribeToChanges);
        });
        
        function subscribeToChanges(cb) {
            createGrid(); // user proc to create or initialize grid

            cb.on(cb.Events.AfterSyncCriteriaBuilder, function () {
                  updateGridColumns(cb.columns); // user proc to update list of query columns
                  updateGridData(); // user proc to update grid data
            });

            cb.loadColumns(); // trigger the initial query columns loading

            // request data from the server when the user changes the filter
            cb.on(cb.Events.CriteriaBuilderChanged,
                function () {
                    onCriteriaBuilderChanged(cb, updateGridData); 
                });
        }
        
        function onCriteriaBuilderChanged(cb, callback) {

            // check if there aren't any incomplete conditions in the CriteriaBuilder
            if (cb.isValid()) {
            
                // send the control state to the server to update the query
                cb.transformSql(function () { 
                    callback(); // a callback to use (usually run) the transformed query
                });
            } 
        }

The updateGridData procedure should perform the AJAX request to the server which will execute the query read from the QueryTransformer.SQL property and return data to the client. Make sure to properly handle SQL query execution errors.
You can also let users change sorting, apply grouping and aggregations, calculate totals and paginate the resultset in your data browsing UI using the QueryTransformer API.

See the Query Results demo project for details (included in the installation package and available on GitHub).

This guide is only for the client-side JavaScript rendering!

Embedding Criteria Builder in your data browsing UI

Comments

Articles in this section

This guide is only for the client-side JavaScript rendering!

Embedding Criteria Builder in your data browsing UI

Related articles

Articles in this section