ServantSoftware.Data.Xml 1.0.0.216

XML ADO.NET Data Provider

The XML ADO.NET Data Provider offers a set of classes that facilitate data access to XML files using the ADO.NET framework. It provides CRUD (Create, Read, Update, Delete) operations to interact with XML files as if they were a database.

Features

• ADO.NET compliant provider for XML files.
• Support for CRUD operations.
• Implementation of ADO.NET interfaces for consistency with other data providers.
• Customizable and extendable to meet specific needs.
• Comprehensive XML comments to assist with usage.
• Support for strongly typed XML data via XmlReader and XmlWriter. Learn more about strongly typed data and Converting to CLR types. If an XML file doesn't have an accompanying XSD, all columns will default to type System.String.

Getting Started

Prerequisites

• .NET 7.0 or later.
• An IDE that supports .NET development, such as Visual Studio.

Installation

You can install the XML ADO.NET Data Provider from the NuGet package manager or by using the following command in your terminal:

dotnet add package ServantSoftware.Data.Xml

Usage

To use the XML ADO.NET Data Provider, you will need to create an XmlConnection instance, then create an XmlCommand instance, and execute it. Here's an example:

using System.Data.XmlClient;

var connectionString = new FileConnectionString() { DataSource = "path/to/your/file.xml" };
using var connection = new XmlConnection(connectionString);
connection.Open();

var commandText = "SELECT * FROM your_element";
using var command = new XmlCommand(commandText, connection);
using var reader = command.ExecuteReader();

while (reader.Read())
{
    // Process data
}

connection.Close();

Connection String

The connection string is mainly used to determine the data source for the provider, which is the path to the XML file.

For example, if your XML structure is:

<database>
    <employees>
        <employee>
            <name>Joe</name>
            <email>Joe@gmail.com</email>
            <salary>56000</salary>
            <married>true</married>
        </employee>
        <employee>
            <name>Bob</name>
            <email>bob32@gmail.com</email>
            <salary>95000</salary>
        </employee>
    </employees>
    <locations>
        <location>
            <city>Houston</city>
            <state>Texas</state>
            <zip>77846</zip>
        </location>
        <location>
            <city>New Braunfels</city>
            <state>Texas</state>
            <zip>78132</zip>
        </location>
    </locations>
</database>

You can query specific elements and attributes, and the hierarchy of XML is treated similarly to tables in relational databases.

XML data has the ability to be strongly typed. XmlReader/XmlWriter supports strongly typed data. (Also see Converting to CLR types). If the XML file does not have an accompanying XSD file, then all columns should just be of type System.String.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• Thanks to the .NET Foundation for the ADO.NET framework.
• Thanks to everyone who has contributed to this project.