Becom.IBMi.SqlApiClient 0.2.6

Becom.IBMi.SqlApiClient

A .NET client library for communicating with the BECOM IBMi SQL API — a REST service that executes SQL statements on an IBM i (AS/400) system and returns structured JSON results.

Requirements

• .NET 10 or later
• A running BECOM IBMi SQL API endpoint

Installation

Install via NuGet:

dotnet add package Becom.IBMi.SqlApiClient

Configuration

The client is configured through an EndpointConfiguration object:

appsettings.json

{
  "SqlApiEndpoint": {
    "Api": "https://your-ibmi-host/sqlapi/",
    "Uname": "APIUSER",
    "Password": "secret",
    "Timeout": 30
  }
}

Registration

Single instance — from appsettings.json

builder.Services.AddSqlApiClient(builder.Configuration);

Single instance — from code

builder.Services.AddSqlApiClient(new EndpointConfiguration
{
    Api = "https://your-ibmi-host/sqlapi/",
    Uname = "APIUSER",
    Password = "secret"
});

Multiple named instances (keyed services)

Register multiple endpoints under different keys and resolve them by name at runtime:

builder.Services.AddSqlApiClient(new EndpointConfiguration
{
    Api = "https://dev-ibmi/sqlapi/",
    Uname = "devuser",
    Password = "devpass"
}, "dev");

builder.Services.AddSqlApiClient(new EndpointConfiguration
{
    Api = "https://prod-ibmi/sqlapi/",
    Uname = "produser",
    Password = "prodpass"
}, "prod");

Resolve by key:

// Constructor injection
public MyService([FromKeyedServices("prod")] IIBMiSQLApi sqlApi) { ... }

// Manual resolution
var prodApi = serviceProvider.GetRequiredKeyedService<IIBMiSQLApi>("prod");

Note: When only one instance is registered, it is also available without a key via IIBMiSQLApi. When multiple instances are registered, keyless resolution returns the first registered instance.

Usage

Inject the service

public class MyService(IIBMiSQLApi sqlApi)
{
    public async Task<List<Customer>> GetCustomersAsync()
    {
        return await sqlApi.CallSqlServiceAsync<Customer>(
            "SELECT CUSTNR, NAME FROM CUSTLIB.CUSTTBL WHERE ACTIVE = 1"
        );
    }
}

Map results to a class

Define a plain class that matches the column names returned by the query:

public class Customer
{
    public int CUSTNR { get; set; }
    public string NAME { get; set; } = string.Empty;
}

Raw JSON

string json = await sqlApi.ExecuteSQLStatementAsync("SELECT * FROM MYLIB.MYTABLE");

Health check

bool isAlive = await sqlApi.TestEnpoint();

API Reference

IIBMiSQLApi

AddSqlApiClient overloads

License

Copyright © BECOM Electronics GmbH. All rights reserved.