com.dtstack.dtcenter.loader.client.ITsdb Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 com.dtstack.dtcenter.loader.client;

import com.dtstack.dtcenter.loader.dto.source.ISourceDTO;
import com.dtstack.dtcenter.loader.dto.tsdb.QueryResult;
import com.dtstack.dtcenter.loader.dto.tsdb.Suggest;
import com.dtstack.dtcenter.loader.dto.tsdb.TsdbPoint;
import com.dtstack.dtcenter.loader.dto.tsdb.TsdbQuery;

import java.util.Collection;
import java.util.List;
import java.util.Map;

/**
 * 提供 OpenTSDB 相关操作方法
 *
 * @author ：wangchuan
 * date：Created in 上午10:06 2021/6/23
 * company: www.dtstack.com
 */
public interface ITsdb {

    /**
     * 同步插入多个点位
     *
     * @param source 数据源信息
     * @param points 插入点位
     * @return Result 返回结果
     */
    Boolean putSync(ISourceDTO source, Collection points);

    /**
     * 查询
     *
     * @param source 数据源信息
     * @param query  查询条件
     * @return result 查询结果
     */
    List query(ISourceDTO source, TsdbQuery query);

    /**
     * 根据 metric 、开始时间、结束时间删除数据
     *
     * @param source    数据源信息
     * @param metric    metric 名称
     * @param startTime 开始时间
     * @param endTime   结束时间
     */
    Boolean deleteData(ISourceDTO source, String metric, long startTime, long endTime);

    /**
     * 根据 metric 、tags、开始时间、结束时间删除数据
     *
     * @param source    数据源信息
     * @param metric    metric 名称
     * @param tags      tags 集合
     * @param startTime 开始时间
     * @param endTime   结束时间
     */
    Boolean deleteData(ISourceDTO source, String metric, Map tags, long startTime, long endTime);

    /**
     * 根据 metric 、字段、开始时间、结束时间删除数据
     *
     * @param source    数据源信息
     * @param metric    metric 名称
     * @param fields    fields 集合
     * @param startTime 开始时间
     * @param endTime   结束时间
     */
    Boolean deleteData(ISourceDTO source, String metric, List fields, long startTime, long endTime);

    /**
     * 根据 metric 、tags、字段、开始时间、结束时间删除数据
     *
     * @param source    数据源信息
     * @param metric    metric 名称
     * @param tags      tags 集合
     * @param fields    fields 结合
     * @param startTime 开始时间
     * @param endTime   结束时间
     */
    Boolean deleteData(ISourceDTO source, String metric, Map tags, List fields, long startTime, long endTime);

    /**
     * 根据 metric 、tags删除数据
     *
     * @param source 数据源信息
     * @param metric metric 名称
     * @param tags   tags 集合
     */
    Boolean deleteMeta(ISourceDTO source, String metric, Map tags);

    /**
     * 根据 metric 、tags、fields删除数据
     *
     * @param source 数据源信息
     * @param metric metric 名称
     * @param tags   tags 集合
     * @param fields fields 集合
     */
    Boolean deleteMeta(ISourceDTO source, String metric, Map tags, List fields);

    /**
     * 根据 metric 、tags 删除数据
     *
     * @param source     数据源信息
     * @param metric     metric 名称
     * @param tags       tags 集合
     * @param deleteData 是否删除数据
     * @param recursive  递归删除
     */
    Boolean deleteMeta(ISourceDTO source, String metric, Map tags, boolean deleteData, boolean recursive);

    /**
     * 根据 metric 、tags 删除数据
     *
     * @param source     数据源信息
     * @param metric     metric 名称
     * @param fields     fields 集合
     * @param tags       tags 集合
     * @param deleteData 是否删除数据
     * @param recursive  递归删除
     */
    Boolean deleteMeta(ISourceDTO source, String metric, List fields, Map tags, boolean deleteData, boolean recursive);

    /**
     * suggest method
     *
     * @param source 数据源信息
     * @param type   suggest 类型
     * @param prefix 前缀匹配
     * @param max    最大返回条数
     * @return result 返回结果
     */
    List suggest(ISourceDTO source, Suggest type, String prefix, int max);

    /**
     * suggest method
     *
     * @param source 数据源信息
     * @param type   suggest 类型
     * @param metric metric 名称
     * @param prefix 前缀匹配
     * @param max    最大返回条数
     * @return result 返回结果
     */
    List suggest(ISourceDTO source, Suggest type, String metric, String prefix, int max);

    /**
     * 获取版本号
     *
     * @param source 数据源信息
     * @return 版本号
     */
    String version(ISourceDTO source);

    /**
     * 获取详细版本信息
     *
     * @param source 数据源信息
     * @return 详细版本信息
     */
    Map getVersionInfo(ISourceDTO source);
}