Package com.clickhouse.data

Interface ClickHouseDataConfig

All Superinterfaces:
Serializable
All Known Implementing Classes:
ClickHouseDataConfig.Wrapped, ClickHouseDataProcessor.UseObjectConfig
public interface ClickHouseDataConfig extends Serializable

  • Field Details

  • Method Details

    • getBufferSize

      static int getBufferSize(int bufferSize)
      Gets buffer size. Same as getBufferSize(bufferSize, DEFAULT_BUFFER_SIZE, DEFAULT_MAX_BUFFER_SIZE).
      Parameters:
      bufferSize - suggested buffer size, zero or negative number is treated as DEFAULT_BUFFER_SIZE
      Returns:
      buffer size

    • getBufferSize

      static int getBufferSize(int bufferSize, int defaultSize, int maxSize)
      Gets buffer size.
      Parameters:
      bufferSize - suggested buffer size, zero or negative number is treated as defaultSize
      defaultSize - default buffer size, zero or negative number is treated as DEFAULT_BUFFER_SIZE
      maxSize - maximum buffer size, zero or negative number is treated as DEFAULT_MAX_BUFFER_SIZE
      Returns:
      buffer size

    • getDefaultReadBufferSize

      static int getDefaultReadBufferSize()
      Gets default read buffer size in byte. Same as getBufferSize(DEFAULT_READ_BUFFER_SIZE, DEFAULT_BUFFER_SIZE, DEFAULT_MAX_BUFFER_SIZE).
      Returns:
      default read buffer size in byte

    • getFormat

      default ClickHouseFormat getFormat()
      Gets data format.
      Returns:
      non-null data format

    • getBufferQueueVariation

      default int getBufferQueueVariation()
      Gets number of times the buffer queue is filled up before increasing capacity of buffer queue. Zero or negative value means the queue length is fixed.
      Returns:
      variation

    • getBufferSize

      default int getBufferSize()
      Gets buffer size in byte can be used for streaming.
      Returns:
      buffer size in byte

    • getMaxBufferSize

      default int getMaxBufferSize()
      Gets max buffer size in byte can be used for streaming.
      Returns:
      max buffer size in byte

    • getReadBufferSize

      default int getReadBufferSize()
      Gets read buffer size in byte.
      Returns:
      read buffer size in byte

    • getWriteBufferSize

      default int getWriteBufferSize()
      Gets write buffer size in byte.
      Returns:
      write buffer size in byte

    • getMaxQueuedBuffers

      default int getMaxQueuedBuffers()
      Gets maximum number of buffers can be queued for processing.
      Returns:
      maximum number of buffers can be queued

    • getReadBufferingMode

      default ClickHouseBufferingMode getReadBufferingMode()
      Gets buffering mode for reading.
      Returns:
      non-null buffering mode for reading

    • getWriteBufferingMode

      default ClickHouseBufferingMode getWriteBufferingMode()
      Gets buffering mode for writing.
      Returns:
      non-null buffering mode for writing

    • getColumnRenameMethod

      default ClickHouseRenameMethod getColumnRenameMethod()
      Gets column rename method.
      Returns:
      non-null column rename method

    • isAsync

      default boolean isAsync()
      Checks whether async call is used.
      Returns:
      true if async call is used; false otherwise

    • isReuseValueWrapper

      default boolean isReuseValueWrapper()
      Checks whether value wrapper ClickHouseValue should be reused.
      Returns:
      true if value wrapper will be reused; false otherwise

    • isUseBinaryString

      default boolean isUseBinaryString()
      Checks whether binary string is supported.
      Returns:
      true if binary string is supported; false otherwise

    • isUseBlockingQueue

      default boolean isUseBlockingQueue()
      Checks whether blocking queue(mainly for piped stream) is used or not.
      Returns:
      true if blocking queue is used; false indicates that non-blocking queue is used(faster but consumed more CPU)

    • isUseObjectsInArray

      default boolean isUseObjectsInArray()
      Checks whether object(instead of primitive) is used in array.
      Returns:
      true if object is used in array; false indicates that primitive type is used(no auto-boxing and less memory footprint)

    • isWidenUnsignedTypes

      default boolean isWidenUnsignedTypes()
      Checks whether widening is enabled for unsigned types, for instance: use long (instead of int) in Java to represent UInt32 in ClickHouse.
      Returns:
      true if widening is enabled; false indicates that same type is shared by signed and unsigned types(e.g. int for both Int32 and UInt32)

    • getReadTimeout

      default int getReadTimeout()
      Gets read timeout in milliseconds.
      Returns:
      read time out in milliseconds

    • getWriteTimeout

      default int getWriteTimeout()
      Gets write timeout in milliseconds.
      Returns:
      write time out in milliseconds

    • getTimeZoneForDate

      TimeZone getTimeZoneForDate()
      Gets time zone for date values.
      Returns:
      time zone, could be null

    • getUseTimeZone

      TimeZone getUseTimeZone()
      Gets preferred time zone.
      Returns:
      non-null preferred time zone