ParquetWriter.Builder (Paimon : Format 0.9.0 API)

java.lang.Object
- org.apache.parquet.hadoop.ParquetWriter.Builder<T,SELF>

类型参数:

T - The type of objects written by the constructed ParquetWriter.

SELF - The type of this builder that is returned by builder methods

直接已知子类:

ParquetRowDataBuilder

封闭类:

ParquetWriter<T>
```
public abstract static class ParquetWriter.Builder<T,SELF extends ParquetWriter.Builder<T,SELF>>
extends Object
```
An abstract builder class for ParquetWriter instances.
Object models should extend this builder to provide writer configuration options.

构造器概要

构造器
限定符构造器和说明

protected Builder(org.apache.parquet.io.OutputFile path)

构造器
限定符	构造器和说明
`protected`	`Builder(org.apache.parquet.io.OutputFile path)`

方法概要

所有方法实例方法抽象方法具体方法已过时的方法
限定符和类型	方法和说明
`ParquetWriter<T>`	`build()` Build a `ParquetWriter` with the accumulated configuration.
`SELF`	`config(String property, String value)` Set a property that will be available to the read path.
`SELF`	`enableDictionaryEncoding()` Enables dictionary encoding for the constructed writer.
`SELF`	`enablePageWriteChecksum()` Enables writing page level checksums for the constructed writer.
`SELF`	`enableValidation()` Enables validation for the constructed writer.
`protected abstract org.apache.parquet.hadoop.api.WriteSupport<T>`	`getWriteSupport(org.apache.hadoop.conf.Configuration conf)`
`protected abstract SELF`	`self()`
`SELF`	`withBloomFilterEnabled(boolean enabled)` Sets the bloom filter enabled/disabled.
`SELF`	`withBloomFilterEnabled(String columnPath, boolean enabled)` Sets the bloom filter enabled/disabled for the specified column.
`SELF`	`withBloomFilterFPP(String columnPath, double fpp)`
`SELF`	`withBloomFilterNDV(String columnPath, long ndv)` Sets the NDV (number of distinct values) for the specified column.
`SELF`	`withByteStreamSplitEncoding(boolean enableByteStreamSplit)`
`SELF`	`withColumnIndexTruncateLength(int length)` Sets the length to be used for truncating binary values in a binary column index.
`SELF`	`withCompressionCodec(org.apache.parquet.hadoop.metadata.CompressionCodecName codecName)` Set the `compression codec` used by the constructed writer.
`SELF`	`withConf(org.apache.hadoop.conf.Configuration conf)` Set the `Configuration` used by the constructed writer.
`SELF`	`withDictionaryEncoding(boolean enableDictionary)` Enable or disable dictionary encoding for the constructed writer.
`SELF`	`withDictionaryEncoding(String columnPath, boolean enableDictionary)` Enable or disable dictionary encoding of the specified column for the constructed writer.
`SELF`	`withDictionaryPageSize(int dictionaryPageSize)` Set the Parquet format dictionary page size used by the constructed writer.
`SELF`	`withMaxPaddingSize(int maxPaddingSize)` Set the maximum amount of padding, in bytes, that will be used to align row groups with blocks in the underlying filesystem.
`SELF`	`withMaxRowCountForPageSizeCheck(int max)` Sets the maximum number of rows to write before a page size check is done.
`SELF`	`withMinRowCountForPageSizeCheck(int min)` Sets the minimum number of rows to write before a page size check is done.
`SELF`	`withPageRowCountLimit(int rowCount)` Sets the Parquet format page row count limit used by the constructed writer.
`SELF`	`withPageSize(int pageSize)` Set the Parquet format page size used by the constructed writer.
`SELF`	`withPageWriteChecksumEnabled(boolean enablePageWriteChecksum)` Enables writing page level checksums for the constructed writer.
`SELF`	`withRowGroupSize(int rowGroupSize)` 已过时。 Use `withRowGroupSize(long)` instead
`SELF`	`withRowGroupSize(long rowGroupSize)` Set the Parquet format row group size used by the constructed writer.
`SELF`	`withStatisticsTruncateLength(int length)` Sets the length which the min/max binary values in row groups are truncated to.
`SELF`	`withValidation(boolean enableValidation)` Enable or disable validation for the constructed writer.
`SELF`	`withWriteMode(org.apache.parquet.hadoop.ParquetFileWriter.Mode mode)` Set the `write mode` used when creating the backing file for this writer.
`SELF`	`withWriterVersion(org.apache.parquet.column.ParquetProperties.WriterVersion version)` Set the `format version` used by the constructed writer.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Builder
```
protected Builder(org.apache.parquet.io.OutputFile path)
```
- 方法详细资料
  - self
