Class OrcDataWriter

Method Details

• writeImpl

  protected void writeImpl(Record record) throws Throwable

  Description copied from class: DataWriter

  Overridden by subclasses to write the specified record to this DataWriter.

  Contract for subclasses (see also docs/authoring/DataWriter.md):

  • Do not call this method directly — DataWriter.write(Record) is the template method that wraps exceptions, increments the record count, and attaches the offending record to thrown DataExceptions.
  • Do not call DataEndpoint.incrementRecordCount() here; DataWriter.write(Record) already does.
  • Throw raw exceptions; DataWriter.write(Record) wraps them via exception(throwable).setRecord(record).

  Specified by:

  writeImpl in class DataWriter

  Throws:

  Throwable

• open

  public void open() throws DataException

  Description copied from class: DataEndpoint

  Makes this endpoint ready for reading or writing.

  Overrides:

  open in class IntegrationWriter

  Throws:

  DataException

• close

  public void close() throws DataException

  Description copied from class: DataEndpoint

  Indicates that this endpoint has finished reading or writing.

  Overrides:

  close in class DataEndpoint

  Throws:

  DataException

• getSchema

  public TypeDescription getSchema()

  Indicates the schema used to write the file.

• setSchema

  public OrcDataWriter setSchema(TypeDescription schema)

  Indicates the schema used to write the file.

• getConfig

  public Configuration getConfig()

  Returns the Orc configuration parameters.

• setConfig

  public OrcDataWriter setConfig(Configuration config)

  Sets the Orc configuration parameters.

• getBatchSize

  public int getBatchSize()

  Indicates the maximum number of records to buffer when writing ORC data (default 1024).

• setBatchSize

  public OrcDataWriter setBatchSize(int batchSize)

  Indicates the maximum number of records to buffer when writing ORC data (default 1024).

• isUseTimestampInstant

  public boolean isUseTimestampInstant()

  Indicates if Instants should be used to store datetime values.

• setUseTimestampInstant

  public OrcDataWriter setUseTimestampInstant(boolean useTimestampInstant)

  Indicates if Instants should be used to store datetime values.

• isOverwrite

  public boolean isOverwrite()

  Overwrites the file if true, otherwise, throws an exception if the file already exists.

• setOverwrite

  public OrcDataWriter setOverwrite(boolean overwrite)

  Overwrites the file if true, otherwise, throws an exception if the file already exists.

• addExceptionProperties

  public DataException addExceptionProperties(DataException exception)

  Description copied from class: Endpoint

  Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

  Overrides:

  addExceptionProperties in class DataWriter

• isUTC

  public boolean isUTC()

  Indicates if datetime values are adjusted to UTC.

• setUTC

  public OrcDataWriter setUTC(boolean isUTC)

  Indicates if datetime values are adjusted to UTC.

• isWriteUuidAsString

  public boolean isWriteUuidAsString()

  Indicates whether UUID values are written as strings or bytes. If set to false, UUID values will be written as bytes.

  
  

  Default value is true.

• setWriteUuidAsString

  public OrcDataWriter setWriteUuidAsString(boolean writeUuidAsString)

  Indicates whether UUID values are written as strings or bytes. If set to false, UUID values will be written as bytes.

  
  

  Default value is true.

• getRowBatchVersion

  public RowBatchVersion getRowBatchVersion()

  Returns RowBatchVersion to store ORC data. precision > TypeDescription.MAX_DECIMAL64_PRECISION (18) then DecimalColumnVector is used instead of Decimal64ColumnVector.

• setRowBatchVersion

  public OrcDataWriter setRowBatchVersion(RowBatchVersion rowBatchVersion)

  Sets RowBatchVersion to store ORC data. If BigDecimal value has precision > TypeDescription.MAX_DECIMAL64_PRECISION (18) then DecimalColumnVector is used instead of Decimal64ColumnVector.

• getBigDecimalPrecision

  public int getBigDecimalPrecision()

  Returns default precision value for BigDecimal type of values. Default value is HiveDecimal.MAX_PRECISION (38).

• setBigDecimalPrecision

  public OrcDataWriter setBigDecimalPrecision(int bigDecimalPrecision)

  Sets default precision value for BigDecimal type of values. Default value is HiveDecimal.MAX_PRECISION (38).

• getBigDecimalScale

  public int getBigDecimalScale()

  Indicates the scale used when writing BigDecimal values (default 10).

• setBigDecimalScale

  public OrcDataWriter setBigDecimalScale(int bigDecimalScale)

  Indicates the scale used when writing BigDecimal values (default 10).

• getRoundingMode

  public RoundingMode getRoundingMode()

  Indicates the rounding algorithm used for all BigDecimal values (default is RoundingMode.HALF_UP).

• setRoundingMode

  public OrcDataWriter setRoundingMode(RoundingMode roundingMode)

  Indicates the rounding algorithm used for all BigDecimal values (default is RoundingMode.HALF_UP).

• getCompressionKind

  public CompressionKind getCompressionKind()

  Indicates the compression used for writing (default NONE).

• setCompressionKind

  public OrcDataWriter setCompressionKind(CompressionKind compressionKind)

  Indicates the compression used for writing (default NONE).

• getPath

  public Path getPath()

  Returns the Path of the ORC file being written.