类全名:com.aliyun.hitsdb.client.TSDBClient

java.lang.Object

com.aliyun.hitsdb.client.TSDBClient

所有已实现的接口:

TSDBCloseableAutoCloseable

public class TSDBClient extends Object implements TSDB
构造器概要
构造器和说明
TSDBClient(TSDBConfig config)
方法概要
限定符和类型 方法和说明
void

close()

关闭时序引擎客户端。

void

close(boolean force)

关闭时序引擎客户端。

void

delete(Query query)

数据删除方法。目前该方法不生效!

void

deleteData(String metric, Date startDate, Date endDate)

删除数据。指定Metric,指定时间范围,删除符合条件的数据。

void

deleteData(String metric, long startTime, long endTime)

删除数据。指定Metric,指定时间范围,删除符合条件的数据。

void

deleteMeta(String metric, Map<String,String> tags)

删除时间线,并且删除时间线相关的所有数据。

void

deleteMeta(Timeline timeline)

删除时间线,并且删除时间线相关的所有数据。

List<TagResult>

dumpMeta(String tagkey, String tagValuePrefix, int max)

获取Tag相关信息。

List<QueryResult>

last(Query query,int num)

查询数据方法。

List<LastDPValue>

lastdp(Collection<Timeline> timelines)

返回某个时间线上的最后一个值。

List<LastDPValue>

lastdp(Timeline… timelines)

返回某个时间线上的最后一个值。

void

put(Point… points)

异步的将时间点写入时序引擎。

void

put(Point point)

异步的将时间点写入时序引擎。

put(Point point)
<T extends Result>T

putSync(Class<T> resultType, Collection<Point> points)

同步的将时间点写入时序引擎。

<T extends Result>T

putSync(Class<T> resultType, Point… points)

同步的将时间点写入时序引擎

Result

putSync(Collection<Point> points)

同步的将时间点写入时序引擎

<T extends Result>T

putSync(Collection<Point> points, Class<T> resultType)

同步的将时间点写入时序引擎。

Result

putSync(Point… points)

同步的将时间点写入时序引擎。

List<QueryResult>

query(Query query)

查询数据方法

void

query(Query query, QueryCallback callback)

查询数据方法

List<String>

suggest(Suggest type, String prefix, int max)

该方法用于查询数据符合条件的metric列表

int

ttl()

获取ttl数值的方法。单位:秒

void

ttl(int lifetime)

设置ttl数值的方法。单位:秒

void

ttl(int lifetime,TimeUnit unit)

从类继承的方法 java.lang.Object

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

构造器详细资料

TSDBClient
public TSDBClient(TSDBConfig config) throws HttpClientInitException
  • 抛出:
HttpClientInitException

方法详细资料

close
public void close() throws IOException

close

public void close(boolean force) throws IOException

关闭时序引擎实例。该方法在程序结束前调用。

  • 指定者:
    • close 在接口中 TSDB
  • 参数:
    • force - true or false
  • 抛出:
    • IOException - exception

deleteData

public void deleteData(String metric, long startTime, long endTime)
  • 指定者:
    • deleteData 在接口中 TSDB
  • 参数:
    • metric - metric
    • startTime - start timestamp
    • endTime - end timestamp

deleteData

public void deleteData(String metric, Date startDate, Date endDate)

指定Metric,指定时间范围内的数据都删除。

  • 指定者:
    • deleteData 在接口中 TSDB
  • 参数:
    • metric - metric name
    • startDate - start date
    • endDate - end date

deleteMeta

public void deleteMeta(String metric,Map<String,String> tags)

删除时间线数据。

  • 指定者:
    • deleteMeta 在接口中 TSDB
  • 参数
    • metric - Metric,度量名称,指标名称t
    • tags - 以Map表示的Tag键值对。

deleteMeta

public void deleteMeta(Timeline timeline)

删除时间线数据。/div>

  • 指定者:
    • deleteMeta 在接口中 TSDB
  • 参数
    • deleteMeta 在接口中 TSDB
    • timeline - Timeline 时间线类的实例。

dumpMeta

public List<TagResult> dumpMeta(String tagkey, String tagValuePrefix, int max)

获取符合条件的Tag列表

  • 指定者:
    • dumpMeta 在接口中 TSDB
  • 参数
    • tagkey - Tag的名称
    • tagValuePrefix - Tag值的前缀
    • max - 最大数量
  • 返回:
    • the List of the TagResult

put

public void put(Point point)

