org.elasticsearch.index.store
Interface Store

All Superinterfaces:
IndexShardComponent
All Known Implementing Classes:
AbstractStore, ByteBufferStore, FsStore, MmapFsStore, NioFsStore, RamStore, SimpleFsStore

public interface Store
extends IndexShardComponent


Method Summary
 void close()
          Close the store.
 org.apache.lucene.store.IndexOutput createOutputWithNoChecksum(java.lang.String name)
           
 void deleteContent()
          Just deletes the content of the store.
 org.apache.lucene.store.Directory directory()
          The Lucene Directory this store is using.
 ByteSizeValue estimateSize()
          The estimated size this store is using.
 void fullDelete()
          Deletes the store completely.
 org.elasticsearch.common.collect.ImmutableMap<java.lang.String,StoreFileMetaData> list()
           
 StoreFileMetaData metaData(java.lang.String name)
           
 boolean suggestUseCompoundFile()
          The store can suggest the best setting for compound file the MergePolicy will use.
 void writeChecksum(java.lang.String name, java.lang.String checksum)
           
 
Methods inherited from interface org.elasticsearch.index.shard.IndexShardComponent
indexSettings, shardId
 

Method Detail

directory

org.apache.lucene.store.Directory directory()
The Lucene Directory this store is using.


createOutputWithNoChecksum

org.apache.lucene.store.IndexOutput createOutputWithNoChecksum(java.lang.String name)
                                                               throws java.io.IOException
Throws:
java.io.IOException

writeChecksum

void writeChecksum(java.lang.String name,
                   java.lang.String checksum)
                   throws java.io.IOException
Throws:
java.io.IOException

metaData

StoreFileMetaData metaData(java.lang.String name)
                           throws java.io.IOException
Throws:
java.io.IOException

list

org.elasticsearch.common.collect.ImmutableMap<java.lang.String,StoreFileMetaData> list()
                                                                                       throws java.io.IOException
Throws:
java.io.IOException

deleteContent

void deleteContent()
                   throws java.io.IOException
Just deletes the content of the store.

Throws:
java.io.IOException

fullDelete

void fullDelete()
                throws java.io.IOException
Deletes the store completely. For example, in FS ones, also deletes the parent directory.

Throws:
java.io.IOException

estimateSize

ByteSizeValue estimateSize()
                           throws java.io.IOException
The estimated size this store is using.

Throws:
java.io.IOException

suggestUseCompoundFile

boolean suggestUseCompoundFile()
The store can suggest the best setting for compound file the MergePolicy will use.


close

void close()
           throws java.io.IOException
Close the store.

Throws:
java.io.IOException