com.lancedb.lance.file

Class LanceFileWriter

java.lang.Object

com.lancedb.lance.file.LanceFileWriter

All Implemented Interfaces:

AutoCloseable

public class LanceFileWriter
extends Object
implements AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	close() Close the LanceFileWriter
static LanceFileWriter	open(String path, org.apache.arrow.memory.BufferAllocator allocator, org.apache.arrow.vector.dictionary.DictionaryProvider dictionaryProvider) Open a LanceFileWriter to write to a given file URI
static LanceFileWriter	open(String path, org.apache.arrow.memory.BufferAllocator allocator, org.apache.arrow.vector.dictionary.DictionaryProvider dictionaryProvider, Map<String,String> storageOptions) Open a LanceFileWriter to write to a given file URI
void	write(org.apache.arrow.vector.VectorSchemaRoot batch) Write a batch of data

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

open

public static LanceFileWriter open(String path,
                                   org.apache.arrow.memory.BufferAllocator allocator,
                                   org.apache.arrow.vector.dictionary.DictionaryProvider dictionaryProvider)
                            throws IOException

Open a LanceFileWriter to write to a given file URI

Parameters:

path - the URI of the file to write to

allocator - the BufferAllocator to use for the writer

dictionaryProvider - the DictionaryProvider to use for the writer

Returns:

a new LanceFileWriter

Throws:

IOException

open

public static LanceFileWriter open(String path,
                                   org.apache.arrow.memory.BufferAllocator allocator,
                                   org.apache.arrow.vector.dictionary.DictionaryProvider dictionaryProvider,
                                   Map<String,String> storageOptions)
                            throws IOException

Open a LanceFileWriter to write to a given file URI

Parameters:

path - the URI of the file to write to

allocator - the BufferAllocator to use for the writer

dictionaryProvider - the DictionaryProvider to use for the writer

storageOptions - additional storage options for the writer

Returns:

a new LanceFileWriter

Throws:

IOException

write

public void write(org.apache.arrow.vector.VectorSchemaRoot batch)
           throws IOException

Write a batch of data

Parameters:

batch - the batch of data to write

Throws:

IOException - if the batch cannot be written

close

public void close()
           throws Exception

Close the LanceFileWriter

This method must be called to release resources when the writer is no longer needed.

This method will also flush all remaining data and write the footer to the file.

Specified by:

close in interface AutoCloseable

Throws:

Exception - if the writer cannot be closed