Skip to content

chore(csharp/src/Drivers/Apache): Cleanup HiveServer2-based code with shared Thrift request/response interfaces #2797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

chore(csharp/src/Drivers/Apache): Cleanup HiveServer2-based code with shared Thrift request/response interfaces #2797

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
538bc59
Partial changes
CurtHagenlocher May 6, 2025
7196588
Merge from main
CurtHagenlocher May 6, 2025
c2f0127
Simplify code by defining shared interfaces on Thrift request and res…
CurtHagenlocher May 6, 2025
100d704
Merge branch 'main' of https://github.com/CurtHagenlocher/arrow-adbc …
CurtHagenlocher May 8, 2025
a99d214
More cleanup plus PR feedback
CurtHagenlocher May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions csharp/src/Drivers/Apache/Attributes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#if !NET5_0_OR_GREATER

namespace System.Diagnostics.CodeAnalysis
{
sealed class MaybeNullWhenAttribute : Attribute
{
public MaybeNullWhenAttribute(bool returnValue) { }
}
}

#endif
109 changes: 35 additions & 74 deletions csharp/src/Drivers/Apache/Hive2/HiveServer2Connection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Reflection;
using System.Text;
Expand Down Expand Up @@ -377,10 +378,7 @@ public override IArrowArrayStream GetObjects(GetObjectsDepth depth, string? cata
if (depth == GetObjectsDepth.All || depth >= GetObjectsDepth.Catalogs)
{
TGetCatalogsReq getCatalogsReq = new TGetCatalogsReq(SessionHandle);
if (AreResultsAvailableDirectly)
{
SetDirectResults(getCatalogsReq);
}
TrySetGetDirectResults(getCatalogsReq);

TGetCatalogsResp getCatalogsResp = Client.GetCatalogs(getCatalogsReq, cancellationToken).Result;

Expand Down Expand Up @@ -416,10 +414,7 @@ public override IArrowArrayStream GetObjects(GetObjectsDepth depth, string? cata
TGetSchemasReq getSchemasReq = new TGetSchemasReq(SessionHandle);
getSchemasReq.CatalogName = catalogPattern;
getSchemasReq.SchemaName = dbSchemaPattern;
if (AreResultsAvailableDirectly)
{
SetDirectResults(getSchemasReq);
}
TrySetGetDirectResults(getSchemasReq);

TGetSchemasResp getSchemasResp = Client.GetSchemas(getSchemasReq, cancellationToken).Result;
if (getSchemasResp.Status.StatusCode == TStatusCode.ERROR_STATUS)
Expand Down Expand Up @@ -449,10 +444,7 @@ public override IArrowArrayStream GetObjects(GetObjectsDepth depth, string? cata
getTablesReq.CatalogName = catalogPattern;
getTablesReq.SchemaName = dbSchemaPattern;
getTablesReq.TableName = tableNamePattern;
if (AreResultsAvailableDirectly)
{
SetDirectResults(getTablesReq);
}
TrySetGetDirectResults(getTablesReq);

TGetTablesResp getTablesResp = Client.GetTables(getTablesReq, cancellationToken).Result;
if (getTablesResp.Status.StatusCode == TStatusCode.ERROR_STATUS)
Expand Down Expand Up @@ -486,10 +478,7 @@ public override IArrowArrayStream GetObjects(GetObjectsDepth depth, string? cata
columnsReq.CatalogName = catalogPattern;
columnsReq.SchemaName = dbSchemaPattern;
columnsReq.TableName = tableNamePattern;
if (AreResultsAvailableDirectly)
{
SetDirectResults(columnsReq);
}
TrySetGetDirectResults(columnsReq);

if (!string.IsNullOrEmpty(columnNamePattern))
columnsReq.ColumnName = columnNamePattern;
Expand Down Expand Up @@ -594,10 +583,7 @@ public override IArrowArrayStream GetTableTypes()
SessionHandle = SessionHandle ?? throw new InvalidOperationException("session not created"),
};

if (AreResultsAvailableDirectly)
{
SetDirectResults(req);
}
TrySetGetDirectResults(req);

CancellationToken cancellationToken = ApacheUtility.GetCancellationToken(QueryTimeoutSeconds, ApacheUtility.TimeUnit.Seconds);
try
Expand Down Expand Up @@ -774,33 +760,24 @@ internal IReadOnlyDictionary<string, int> GetColumnIndexMap(List<TColumnDesc> co

protected abstract int ColumnMapIndexOffset { get; }

protected abstract Task<TRowSet> GetRowSetAsync(TGetTableTypesResp response, CancellationToken cancellationToken = default);
protected abstract Task<TRowSet> GetRowSetAsync(TGetColumnsResp response, CancellationToken cancellationToken = default);
protected abstract Task<TRowSet> GetRowSetAsync(TGetTablesResp response, CancellationToken cancellationToken = default);
protected abstract Task<TRowSet> GetRowSetAsync(TGetCatalogsResp getCatalogsResp, CancellationToken cancellationToken = default);
protected abstract Task<TRowSet> GetRowSetAsync(TGetSchemasResp getSchemasResp, CancellationToken cancellationToken = default);
protected internal abstract Task<TRowSet> GetRowSetAsync(TGetPrimaryKeysResp response, CancellationToken cancellationToken = default);
protected abstract Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetSchemasResp response, CancellationToken cancellationToken = default);
protected abstract Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetCatalogsResp response, CancellationToken cancellationToken = default);
protected abstract Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetColumnsResp response, CancellationToken cancellationToken = default);
protected abstract Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetTablesResp response, CancellationToken cancellationToken = default);
protected internal abstract Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetPrimaryKeysResp response, CancellationToken cancellationToken = default);
protected abstract Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(IResponse response, CancellationToken cancellationToken = default);
protected abstract Task<TRowSet> GetRowSetAsync(IResponse response, CancellationToken cancellationToken = default);

