public final class ByteBuffersDirectory extends BaseDirectory
ByteBuffer
-based Directory
implementation that
can be used to store index files on the heap.
Important: Note that MMapDirectory
is nearly always a better choice as
it uses OS caches more effectively (through memory-mapped buffers).
A heap-based directory like this one can have the advantage in case of ephemeral, small,
short-lived indexes when disk syncs provide an additional overhead.
Modifier and Type | Field and Description |
---|---|
static BiFunction<String,ByteBuffersDataOutput,IndexInput> |
OUTPUT_AS_BYTE_ARRAY |
static BiFunction<String,ByteBuffersDataOutput,IndexInput> |
OUTPUT_AS_MANY_BUFFERS |
static BiFunction<String,ByteBuffersDataOutput,IndexInput> |
OUTPUT_AS_MANY_BUFFERS_LUCENE |
static BiFunction<String,ByteBuffersDataOutput,IndexInput> |
OUTPUT_AS_ONE_BUFFER |
isOpen, lockFactory
Constructor and Description |
---|
ByteBuffersDirectory() |
ByteBuffersDirectory(LockFactory lockFactory) |
ByteBuffersDirectory(LockFactory factory,
Supplier<ByteBuffersDataOutput> bbOutputSupplier,
BiFunction<String,ByteBuffersDataOutput,IndexInput> outputToInput) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the directory.
|
IndexOutput |
createOutput(String name,
IOContext context)
Creates a new, empty file in the directory and returns an
IndexOutput
instance for appending data to this file. |
IndexOutput |
createTempOutput(String prefix,
String suffix,
IOContext context)
Creates a new, empty, temporary file in the directory and returns an
IndexOutput
instance for appending data to this file. |
void |
deleteFile(String name)
Removes an existing file in the directory.
|
long |
fileLength(String name)
Returns the byte length of a file in the directory.
|
Set<String> |
getPendingDeletions()
Returns a set of files currently pending deletion in this directory.
|
String[] |
listAll()
Returns names of all files stored in this directory.
|
IndexInput |
openInput(String name,
IOContext context)
Opens a stream for reading an existing file.
|
void |
rename(String source,
String dest)
Renames
source file to dest file where
dest must not already exist in the directory. |
void |
sync(Collection<String> names)
Ensures that any writes to these files are moved to
stable storage (made durable).
|
void |
syncMetaData()
Ensures that directory metadata, such as recent file renames, are moved to stable
storage.
|
ensureOpen, obtainLock, toString
copyFrom, openChecksumInput
public static final BiFunction<String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_MANY_BUFFERS
public static final BiFunction<String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_ONE_BUFFER
public static final BiFunction<String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_BYTE_ARRAY
public static final BiFunction<String,ByteBuffersDataOutput,IndexInput> OUTPUT_AS_MANY_BUFFERS_LUCENE
public ByteBuffersDirectory()
public ByteBuffersDirectory(LockFactory lockFactory)
public ByteBuffersDirectory(LockFactory factory, Supplier<ByteBuffersDataOutput> bbOutputSupplier, BiFunction<String,ByteBuffersDataOutput,IndexInput> outputToInput)
public String[] listAll() throws IOException
Directory
String.compareTo(java.lang.String)
) order.listAll
in class Directory
IOException
- in case of I/O errorpublic void deleteFile(String name) throws IOException
Directory
NoSuchFileException
or FileNotFoundException
if name
points to a non-existing file.deleteFile
in class Directory
name
- the name of an existing file.IOException
- in case of I/O errorpublic long fileLength(String name) throws IOException
Directory
NoSuchFileException
or FileNotFoundException
if name
points to a non-existing file.fileLength
in class Directory
name
- the name of an existing file.IOException
- in case of I/O errorpublic IndexOutput createOutput(String name, IOContext context) throws IOException
Directory
IndexOutput
instance for appending data to this file.
This method must throw FileAlreadyExistsException
if the file
already exists.createOutput
in class Directory
name
- the name of the file to create.IOException
- in case of I/O errorpublic IndexOutput createTempOutput(String prefix, String suffix, IOContext context) throws IOException
Directory
IndexOutput
instance for appending data to this file.
The temporary file name (accessible via IndexOutput.getName()
) will start with
prefix
, end with suffix
and have a reserved file extension .tmp
.createTempOutput
in class Directory
IOException
public void rename(String source, String dest) throws IOException
Directory
source
file to dest
file where
dest
must not already exist in the directory.
It is permitted for this operation to not be truly atomic, for example
both source
and dest
can be visible temporarily in Directory.listAll()
.
However, the implementation of this method must ensure the content of
dest
appears as the entire source
atomically. So once
dest
is visible for readers, the entire content of previous source
is visible.
This method is used by IndexWriter to publish commits.rename
in class Directory
IOException
public void sync(Collection<String> names) throws IOException
Directory
sync
in class Directory
IOException
Directory.syncMetaData()
public void syncMetaData() throws IOException
Directory
syncMetaData
in class Directory
IOException
Directory.sync(Collection)
public IndexInput openInput(String name, IOContext context) throws IOException
Directory
NoSuchFileException
or FileNotFoundException
if name
points to a non-existing file.openInput
in class Directory
name
- the name of an existing file.IOException
- in case of I/O errorpublic void close() throws IOException
Directory
close
in interface Closeable
close
in interface AutoCloseable
close
in class Directory
IOException
public Set<String> getPendingDeletions()
Directory
getPendingDeletions
in class Directory
Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.