Interface SourceDescription


  • public interface SourceDescription
    Metadata for a ksqlDB stream or table.
    • Method Detail

      • name

        String name()
        Returns:
        name of this stream/table
      • type

        String type()
        Returns:
        type of this source, i.e., whether this source is a stream or table
      • fields

        List<FieldInfo> fields()
        Returns:
        list of fields (key and value) present in this stream/table
      • topic

        String topic()
        Returns:
        name of the Kafka topic underlying this ksqlDB stream/table
      • keyFormat

        String keyFormat()
        Returns:
        key serialization format of the data in this stream/table
      • valueFormat

        String valueFormat()
        Returns:
        value serialization format of the data in this stream/table
      • readQueries

        List<QueryInfo> readQueries()
        Returns:
        list of ksqlDB queries currently reading from this stream/table
      • writeQueries

        List<QueryInfo> writeQueries()
        Returns:
        list of ksqlDB queries currently writing to this stream/table
      • timestampColumn

        Optional<String> timestampColumn()
        Returns:
        name of the column configured as the TIMESTAMP for this stream/table, if any
      • windowType

        Optional<String> windowType()
        Returns the type of the window (e.g., "TUMBLING", "HOPPING", "SESSION") associated with this source, if this source is a windowed table. Else, empty.
        Returns:
        type of the window, if applicable
      • sqlStatement

        String sqlStatement()
        Returns the ksqlDB statement text used to create this stream/table. This text may not be exactly the statement submitted in order to create this stream/table, but submitting this statement will result in exactly this stream/table being created.
        Returns:
        the ksqlDB statement text