Package org.apache.arrow.datafusion

Interface RecordBatchStream

All Superinterfaces:
AutoCloseable, org.apache.arrow.vector.dictionary.DictionaryProvider
public interface RecordBatchStream extends AutoCloseable, org.apache.arrow.vector.dictionary.DictionaryProvider
A record batch stream is a stream of tabular Arrow data that can be iterated over asynchronously

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.apache.arrow.vector.dictionary.DictionaryProvider

    org.apache.arrow.vector.dictionary.DictionaryProvider.MapDictionaryProvider

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getPointer()
    Get a pointer to the native object
    org.apache.arrow.vector.VectorSchemaRoot
    getVectorSchemaRoot()
    Get the VectorSchemaRoot that will be populated with data as the stream is iterated over
    CompletableFuture<Boolean>
    loadNextBatch()
    Load the next record batch in the stream into the VectorSchemaRoot

    Methods inherited from interface java.lang.AutoCloseable

    close

    Methods inherited from interface org.apache.arrow.vector.dictionary.DictionaryProvider

    getDictionaryIds, lookup

  • Method Details

    • getVectorSchemaRoot

      org.apache.arrow.vector.VectorSchemaRoot getVectorSchemaRoot()
      Get the VectorSchemaRoot that will be populated with data as the stream is iterated over
      Returns:
      the stream's VectorSchemaRoot

    • loadNextBatch

      CompletableFuture<Boolean> loadNextBatch()
      Load the next record batch in the stream into the VectorSchemaRoot
      Returns:
      Future that will complete with true if a batch was loaded or false if the end of the stream has been reached

    • getPointer

      long getPointer()
      Get a pointer to the native object
      Returns:
      Pointer value as a long