ArdenHide.Utils.QueryExecutor 1.0.0

Suggested Alternatives

ArdenHide.Utils.QueryExecutor 1.0.1

Additional Details

The NOT user-friendly `GetConnectionString()` method has been removed, and replaced with a private `connectionString` field that is initialized in the constructor.

There is a newer version of this package available.
See the version list below for details.
dotnet add package ArdenHide.Utils.QueryExecutor --version 1.0.0                
NuGet\Install-Package ArdenHide.Utils.QueryExecutor -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ArdenHide.Utils.QueryExecutor" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ArdenHide.Utils.QueryExecutor --version 1.0.0                
#r "nuget: ArdenHide.Utils.QueryExecutor, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ArdenHide.Utils.QueryExecutor as a Cake Addin
#addin nuget:?package=ArdenHide.Utils.QueryExecutor&version=1.0.0

// Install ArdenHide.Utils.QueryExecutor as a Cake Tool
#tool nuget:?package=ArdenHide.Utils.QueryExecutor&version=1.0.0                

QueryExecutor

Overview

The QueryExecutor library is a lightweight and easy-to-use library for executing SQL commands and retrieving JSON results. It also supports AWS X-Ray tracing for monitoring and analyzing your database calls.

Installation

To install the QueryExecutor library, add the NuGet package to your project.

Usage

To use the QueryExecutor library, follow these steps:

  1. Create a custom class that extends the Executor class:
namespace YourNamespace
{
    public class YourQueryExecutor : Executor
    {
        public YourQueryExecutor(string cmdText) : base(cmdText) { }

        public override bool EnableAWSXRay { get; set; } = false;

        public override string GetConnectionString() =>
            "Server=localhost;Database=mydatabase;User Id=myusername;Password=mypassword;";
    }
}

Replace YourNamespace, YourQueryExecutor, and the connection string with your desired values.

  1. Create an instance of your custom Executor class and execute the command:
var query = "SELECT * FROM TableName FOR JSON AUTO"; // request that returns json
var executor = new YourQueryExecutor(query);
var jsonResponse = executor.Execute();

Configuration

You can customize the behavior of the QueryExecutor library by changing the properties of your custom Executor class:

  • EnableAWSXRay: Set this property to true to enable AWS X-Ray tracing. By default, it is set to false.
var queryExecutor = new YourQueryExecutor(cmdText)
{
    EnableAWSXRay = true
};
  • GetConnectionString(): Override this method to provide the connection string for your database. This method must return a valid connection string.
public override string GetConnectionString() =>
    "Server=localhost;Database=mydatabase;User Id=myusername;Password=mypassword;";
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 421 10/20/2023
1.0.1 1,017 4/21/2023
1.0.0 207 4/20/2023 1.0.0 is deprecated because it is no longer maintained.