VOOZH about

URL: https://www.cdata.com/kb/tech/xml-ado-blazor.rst

โ‡ฑ Connect to XML Data from Blazor Apps


Connect to XML Data from Blazor Apps

๐Ÿ‘ Cameron Leblanc
Cameron Leblanc
Senior Technology Evangelist
Build ASP.NET Core Blazor C# apps that integrate with real-time XML data using standard SQL.

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 ADO.NET Provider for XML can be used with standard ADO.NET interfaces, such as LINQ and Entity Framework, to interact with live XML 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 XML using standard SQL queries.

Install the CData ADO.NET Provider for XML

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

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

๐Ÿ‘ Install ADO.NET XML Provider from NuGet.

Create a XML-Connected Blazor App

Start by creating a Blazor project that references the CData ADO.NET Provider for XML

  1. Create a Blazor project on Visual Studio.
  2. ๐Ÿ‘ Create a Blazor app project.
  3. From the Solution Explorer, right click Dependencies, then click Add Project Reference.
  4. In the Reference Manager, click the Browse button, and choose the .dll file of the installed ADO.NET Provider (e.g. System.Data.CData.XML.dll, typically located at C:\Program Files\CData\CData ADO.NET Provider for XML\lib etstandard2.0).
  5. ๐Ÿ‘ Reference ADO.NET for XML .dll in the Blazor app.

SELECT XML Data from the Blazor App

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

    Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) XML Files

    CData Drivers let you work with XML files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.

    Setting connection properties for local files

    Set the URI property to local folder path.

    Setting connection properties for files stored in Amazon S3

    To connect to XML file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended XML files exist. In addition, at least set these properties:

    • AWSAccessKey: AWS Access Key (username)
    • AWSSecretKey: AWS Secret Key

    Setting connection properties for files stored in Box

    To connect to XML file(s) within Box, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Box.

    Dropbox

    To connect to XML file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.

    SharePoint Online (SOAP)

    To connect to XML file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. Set User, Password, and StorageBaseURL.

    SharePoint Online REST

    To connect to XML file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.

    Google Drive

    To connect to XML file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.

    The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

    • Document (default): Model a top-level, document view of your XML data. The data provider returns nested elements as aggregates of data.
    • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
    • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

    See the Modeling XML Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

    For example: URI=C:/people.xml;DataModel=Relational;

  3. The code below creates a simple Blazor app for displaying XML data, using standard SQL to query XML just like SQL Server.
     @page "/"
     @using System.Data;
     @using System.Data.CData.XML;
     
     <h1>Hello, world!</h1>
     
     Welcome to your Data app.
     
     <div class="row">
     <div class="col-12">
     
     @using (XMLConnection connection = new XMLConnection(
     "URI=C:/people.xml;DataModel=Relational;"))
     {
     var sql = "SELECT [people].[personal.age] AS age, [people].[personal.gender] AS gender, [people].[personal.name.first] AS first_name, [people].[personal.name.last] AS last_name, [vehicles].[model], FROM [people] JOIN [vehicles] ON [people].[_id] = [vehicles].[people_id]";
     var results = new DataTable();
     
     XMLDataAdapter dataAdapter = new XMLDataAdapter(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 XML data as an HTML table in the Blazor app. ๐Ÿ‘ Query XML from Blazor app.

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

Ready to get started?

Download a free trial of the XML Data Provider to get started:

 Download Now

Learn more:

๐Ÿ‘ XML Documents Icon
XML ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with XML data stores.