InodeStore (Alluxio Parent 2.9.4-SNAPSHOT API)

All Superinterfaces:

AutoCloseable, Checkpointed, Closeable, ReadOnlyInodeStore

All Known Implementing Classes:

CachingInodeStore, HeapInodeStore, RocksInodeStore
```
@ThreadSafe
public interface InodeStore
extends ReadOnlyInodeStore, Checkpointed, Closeable
```
Inode metadata storage. The inode store manages metadata about individual inodes, as well as the parent-child relationships between them. Writes to the inode store happen atomically, so it is safe to concurrently read and write the same key. It is undefined whether the read will see the old value or the new value. The inode store needs a way to temporarily prevent modification to individual inodes or edges. It does this by acquiring inode lock manager write locks. This requires that the user acquires inode manager locks when making any modifications to the inode store.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`InodeStore.Factory` Factory for creating inode stores.
`static interface`	`InodeStore.WriteBatch` Used to perform batched writes.

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Logger LOG

Fields
Modifier and Type	Field and Description
`static org.slf4j.Logger`	`LOG`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addChild(long parentId, InodeView child)` Makes an inode the child of the specified parent.
`void`	`addChild(long parentId, String childName, Long childId)` Makes an inode the child of the specified parent.
`void`	`clear()` Removes all inodes and edges.
`default void`	`close()`
`default InodeStore.WriteBatch`	`createWriteBatch()` Creates a write batch.
`default Optional<Inode>`	`get(long id, ReadOption option)`
`default String`	`getInodePathString(InodeView inode)` Traverses the inode path starting from the given inode up to the root.
`default Optional<MutableInode<?>>`	`getMutable(long id)`
`Optional<MutableInode<?>>`	`getMutable(long id, ReadOption option)` Gets a mutable representation of the specified inode.
`default void`	`remove(InodeView inode)` Removes an inode from the inode store.
`void`	`remove(Long inodeId)` Removes an inode from the inode store.
`void`	`removeChild(long parentId, String name)` Removes a child from a parent inode.
`default void`	`removeInodeAndParentEdge(InodeView inode)` Removes an inode and the edge leading to it from the inode store.
`default boolean`	`supportsBatchWrite()`
`void`	`writeInode(MutableInode<?> inode)` Adds the given inode, or overwrites it if it already exists.
`default void`	`writeNewInode(MutableInode<?> inode)` Adds a new inode.

Methods inherited from interface alluxio.master.metastore.ReadOnlyInodeStore
allEdges, allInodes, get, getChild, getChild, getChild, getChild, getChildId, getChildId, getChildId, getChildIds, getChildIds, getChildIds, getChildren, getChildren, getChildren, getChildren, getChildrenFrom, getChildrenPrefix, getChildrenPrefixFrom, hasChildren, hasChildren

Methods inherited from interface alluxio.master.journal.checkpoint.Checkpointed
getCheckpointName, restoreFromCheckpoint, writeToCheckpoint

- Field Detail
  - LOG
```
static final org.slf4j.Logger LOG
```
- Method Detail
  - getMutable
```
Optional<MutableInode<?>> getMutable(long id,
                                     ReadOption option)
```
    Gets a mutable representation of the specified inode. Mutating the returned inode requires holding an inode lock manager read or write lock on the inode.
    
    Parameters:
    
    id - an inode id
    
    option - read options
    
    Returns:
    
    the inode with the given id, if it exists
  - getMutable
```
default Optional<MutableInode<?>> getMutable(long id)
```
    Parameters:
    
    id - an inode id
    
    Returns:
    
    the result of getMutable(long, ReadOption) with default option
  - get
```
default Optional<Inode> get(long id,
                            ReadOption option)
```
    Specified by:
    
    get in interface ReadOnlyInodeStore
    
    Parameters:
    
    id - an inode id
    
    option - the options
    
    Returns:
    
    the inode with the given id, if it exists
  - remove
```
void remove(Long inodeId)
```
    Removes an inode from the inode store. This does *not* remove the edge leading to the inode. This method requires an inode lock manager read or write lock on the removed inode.
    
    Parameters:
    
    inodeId - an inode to remove
  - remove
```
default void remove(InodeView inode)
```
    Removes an inode from the inode store. This does *not* remove the edge leading to the inode. This method requires an inode lock manager read or write lock on the removed inode.
    
    Parameters:
    
    inode - an inode to remove
  - removeInodeAndParentEdge
```
default void removeInodeAndParentEdge(InodeView inode)
```
    Removes an inode and the edge leading to it from the inode store. This method requires an inode lock manager read or write locks on the removed inode and edge.
    
    Parameters:
    
    inode - an inode to remove
  - writeInode
```
void writeInode(MutableInode<?> inode)
```
    Adds the given inode, or overwrites it if it already exists. If it is known that the inode is new, prefer writeNewInode(MutableInode). This method requires an inode lock manager read or write lock on the written inode.
    
    Parameters:
    
    inode - the inode to write
  - writeNewInode
```
default void writeNewInode(MutableInode<?> inode)
```
    Adds a new inode. This method is similar to writeInode(MutableInode), but with an added information that the inode is new. This allows some inode stores to perform extra optimizations. This method requires an inode lock manager read or write lock on the written inode.
    
    Parameters:
    
    inode - the inode to write
  - createWriteBatch
```
default InodeStore.WriteBatch createWriteBatch()
```
    Creates a write batch. Not all implementations support this, so callers should first check supportsBatchWrite().
    
    Returns:
    
    a InodeStore.WriteBatch which can be used to perform a batched write
  - supportsBatchWrite
```
default boolean supportsBatchWrite()
```
    Returns:
    
    whether the inode store implementation supports batch writes
  - clear
```
void clear()
```
    Removes all inodes and edges.
  - addChild
```
void addChild(long parentId,
              String childName,
              Long childId)
```
    Makes an inode the child of the specified parent. This method requires an inode lock manager read or write locks on the added edge.
    
    Parameters:
    
    parentId - the parent id
    
    childName - the child name
    
    childId - the child inode id
  - addChild
```
default void addChild(long parentId,
                      InodeView child)
```
    Makes an inode the child of the specified parent. This method requires an inode lock manager read or write locks on the added edge.
    
    Parameters:
    
    parentId - the parent id
    
    child - the child inode
  - removeChild
```
void removeChild(long parentId,
                 String name)
```
    Removes a child from a parent inode. This method requires an inode lock manager read or write locks on the removed edge.
    
    Parameters:
    
    parentId - the parent inode id
    
    name - the child name
  - close
```
default void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - getInodePathString
```
default String getInodePathString(InodeView inode)
```
    Traverses the inode path starting from the given inode up to the root. Used for debugging.
    
    Parameters:
    
    inode - the leaf inode
    
    Returns:
    
    the string that contains all inode proto on the path

Interface InodeStore

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface alluxio.master.metastore.ReadOnlyInodeStore

Methods inherited from interface alluxio.master.journal.checkpoint.Checkpointed

Field Detail

LOG

Method Detail

getMutable

getMutable

get

remove

remove

removeInodeAndParentEdge

writeInode

writeNewInode

createWriteBatch

supportsBatchWrite

clear

addChild

addChild

removeChild

close

getInodePathString