```
protected abstract SELF self()
```
    返回:
    
    this as the correct subclass of ParquetWriter.Builder.
  - getWriteSupport
```
protected abstract org.apache.parquet.hadoop.api.WriteSupport<T> getWriteSupport(org.apache.hadoop.conf.Configuration conf)
```
    参数:
    
    conf - a configuration
    
    返回:
    
    an appropriate WriteSupport for the object model.
  - withConf
```
public SELF withConf(org.apache.hadoop.conf.Configuration conf)
```
    Set the Configuration used by the constructed writer.
    
    参数:
    
    conf - a Configuration
    
    返回:
    
    this builder for method chaining.
  - withWriteMode
```
public SELF withWriteMode(org.apache.parquet.hadoop.ParquetFileWriter.Mode mode)
```
    Set the write mode used when creating the backing file for this writer.
    
    参数:
    
    mode - a ParquetFileWriter.Mode
    
    返回:
    
    this builder for method chaining.
  - withCompressionCodec
```
public SELF withCompressionCodec(org.apache.parquet.hadoop.metadata.CompressionCodecName codecName)
```
    Set the compression codec used by the constructed writer.
    
    参数:
    
    codecName - a CompressionCodecName
    
    返回:
    
    this builder for method chaining.
  - withRowGroupSize
```
@Deprecated
public SELF withRowGroupSize(int rowGroupSize)
```
    已过时。 Use withRowGroupSize(long) instead
    
    Set the Parquet format row group size used by the constructed writer.
    
    参数:
    
    rowGroupSize - an integer size in bytes
    
    返回:
    
    this builder for method chaining.
  - withRowGroupSize
```
public SELF withRowGroupSize(long rowGroupSize)
```
    Set the Parquet format row group size used by the constructed writer.
    
    参数:
    
    rowGroupSize - an integer size in bytes
    
    返回:
    
    this builder for method chaining.
  - withPageSize
```
public SELF withPageSize(int pageSize)
```
    Set the Parquet format page size used by the constructed writer.
    
    参数:
    
    pageSize - an integer size in bytes
    
    返回:
    
    this builder for method chaining.
  - withPageRowCountLimit
```
public SELF withPageRowCountLimit(int rowCount)
```
    Sets the Parquet format page row count limit used by the constructed writer.
    
    参数:
    
    rowCount - limit for the number of rows stored in a page
    
    返回:
    
    this builder for method chaining
  - withDictionaryPageSize
```
public SELF withDictionaryPageSize(int dictionaryPageSize)
```
    Set the Parquet format dictionary page size used by the constructed writer.
    
    参数:
    
    dictionaryPageSize - an integer size in bytes
    
    返回:
    
    this builder for method chaining.
  - withMaxPaddingSize
```
public SELF withMaxPaddingSize(int maxPaddingSize)
```
    Set the maximum amount of padding, in bytes, that will be used to align row groups with blocks in the underlying filesystem. If the underlying filesystem is not a block filesystem like HDFS, this has no effect.
    
    参数:
    
    maxPaddingSize - an integer size in bytes
    
    返回:
    
    this builder for method chaining.
  - enableDictionaryEncoding
```
public SELF enableDictionaryEncoding()
```
    Enables dictionary encoding for the constructed writer.
    
    返回:
    
    this builder for method chaining.
  - withDictionaryEncoding
```
public SELF withDictionaryEncoding(boolean enableDictionary)
```
    Enable or disable dictionary encoding for the constructed writer.
    
    参数:
    
    enableDictionary - whether dictionary encoding should be enabled
    
    返回:
    
    this builder for method chaining.
  - withByteStreamSplitEncoding
```
public SELF withByteStreamSplitEncoding(boolean enableByteStreamSplit)
```
  - withDictionaryEncoding
```
public SELF withDictionaryEncoding(String columnPath,
                                   boolean enableDictionary)
```
    Enable or disable dictionary encoding of the specified column for the constructed writer.
    
    参数:
    
    columnPath - the path of the column (dot-string)
    
    enableDictionary - whether dictionary encoding should be enabled
    
    返回:
    
    this builder for method chaining.
  - enableValidation
```
public SELF enableValidation()
```
    Enables validation for the constructed writer.
    
    返回:
    
    this builder for method chaining.
  - withValidation
```
public SELF withValidation(boolean enableValidation)
```
    Enable or disable validation for the constructed writer.
    
    参数:
    
    enableValidation - whether validation should be enabled
    
    返回:
    
    this builder for method chaining.
  - withWriterVersion
