Add streaming HTTP response support to gremlin-driver (#3419) Adds streaming GraphBinary response deserialization to the Java driver. Instead of buffering the entire HTTP response body before processing, results are now delivered to the ResultSet as they arrive from the server. This reduces time-to-first-result for large result sets without requiring application code changes. Design ------ The streaming pipeline replaces HttpObjectAggregator + HttpGremlinResponseDecoder with a single HttpStreamingResponseHandler that feeds HTTP content chunks to a reader thread via a BlockingQueue<ByteBuf>. The reader deserializes GraphBinary items one at a time using an InputStream-backed Buffer adapter, allowing existing TypeSerializer implementations to work unchanged. New classes: - HttpStreamingResponseHandler: Netty handler orchestrating the streaming lifecycle - ByteBufQueueInputStream: bridges event loop to reader thread via blocking queue - InputStreamBuffer: read-only Buffer over InputStream for TypeSerializers - GraphBinaryStreamResponseReader: pull-based deserializer on a dedicated thread Non-GraphBinary serializers automatically fall back to the buffered pipeline. Connection lifecycle -------------------- Connection pool return is driven by wire-level completion (LAST_CONTENT_READ_RESPONSE), not application-level completion (ResultSet.markComplete). This ensures all HTTP bytes are consumed before the connection is reused, preventing framing corruption. An AtomicBoolean guard makes returnToPool() idempotent across concurrent error paths. Error handling races between the event loop and reader thread are resolved by marking errors on the ResultSet before signaling end-of-stream — CompletableFuture's single-completion semantics guarantee the correct error surfaces to the caller. Server-side fixes ----------------- Prevents connection corruption from double-LastHttpContent when writeError() is called after response streaming has already terminated. Guards writeError() against writes in FINISHED/ERROR state and defers state transitions until after serialization.
Apache TinkerPop™ is a graph computing framework for both graph databases (OLTP) and graph analytic systems (OLAP). It provides the Gremlin graph traversal language, drivers, and tools for working with property graphs across a wide variety of underlying data systems.
TinkerPop defines a common interface and language (Gremlin) so that applications can work against many different graph systems without being locked into a single vendor. It includes a reference in‑memory graph database (TinkerGraph), Gremlin Server, language variants, and a rich collection of recipes and documentation.
Key resources:
TinkerPop uses Maven and requires Java 11/17 for proper building and proper operations. To build, execute unit tests and package Gremlin Console/Server run:
mvn clean install
Please see the Building on Windows section for Windows-specific build instructions.
The zip distributions can be found in the following directories:
gremlin-server/targetgremlin-console/targetPlease see the CONTRIBUTING.md file for more detailed information and options for building, test running and developing TinkerPop.
Download Gremlin Console (compatible with Java 11/17) and unzip to a directory, then:
$ bin/gremlin.sh \,,,/ (o o) -----oOOo-(3)-oOOo----- plugin activated: tinkerpop.server plugin activated: tinkerpop.utilities plugin activated: tinkerpop.tinkergraph gremlin> Gremlin.version() ==>3.8.0 gremlin> graph = TinkerFactory.createModern() ==>tinkergraph[vertices:6 edges:6] gremlin> g = traversal().with(graph) ==>graphtraversalsource[tinkergraph[vertices:6 edges:6], standard] gremlin> g.V().has('name','vadas').valueMap() ==>[name:[vadas], age:[27]]
From the Gremlin Console, you can connect to a TinkerGraph instance and run your first traversals. Refer to the Getting Started for detailed walkthroughs and examples.
Common ways to use TinkerPop include:
See the Reference Documentation for supported features, configuration options, and other details.
The full TinkerPop documentation is published on the project website and is also maintained in this repository under docs/src/ as AsciiDoc “books.”
When changing or adding documentation, follow the existing AsciiDoc structure in docs/src/** and update the relevant index.asciidoc files so new content is included in the build.
Contributions to Apache TinkerPop are welcome. The Developer Documentation and contributing guide describe how to set up a development environment, run tests, and submit changes.
CONTRIBUTING.md in the repository root.Before opening a pull request, please:
CHANGELOG.asciidoc and upgrade docs when behavior or public APIs change.If you use AI coding agents or IDE assistants when working on TinkerPop, please consult AGENTS.md. That file summarizes:
AGENTS.md is a concise guide for tools and tool‑using contributors, while CONTRIBUTING.md and the Developer Documentation remain the canonical sources for project policies and processes.
Apache TinkerPop is an open source project of The Apache Software Foundation and is licensed under the Apache License, Version 2.0. See the LICENSE file in this repository for details.