• Home
• dev.responsive
• kafka-client
• 0.28.0
• source code
• RemoteWindowedTable.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

dev.responsive.kafka.internal.db.RemoteWindowedTable Maven / Gradle / Ivy

/*
 * Copyright 2023 Responsive Computing, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package dev.responsive.kafka.internal.db;

import dev.responsive.kafka.internal.utils.WindowedKey;
import org.apache.kafka.common.utils.Bytes;
import org.apache.kafka.streams.state.KeyValueIterator;

public interface RemoteWindowedTable extends RemoteTable {

  /**
   * Initializes the table by setting the metadata fields to
   * their initialized values.
   *
   * @return a {@link WindowFlushManager} that gives the callee access
   * to run statements on {@code table}
   */
  WindowFlushManager init(
      final int kafkaPartition
  );

  /**
   * Retrieves the value of the given {@code kafkaPartition} and {@code key}.
   *
   * @param kafkaPartition  the kafka partition
   * @param key             the data key
   * @param windowStart     the start time of the window
   *
   * @return the value previously set
   */
  byte[] fetch(
      int kafkaPartition,
      Bytes key,
      long windowStart
  );

  /**
   * Retrieves the range of windows of the given {@code kafkaPartition} and {@code key} with a
   * start time between {@code timeFrom} and {@code timeTo}.
   *
   * @param kafkaPartition the kafka partition
   * @param key            the data key
   * @param timeFrom       the min timestamp (inclusive)
   * @param timeTo         the max timestamp (inclusive)
   *
   * @return a forwards iterator over the retrieved windows and values previously set
   */
  KeyValueIterator fetch(
      int kafkaPartition,
      Bytes key,
      long timeFrom,
      long timeTo
  );

  /**
   * Retrieves the range of windows of the given {@code kafkaPartition} and {@code key} with a
   * start time between {@code timeFrom} and {@code timeTo}.
   *
   * @param kafkaPartition the kafka partition
   * @param key            the data key
   * @param timeFrom       the min timestamp (inclusive)
   * @param timeTo         the max timestamp (inclusive)
   *
   * @return a backwards iterator over the retrieved windows and values previously set
   */
  KeyValueIterator backFetch(
      int kafkaPartition,
      Bytes key,
      long timeFrom,
      long timeTo
  );

  /**
   * Retrieves the range of windows of the given {@code kafkaPartition} for all keys
   * between {@code fromKey} and {@code toKey} with a start time between {@code timeFrom}
   * and {@code timeTo}.
   *
   * @param kafkaPartition the kafka partition
   * @param fromKey        the min data key (inclusive)
   * @param toKey          the max data key (inclusive)
   * @param timeFrom       the min timestamp (inclusive)
   * @param timeTo         the max timestamp (inclusive)
   *
   * @return a forwards iterator over the retrieved windows and values previously set
   */
  KeyValueIterator fetchRange(
      int kafkaPartition,
      Bytes fromKey,
      Bytes toKey,
      long timeFrom,
      long timeTo
  );

  /**
   * Retrieves the range of windows of the given {@code kafkaPartition} for all keys
   * between {@code fromKey} and {@code toKey} with a start time between {@code timeFrom}
   * and {@code timeTo}.
   *
   * @param kafkaPartition the kafka partition
   * @param fromKey        the min data key (inclusive)
   * @param toKey          the max data key (inclusive)
   * @param timeFrom       the min timestamp (inclusive)
   * @param timeTo         the max timestamp (inclusive)
   *
   * @return a backwards iterator over the retrieved windows and values previously set
   */
  KeyValueIterator backFetchRange(
      int kafkaPartition,
      Bytes fromKey,
      Bytes toKey,
      long timeFrom,
      long timeTo
  );

  /**
   * Retrieves the windows of the given {@code kafkaPartition} across all keys and with a
   * start time between {@code timeFrom} and {@code timeTo}.
   *
   * @param kafkaPartition the partition
   * @param timeFrom       the min timestamp (inclusive)
   * @param timeTo         the max timestamp (inclusive)
   *
   * @return a forwards iterator over the retrieved windows and values previously set
   */
  KeyValueIterator fetchAll(
      int kafkaPartition,
      long timeFrom,
      long timeTo
  );

  /**
   * Retrieves the windows of the given {@code kafkaPartition} across all keys and with a
   * start time between {@code timeFrom} and {@code timeTo}.
   *
   * @param kafkaPartition the partition
   * @param timeFrom       the min timestamp (inclusive)
   * @param timeTo         the max timestamp (inclusive)
   *
   * @return a backwards iterator over the retrieved windows and values previously set
   */
  KeyValueIterator backFetchAll(
      int kafkaPartition,
      long timeFrom,
      long timeTo
  );
}