```
public SELF withWriterVersion(org.apache.parquet.column.ParquetProperties.WriterVersion version)
```
    Set the format version used by the constructed writer.
    
    参数:
    
    version - a WriterVersion
    
    返回:
    
    this builder for method chaining.
  - enablePageWriteChecksum
```
public SELF enablePageWriteChecksum()
```
    Enables writing page level checksums for the constructed writer.
    
    返回:
    
    this builder for method chaining.
  - withPageWriteChecksumEnabled
```
public SELF withPageWriteChecksumEnabled(boolean enablePageWriteChecksum)
```
    Enables writing page level checksums for the constructed writer.
    
    参数:
    
    enablePageWriteChecksum - whether page checksums should be written out
    
    返回:
    
    this builder for method chaining.
  - withBloomFilterNDV
```
public SELF withBloomFilterNDV(String columnPath,
                               long ndv)
```
    Sets the NDV (number of distinct values) for the specified column.
    
    参数:
    
    columnPath - the path of the column (dot-string)
    
    ndv - the NDV of the column
    
    返回:
    
    this builder for method chaining.
  - withBloomFilterFPP
```
public SELF withBloomFilterFPP(String columnPath,
                               double fpp)
```
  - withBloomFilterEnabled
```
public SELF withBloomFilterEnabled(boolean enabled)
```
    Sets the bloom filter enabled/disabled.
    
    参数:
    
    enabled - whether to write bloom filters
    
    返回:
    
    this builder for method chaining
  - withBloomFilterEnabled
```
public SELF withBloomFilterEnabled(String columnPath,
                                   boolean enabled)
```
    Sets the bloom filter enabled/disabled for the specified column. If not set for the column specifically the default enabled/disabled state will take place. See withBloomFilterEnabled(boolean).
    
    参数:
    
    columnPath - the path of the column (dot-string)
    
    enabled - whether to write bloom filter for the column
    
    返回:
    
    this builder for method chaining
  - withMinRowCountForPageSizeCheck
```
public SELF withMinRowCountForPageSizeCheck(int min)
```
    Sets the minimum number of rows to write before a page size check is done.
    
    参数:
    
    min - writes at least `min` rows before invoking a page size check
    
    返回:
    
    this builder for method chaining
  - withMaxRowCountForPageSizeCheck
```
public SELF withMaxRowCountForPageSizeCheck(int max)
```
    Sets the maximum number of rows to write before a page size check is done.
    
    参数:
    
    max - makes a page size check after `max` rows have been written
    
    返回:
    
    this builder for method chaining
  - withColumnIndexTruncateLength
```
public SELF withColumnIndexTruncateLength(int length)
```
    Sets the length to be used for truncating binary values in a binary column index.
    
    参数:
    
    length - the length to truncate to
    
    返回:
    
    this builder for method chaining
  - withStatisticsTruncateLength
```
public SELF withStatisticsTruncateLength(int length)
```
    Sets the length which the min/max binary values in row groups are truncated to.
    
    参数:
    
    length - the length to truncate to
    
    返回:
    
    this builder for method chaining
  - config
```
public SELF config(String property,
                   String value)
```
    Set a property that will be available to the read path. For writers that use a Hadoop configuration, this is the recommended way to add configuration values.
    
    参数:
    
    property - a String property name
    
    value - a String property value
    
    返回:
    
    this builder for method chaining.
  - build
```
public ParquetWriter<T> build()
                       throws IOException
```
    Build a ParquetWriter with the accumulated configuration.
    
    返回:
    
    a configured ParquetWriter instance.
    
    抛出:
    
    IOException - if there is an error while creating the writer

类 ParquetWriter.Builder<T,SELF extends ParquetWriter.Builder<T,SELF>>

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Builder

方法详细资料

self

getWriteSupport

withConf

withWriteMode

withCompressionCodec

withRowGroupSize

withRowGroupSize

withPageSize

withPageRowCountLimit

withDictionaryPageSize

withMaxPaddingSize

enableDictionaryEncoding

withDictionaryEncoding

withByteStreamSplitEncoding

withDictionaryEncoding

enableValidation

withValidation

withWriterVersion

enablePageWriteChecksum

withPageWriteChecksumEnabled

withBloomFilterNDV

withBloomFilterFPP

withBloomFilterEnabled

withBloomFilterEnabled

withMinRowCountForPageSizeCheck

withMaxRowCountForPageSizeCheck

withColumnIndexTruncateLength

withStatisticsTruncateLength

config

build