Package org.apache.flink.state.forst

Interface ForStOptionsFactory

All Superinterfaces:
Serializable
All Known Subinterfaces:
ConfigurableForStOptionsFactory
@Experimental public interface ForStOptionsFactory extends Serializable
A factory for DBOptions and ColumnFamilyOptions to be passed to the ForStStateBackend. Options have to be created lazily by this factory, because the Options class is not serializable and holds pointers to native code.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.forstdb.ColumnFamilyOptions
    createColumnOptions(org.forstdb.ColumnFamilyOptions currentOptions, Collection<AutoCloseable> handlesToClose)
    This method should set the additional options on top of the current options object.
    org.forstdb.DBOptions
    createDBOptions(org.forstdb.DBOptions currentOptions, Collection<AutoCloseable> handlesToClose)
    This method should set the additional options on top of the current options object.
    default ForStNativeMetricOptions
    createNativeMetricsOptions(ForStNativeMetricOptions nativeMetricOptions)
    This method should enable certain ForSt metrics to be forwarded to Flink's metrics reporter.
    default org.forstdb.ReadOptions
    createReadOptions(org.forstdb.ReadOptions currentOptions, Collection<AutoCloseable> handlesToClose)
    This method should set the additional options on top of the current options object.
    default org.forstdb.WriteOptions
    createWriteOptions(org.forstdb.WriteOptions currentOptions, Collection<AutoCloseable> handlesToClose)
    This method should set the additional options on top of the current options object.

  • Method Details

    • createDBOptions

      org.forstdb.DBOptions createDBOptions(org.forstdb.DBOptions currentOptions, Collection<AutoCloseable> handlesToClose)
      This method should set the additional options on top of the current options object. The current options object may contain pre-defined options based on flags that have been configured on the state backend.

      It is important to set the options on the current object and return the result from the setter methods, otherwise the pre-defined options may get lost.

      Parameters:
      currentOptions - The options object with the pre-defined options.
      handlesToClose - The collection to register newly created RocksObjects.
      Returns:
      The options object on which the additional options are set.

    • createColumnOptions

      org.forstdb.ColumnFamilyOptions createColumnOptions(org.forstdb.ColumnFamilyOptions currentOptions, Collection<AutoCloseable> handlesToClose)
      This method should set the additional options on top of the current options object. The current options object may contain pre-defined options based on flags that have been configured on the state backend.

      It is important to set the options on the current object and return the result from the setter methods, otherwise the pre-defined options may get lost.

      Parameters:
      currentOptions - The options object with the pre-defined options.
      handlesToClose - The collection to register newly created RocksObjects.
      Returns:
      The options object on which the additional options are set.

    • createNativeMetricsOptions

      default ForStNativeMetricOptions createNativeMetricsOptions(ForStNativeMetricOptions nativeMetricOptions)
      This method should enable certain ForSt metrics to be forwarded to Flink's metrics reporter.

      Enabling these monitoring options may degrade ForSt performance and should be set with care.

      Parameters:
      nativeMetricOptions - The options object with the pre-defined options.
      Returns:
      The options object on which the additional options are set.

    • createWriteOptions

      default org.forstdb.WriteOptions createWriteOptions(org.forstdb.WriteOptions currentOptions, Collection<AutoCloseable> handlesToClose)
      This method should set the additional options on top of the current options object. The current options object may contain pre-defined options based on flags that have been configured on the state backend.

      It is important to set the options on the current object and return the result from the setter methods, otherwise the pre-defined options may get lost.

      Parameters:
      currentOptions - The options object with the pre-defined options.
      handlesToClose - The collection to register newly created RocksObjects.
      Returns:
      The options object on which the additional options are set.

    • createReadOptions

      default org.forstdb.ReadOptions createReadOptions(org.forstdb.ReadOptions currentOptions, Collection<AutoCloseable> handlesToClose)
      This method should set the additional options on top of the current options object. The current options object may contain pre-defined options based on flags that have been configured on the state backend.

      It is important to set the options on the current object and return the result from the setter methods, otherwise the pre-defined options may get lost.

      Parameters:
      currentOptions - The options object with the pre-defined options.
      handlesToClose - The collection to register newly created RocksObjects.
      Returns:
      The options object on which the additional options are set.