Package io.deephaven.extensions.barrage.util

Interface StreamReaderOptions

All Known Implementing Classes:
BarrageSnapshotOptions, BarrageSubscriptionOptions
public interface StreamReaderOptions

  • Method Details

    • useDeephavenNulls

      boolean useDeephavenNulls()
      Returns:
      whether we encode the validity buffer to express null values or QueryConstants's NULL values.

    • columnConversionMode

      @FinalDefault @Deprecated default ColumnConversionMode columnConversionMode()
      Deprecated.
      Since 0.37.0 and is marked for removal. (Note, GWT does not support encoding this context via annotation values.)
      Returns:
      the conversion mode to use for object columns

    • batchSize

      int batchSize()
      Returns:
      the ideal number of records to send per record batch

    • maxMessageSize

      int maxMessageSize()
      Returns:
      the maximum number of bytes that should be sent in a single message.

    • columnsAsList

      default boolean columnsAsList()
      Some Flight clients cannot handle modifications that have irregular column counts. These clients request that the server wrap all columns in a list to enable each column having a variable length.
      Returns:
      true if the columns should be wrapped in a list

    • previewListLengthLimit

      default long previewListLengthLimit()
      The maximum length of any list / array to encode.
      • If zero, list lengths will not be limited.
      • If non-zero, the server will limit the length of any encoded list / array to the absolute value of the returned length.
      • If less than zero, the server will encode elements from the end of the list / array, rather than rom the beginning.

      Note: The server is unable to indicate when truncation occurs. To detect truncation request one more element than the maximum number you wish to display.

      Returns:
      the maximum length of any list / array to encode; zero means no limit; negative values indicate to treat the limit as a tail instead of a head