TriQL.Client.Compression
1.0.0-preview.1
Prefix Reserved
See the version list below for details.
dotnet add package TriQL.Client.Compression --version 1.0.0-preview.1
NuGet\Install-Package TriQL.Client.Compression -Version 1.0.0-preview.1
<PackageReference Include="TriQL.Client.Compression" Version="1.0.0-preview.1" />
<PackageVersion Include="TriQL.Client.Compression" Version="1.0.0-preview.1" />
<PackageReference Include="TriQL.Client.Compression" />
paket add TriQL.Client.Compression --version 1.0.0-preview.1
#r "nuget: TriQL.Client.Compression, 1.0.0-preview.1"
#:package TriQL.Client.Compression@1.0.0-preview.1
#addin nuget:?package=TriQL.Client.Compression&version=1.0.0-preview.1&prerelease
#tool nuget:?package=TriQL.Client.Compression&version=1.0.0-preview.1&prerelease
TriQL — .NET Client for Trino
TriQL is a from-scratch .NET client library for Trino. It provides two complementary programming surfaces over the same core engine:
- TriQL SDK (
TriQL.Client) — a low-level, async-first client that maps directly onto the Trino client protocol (sessions, statements, pages, rows). Intended for high-throughput data movement, custom tooling, and callers who want explicit control over paging and buffering. - TriQL ADO.NET Provider (
TriQL.Data.ADO) — a completeSystem.Data.Commonprovider (DbConnection,DbCommand,DbDataReader,DbParameter,DbProviderFactory) so that Trino can be used from existing ADO.NET-based applications, ORMs, reporting tools, and BI connectors.
Additional packages:
TriQL.Client.Auth— cloud/enterprise authentication providers (Microsoft Entra ID, OAuth 2.0 client credentials) kept isolated so their dependencies never leak into the core client.TriQL.Client.Compression— support for compressed spooled protocol payloads.
See docs/requirements.md for the full requirements specification and docs/implementation-plan.md for the phased delivery plan.
Status
⚠️ Pre-release. TriQL has not yet shipped a stable 1.0.0. Published 1.0.0-preview.*
packages are functional but their APIs and package layout may still change before 1.0.0. From
1.0.0 onward TriQL follows Semantic Versioning: breaking public-API changes
only in a major version, additive API in minors, fixes in patches. The public API surface of each
shipping package is locked by PublicAPI.Shipped.txt baselines and enforced at build time.
Requirements
- .NET 8.0 or .NET 10.0.
netstandard2.0and .NET Framework are not supported. - Trino server 466 or later (27 Nov 2024, the release that introduced the spooling protocol).
This is the minimum version the conformance suite verifies against; the CI matrix covers
{466, latest}.
Install
dotnet add package TriQL.Client # streaming SDK
dotnet add package TriQL.Data.ADO # ADO.NET provider
dotnet add package TriQL.Client.Auth # optional: Entra ID / OAuth2 authentication
While TriQL is in preview, add --prerelease to each command.
Quick start: TriQL SDK (streaming)
using TriQL.Client;
var options = new TrinoSessionOptions
{
Server = new Uri("https://trino.example.com:443/"),
Catalog = "tpch",
Schema = "tiny",
};
await using var client = new TrinoClient(options);
await using var resultSet = await client.ExecuteAsync("SELECT nationkey, name FROM tpch.tiny.nation ORDER BY nationkey");
await foreach (var row in resultSet.ReadRowsAsync())
{
Console.WriteLine($"{row.GetInt64(0)}: {row.GetString(1)}");
}
Quick start: ADO.NET provider
using System.Data.Common;
using TriQL.Data.ADO;
var connectionString = new TrinoConnectionStringBuilder
{
Server = "https://trino.example.com:443/",
Catalog = "tpch",
Schema = "tiny",
}.ConnectionString;
await using DbConnection connection = new TrinoConnection(connectionString);
await connection.OpenAsync();
await using var command = connection.CreateCommand();
command.CommandText = "SELECT nationkey, name FROM tpch.tiny.nation ORDER BY nationkey";
await using var reader = await command.ExecuteReaderAsync();
while (await reader.ReadAsync())
{
Console.WriteLine($"{reader.GetInt64(0)}: {reader.GetString(1)}");
}
More runnable examples — including Microsoft Entra ID authentication and IAsyncEnumerable
consumption — live in
samples/TriQL.Samples.Console.
Spooling protocol (experimental)
Trino's spooling protocol (compressed, object-storage-backed result segments) is implemented but
ships off by default and opt-in in 1.0: TrinoSessionOptions.QueryDataEncodings defaults to
an empty list, which forces the direct protocol. Enable it explicitly once your cluster is
configured for spooling:
options.QueryDataEncodings = ["json+zstd", "json+lz4", "json"];
Spooling is opt-in in 1.0 because it is verified against a scripted test double rather than a real spooling-configured cluster; see docs/implementation-plan.md for the plan to validate it against real object storage and promote it to the default in 1.1.0.
Documentation
- Connection-string reference
- Type-mapping reference
- Troubleshooting guide
- Benchmarks
- API reference (generated from XML doc comments)
- Publishing guide (maintainers: release and NuGet process)
License
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
- TriQL.Client (>= 1.0.0-preview.1)
-
net8.0
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
- TriQL.Client (>= 1.0.0-preview.1)
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 |
|---|---|---|
| 1.1.0 | 125 | 10/21/2026 |
| 1.0.0 | 114 | 10/5/2026 |
| 1.0.0-preview.1 | 87 | 9/12/2026 |