com.pingcap.tikv.ReadOnlyPDClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tikv-client Show documentation

There is a newer version: 3.2.3

/*
 * Copyright 2017 PingCAP, 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,
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.pingcap.tikv;

import com.google.protobuf.ByteString;
import com.pingcap.tikv.meta.TiTimestamp;
import com.pingcap.tikv.region.TiRegion;
import com.pingcap.tikv.util.BackOffer;
import java.util.List;
import java.util.concurrent.Future;
import org.tikv.kvproto.Metapb.Store;

/** Readonly PD client including only reading related interface Supposed for TiDB-like use cases */
public interface ReadOnlyPDClient {
  /**
   * Get Timestamp from Placement Driver
   *
   * @return a timestamp object
   */
  TiTimestamp getTimestamp(BackOffer backOffer);

  /**
   * Get Region from PD by key specified
   *
   * @param key key in bytes for locating a region
   * @return the region whose startKey and endKey range covers the given key
   */
  TiRegion getRegionByKey(BackOffer backOffer, ByteString key);

  Future getRegionByKeyAsync(BackOffer backOffer, ByteString key);

  /**
   * Get Region by Region Id
   *
   * @param id Region Id
   * @return the region corresponding to the given Id
   */
  TiRegion getRegionByID(BackOffer backOffer, long id);

  Future getRegionByIDAsync(BackOffer backOffer, long id);

  /**
   * Get Store by StoreId
   *
   * @param storeId StoreId
   * @return the Store corresponding to the given Id
   */
  Store getStore(BackOffer backOffer, long storeId);

  Future getStoreAsync(BackOffer backOffer, long storeId);

  List getAllStores(BackOffer backOffer);
}