TableParser
API
Generated with
TableParser/com.phasmidsoftware.tableparser/com.phasmidsoftware.tableparser.parquet/ParquetParser

ParquetParser

com.phasmidsoftware.tableparser.parquet.ParquetParser
object ParquetParser

Entry point for parsing Parquet files and datasets into typed Tables.

Typical usage for single files:

 given ColumnHelper[YellowTaxiTrip] =
   columnHelper(camelToSnakeCaseColumnNameMapper)

 val result: Try[Table[YellowTaxiTrip]] =
   ParquetParser.parse[YellowTaxiTrip](Path.of("data/yellow_2024.parquet"))

Typical usage for dataset directories:

 val result: Try[Table[YellowTaxiTrip]] =
   ParquetParser.parseDataset[YellowTaxiTrip](Path.of("data/yellow_2024"))

Row's ParquetCellConverter is its own given, if it has one; otherwise it's derived (see ParquetCellConverter.derived), using the ColumnHelper of each case class.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

inline def parse[Row](path: Path): Try[Table[Row]]

Parse a single Parquet file into a Table[Row]. Fails if path is a directory; use parseDataset for dataset directories.

Parse a single Parquet file into a Table[Row]. Fails if path is a directory; use parseDataset for dataset directories.

Type parameters

Row

the target case class type.

Value parameters

path

a java.nio.file.Path to a .parquet file.

Attributes

Returns

a Try[Table[Row]].

inline def parseDataset[Row](path: Path): Try[Table[Row]]

Parse a Parquet dataset directory into a Table[Row]. Dataset directories contain multiple part-*.parquet files. Fails if path is not a directory; use parse for single files.

Parse a Parquet dataset directory into a Table[Row]. Dataset directories contain multiple part-*.parquet files. Fails if path is not a directory; use parse for single files.

Type parameters

Row

the target case class type.

Value parameters

path

a java.nio.file.Path to a directory containing part files.

Attributes

Returns

a Try[Table[Row]].

Generated with