Connect to Carbone Data from Blazor Apps

Blazor is a framework for developing modern, client-side web UIs using .NET technology. Instead of coding in JavaScript, developers can use the familiar C# language and .NET libraries to build app UIs.

The CData API Driver for ADO.NET can be used with standard ADO.NET interfaces, such as LINQ and Entity Framework, to interact with live Carbone data. Since Blazor supports .NET Core, developers can use CData ADO.NET Providers in Blazor apps. In this article, we will guide you to build a simple Blazor app that talks to Carbone using standard SQL queries.

Install the CData API Driver for ADO.NET

CData ADO.NET Providers allow users to access Carbone just like they would access SQL Server, using simple SQL queries.

Install the Carbone ADO.NET Data Provider from the CData website or from NuGet. Search NuGet for "Carbone ADO.NET Data Provider."

Create a Carbone-Connected Blazor App

Start by creating a Blazor project that references the CData API Driver for ADO.NET

1. Create a Blazor project on Visual Studio.

2. From the Solution Explorer, right click Dependencies, then click Add Project Reference.
3. In the Reference Manager, click the Browse button, and choose the .dll file of the installed ADO.NET Provider (e.g. System.Data.CData.API.dll, typically located at C:\Program Files\CData\CData API Driver for ADO.NET\lib etstandard2.0).

SELECT Carbone Data from the Blazor App

1. Open the Index.razor file from the Project page.
2. In a APIConnection object, set the connection string:

   Start by setting the Profile connection property to the location of the Carbone Profile on disk (e.g. C:\profiles\Carbone.apip). Next, set the ProfileSettings connection property to the connection string for Carbone (see below).

   Carbone API Profile Settings

   Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

   1. Log in to your Carbone account at https://account.carbone.io
   2. Copy the API key shown on the account home page

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Carbone API key (Bearer token).
   • CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

   For example: Profile=C:\profiles\Carbone.apip;AuthScheme=APIKey;APIKey=your_api_key;

3. The code below creates a simple Blazor app for displaying Carbone data, using standard SQL to query Carbone just like SQL Server.

   @page "/"
   @using System.Data;
   @using System.Data.CData.API;
   
   <h1>Hello, world!</h1>
   
   Welcome to your Data app.
   
   <div class="row">
       <div class="col-12">
   
           @using (APIConnection connection = new APIConnection(
             "Profile=C:\profiles\Carbone.apip;AuthScheme=APIKey;APIKey=your_api_key;"))
           {
               var sql = "SELECT Id, Name FROM Templates WHERE Category = 'Invoices'";
               var results = new DataTable();
   
               APIDataAdapter dataAdapter = new APIDataAdapter(sql, connection);
               dataAdapter.Fill(results);
   
               <table class="table table-bordered">
                   <thead class="thead-light">
                       <tr>
                           @foreach (DataColumn item in results.Rows[0].Table.Columns)
                           {
                               <th scope="col">@item.ColumnName</th>
                           }
                       </tr>
                   </thead>
                   <tbody>
                       @foreach (DataRow row in results.Rows)
                       {
                           <tr>
                               @foreach (var column in row.ItemArray)
                               {
                                   <td>@column.ToString()</td>
                               }
                           </tr>
                       }
                   </tbody>
               </table>
           }
       </div>
   </div>

4. Rebuild and run the project. The ADO.NET Provider renders Carbone data as an HTML table in the Blazor app.

   At this point, you have a Carbone-connected Blazor app, capable of working with live Carbone data just like you would work with a SQL Server instance. Download a free, 30-day trial and start working with live Carbone data in your Blazor apps today.