Represents a query whose results can be streamed. If the stream fails with a retryable error,
implementations of StreamableQuery can optionally support retries with a cursor, as indicated by
isRetryableWithCursor. Retrying with a cursor means that the StreamableQuery can be resumed
where it failed by first calling startAfter(lastDocumentReceived).
Plans and optionally executes this query. Returns an ApiFuture that will be resolved with the
planner information, statistics from the query execution (if any), and the query results (if
any).
[[["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-09-04 UTC."],[],[],null,["# Class StreamableQuery<SnapshotType> (3.32.1)\n\nVersion latestkeyboard_arrow_down\n\n- [3.32.1 (latest)](/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.StreamableQuery)\n- [3.32.0](/java/docs/reference/google-cloud-firestore/3.32.0/com.google.cloud.firestore.StreamableQuery)\n- [3.31.9](/java/docs/reference/google-cloud-firestore/3.31.9/com.google.cloud.firestore.StreamableQuery)\n- [3.30.11](/java/docs/reference/google-cloud-firestore/3.30.11/com.google.cloud.firestore.StreamableQuery)\n- [3.28.0](/java/docs/reference/google-cloud-firestore/3.28.0/com.google.cloud.firestore.StreamableQuery)\n- [3.27.2](/java/docs/reference/google-cloud-firestore/3.27.2/com.google.cloud.firestore.StreamableQuery)\n- [3.26.5](/java/docs/reference/google-cloud-firestore/3.26.5/com.google.cloud.firestore.StreamableQuery)\n- [3.25.1](/java/docs/reference/google-cloud-firestore/3.25.1/com.google.cloud.firestore.StreamableQuery)\n- [3.24.3](/java/docs/reference/google-cloud-firestore/3.24.3/com.google.cloud.firestore.StreamableQuery)\n- [3.22.0](/java/docs/reference/google-cloud-firestore/3.22.0/com.google.cloud.firestore.StreamableQuery)\n- [3.21.4](/java/docs/reference/google-cloud-firestore/3.21.4/com.google.cloud.firestore.StreamableQuery)\n- [3.20.0](/java/docs/reference/google-cloud-firestore/3.20.0/com.google.cloud.firestore.StreamableQuery)\n- [3.17.0](/java/docs/reference/google-cloud-firestore/3.17.0/com.google.cloud.firestore.StreamableQuery)\n- [3.16.3](/java/docs/reference/google-cloud-firestore/3.16.3/com.google.cloud.firestore.StreamableQuery)\n- [3.15.7](/java/docs/reference/google-cloud-firestore/3.15.7/com.google.cloud.firestore.StreamableQuery)\n- [3.14.4](/java/docs/reference/google-cloud-firestore/3.14.4/com.google.cloud.firestore.StreamableQuery)\n- [3.13.2](/java/docs/reference/google-cloud-firestore/3.13.2/com.google.cloud.firestore.StreamableQuery)\n- [3.12.1](/java/docs/reference/google-cloud-firestore/3.12.1/com.google.cloud.firestore.StreamableQuery)\n- [3.11.0](/java/docs/reference/google-cloud-firestore/3.11.0/com.google.cloud.firestore.StreamableQuery)\n- [3.10.0](/java/docs/reference/google-cloud-firestore/3.10.0/com.google.cloud.firestore.StreamableQuery)\n- [3.9.6](/java/docs/reference/google-cloud-firestore/3.9.6/com.google.cloud.firestore.StreamableQuery)\n- [3.8.2](/java/docs/reference/google-cloud-firestore/3.8.2/com.google.cloud.firestore.StreamableQuery)\n- [3.7.10](/java/docs/reference/google-cloud-firestore/3.7.10/com.google.cloud.firestore.StreamableQuery)\n- [3.6.0](/java/docs/reference/google-cloud-firestore/3.6.0/com.google.cloud.firestore.StreamableQuery)\n- [3.5.0](/java/docs/reference/google-cloud-firestore/3.5.0/com.google.cloud.firestore.StreamableQuery)\n- [3.4.2](/java/docs/reference/google-cloud-firestore/3.4.2/com.google.cloud.firestore.StreamableQuery)\n- [3.3.0](/java/docs/reference/google-cloud-firestore/3.3.0/com.google.cloud.firestore.StreamableQuery)\n- [3.2.0](/java/docs/reference/google-cloud-firestore/3.2.0/com.google.cloud.firestore.StreamableQuery)\n- [3.1.0](/java/docs/reference/google-cloud-firestore/3.1.0/com.google.cloud.firestore.StreamableQuery)\n- [3.0.21](/java/docs/reference/google-cloud-firestore/3.0.21/com.google.cloud.firestore.StreamableQuery) \n\n public abstract class StreamableQuery\u003cSnapshotType\u003e\n\nRepresents a query whose results can be streamed. If the stream fails with a retryable error,\nimplementations of StreamableQuery can optionally support retries with a cursor, as indicated by\n`isRetryableWithCursor`. Retrying with a cursor means that the StreamableQuery can be resumed\nwhere it failed by first calling `startAfter(lastDocumentReceived)`. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e StreamableQuery\\\u003cSnapshotType\\\u003e \n\nInherited Members\n-----------------\n\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### explain(ExplainOptions options)\n\n public ApiFuture\u003cExplainResults\u003cSnapshotType\u003e\u003e explain(ExplainOptions options)\n\nPlans and optionally executes this query. Returns an ApiFuture that will be resolved with the\nplanner information, statistics from the query execution (if any), and the query results (if\nany).\n\n### get()\n\n public abstract ApiFuture\u003cSnapshotType\u003e get()\n\nExecutes the query and returns the results as QuerySnapshot.\n\n### getFirestore()\n\n public Firestore getFirestore()\n\nGets the Firestore instance associated with this query.\n\n### toString()\n\n public String toString()\n\n**Overrides** \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--)"]]
