Creates a new read session. A read session divides the contents of a
BigQuery table into one or more streams, which can then be used to read
data from the table. The read session also specifies properties of the
data to be read, such as a list of columns or a push-down filter describing
the rows to be returned.
A particular row can be read by at most one stream. When the caller has
reached the end of each stream in the session, then all the data in the
table has been read.
Data is assigned to each stream such that roughly the same number of
rows can be read from each stream. Because the server-side unit for
assigning data is collections of rows, the API does not guarantee that
each stream will return the same number or rows. Additionally, the
limits are enforced based on the number of pre-filtered rows, so some
filters can lead to lopsided assignments.
Read sessions automatically expire 6 hours after they are created and do
not require manual clean-up by the caller.
Splits a given ReadStream into two ReadStream objects. These
ReadStream objects are referred to as the primary and the residual
streams of the split. The original ReadStream can still be read from in
the same manner as before. Both of the returned ReadStream objects can
also be read from, and the rows returned by both child streams will be
the same as the rows read from the original stream.
Moreover, the two child streams will be allocated back-to-back in the
original ReadStream. Concretely, it is guaranteed that for streams
original, primary, and residual, that original[0-j] = primary[0-j] and
original[j-n] = residual[0-m] once the streams have been read to
completion.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-18 UTC."],[],[],null,["# Class BigQueryReadGrpc.BigQueryReadFutureStub (3.16.2)\n\nVersion latestkeyboard_arrow_down\n\n- [3.16.2 (latest)](/java/docs/reference/google-cloud-bigquerystorage/latest/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.16.1](/java/docs/reference/google-cloud-bigquerystorage/3.16.1/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.15.3](/java/docs/reference/google-cloud-bigquerystorage/3.15.3/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.14.1](/java/docs/reference/google-cloud-bigquerystorage/3.14.1/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.12.0](/java/docs/reference/google-cloud-bigquerystorage/3.12.0/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.11.4](/java/docs/reference/google-cloud-bigquerystorage/3.11.4/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.10.3](/java/docs/reference/google-cloud-bigquerystorage/3.10.3/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.9.3](/java/docs/reference/google-cloud-bigquerystorage/3.9.3/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.8.0](/java/docs/reference/google-cloud-bigquerystorage/3.8.0/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.6.1](/java/docs/reference/google-cloud-bigquerystorage/3.6.1/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.5.2](/java/docs/reference/google-cloud-bigquerystorage/3.5.2/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.4.0](/java/docs/reference/google-cloud-bigquerystorage/3.4.0/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.3.1](/java/docs/reference/google-cloud-bigquerystorage/3.3.1/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.2.0](/java/docs/reference/google-cloud-bigquerystorage/3.2.0/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.1.0](/java/docs/reference/google-cloud-bigquerystorage/3.1.0/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [3.0.1](/java/docs/reference/google-cloud-bigquerystorage/3.0.1/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [2.47.0](/java/docs/reference/google-cloud-bigquerystorage/2.47.0/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [2.45.0](/java/docs/reference/google-cloud-bigquerystorage/2.45.0/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [2.44.1](/java/docs/reference/google-cloud-bigquerystorage/2.44.1/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub)\n- [2.43.0](/java/docs/reference/google-cloud-bigquerystorage/2.43.0/com.google.cloud.bigquery.storage.v1.BigQueryReadGrpc.BigQueryReadFutureStub) \n\n public static final class BigQueryReadGrpc.BigQueryReadFutureStub extends AbstractFutureStub\u003cBigQueryReadGrpc.BigQueryReadFutureStub\u003e\n\nA stub to allow clients to do ListenableFuture-style rpc calls to service BigQueryRead.\n\nBigQuery Read API.\nThe Read API can be used to read data from BigQuery. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e io.grpc.stub.AbstractStub \\\u003e io.grpc.stub.AbstractFutureStub \\\u003e BigQueryReadGrpc.BigQueryReadFutureStub \n\nInherited Members\n-----------------\n\nio.grpc.stub.AbstractFutureStub.\\\u003cT\\\u003enewStub(io.grpc.stub.AbstractStub.StubFactory\\\u003cT\\\u003e,io.grpc.Channel) \nio.grpc.stub.AbstractFutureStub.\\\u003cT\\\u003enewStub(io.grpc.stub.AbstractStub.StubFactory\\\u003cT\\\u003e,io.grpc.Channel,io.grpc.CallOptions) \nio.grpc.stub.AbstractStub.\\\u003cT\\\u003ewithOption(io.grpc.CallOptions.Key\\\u003cT\\\u003e,T) \nio.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions) \nio.grpc.stub.AbstractStub.getCallOptions() \nio.grpc.stub.AbstractStub.getChannel() \nio.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials) \nio.grpc.stub.AbstractStub.withChannel(io.grpc.Channel) \nio.grpc.stub.AbstractStub.withCompression(java.lang.String) \nio.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline) \nio.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration) \nio.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit) \nio.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor) \nio.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...) \nio.grpc.stub.AbstractStub.withMaxInboundMessageSize(int) \nio.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int) \nio.grpc.stub.AbstractStub.withOnReadyThreshold(int) \nio.grpc.stub.AbstractStub.withWaitForReady() \n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nMethods\n-------\n\n### build(Channel channel, CallOptions callOptions)\n\n protected BigQueryReadGrpc.BigQueryReadFutureStub build(Channel channel, CallOptions callOptions)\n\n**Overrides** \nio.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)\n\n### createReadSession(CreateReadSessionRequest request)\n\n public ListenableFuture\u003cReadSession\u003e createReadSession(CreateReadSessionRequest request)\n\nCreates a new read session. A read session divides the contents of a\nBigQuery table into one or more streams, which can then be used to read\ndata from the table. The read session also specifies properties of the\ndata to be read, such as a list of columns or a push-down filter describing\nthe rows to be returned.\nA particular row can be read by at most one stream. When the caller has\nreached the end of each stream in the session, then all the data in the\ntable has been read.\nData is assigned to each stream such that roughly the same number of\nrows can be read from each stream. Because the server-side unit for\nassigning data is collections of rows, the API does not guarantee that\neach stream will return the same number or rows. Additionally, the\nlimits are enforced based on the number of pre-filtered rows, so some\nfilters can lead to lopsided assignments.\nRead sessions automatically expire 6 hours after they are created and do\nnot require manual clean-up by the caller.\n\n### splitReadStream(SplitReadStreamRequest request)\n\n public ListenableFuture\u003cSplitReadStreamResponse\u003e splitReadStream(SplitReadStreamRequest request)\n\nSplits a given `ReadStream` into two `ReadStream` objects. These\n`ReadStream` objects are referred to as the primary and the residual\nstreams of the split. The original `ReadStream` can still be read from in\nthe same manner as before. Both of the returned `ReadStream` objects can\nalso be read from, and the rows returned by both child streams will be\nthe same as the rows read from the original stream.\nMoreover, the two child streams will be allocated back-to-back in the\noriginal `ReadStream`. Concretely, it is guaranteed that for streams\noriginal, primary, and residual, that original\\[0-j\\] = primary\\[0-j\\] and\noriginal\\[j-n\\] = residual\\[0-m\\] once the streams have been read to\ncompletion."]]