parquet-wasm - v0.9.0
    Preparing search index...

    Class WriterPropertiesBuilder

    Builder to create a writing configuration for writeParquet

    Call build on the finished builder to create an immputable WriterProperties to pass to writeParquet

    Index
    • Returns void

    • Finalizes the configuration and returns immutable writer properties struct.

      Returns WriterProperties

    • Returns void

    • Sets flag to enable/disable dictionary encoding for a column. Takes precedence over globally defined settings.

      Parameters

      • col: string
      • value: boolean

      Returns WriterPropertiesBuilder

    • Sets encoding for a column. Takes precedence over globally defined settings.

      If dictionary is not enabled, this is treated as a primary encoding for this column. In case when dictionary is enabled for this column, either through global defaults or explicitly, this value is considered to be a fallback encoding for this column.

      Panics if user tries to set dictionary encoding here, regardless of dictionary encoding flag being set.

      Parameters

      Returns WriterPropertiesBuilder

    • EXPERIMENTAL: Enables content-defined chunking, which writes data pages at boundaries determined by the column values so that unchanged data produces identical bytes across file versions. Omitted options use the upstream defaults.

      Throws if:

      • minChunkSize is 0
      • maxChunkSize is not greater than minChunkSize

      Parameters

      Returns WriterPropertiesBuilder

    • Sets flag to enable/disable dictionary encoding for any column.

      Use this method to set dictionary encoding, instead of explicitly specifying encoding in set_encoding method.

      Parameters

      • value: boolean

      Returns WriterPropertiesBuilder

    • Sets encoding for any column.

      If dictionary is not enabled, this is treated as a primary encoding for all columns. In case when dictionary is enabled for any column, this value is considered to be a fallback encoding for that column.

      Panics if user tries to set dictionary encoding here, regardless of dictionary encoding flag being set.

      Parameters

      Returns WriterPropertiesBuilder