protected internal virtual bool AreResultsAvailableDirectly => false;

protected virtual void SetDirectResults(TGetColumnsReq request) => throw new System.NotImplementedException();

protected virtual void SetDirectResults(TGetCatalogsReq request) => throw new System.NotImplementedException();

protected virtual void SetDirectResults(TGetSchemasReq request) => throw new System.NotImplementedException();

protected virtual void SetDirectResults(TGetTablesReq request) => throw new System.NotImplementedException();

protected virtual void SetDirectResults(TGetTableTypesReq request) => throw new System.NotImplementedException();

protected virtual void SetDirectResults(TGetPrimaryKeysReq request) => throw new System.NotImplementedException();

protected virtual void SetDirectResults(TGetCrossReferenceReq request) => throw new System.NotImplementedException();
protected internal virtual bool TrySetGetDirectResults(IRequest request) => false;
protected internal virtual bool TryGetDirectResults(TSparkDirectResults? directResults, [MaybeNullWhen(false)] out QueryResult result)
{
result = null;
return false;
}
protected internal virtual bool TryGetDirectResults(
TSparkDirectResults? directResults,
[MaybeNullWhen(false)] out TGetResultSetMetadataResp metadata,
[MaybeNullWhen(false)] out TRowSet rowSet)
{
metadata = null;
rowSet = null;
return false;
}

protected internal abstract int PositionRequiredOffset { get; }

Expand Down Expand Up @@ -923,10 +900,7 @@ internal async Task<TGetCatalogsResp> GetCatalogsAsync(CancellationToken cancell
}

TGetCatalogsReq req = new TGetCatalogsReq(SessionHandle);
if (AreResultsAvailableDirectly)
{
SetDirectResults(req);
}
TrySetGetDirectResults(req);

TGetCatalogsResp resp = await Client.GetCatalogs(req, cancellationToken);
if (resp.Status.StatusCode != TStatusCode.SUCCESS_STATUS)
Expand All @@ -950,10 +924,8 @@ internal async Task<TGetSchemasResp> GetSchemasAsync(
}

TGetSchemasReq req = new(SessionHandle);
if (AreResultsAvailableDirectly)
{
SetDirectResults(req);
}
TrySetGetDirectResults(req);

