-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Flight SQL implementation for C# that is compatible with the C++ and Java implementations. Closes issue #36078 * Closes: #36078 Lead-authored-by: Jeremy Osterhoudt <jeremy.osterhoudt@ge.com> Co-authored-by: Weston Pace <weston.pace@gmail.com> Signed-off-by: Weston Pace <weston.pace@gmail.com>
- Loading branch information
1 parent
78b0c10
commit be5ab86
Showing
27 changed files
with
1,508 additions
and
32 deletions.
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
18 changes: 18 additions & 0 deletions
18
csharp/src/Apache.Arrow.Flight.Sql/Apache.Arrow.Flight.Sql.csproj
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,18 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFramework>netstandard2.1</TargetFramework> | ||
| <Nullable>enable</Nullable> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Grpc.Tools" Version="2.42.0" PrivateAssets="All" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\Apache.Arrow.Flight\Apache.Arrow.Flight.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Protobuf Include="..\..\..\format\FlightSql.proto" Access="public" /> | ||
| </ItemGroup> | ||
| </Project> |
Large diffs are not rendered by default.
Oops, something went wrong.
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,158 @@ | ||
| // 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.Buffers; | ||
| using System.Collections.Generic; | ||
| using Arrow.Flight.Protocol.Sql; | ||
| using Google.Protobuf; | ||
| using Google.Protobuf.WellKnownTypes; | ||
|
|
||
| namespace Apache.Arrow.Flight.Sql | ||
| { | ||
| /// <summary> | ||
| /// Helper methods for doing common Flight Sql tasks and conversions | ||
| /// </summary> | ||
| public class FlightSqlUtils | ||
| { | ||
| public static readonly FlightActionType FlightSqlCreatePreparedStatement = new("CreatePreparedStatement", | ||
| "Creates a reusable prepared statement resource on the server. \n" + | ||
| "Request Message: ActionCreatePreparedStatementRequest\n" + | ||
| "Response Message: ActionCreatePreparedStatementResult"); | ||
|
|
||
| public static readonly FlightActionType FlightSqlClosePreparedStatement = new("ClosePreparedStatement", | ||
| "Closes a reusable prepared statement resource on the server. \n" + | ||
| "Request Message: ActionClosePreparedStatementRequest\n" + | ||
| "Response Message: N/A"); | ||
|
|
||
| /// <summary> | ||
| /// List of possible actions | ||
| /// </summary> | ||
| public static readonly List<FlightActionType> FlightSqlActions = new() | ||
| { | ||
| FlightSqlCreatePreparedStatement, | ||
| FlightSqlClosePreparedStatement | ||
| }; | ||
|
|
||
| /// <summary> | ||
| /// Helper to parse {@link com.google.protobuf.Any} objects to the specific protobuf object. | ||
| /// </summary> | ||
| /// <param name="source">the raw bytes source value.</param> | ||
| /// <returns>the materialized protobuf object.</returns> | ||
| public static Any Parse(ByteString source) | ||
| { | ||
| return Any.Parser.ParseFrom(source); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Helper to unpack {@link com.google.protobuf.Any} objects to the specific protobuf object. | ||
| /// </summary> | ||
| /// <param name="source">the parsed Source value.</param> | ||
| /// <typeparam name="T">IMessage</typeparam> | ||
| /// <returns>the materialized protobuf object.</returns> | ||
| public static T Unpack<T>(Any source) where T : IMessage, new() | ||
| { | ||
| return source.Unpack<T>(); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Helper to parse and unpack {@link com.google.protobuf.Any} objects to the specific protobuf object. | ||
| /// </summary> | ||
| /// <param name="source">the raw bytes source value.</param> | ||
| /// <typeparam name="T">IMessage</typeparam> | ||
| /// <returns>the materialized protobuf object.</returns> | ||
| public static T ParseAndUnpack<T>(ByteString source) where T : IMessage, new() | ||
| { | ||
| return Unpack<T>(Parse(source)); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// A set of helper functions for converting encoded commands to IMessage types | ||
| /// </summary> | ||
| public static class FlightSqlExtensions | ||
| { | ||
| private static Any ParsedCommand(this FlightDescriptor descriptor) | ||
| { | ||
| return FlightSqlUtils.Parse(descriptor.Command); | ||
| } | ||
|
|
||
| private static IMessage UnpackMessage(this Any command) | ||
| { | ||
| if (command.Is(CommandStatementQuery.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandStatementQuery>(command); | ||
| if (command.Is(CommandPreparedStatementQuery.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandPreparedStatementQuery>(command); | ||
| if (command.Is(CommandGetCatalogs.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetCatalogs>(command); | ||
| if (command.Is(CommandGetDbSchemas.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetDbSchemas>(command); | ||
| if (command.Is(CommandGetTables.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetTables>(command); | ||
| if (command.Is(CommandGetTableTypes.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetTableTypes>(command); | ||
| if (command.Is(CommandGetSqlInfo.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetSqlInfo>(command); | ||
| if (command.Is(CommandGetPrimaryKeys.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetPrimaryKeys>(command); | ||
| if (command.Is(CommandGetExportedKeys.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetExportedKeys>(command); | ||
| if (command.Is(CommandGetImportedKeys.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetImportedKeys>(command); | ||
| if (command.Is(CommandGetCrossReference.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetCrossReference>(command); | ||
| if (command.Is(CommandGetXdbcTypeInfo.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandGetXdbcTypeInfo>(command); | ||
| if (command.Is(TicketStatementQuery.Descriptor)) | ||
| return FlightSqlUtils.Unpack<TicketStatementQuery>(command); | ||
| if (command.Is(TicketStatementQuery.Descriptor)) | ||
| return FlightSqlUtils.Unpack<TicketStatementQuery>(command); | ||
| if (command.Is(CommandStatementUpdate.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandStatementUpdate>(command); | ||
| if (command.Is(CommandPreparedStatementUpdate.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandPreparedStatementUpdate>(command); | ||
| if (command.Is(CommandPreparedStatementQuery.Descriptor)) | ||
| return FlightSqlUtils.Unpack<CommandPreparedStatementQuery>(command); | ||
|
|
||
| throw new ArgumentException("The defined request is invalid."); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Extracts a command from a FlightDescriptor | ||
| /// </summary> | ||
| /// <param name="descriptor"></param> | ||
| /// <returns>An IMessage that has been parsed and unpacked</returns> | ||
| public static IMessage? ParsedAndUnpackedMessage(this FlightDescriptor descriptor) | ||
| { | ||
| try | ||
| { | ||
| return descriptor.ParsedCommand().UnpackMessage(); | ||
| } | ||
| catch (ArgumentException) | ||
| { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| public static ByteString Serialize(this IBufferMessage message) | ||
| { | ||
| int size = message.CalculateSize(); | ||
| var writer = new ArrayBufferWriter<byte>(size); | ||
| message.WriteTo(writer); | ||
| var schemaBytes = writer.WrittenSpan; | ||
| return ByteString.CopyFrom(schemaBytes); | ||
| } | ||
| } | ||
| } |
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,22 @@ | ||
| // 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. | ||
|
|
||
| namespace Apache.Arrow.Flight.Sql; | ||
|
|
||
| public static class SqlAction | ||
| { | ||
| public const string CreateRequest = "CreatePreparedStatement"; | ||
| public const string CloseRequest = "ClosePreparedStatement"; | ||
| } |
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
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,53 @@ | ||
| // 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 Google.Protobuf; | ||
|
|
||
| namespace Apache.Arrow.Flight; | ||
|
|
||
| public class FlightData | ||
| { | ||
| public FlightDescriptor Descriptor { get; } | ||
| public ByteString AppMetadata { get; } | ||
| public ByteString DataBody { get; } | ||
| public ByteString DataHeader { get; } | ||
|
|
||
| public FlightData(FlightDescriptor descriptor, ByteString dataBody = null, ByteString dataHeader = null, ByteString appMetadata = null) | ||
| { | ||
| Descriptor = descriptor; | ||
| DataBody = dataBody; | ||
| DataHeader = dataHeader; | ||
| AppMetadata = appMetadata; | ||
| } | ||
|
|
||
| internal FlightData(Protocol.FlightData protocolFlightData) | ||
| { | ||
| Descriptor = protocolFlightData.FlightDescriptor == null ? null : new FlightDescriptor(protocolFlightData.FlightDescriptor); | ||
| DataBody = protocolFlightData.DataBody; | ||
| DataHeader = protocolFlightData.DataHeader; | ||
| AppMetadata = protocolFlightData.AppMetadata; | ||
| } | ||
|
|
||
| internal Protocol.FlightData ToProtocol() | ||
| { | ||
| return new Protocol.FlightData | ||
| { | ||
| FlightDescriptor = Descriptor?.ToProtocol(), | ||
| AppMetadata = AppMetadata, | ||
| DataBody = DataBody, | ||
| DataHeader = DataHeader | ||
| }; | ||
| } | ||
| } |
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,58 @@ | ||
| // 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 Google.Protobuf; | ||
|
|
||
| namespace Apache.Arrow.Flight; | ||
|
|
||
| public class FlightHandshakeRequest | ||
| { | ||
| private readonly Protocol.HandshakeRequest _result; | ||
| public ByteString Payload => _result.Payload; | ||
| public ulong ProtocolVersion => _result.ProtocolVersion; | ||
|
|
||
| internal FlightHandshakeRequest(Protocol.HandshakeRequest result) | ||
| { | ||
| _result = result; | ||
| } | ||
|
|
||
| public FlightHandshakeRequest(ByteString payload, ulong protocolVersion = 1) | ||
| { | ||
| _result = new Protocol.HandshakeRequest | ||
| { | ||
| Payload = payload, | ||
| ProtocolVersion = protocolVersion | ||
| }; | ||
| } | ||
|
|
||
| internal Protocol.HandshakeRequest ToProtocol() | ||
| { | ||
| return _result; | ||
| } | ||
|
|
||
| public override bool Equals(object obj) | ||
| { | ||
| if(obj is FlightHandshakeRequest other) | ||
| { | ||
| return Equals(_result, other._result); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| public override int GetHashCode() | ||
| { | ||
| return _result.GetHashCode(); | ||
| } | ||
| } |
Oops, something went wrong.