Package org.apache.flink.table.runtime.operators.join.stream.state

Interface JoinRecordStateView

  • All Known Subinterfaces:
    OuterJoinRecordStateView
    public interface JoinRecordStateView
    A JoinRecordStateView is a view to the join state. It encapsulates the join state and provides some APIs facing the input records. The join state is used to store input records. The structure of the join state is vary depending on the JoinInputSideSpec.

    For example: when the JoinInputSideSpec is JoinKeyContainsUniqueKey, we will use ValueState to store records which has better performance.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addRecord​(org.apache.flink.table.data.RowData record)
      Add a new record to the state view.
      Iterable<org.apache.flink.table.data.RowData> getRecords()
      Gets all the records under the current context (i.e. join key).
      void retractRecord​(org.apache.flink.table.data.RowData record)
      Retract the record from the state view.

    • Method Detail

      • addRecord

        void addRecord​(org.apache.flink.table.data.RowData record)
        throws Exception
        Add a new record to the state view.
        Throws:
        Exception

      • retractRecord

        void retractRecord​(org.apache.flink.table.data.RowData record)
            throws Exception
        Retract the record from the state view.
        Throws:
        Exception

      • getRecords

        Iterable<org.apache.flink.table.data.RowData> getRecords()
                                                  throws Exception
        Gets all the records under the current context (i.e. join key).
        Throws:
        Exception