-
Notifications
You must be signed in to change notification settings - Fork 4k
ARROW-7744: [Java] Implement Flight JDBC Driver [WIP] #6343
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.
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
Closed
Closed
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
9a12bc6
Basic skeleton for JDBC driver
andygrove acbaf12
add unit test
andygrove f15f31a
test executing query and fetching one row
andygrove 3c70a5b
rename classes to use Flight prefix to simplify imports
andygrove d91884f
move type conversion code to helper class for easier unit testing
andygrove fbd9549
make most methods throw SQLFeatureNotSupportedException
andygrove 78b3083
Fix mvn verify issues
andygrove ba9fd9f
ignore test
andygrove 767e9e7
Implement ResultSet.next() and more data type conversion logic
andygrove 3e174d2
ResultSetMetaData and bug fixes
andygrove 3abf8bb
Add java.sql.Driver
andygrove File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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. | ||
| --> | ||
|
|
||
| # Apache Arrow Flight JDBC Driver | ||
|
|
||
| JDBC Driver for executing queries against Flight servers. |
This file contains hidden or 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,254 @@ | ||
| <?xml version="1.0"?> | ||
| <!-- 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. --> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <parent> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>arrow-java-root</artifactId> | ||
| <version>0.16.0-SNAPSHOT</version> | ||
| <relativePath>../../pom.xml</relativePath> | ||
| </parent> | ||
|
|
||
| <artifactId>flight-jdbc</artifactId> | ||
| <name>Arrow Flight JDBC</name> | ||
| <description>(Experimental)Flight JDBC Driver</description> | ||
| <packaging>jar</packaging> | ||
|
|
||
| <properties> | ||
| <dep.grpc.version>1.24.0</dep.grpc.version> | ||
| <dep.protobuf.version>3.7.1</dep.protobuf.version> | ||
| <forkCount>1</forkCount> | ||
| </properties> | ||
|
|
||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>flight-core</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>arrow-memory</artifactId> | ||
| <version>${project.version}</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>arrow-vector</artifactId> | ||
| <version>${project.version}</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>io.grpc</groupId> | ||
| <artifactId>grpc-api</artifactId> | ||
| <version>${dep.grpc.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>io.grpc</groupId> | ||
| <artifactId>grpc-stub</artifactId> | ||
| <version>${dep.grpc.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>io.grpc</groupId> | ||
| <artifactId>grpc-protobuf</artifactId> | ||
| <version>${dep.grpc.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.google.protobuf</groupId> | ||
| <artifactId>protobuf-java</artifactId> | ||
| <version>${dep.protobuf.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.google.guava</groupId> | ||
| <artifactId>guava</artifactId> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.slf4j</groupId> | ||
| <artifactId>slf4j-api</artifactId> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
||
| <build> | ||
| <extensions> | ||
| <extension> | ||
| <groupId>kr.motd.maven</groupId> | ||
| <artifactId>os-maven-plugin</artifactId> | ||
| <version>1.5.0.Final</version> | ||
| </extension> | ||
| </extensions> | ||
| <plugins> | ||
| <plugin> | ||
| <artifactId>maven-surefire-plugin</artifactId> | ||
| <configuration> | ||
| <enableAssertions>false</enableAssertions> | ||
| <systemPropertyVariables> | ||
| <arrow.test.dataRoot>${project.basedir}/../../../testing/data</arrow.test.dataRoot> | ||
| </systemPropertyVariables> | ||
| </configuration> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-shade-plugin</artifactId> | ||
| <version>3.1.1</version> | ||
| <executions> | ||
| <execution> | ||
| <id>shade-main</id> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>shade</goal> | ||
| </goals> | ||
| <configuration> | ||
| <shadedArtifactAttached>true</shadedArtifactAttached> | ||
| <shadedClassifierName>shaded</shadedClassifierName> | ||
| <artifactSet> | ||
| <includes> | ||
| <include>io.grpc:*</include> | ||
| <include>com.google.protobuf:*</include> | ||
| </includes> | ||
| </artifactSet> | ||
| <relocations> | ||
| <relocation> | ||
| <pattern>com.google.protobuf</pattern> | ||
| <shadedPattern>arrow.flight.com.google.protobuf</shadedPattern> | ||
| </relocation> | ||
| </relocations> | ||
| <transformers> | ||
| <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" /> | ||
| </transformers> | ||
| </configuration> | ||
| </execution> | ||
| <execution> | ||
| <id>shade-ext</id> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>shade</goal> | ||
| </goals> | ||
| <configuration> | ||
| <shadedArtifactAttached>true</shadedArtifactAttached> | ||
| <shadedClassifierName>shaded-ext</shadedClassifierName> | ||
| <artifactSet> | ||
| <includes> | ||
| <include>io.grpc:*</include> | ||
| <include>com.google.protobuf:*</include> | ||
| <include>com.google.guava:*</include> | ||
| </includes> | ||
| </artifactSet> | ||
| <relocations> | ||
| <relocation> | ||
| <pattern>com.google.protobuf</pattern> | ||
| <shadedPattern>arrow.flight.com.google.protobuf</shadedPattern> | ||
| </relocation> | ||
| <relocation> | ||
| <pattern>com.google.common</pattern> | ||
| <shadedPattern>arrow.flight.com.google.common</shadedPattern> | ||
| </relocation> | ||
| </relocations> | ||
| <transformers> | ||
| <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" /> | ||
| </transformers> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.xolstice.maven.plugins</groupId> | ||
| <artifactId>protobuf-maven-plugin</artifactId> | ||
| <version>0.5.0</version> | ||
| <configuration> | ||
| <protocArtifact>com.google.protobuf:protoc:${dep.protobuf.version}:exe:${os.detected.classifier}</protocArtifact> | ||
| <clearOutputDirectory>false</clearOutputDirectory> | ||
| <pluginId>grpc-java</pluginId> | ||
| <pluginArtifact>io.grpc:protoc-gen-grpc-java:${dep.grpc.version}:exe:${os.detected.classifier}</pluginArtifact> | ||
| </configuration> | ||
| <executions> | ||
| <execution> | ||
| <id>src</id> | ||
| <configuration> | ||
| <protoSourceRoot>${basedir}/../../../format/</protoSourceRoot> | ||
| <outputDirectory>${project.build.directory}/generated-sources/protobuf</outputDirectory> | ||
| </configuration> | ||
| <goals> | ||
| <goal>compile</goal> | ||
| <goal>compile-custom</goal> | ||
| </goals> | ||
| </execution> | ||
| <execution> | ||
| <id>test</id> | ||
| <configuration> | ||
| <protoSourceRoot>${basedir}/src/test/protobuf</protoSourceRoot> | ||
| <outputDirectory>${project.build.directory}/generated-test-sources//protobuf</outputDirectory> | ||
| </configuration> | ||
| <goals> | ||
| <goal>compile</goal> | ||
| <goal>compile-custom</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-dependency-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>analyze</id> | ||
| <phase>verify</phase> | ||
| <goals> | ||
| <goal>analyze-only</goal> | ||
| </goals> | ||
| <configuration> | ||
| <ignoredDependencies combine.children="append"> | ||
| <ignoredDependency>io.netty:netty-tcnative-boringssl-static:*</ignoredDependency> | ||
| </ignoredDependencies> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> <!-- add generated sources to classpath --> | ||
| <groupId>org.codehaus.mojo</groupId> | ||
| <artifactId>build-helper-maven-plugin</artifactId> | ||
| <version>1.9.1</version> | ||
| <executions> | ||
| <execution> | ||
| <id>add-generated-sources-to-classpath</id> | ||
| <phase>generate-sources</phase> | ||
| <goals> | ||
| <goal>add-source</goal> | ||
| </goals> | ||
| <configuration> | ||
| <sources> | ||
| <source>${project.build.directory}/generated-sources/protobuf</source> | ||
| </sources> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <artifactId>maven-assembly-plugin</artifactId> | ||
| <version>3.0.0</version> | ||
| <configuration> | ||
| <descriptorRefs> | ||
| <descriptorRef>jar-with-dependencies</descriptorRef> | ||
| </descriptorRefs> | ||
| </configuration> | ||
| <executions> | ||
| <execution> | ||
| <id>make-assembly</id> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>single</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </project> |
81 changes: 81 additions & 0 deletions
81
java/flight/flight-jdbc/src/main/java/org/apache/arrow/jdbc/Driver.java
This file contains hidden or 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,81 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.apache.arrow.jdbc; | ||
|
|
||
| import java.sql.Connection; | ||
| import java.sql.DriverPropertyInfo; | ||
| import java.sql.SQLException; | ||
| import java.sql.SQLFeatureNotSupportedException; | ||
| import java.util.Properties; | ||
| import java.util.logging.Logger; | ||
|
|
||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * Driver. | ||
| */ | ||
| public class Driver implements java.sql.Driver { | ||
|
|
||
| private static final org.slf4j.Logger logger = LoggerFactory.getLogger(Driver.class); | ||
|
|
||
| /** JDBC connection string prefix. */ | ||
| private static final String PREFIX = "jdbc:arrow://"; | ||
|
|
||
| @Override | ||
| public Connection connect(String url, Properties properties) throws SQLException { | ||
| logger.info("connect() url={}", url); | ||
| //TODO this needs much more work to parse full URLs but this is enough to get end to end tests running | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| String c = url.substring(PREFIX.length()); | ||
| int i = c.indexOf(':'); | ||
| if (i == -1) { | ||
| return new FlightConnection(c, 50051); | ||
| } else { | ||
| return new FlightConnection(c.substring(0,i), Integer.parseInt(c.substring(i + 1))); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public boolean acceptsURL(String url) throws SQLException { | ||
| return url != null && url.startsWith(PREFIX); | ||
| } | ||
|
|
||
| @Override | ||
| public DriverPropertyInfo[] getPropertyInfo(String s, Properties properties) throws SQLException { | ||
| return new DriverPropertyInfo[0]; | ||
| } | ||
|
|
||
| @Override | ||
| public int getMajorVersion() { | ||
| return 0; | ||
| } | ||
|
|
||
| @Override | ||
| public int getMinorVersion() { | ||
| return 16; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean jdbcCompliant() { | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public Logger getParentLogger() throws SQLFeatureNotSupportedException { | ||
| throw new SQLFeatureNotSupportedException(); | ||
| } | ||
| } | ||
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.
Flight has a set of URI schemes (
grpc+tcp,grpc+tls, etc), maybe those should be reflected?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.
Then the Flight URI (minus the jdbc prefix) could get passed to the
FlightConnection.