Package edu.stanford.slac.archiverappliance.plain.parquet

Class ParquetPlainFileHandler

java.lang.Object

edu.stanford.slac.archiverappliance.plain.parquet.ParquetPlainFileHandler

All Implemented Interfaces:

PlainFileHandler, PlainStreams

public class ParquetPlainFileHandler
extends Object
implements PlainFileHandler

An implementation of PlainFileHandler that uses the Parquet file format for storing and retrieving EPICS event data.

This handler is responsible for all file-level operations related to Parquet files, including reading, writing, compression, and metadata extraction.

See Also:

• PlainFileHandler
• PlainStoragePlugin
• ParquetInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARQUET_PLUGIN_IDENTIFIER
static final String	ZSTD_BUFFER_POOL_ENABLED
static final String	ZSTD_LEVEL
static final String	ZSTD_WORKERS

Fields inherited from interface edu.stanford.slac.archiverappliance.plain.PlainFileHandler

logger

Constructor Summary

Constructors

Constructor	Description
ParquetPlainFileHandler()

Method Summary

Modifier and Type	Method	Description
AppendDataStateData	appendDataStateData(Instant timestamp, PartitionGranularity partitionGranularity, String rootFolder, String desc, PVNameToKeyMapping pv2key)
boolean	backUpFiles(boolean backupFilesBeforeETL)
EventFileWriter	createEventFileWriter(String pvName, Path path, ArchDBRTypes type, short year)
Event	dataAtTime(List<Path> pathList, String pvName, Instant atTime, Instant startAtTime, BiDirectionalIterable.IterationDirection iterationDirection)
void	dataDeleteTempFiles(BasicContext context, String pvName, String randSuffix, String rootFolder, PVNameToKeyMapping pv2key)
void	dataMovePaths(BasicContext context, String pvName, String randSuffix, String suffix, String rootFolder, PVNameToKeyMapping pv2key)
FileInfo	fileInfo(Path path)
String	getPathKey(Path path)
EventStream	getStream(String pvName, Path path, ArchDBRTypes dbrType)
EventStream	getTimeStream(String pvName, Path path, Instant start, Instant end, boolean skipSearch, FileInfo fileInfo)
EventStream	getTimeStream(String pvName, Path path, ArchDBRTypes dbrType, Instant start, Instant end, boolean skipSearch)
void	initCompression(Map<String,String> queryStrings)
void	markForDeletion(Path path)
ETLInfoListProcessor	optimisedETLInfoListProcessor(ETLDest etlDest)
String	pluginIdentifier()
String	toString()
String	updateRootFolderStr(String rootFolderStr)
Map<URLKey,String>	urlOptions()

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.stanford.slac.archiverappliance.plain.PlainFileHandler

getExtensionString, getPathResolver, rootFolderPath, useSearchForPositions

Field Details

PARQUET_PLUGIN_IDENTIFIER

public static final String PARQUET_PLUGIN_IDENTIFIER

See Also:

• Constant Field Values

ZSTD_BUFFER_POOL_ENABLED

public static final String ZSTD_BUFFER_POOL_ENABLED

See Also:

• Constant Field Values

ZSTD_LEVEL

public static final String ZSTD_LEVEL

See Also:

• Constant Field Values

ZSTD_WORKERS

public static final String ZSTD_WORKERS

See Also:

• Constant Field Values

Constructor Details

ParquetPlainFileHandler

public ParquetPlainFileHandler()

Method Details

toString

public String toString()

Overrides:

toString in class Object

pluginIdentifier

public String pluginIdentifier()

Specified by:

pluginIdentifier in interface PlainFileHandler

initCompression

public void initCompression(Map<String,String> queryStrings)

Specified by:

initCompression in interface PlainFileHandler

fileInfo

public FileInfo fileInfo(Path path)
                  throws IOException

Specified by:

fileInfo in interface PlainFileHandler

Throws:

IOException

getTimeStream

public EventStream getTimeStream(String pvName,
 Path path,
 ArchDBRTypes dbrType,
 Instant start,
 Instant end,
 boolean skipSearch)
                          throws IOException

Specified by:

getTimeStream in interface PlainStreams

Throws:

IOException

getTimeStream

public EventStream getTimeStream(String pvName,
 Path path,
 Instant start,
 Instant end,
 boolean skipSearch,
 FileInfo fileInfo)
                          throws IOException

Specified by:

getTimeStream in interface PlainStreams

Throws:

IOException

getStream

public EventStream getStream(String pvName,
 Path path,
 ArchDBRTypes dbrType)
                      throws IOException

Specified by:

getStream in interface PlainStreams

Throws:

IOException

dataAtTime

public Event dataAtTime(List<Path> pathList,
 String pvName,
 Instant atTime,
 Instant startAtTime,
 BiDirectionalIterable.IterationDirection iterationDirection)
                 throws IOException

Specified by:

dataAtTime in interface PlainStreams

Throws:

IOException

appendDataStateData

public AppendDataStateData appendDataStateData(Instant timestamp,
 PartitionGranularity partitionGranularity,
 String rootFolder,
 String desc,
 PVNameToKeyMapping pv2key)

Specified by:

appendDataStateData in interface PlainFileHandler

createEventFileWriter

public EventFileWriter createEventFileWriter(String pvName,
 Path path,
 ArchDBRTypes type,
 short year)
                                      throws IOException

Specified by:

createEventFileWriter in interface PlainFileHandler

Throws:

IOException

markForDeletion

public void markForDeletion(Path path)
                     throws IOException

Specified by:

markForDeletion in interface PlainFileHandler

Throws:

IOException

dataMovePaths

public void dataMovePaths(BasicContext context,
 String pvName,
 String randSuffix,
 String suffix,
 String rootFolder,
 PVNameToKeyMapping pv2key)
                   throws IOException

Specified by:

dataMovePaths in interface PlainFileHandler

Throws:

IOException

dataDeleteTempFiles

public void dataDeleteTempFiles(BasicContext context,
 String pvName,
 String randSuffix,
 String rootFolder,
 PVNameToKeyMapping pv2key)
                         throws IOException

Specified by:

dataDeleteTempFiles in interface PlainFileHandler

Throws:

IOException

optimisedETLInfoListProcessor

public ETLInfoListProcessor optimisedETLInfoListProcessor(ETLDest etlDest)

Specified by:

optimisedETLInfoListProcessor in interface PlainFileHandler

updateRootFolderStr

public String updateRootFolderStr(String rootFolderStr)

Specified by:

updateRootFolderStr in interface PlainFileHandler

backUpFiles

public boolean backUpFiles(boolean backupFilesBeforeETL)

Specified by:

backUpFiles in interface PlainFileHandler

urlOptions

public Map<URLKey,String> urlOptions()

Specified by:

urlOptions in interface PlainFileHandler

getPathKey

public String getPathKey(Path path)

Specified by:

getPathKey in interface PlainFileHandler