异步写数据

  • 指定者:
    • put 在接口中 TSDB
  • 参数
    • point - 时间点

query

public List<QueryResult> query(Query query)

查询数据

  • 指定者:
    • query 在接口中 TSDB
  • 参数
    • query - Query 查询类实例
  • 返回
    • result : QueryResult 查询结果类的实例。

query

public void query(QueryQueryCallback

异步查询方法,查询结果在回调中返回。

  • 指定者:
    • query 在接口中 TSDB
  • 参数
    • query - Query 查询类实例
    • callback - 查询回调接口的实例。查询结果会在回调方法中异步返回。

suggest

public List<String> suggest(Suggest type, String prefix, int max)

suggest method

  • 指定者:
    • suggest 在接口中 TSDB
  • 参数
    • type - 数据类型
    • prefix - 前缀
    • max - 最大数量
  • 返回:
    • result

ttl

public int ttl()

获取TTL数值。单位:秒

  • 指定者:
    • suggest 在接口中 TSDB
  • 返回:
    • ttl值,单位为秒。

ttl

public void ttl(int lifetime)

设置TTL数值。

  • 指定者:
    • ttl 在接口中 TSDB
  • 参数:
    • lifetime - ttl的数值。单位为秒。

ttl

public void ttl(int lifetime, TimeUnit unit)
  • 指定者:
    • ttl 在接口中 TSDB
  • 参数:
    • lifetime - ttl的数值。
    • unit - ttl的单位。

last

public List<QueryResult> last(Query query, int num) throws HttpUnknowStatusException
  • 指定者:
    • last 在接口中 TSDB
  • 参数:
    • query - Query 查询类实例。
    • num - 需要的查询结果中时间线上最后点的个数
  • 返回:
    • 查询结果列表
  • 抛出:
    • HttpUnknowStatusException - Exception

putSync

public Result putSync(Collection<Point> points)

同步写入时间点

  • 指定者:
    • putSync 在接口中 TSDB
  • 参数:
    • points - 时间点数量。
  • 返回:
    • Result实例。该对象无实际作用,只是用来表示方法返回了。

putSync

public <T extends Result> T putSync(Collection<Point> points, Class<T> resultType)

同步写入方法

  • 指定者:
    • putSync 在接口中 TSDB
  • 类型参数:
    • T - Result.class, SummaryResult.class, DetailsResult.class
  • 参数:
    • points - 时间点的集合。
    • resultType - 结果类型
  • 返回:
    • Result实例。

delete

public void delete(Query query) throws HttpUnknowStatusException

删除方法,该方法尚未生效。

  • 指定者:
    • delete 在接口中 TSDB
  • 参数:
    • query - query
  • 抛出:
    • HttpUnknowStatusException - Exception

lastdp

public List<LastDPValue> lastdp(Collection<Timeline> timelines) throws HttpUnknowStatusException

获取指定时间线上的最后一个数据点。

  • 指定者:
    • lastdp 在接口中 TSDB
  • 参数:
    • timelines - Timelines实例。
  • 返回
    • 结果
  • 抛出:
    • HttpUnknowStatusException - Exception

lastdp

public List<LastDPValue> lastdp(Timeline… timelines) throws HttpUnknowStatusException

获取指定时间线上的最后一个数据点。

  • 指定者:
    • lastdp 在接口中 TSDB
  • 参数:
    • timelines - 时间线的值。
  • 返回
    • List
  • 抛出:
    • HttpUnknowStatusException - Exception

put

public void put(Point… points)

异步写时间点指定者:

  • 指定者:
    • put 在接口中 TSDB
  • 参数:
    • points - 时间点集合

putSync

public Result putSync(Point… points)

同步写时间点

  • 指定者:
    • putSync 在接口中 TSDB
  • 参数:
    • points - 时间点集合
  • 返回:
    • Result

putSync

public <T extends Result> T putSync(Class<T> resultType, Collection<Point> points)

同步写

  • 指定者:
    • putSync 在接口中 TSDB
  • 类型参数
    • T - Result.class, SummaryResult.class, DetailsResult.class
  • 参数:
    • resultType - 结果类型
    • points - 时间点集合
  • 返回:
    • Result

putSync

public <T extends Result> T putSync(Class<T> resultType, Point… points)

同步写方法

  • 指定者:
    • putSync 在接口中 TSDB
  • 类型参数
    • T - Result.class, SummaryResult.class, DetailsResult.class
  • 参数:
    • resultType - 结果类型
    • points - 时间点集合
  • 返回:
    • Result