35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- DataPRO/DTS.Core.DbAPIWrapper/ApiInfo.cs
|
||
|
|
- DataPRO/DTS.Core.DbAPIWrapper/DbApiWrapper.cs
|
||
|
|
generated_at: "2026-04-17T16:38:08.882749+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "cb91814bb67d2020"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Core.DbAPIWrapper
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module provides a wrapper layer around the `DbAPI.DbAPI` database access library, abstracting connection management, user authentication, and data retrieval operations for test setups and DAS (Data Acquisition System) records. It serves as the primary interface for client code to interact with the underlying database, encapsulating connection details and user session state within a single cohesive class.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### Class: `ApiInfo`
|
||
|
|
A data container class holding authenticated session state.
|
||
|
|
|
||
|
|
| Property | Type | Description |
|
||
|
|
|----------|------|-------------|
|
||
|
|
| `UserDbRecord` | `IUserDbRecord?` | Nullable user database record representing the authenticated user. |
|
||
|
|
| `ConnectionDetails` | `IConnectionDetails?` | Nullable connection details for the active session. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### Class: `DbApiWrapper`
|
||
|
|
|
||
|
|
#### Constructor
|
||
|
|
```csharp
|
||
|
|
public DbApiWrapper(string dbServer, string
|