if (catalogName != null)
{
req.CatalogName = catalogName;
Expand Down Expand Up @@ -987,10 +959,8 @@ internal async Task<TGetTablesResp> GetTablesAsync(
}

TGetTablesReq req = new(SessionHandle);
if (AreResultsAvailableDirectly)
{
SetDirectResults(req);
}
TrySetGetDirectResults(req);

if (catalogName != null)
{
req.CatalogName = catalogName;
Expand Down Expand Up @@ -1032,10 +1002,8 @@ internal async Task<TGetColumnsResp> GetColumnsAsync(
}

TGetColumnsReq req = new(SessionHandle);
if (AreResultsAvailableDirectly)
{
SetDirectResults(req);
}
TrySetGetDirectResults(req);

if (catalogName != null)
{
req.CatalogName = catalogName;
Expand Down Expand Up @@ -1076,10 +1044,8 @@ internal async Task<TGetPrimaryKeysResp> GetPrimaryKeysAsync(
}

TGetPrimaryKeysReq req = new(SessionHandle);
if (AreResultsAvailableDirectly)
{
SetDirectResults(req);
}
TrySetGetDirectResults(req);

if (catalogName != null)
{
req.CatalogName = catalogName!;
Expand Down Expand Up @@ -1119,10 +1085,8 @@ internal async Task<TGetCrossReferenceResp> GetCrossReferenceAsync(
}

TGetCrossReferenceReq req = new(SessionHandle);
if (AreResultsAvailableDirectly)
{
SetDirectResults(req);
}
TrySetGetDirectResults(req);

if (catalogName != null)
{
req.ParentCatalogName = catalogName!;
Expand Down Expand Up @@ -1255,10 +1219,7 @@ public override Schema GetTableSchema(string? catalog, string? dbSchema, string?
getColumnsReq.CatalogName = catalog;
getColumnsReq.SchemaName = dbSchema;
getColumnsReq.TableName = tableName;
if (AreResultsAvailableDirectly)
{
SetDirectResults(getColumnsReq);
}
TrySetGetDirectResults(getColumnsReq);

CancellationToken cancellationToken = ApacheUtility.GetCancellationToken(QueryTimeoutSeconds, ApacheUtility.TimeUnit.Seconds);
try
Expand Down
22 changes: 2 additions & 20 deletions csharp/src/Drivers/Apache/Hive2/HiveServer2HttpConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,27 +293,9 @@ protected override ColumnsMetadataColumnNames GetColumnsMetadataColumnNames()
};
}

protected override Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetSchemasResp response, CancellationToken cancellationToken = default) =>
protected override Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(IResponse response, CancellationToken cancellationToken = default) =>
GetResultSetMetadataAsync(response.OperationHandle, Client, cancellationToken);
protected override Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetCatalogsResp response, CancellationToken cancellationToken = default) =>
GetResultSetMetadataAsync(response.OperationHandle, Client, cancellationToken);
protected override Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetColumnsResp response, CancellationToken cancellationToken = default) =>
GetResultSetMetadataAsync(response.OperationHandle, Client, cancellationToken);
protected override Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetTablesResp response, CancellationToken cancellationToken = default) =>
GetResultSetMetadataAsync(response.OperationHandle, Client, cancellationToken);
protected internal override Task<TGetResultSetMetadataResp> GetResultSetMetadataAsync(TGetPrimaryKeysResp response, CancellationToken cancellationToken = default) =>
GetResultSetMetadataAsync(response.OperationHandle, Client, cancellationToken);
protected override Task<TRowSet> GetRowSetAsync(TGetTableTypesResp response, CancellationToken cancellationToken = default) =>
FetchResultsAsync(response.OperationHandle, cancellationToken: cancellationToken);
protected override Task<TRowSet> GetRowSetAsync(TGetColumnsResp response, CancellationToken cancellationToken = default) =>
FetchResultsAsync(response.OperationHandle, cancellationToken: cancellationToken);
protected override Task<TRowSet> GetRowSetAsync(TGetTablesResp response, CancellationToken cancellationToken = default) =>
FetchResultsAsync(response.OperationHandle, cancellationToken: cancellationToken);
protected override Task<TRowSet> GetRowSetAsync(TGetCatalogsResp response, CancellationToken cancellationToken = default) =>
FetchResultsAsync(response.OperationHandle, cancellationToken: cancellationToken);
protected override Task<TRowSet> GetRowSetAsync(TGetSchemasResp response, CancellationToken cancellationToken = default) =>
FetchResultsAsync(response.OperationHandle, cancellationToken: cancellationToken);
protected internal override Task<TRowSet> GetRowSetAsync(TGetPrimaryKeysResp response, CancellationToken cancellationToken = default) =>
protected override Task<TRowSet> GetRowSetAsync(IResponse response, CancellationToken cancellationToken = default) =>
FetchResultsAsync(response.OperationHandle, cancellationToken: cancellationToken);

