apache / apache/arrow-java

Offer an un-shaded version of the Flight SQL JDBC driver

Open
#161 3 comments 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
94
Forks
152
Avg merge
3d 16h
Merged PRs (30d)
11

Description

### Describe the enhancement requested

The Arrow Flight SQL JDBC driver shades and relocates all of its Maven dependencies into the driver JAR. While this is probably good and desired for folks who need to download the JAR and install it into whatever tool they're using to connect to something, it can cause an issue for those who are embedding the driver within their own service.

As an example, we're using [OpenTelemetry's Java auto instrumentation agent](https://opentelemetry.io/docs/instrumentation/java/automatic/). This agent modifies bytecode as it's loaded to include OpenTelemetry instrumentation for distributed tracing. It has built in support for gRPC clients and servers. Unfortunately, because the Arrow Flight SQL JDBC driver shades and relocates the gRPC libraries, they no longer utilize the same package name as what the Java agent expects. Subsequently, OpenTelemetry does not instrument the client calls and can not perform context propagation from the client to the server.

Would it be possible to publish both a shaded+relocated version of the driver and an un-shaded version of the driver?

The Maven Shade plugin supports building and publishing both artifacts via the [shadedArtifactAttached](https://maven.apache.org/plugins/maven-shade-plugin/examples/attached-artifact.html) configuration option. The JDBC driver has this option explicitly disabled for some reason.

### Component(s)

Java

Contributor guide

Open the contributing guide

Research direction

Inspect the Maven Shade configuration for the Flight SQL JDBC driver, starting with the setting that disables shadedArtifactAttached. Check how the JDBC driver artifact is currently built and published, then verify that both shaded/relocated and unshaded artifacts are produced without breaking the existing driver packaging.

Written by the indexing model from the issue text.

Assessment

Tech stack
grpc, java
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.