Package org.apache.beam.sdk.io.gcp.spanner.changestreams.dao

Class PartitionMetadataAdminDao

  • public class PartitionMetadataAdminDao
extends java.lang.Object
    Data access object for creating and dropping the partition metadata table.

    The partition metadata table will be used to keep the state of a partition as the Connector is performing change stream queries.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String COLUMN_CREATED_AT
      Metadata table column name for the timestamp at which the partition row was first created.
      static java.lang.String COLUMN_END_TIMESTAMP
      Metadata table column name for the timestamp to end the change stream query of the partition.
      static java.lang.String COLUMN_FINISHED_AT
      Metadata table column name for the timestamp at which the partition was marked as finished by the ReadChangeStreamPartitionDoFn SDF.
      static java.lang.String COLUMN_HEARTBEAT_MILLIS
      Metadata table column name for the change stream query heartbeat interval in millis.
      static java.lang.String COLUMN_PARENT_TOKENS
      Metadata table column name for parent partition tokens.
      static java.lang.String COLUMN_PARTITION_TOKEN
      Metadata table column name for the partition token.
      static java.lang.String COLUMN_RUNNING_AT
      Metadata table column name for the timestamp at which the partition was marked as running by the ReadChangeStreamPartitionDoFn SDF.
      static java.lang.String COLUMN_SCHEDULED_AT
      Metadata table column name for the timestamp at which the partition was scheduled by the DetectNewPartitionsDoFn SDF.
      static java.lang.String COLUMN_START_TIMESTAMP
      Metadata table column name for the timestamp to start the change stream query of the partition.
      static java.lang.String COLUMN_STATE
      Metadata table column name for the state that the partition is currently in.
      static java.lang.String COLUMN_WATERMARK
      Metadata table column name for the current watermark of the partition.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void createPartitionMetadataTable()
      Creates the metadata table in the given instance, database configuration, with the constructor specified table name.
      void deletePartitionMetadataTable()
      Drops the metadata table.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • COLUMN_PARTITION_TOKEN

        public static final java.lang.String COLUMN_PARTITION_TOKEN
        Metadata table column name for the partition token.
        See Also:
        Constant Field Values

      • COLUMN_PARENT_TOKENS

        public static final java.lang.String COLUMN_PARENT_TOKENS
        Metadata table column name for parent partition tokens.
        See Also:
        Constant Field Values

      • COLUMN_START_TIMESTAMP

        public static final java.lang.String COLUMN_START_TIMESTAMP
        Metadata table column name for the timestamp to start the change stream query of the partition.
        See Also:
        Constant Field Values

      • COLUMN_END_TIMESTAMP

        public static final java.lang.String COLUMN_END_TIMESTAMP
        Metadata table column name for the timestamp to end the change stream query of the partition.
        See Also:
        Constant Field Values

      • COLUMN_HEARTBEAT_MILLIS

        public static final java.lang.String COLUMN_HEARTBEAT_MILLIS
        Metadata table column name for the change stream query heartbeat interval in millis.
        See Also:
        Constant Field Values

      • COLUMN_STATE

        public static final java.lang.String COLUMN_STATE
        Metadata table column name for the state that the partition is currently in. Possible states can be seen in PartitionMetadata.State.
        See Also:
        Constant Field Values

      • COLUMN_WATERMARK

        public static final java.lang.String COLUMN_WATERMARK
        Metadata table column name for the current watermark of the partition.
        See Also:
        Constant Field Values

      • COLUMN_CREATED_AT

        public static final java.lang.String COLUMN_CREATED_AT
        Metadata table column name for the timestamp at which the partition row was first created.
        See Also:
        Constant Field Values

      • COLUMN_SCHEDULED_AT

        public static final java.lang.String COLUMN_SCHEDULED_AT
        Metadata table column name for the timestamp at which the partition was scheduled by the DetectNewPartitionsDoFn SDF.
        See Also:
        Constant Field Values

    • Method Detail

      • createPartitionMetadataTable

        public void createPartitionMetadataTable()
        Creates the metadata table in the given instance, database configuration, with the constructor specified table name. The operation is intended to complete in TIMEOUT_MINUTES minutes and specifies a TTL of partition rows after they are marked as FINISHED as TTL_AFTER_PARTITION_FINISHED_DAYS days.

      • deletePartitionMetadataTable

        public void deletePartitionMetadataTable()
        Drops the metadata table. This operation should complete in TIMEOUT_MINUTES minutes.