protected internal override int PositionRequiredOffset => 0;
Expand Down
30 changes: 5 additions & 25 deletions csharp/src/Drivers/Apache/Hive2/HiveServer2Statement.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,33 +438,21 @@ private async Task<QueryResult> GetColumnsAsync(CancellationToken cancellationTo
cancellationToken);
OperationHandle = resp.OperationHandle;

// Common variables declared upfront
TGetResultSetMetadataResp metadata;
Schema schema;
TRowSet rowSet;

// For GetColumns, we need to enhance the result with BASE_TYPE_NAME
if (Connection.AreResultsAvailableDirectly && resp.DirectResults?.ResultSet?.Results != null)
{
// Get data from direct results
metadata = resp.DirectResults.ResultSetMetadata;
schema = Connection.SchemaParser.GetArrowSchema(metadata.Schema, Connection.DataTypeConversion);
rowSet = resp.DirectResults.ResultSet.Results;
}
else
if (!Connection.TryGetDirectResults(resp.DirectResults, out TGetResultSetMetadataResp? metadata, out TRowSet? rowSet))
{
// Poll and fetch results
await HiveServer2Connection.PollForResponseAsync(OperationHandle!, Connection.Client, PollTimeMilliseconds, cancellationToken);

// Get metadata
metadata = await HiveServer2Connection.GetResultSetMetadataAsync(OperationHandle!, Connection.Client, cancellationToken);
schema = Connection.SchemaParser.GetArrowSchema(metadata.Schema, Connection.DataTypeConversion);

// Fetch the results
rowSet = await Connection.FetchResultsAsync(OperationHandle!, BatchSize, cancellationToken);
}

// Common processing for both paths
Schema schema = Connection.SchemaParser.GetArrowSchema(metadata!.Schema, Connection.DataTypeConversion);
int columnCount = HiveServer2Reader.GetColumnCount(rowSet);
int rowCount = HiveServer2Reader.GetRowCount(rowSet, columnCount);
IReadOnlyList<IArrowArray> data = HiveServer2Reader.GetArrowArrayData(rowSet, columnCount, schema, Connection.DataTypeConversion);
Expand All @@ -481,21 +469,13 @@ private async Task<Schema> GetResultSetSchemaAsync(TOperationHandle operationHan

private async Task<QueryResult> GetQueryResult(TSparkDirectResults? directResults, CancellationToken cancellationToken)
{
Schema schema;
if (Connection.AreResultsAvailableDirectly && directResults?.ResultSet?.Results != null)
if (Connection.TryGetDirectResults(directResults, out QueryResult? result))
{
TGetResultSetMetadataResp resultSetMetadata = directResults.ResultSetMetadata;
schema = Connection.SchemaParser.GetArrowSchema(resultSetMetadata.Schema, Connection.DataTypeConversion);
TRowSet rowSet = directResults.ResultSet.Results;
int columnCount = HiveServer2Reader.GetColumnCount(rowSet);
int rowCount = HiveServer2Reader.GetRowCount(rowSet, columnCount);
IReadOnlyList<IArrowArray> data = HiveServer2Reader.GetArrowArrayData(rowSet, columnCount, schema, Connection.DataTypeConversion);

return new QueryResult(rowCount, new HiveServer2Connection.HiveInfoArrowStream(schema, data));
return result!;
}

await HiveServer2Connection.PollForResponseAsync(OperationHandle!, Connection.Client, PollTimeMilliseconds, cancellationToken);
schema = await GetResultSetSchemaAsync(OperationHandle!, Connection.Client, cancellationToken);
Schema schema = await GetResultSetSchemaAsync(OperationHandle!, Connection.Client, cancellationToken);

return new QueryResult(-1, Connection.NewReader(this, schema));
}
Expand Down
Loading
Loading