feat(csharp/src/Drivers): introduce drivers for Apache systems built on Thrift #1710
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,6 +65,7 @@ python/doc/ | |
| # Egg metadata | ||
| *.egg-info | ||
|
|
||
| .vs/ | ||
| .vscode | ||
| .idea/ | ||
| .pytest_cache/ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFrameworks>net472;net6.0</TargetFrameworks> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="ApacheThrift" Version="0.19.0" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\Apache.Arrow.Adbc\Apache.Arrow.Adbc.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Apache.Arrow.Ipc; | ||
| using Apache.Hive.Service.Rpc.Thrift; | ||
| using Thrift.Protocol; | ||
| using Thrift.Transport; | ||
|
|
||
| namespace Apache.Arrow.Adbc.Drivers.Apache.Hive2 | ||
| { | ||
| public abstract class HiveServer2Connection : AdbcConnection | ||
| { | ||
| const string userAgent = "AdbcExperimental/0.0"; | ||
|
|
||
| protected TOperationHandle operationHandle; | ||
| protected IReadOnlyDictionary<string, string> properties; | ||
| internal TTransport transport; | ||
| internal TCLIService.Client client; | ||
| internal TSessionHandle sessionHandle; | ||
|
|
||
| internal HiveServer2Connection() : this(null) | ||
| { | ||
|
|
||
| } | ||
|
|
||
| internal HiveServer2Connection(IReadOnlyDictionary<string, string> properties) | ||
| { | ||
| this.properties = properties; | ||
| } | ||
|
|
||
| public void Open() | ||
| { | ||
| TProtocol protocol = CreateProtocol(); | ||
| this.transport = protocol.Transport; | ||
| this.client = new TCLIService.Client(protocol); | ||
|
|
||
| var s0 = this.client.OpenSession(CreateSessionRequest()).Result; | ||
| this.sessionHandle = s0.SessionHandle; | ||
| } | ||
|
|
||
| protected abstract TProtocol CreateProtocol(); | ||
| protected abstract TOpenSessionReq CreateSessionRequest(); | ||
|
|
||
| public override IArrowArrayStream GetObjects(GetObjectsDepth depth, string catalogPattern, string dbSchemaPattern, string tableNamePattern, List<string> tableTypes, string columnNamePattern) | ||
| { | ||
| Dictionary<string, Dictionary<string, Dictionary<string, List<string>>>> catalogMap = new Dictionary<string, Dictionary<string, Dictionary<string, List<string>>>>(); | ||
| if (depth == GetObjectsDepth.All || depth >= GetObjectsDepth.Catalogs) | ||
| { | ||
| TGetCatalogsReq getCatalogsReq = new TGetCatalogsReq(this.sessionHandle); | ||
| } | ||
|
|
||
| if (depth == GetObjectsDepth.All || depth >= GetObjectsDepth.DbSchemas) | ||
| { | ||
| TGetSchemasReq getSchemasReq = new TGetSchemasReq(this.sessionHandle); | ||
| } | ||
|
|
||
| if (depth == GetObjectsDepth.All || depth >= GetObjectsDepth.Tables) | ||
| { | ||
| TGetTablesReq getTablesReq = new TGetTablesReq(this.sessionHandle); | ||
| } | ||
|
|
||
| if (depth == GetObjectsDepth.All) | ||
| { | ||
| TGetColumnsReq columnsReq = new TGetColumnsReq(this.sessionHandle); | ||
| columnsReq.CatalogName = catalogPattern; | ||
| columnsReq.SchemaName = dbSchemaPattern; | ||
| columnsReq.TableName = tableNamePattern; | ||
|
|
||
| if (!string.IsNullOrEmpty(columnNamePattern)) | ||
| columnsReq.ColumnName = columnNamePattern; | ||
|
|
||
| var columnsResponse = this.client.GetColumns(columnsReq).Result; | ||
| if (columnsResponse.Status.StatusCode == TStatusCode.ERROR_STATUS) | ||
| { | ||
| throw new Exception(columnsResponse.Status.ErrorMessage); | ||
| } | ||
|
|
||
| this.operationHandle = columnsResponse.OperationHandle; | ||
| } | ||
|
|
||
| PollForResponse(); | ||
|
|
||
| Schema schema = GetSchema(); | ||
|
|
||
| return new GetObjectsReader(this,schema); | ||
| } | ||
|
|
||
| public override IArrowArrayStream GetInfo(List<int> codes) | ||
| { | ||
| throw new NotImplementedException(); | ||
| } | ||
|
|
||
| public override IArrowArrayStream GetTableTypes() | ||
| { | ||
| throw new NotImplementedException(); | ||
| } | ||
|
|
||
| protected void PollForResponse() | ||
| { | ||
| TGetOperationStatusResp statusResponse = null; | ||
| do | ||
| { | ||
| if (statusResponse != null) { Thread.Sleep(500); } | ||
|
There was a problem hiding this comment. This is a good reminder for me that we really need a more async-friendly API, ideally a cross-process one. There was a problem hiding this comment. Do you mean at the ADBC API definition level? CC @zeroshade who has been thinking about this. It's something I would like to tackle, but there are questions about compatibility and what happens to the sync API afterwards and if we also want to try to 'fix' other things at the same time. There was a problem hiding this comment. I put some thoughts into #811 which is the only existing issue we have that sort of tracks async. There was a problem hiding this comment. @CurtHagenlocher - I have some private WIP to use |
||
| TGetOperationStatusReq request = new TGetOperationStatusReq(this.operationHandle); | ||
| statusResponse = this.client.GetOperationStatus(request).Result; | ||
| } while (statusResponse.OperationState == TOperationState.PENDING_STATE || statusResponse.OperationState == TOperationState.RUNNING_STATE); | ||
| } | ||
|
|
||
|
|
||
| public override void Dispose() | ||
| { | ||
| if (this.client != null) | ||
| { | ||
| TCloseSessionReq r6 = new TCloseSessionReq(this.sessionHandle); | ||
| this.client.CloseSession(r6).Wait(); | ||
|
|
||
| this.transport.Close(); | ||
| this.client.Dispose(); | ||
| this.transport = null; | ||
| this.client = null; | ||
| } | ||
| } | ||
|
|
||
| protected Schema GetSchema() | ||
| { | ||
| TGetResultSetMetadataReq request = new TGetResultSetMetadataReq(this.operationHandle); | ||
| TGetResultSetMetadataResp response = this.client.GetResultSetMetadata(request).Result; | ||
| return SchemaParser.GetArrowSchema(response.Schema); | ||
| } | ||
|
|
||
| sealed class GetObjectsReader : IArrowArrayStream | ||
| { | ||
| HiveServer2Connection connection; | ||
| Schema schema; | ||
| List<TSparkArrowBatch> batches; | ||
| int index; | ||
| IArrowReader reader; | ||
|
|
||
| public GetObjectsReader(HiveServer2Connection connection, Schema schema) | ||
| { | ||
| this.connection = connection; | ||
| this.schema = schema; | ||
| } | ||
|
|
||
| public Schema Schema { get { return schema; } } | ||
|
|
||
| public async ValueTask<RecordBatch> ReadNextRecordBatchAsync(CancellationToken cancellationToken = default) | ||
| { | ||
| while (true) | ||
| { | ||
| if (this.reader != null) | ||
| { | ||
| RecordBatch next = await this.reader.ReadNextRecordBatchAsync(cancellationToken); | ||
| if (next != null) | ||
| { | ||
| return next; | ||
| } | ||
| this.reader = null; | ||
| } | ||
|
|
||
| if (this.batches != null && this.index < this.batches.Count) | ||
| { | ||
| this.reader = new ArrowStreamReader(new ChunkStream(this.schema, this.batches[this.index++].Batch)); | ||
| continue; | ||
| } | ||
|
|
||
| this.batches = null; | ||
| this.index = 0; | ||
|
|
||
| if (this.connection == null) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| TFetchResultsReq request = new TFetchResultsReq(this.connection.operationHandle, TFetchOrientation.FETCH_NEXT, 50000); | ||
| TFetchResultsResp response = await this.connection.client.FetchResults(request, cancellationToken); | ||
| this.batches = response.Results.ArrowBatches; | ||
|
|
||
| if (!response.HasMoreRows) | ||
| { | ||
| this.connection = null; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void Dispose() | ||
| { | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| using System; | ||
|
|
||
| namespace Apache.Arrow.Adbc.Drivers.Apache.Hive2 | ||
| { | ||
| public class HiveServer2Exception : AdbcException | ||
| { | ||
| private string _sqlState; | ||
| private int _nativeError; | ||
|
|
||
| public HiveServer2Exception() | ||
| { | ||
| } | ||
|
|
||
| public HiveServer2Exception(string message) : base(message) | ||
| { | ||
| } | ||
|
|
||
| public HiveServer2Exception(string message, AdbcStatusCode statusCode) : base(message, statusCode) | ||
| { | ||
| } | ||
|
|
||
| public HiveServer2Exception(string message, Exception innerException) : base(message, innerException) | ||
| { | ||
| } | ||
|
|
||
| public HiveServer2Exception(string message, AdbcStatusCode statusCode, Exception innerException) : base(message, statusCode, innerException) | ||
| { | ||
| } | ||
|
|
||
| public override string SqlState | ||
| { | ||
| get { return _sqlState; } | ||
| } | ||
|
|
||
| public override int NativeError | ||
| { | ||
| get { return _nativeError; } | ||
| } | ||
|
|
||
| internal HiveServer2Exception SetSqlState(string sqlState) | ||
| { | ||
| _sqlState = sqlState; | ||
| return this; | ||
| } | ||
|
|
||
| internal HiveServer2Exception SetNativeError(int nativeError) | ||
| { | ||
| _nativeError = nativeError; | ||
| return this; | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This appears to be quite incomplete. Consider removing it from this PR and submitting separately once it's complete and tested.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can't remove it. HiveServer2 is the base class that Spark and Impala build on, but I will add details to the readme.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean the body, or at least the parts of the body that aren't implemented. It could always throw a NotImplementedException for when e.g. depth != GetObjectsDepth.All.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, removed the implementation here. It was not working and not useful as base functionality.