Package dev.vortex.api

Interface VortexWriter

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
JNIWriter
public interface VortexWriter extends AutoCloseable
Writer for creating Vortex files from Arrow data.

This class provides methods to write Arrow VectorSchemaRoot batches to Vortex format files.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closes the writer and finalizes the Vortex file.
    static VortexWriter
    create(String uri, DType dtype, Map<String,String> options)
    Creates a new VortexWriter for writing to the specified file path.
    void
    writeBatch(byte[] arrowData)
    Writes a batch of Arrow data to the Vortex file.
    void
    writeBatchFfi(long arrowArrayAddr, long arrowSchemaAddr)
    Writes a batch of Arrow data directly from Arrow C Data Interface pointers.

  • Method Details

    • create

      static VortexWriter create(String uri, DType dtype, Map<String,String> options) throws IOException
      Creates a new VortexWriter for writing to the specified file path.
      Parameters:
      uri - The URI for where the file is opened
      dtype - The Vortex DType for data that gets written
      options - additional writer options
      Returns:
      a new VortexWriter instance
      Throws:
      IOException - if the writer cannot be created

    • writeBatch

      void writeBatch(byte[] arrowData) throws IOException
      Writes a batch of Arrow data to the Vortex file.
      Parameters:
      arrowData - the Arrow data in IPC format as byte array
      Throws:
      IOException - if writing fails

    • writeBatchFfi

      void writeBatchFfi(long arrowArrayAddr, long arrowSchemaAddr) throws IOException
      Writes a batch of Arrow data directly from Arrow C Data Interface pointers.

      This avoids the IPC serialization overhead by accepting raw memory addresses of ArrowArray and ArrowSchema structs.

      Parameters:
      arrowArrayAddr - memory address of the ArrowArray struct
      arrowSchemaAddr - memory address of the ArrowSchema struct
      Throws:
      IOException - if writing fails

    • close

      void close() throws IOException
      Closes the writer and finalizes the Vortex file.

      This method must be called to ensure the file is properly written with all necessary metadata and footers.

      Specified by:
      close in interface AutoCloseable
      Throws:
      IOException - if closing fails