Package org.apache.juneau.marshall.parquet

Annotation Interface ParquetConfig

@Documented @Target({TYPE,METHOD}) @Retention(RUNTIME) @Inherited @Repeatable(Array.class) @ContextApply({SerializerApply.class,ParserApply.class}) public @interface ParquetConfig
Annotation for configuring Parquet serializer/parser on classes and methods.
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    addBeanTypes
    Add bean types column.
    String
    compressionCodec
    Compression codec used when writing ("UNCOMPRESSED" or "GZIP", case-insensitive).
    String
    maxCount
    Maximum allowed wire-declared element count (file/row-group row counts, column-chunk value counts) when parsing.
    String
    maxDecompressedBytes
    Maximum allowed aggregate decompressed-byte total across every Parquet page read during a single parse.
    String
    maxInputLength
    Maximum allowed size (in bytes) of the whole Parquet input buffered into memory before parsing.
    String
    maxLength
    Maximum allowed wire-declared length (in bytes) for a single Parquet page (compressed or uncompressed) when parsing.
    String
    pageSize
    Page size in bytes.
    int
    rank
    Rank for application order.
    String
    rowGroupSize
    Row group size in bytes.

  • Element Details

    • compressionCodec

      String compressionCodec
      Compression codec used when writing ("UNCOMPRESSED" or "GZIP", case-insensitive).

      Any other value fails fast with an IllegalArgumentException naming the bad value and the valid write codecs. This includes unknown names (typos) and "SNAPPY", which the parser can decode but the serializer cannot write. The parser detects the codec from the file and ignores this setting.

      Default:
      ""

    • rowGroupSize

      String rowGroupSize
      Row group size in bytes.
      Default:
      ""

    • pageSize

      String pageSize
      Page size in bytes.
      Default:
      ""

    • addBeanTypes

      String addBeanTypes
      Add bean types column.
      Default:
      ""

    • maxLength

      String maxLength
      Maximum allowed wire-declared length (in bytes) for a single Parquet page (compressed or uncompressed) when parsing.

      Guards against malformed or adversarial input where a small file declares a huge per-page byte size. Default is "268435456" (256 MiB). A value of "0" or less disables the cap.

      Returns:
      The annotation value.
      Default:
      ""

    • maxCount

      String maxCount
      Maximum allowed wire-declared element count (file/row-group row counts, column-chunk value counts) when parsing.

      Guards against malformed or adversarial input where a small footer declares a huge row or value count. Default is "10000000" (10 million). A value of "0" or less disables the cap.

      Returns:
      The annotation value.
      Default:
      ""

    • maxInputLength

      String maxInputLength
      Maximum allowed size (in bytes) of the whole Parquet input buffered into memory before parsing.

      Guards against an oversized input being buffered unbounded into memory. Default is "268435456" (256 MiB). A value of "0" or less disables the cap.

      Returns:
      The annotation value.
      Default:
      ""

    • maxDecompressedBytes

      String maxDecompressedBytes
      Maximum allowed aggregate decompressed-byte total across every Parquet page read during a single parse.

      Guards against a decompression bomb assembled from many pages that each individually pass the per-page maxLength() cap. Default is "67108864" (64 MiB). A value of "0" or less disables the cap.

      Returns:
      The annotation value.
      Default:
      ""

    • rank

      int rank
      Rank for application order.
      Default:
      0