org.apache.hadoop.hive.common.io

Interface FileMetadataCache

public interface FileMetadataCache

Method Summary

Modifier and Type	Method and Description
void	decRefBuffer(MemoryBufferOrBuffers buffer) Releases the buffer returned from getFileMetadata or putFileMetadata method.
MemoryBufferOrBuffers	getFileMetadata(Object fileKey)
long	markBuffersForProactiveEviction(Predicate<CacheTag> predicate, boolean isInstantDeallocation) Iterates through the file entries of this cache and for those that match the given predicate (aka have a matching CacheTag) will have their buffers marked for (a later) proactive eviction.
MemoryBufferOrBuffers	putFileMetadata(Object fileKey, ByteBuffer tailBuffer) Deprecated.
MemoryBufferOrBuffers	putFileMetadata(Object fileKey, ByteBuffer tailBuffer, CacheTag tag) Deprecated.
MemoryBufferOrBuffers	putFileMetadata(Object fileKey, ByteBuffer tailBuffer, CacheTag tag, AtomicBoolean isStopped) Puts the metadata for a given file (e.g.
MemoryBufferOrBuffers	putFileMetadata(Object fileKey, int length, InputStream is) Deprecated.
MemoryBufferOrBuffers	putFileMetadata(Object fileKey, int length, InputStream is, CacheTag tag) Deprecated.
MemoryBufferOrBuffers	putFileMetadata(Object fileKey, int length, InputStream is, CacheTag tag, AtomicBoolean isStopped)

Method Detail

getFileMetadata

MemoryBufferOrBuffers getFileMetadata(Object fileKey)

Returns:

Metadata for a given file (ORC or Parquet footer). The caller must decref this buffer when done.

putFileMetadata

@Deprecated
MemoryBufferOrBuffers putFileMetadata(Object fileKey,
                                                  int length,
                                                  InputStream is)
                                           throws IOException

Deprecated.

Throws:

IOException

putFileMetadata

@Deprecated
MemoryBufferOrBuffers putFileMetadata(Object fileKey,
                                                  ByteBuffer tailBuffer)

Deprecated.

putFileMetadata

@Deprecated
MemoryBufferOrBuffers putFileMetadata(Object fileKey,
                                                  int length,
                                                  InputStream is,
                                                  CacheTag tag)
                                           throws IOException

Deprecated.

Throws:

IOException

putFileMetadata

@Deprecated
MemoryBufferOrBuffers putFileMetadata(Object fileKey,
                                                  ByteBuffer tailBuffer,
                                                  CacheTag tag)

Deprecated.

decRefBuffer

void decRefBuffer(MemoryBufferOrBuffers buffer)

Releases the buffer returned from getFileMetadata or putFileMetadata method.

Parameters:

buffer - The buffer to release.

putFileMetadata

MemoryBufferOrBuffers putFileMetadata(Object fileKey,
                                      ByteBuffer tailBuffer,
                                      CacheTag tag,
                                      AtomicBoolean isStopped)

Puts the metadata for a given file (e.g. a footer buffer into cache).

Parameters:

fileKey - The file key.

Returns:

The buffer or buffers representing the cached footer. The caller must decref this buffer when done.

putFileMetadata

MemoryBufferOrBuffers putFileMetadata(Object fileKey,
                                      int length,
                                      InputStream is,
                                      CacheTag tag,
                                      AtomicBoolean isStopped)
                               throws IOException

Throws:

IOException

markBuffersForProactiveEviction

long markBuffersForProactiveEviction(Predicate<CacheTag> predicate,
                                     boolean isInstantDeallocation)

Iterates through the file entries of this cache and for those that match the given predicate (aka have a matching CacheTag) will have their buffers marked for (a later) proactive eviction.

Parameters:

predicate - - matching the predicate indicates eligibility for proactive eviction

isInstantDeallocation - - whether to ask allocator to deallocate eligible buffers immediately after marking

Returns:

number of bytes marked in the buffers eligible for eviction