Uses of Class org.apache.orc.OrcFile.WriterOptions (ORC Core 1.6.5 API)
Date: 2020-10-01

## Uses of Class
org.apache.orc.OrcFile.WriterOptions

- Packages that use OrcFile.WriterOptions
  Package | Description
  --- | ---
  org.apache.orc |
  org.apache.orc.impl |
  org.apache.orc.impl.writer |

- - ### Uses of OrcFile.WriterOptions in org.apache.orc

    Methods in org.apache.orc that return OrcFile.WriterOptions
    Modifier and Type | Method and Description
    --- | ---
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`blockPadding(boolean value)` Sets whether the HDFS blocks are padded to prevent stripes from straddling blocks.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`blockSize(long value)` Set the file system block size for the file.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`bloomFilterColumns(String columns)` Comma separated values of column names for which bloom filter is to be created.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`bloomFilterFpp(double fpp)` Specify the false positive probability for bloom filter.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`bloomFilterVersion(OrcFile.BloomFilterVersion version)` Set the version of the bloom filters to write.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`bufferSize(int value)` The size of the memory buffers used for compressing and storing the stripe in memory.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`callback(OrcFile.WriterCallback callback)` Add a listener for when the stripe and file are about to be closed.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`clone()`
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`compress(CompressionKind value)` Sets the generic compression that is used to compress the data.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`directEncodingColumns(String value)` Set the comma-separated list of columns that should be direct encoded.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`encodingStrategy(OrcFile.EncodingStrategy strategy)` Sets the encoding strategy that is used to encode the data.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`encrypt(String value)` Encrypt a set of columns with a key.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`enforceBufferSize()` Enforce writer to use requested buffer size instead of estimating buffer size based on stripe size and number of columns.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`fileSystem(FileSystem value)` Provide the filesystem for the path, if the client has it available.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`masks(String value)` Set the masks for the unencrypted data.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`memory(MemoryManager value)` A package local option to set the memory manager.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`overwrite(boolean value)` If the output file already exists, should it be overwritten? If it is not provided, write operation will fail if the file already exists.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`paddingTolerance(double value)` Sets the tolerance for block padding as a percentage of stripe size.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`physicalWriter(PhysicalWriter writer)` Change the physical writer of the ORC file.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`rowIndexStride(int value)` Set the distance between entries in the row index.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`setKeyProvider(KeyProvider provider)` Set the key provider for column encryption.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`setKeyVersion(String keyName, int version, EncryptionAlgorithm algorithm)` For users that need to override the current version of a key, this method allows them to define the version and algorithm for a given key.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`setProlepticGregorian(boolean newValue)` Should the writer use the proleptic Gregorian calendar for times and dates.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`setSchema(TypeDescription schema)` Set the schema for the file.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`setShims(HadoopShims value)` Set the HadoopShims to use.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`stripeSize(long value)` Set the stripe size for the file.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`useUTCTimestamp(boolean value)` Manually set the time zone for the writer to utc.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`version(OrcFile.Version value)` Sets the version of the file that will be written.
    `static OrcFile.WriterOptions` | OrcFile.`writerOptions(Configuration conf)` Create a set of writer options based on a configuration.
    `static OrcFile.WriterOptions` | OrcFile.`writerOptions(Properties tableProperties, Configuration conf)` Create a set of write options based on a set of table properties and configuration.
    `protected OrcFile.WriterOptions` | OrcFile.WriterOptions.`writerVersion(OrcFile.WriterVersion version)` Manually set the writer version.
    `OrcFile.WriterOptions` | OrcFile.WriterOptions.`writeVariableLengthBlocks(boolean value)` Should the ORC file writer use HDFS variable length blocks, if they are available?

    Methods in org.apache.orc with parameters of type OrcFile.WriterOptions
    Modifier and Type | Method and Description
    --- | ---
    `static Writer` | OrcFile.`createWriter(Path path, OrcFile.WriterOptions opts)` Create an ORC file writer.
    `static List<Path>` | OrcFile.`mergeFiles(Path outputPath, OrcFile.WriterOptions options, List<Path> inputFiles)` Merges multiple ORC files that all have the same schema to produce a single ORC file.

  - ### Uses of OrcFile.WriterOptions in org.apache.orc.impl

    Constructors in org.apache.orc.impl with parameters of type OrcFile.WriterOptions
    Constructor and Description
    `PhysicalFsWriter(FileSystem fs, Path path, OrcFile.WriterOptions opts)`
    `PhysicalFsWriter(FileSystem fs, Path path, OrcFile.WriterOptions opts, WriterEncryptionVariant[] encryption)`
    `WriterImpl(FileSystem fs, Path path, OrcFile.WriterOptions opts)`

  - ### Uses of OrcFile.WriterOptions in org.apache.orc.impl.writer

    Constructors in org.apache.orc.impl.writer with parameters of type OrcFile.WriterOptions
    Constructor and Description
    `WriterImplV2(FileSystem fs, Path path, OrcFile.WriterOptions opts)`

Copyright © 2013–2020 The Apache Software Foundation. All rights reserved.