search

awslabs / amazon-qldb-driver-dotnet

Apache License 2.0
9 stars 16 forks source link

readme

Amazon QLDB .NET Driver

This is the .NET driver for Amazon Quantum Ledger Database (QLDB), which allows .NET developers to write software that makes use of AmazonQLDB.

nuget license AWS Provider codecov

Requirements

Basic Configuration

See Accessing Amazon QLDB for information on connecting to AWS.

.NET Standard 2.0

The driver targets .NET Standard 2.0.

Getting Started

Please see the Quickstart guide for the Amazon QLDB Driver for .Net.

See Also

  1. Using the Amazon QLDB Driver for .NET — The best way to get familiar with the Amazon QLDB Driver for .NET is to read Getting Started with the Amazon QLDB Driver in the Amazon QLDB Developer Guide.
  2. QLDB .NET Driver accepts and returns Amazon ION Documents. Amazon Ion is a richly-typed, self-describing, hierarchical data serialization format offering interchangeable binary and text representations. For more information read the ION docs.
    1. In version >=1.3.0, support is added for accepting and returning native C# types. See here for a quick guide on how to use this new feature.
  3. Amazon ION Cookbook: This cookbook provides code samples for some simple Amazon Ion use cases.
  4. Amazon QLDB supports the PartiQL query language. PartiQL provides SQL-compatible query access across multiple data stores containing structured data, semistructured data, and nested data. For more information read the PartiQL docs.
  5. Refer the section Common Errors while using the Amazon QLDB Drivers which describes runtime errors that can be thrown by the Amazon QLDB Driver when calling the qldb-session APIs.

Development

Setup

Assuming that Visual Studio is being used, open the solution file (Amazon.QLDB.Driver.sln).

Right click the solution in the Solution Explorer and press "Restore NuGet Packages" if it does not do so automatically.

Running Tests

You can run the unit tests by right clicking the Amazon.QLDB.Driver.Tests project, that is a part of the solution file, and pressing "Run Tests".

Alternatively you can run the unit tests on the command line with the following:

dotnet test Amazon.QLDB.Driver.Tests

To run the integration tests, you must run it on the command line with the following:

dotnet test Amazon.QLDB.Driver.IntegrationTests --settings Amazon.QLDB.Driver.IntegrationTests/.runsettings

Documentation

DocFx is used for documentation. Download Docfx as docfx.zip, unzip and extract it to a local folder, and add it to PATH.

You can generate the docstring HTML locally by running the following in the root directory of this repository:

docfx docs/docfx.json --serve

License

This library is licensed under the Apache 2.0 License.