TSDBClient类API参考-时间序列数据库 TSDB-阿里云

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

java.lang.Object：com.aliyun.hitsdb.client.TSDBClient

所有已实现的接口：TSDB，Closeable，AutoCloseable

public class TSDBClient extends Objectimplements TSDB

构造器概要

构造器和说明

TSDBClient(TSDBConfig config)

构造器详细资料

TSDBClient

public TSDBClient(TSDBConfig config) throws HttpClientInitException

抛出：HttpClientInitException

方法概要

限定符和类型	方法和说明
`void`	`close()`，关闭TSDB客户端。详情请参见关闭TSDB客户端。
`void`	`close(boolean force)`，关闭TSDB客户端。详情请参见关闭TSDB客户端。
`void`	`delete(Query query)`，删除数据。详情请参见删除数据。注意目前该方法不生效。
`void`	`delete(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相关信息。详情请参见获取Tag相关信息。
`List<QueryResult>`	`last(Query query,int num)`，查询数据方法。详情请参见查询数据。
`<QueryResult>`	`lastdp(Collection<Timeline> timelines)`，查询某个时间线上的最后一个值。详情请参见查询某个时间线上的最后一个值。
`List<LastDPValue>`	`lastdp(Timeline… timelines)`，查询某个时间线上的最后一个值。详情请参见查询某个时间线上的最后一个值。
`void`	`put(Point… points)` 将时间点异步写入TSDB。详情请参见将时间点异步写入TSDB。
`void`	`put(Point point)` 将时间点异步写入TSDB。详情请参见将时间点异步写入TSDB。
`<T extends Result>T`	`putSync(Class<T> resultType, Collection<Point> points)` ，将时间点同步写入TSDB。详情请参见将时间点同步写入TSDB。
`<T extends Result>T`	`putSync(Class<T> resultType, Point… points)` ，将时间点同步写入TSDB。详情请参见将时间点同步写入TSDB。
`Result`	`putSync(Collection<Point> points)` ，将时间点同步写入TSDB。详情请参见将时间点同步写入TSDB。
`<T extends Result>T`	`putSync(Collection<Point> points, Class<T> resultType)` ，将时间点同步写入TSDB。详情请参见将时间点同步写入TSDB。
`Result`	`putSync(Point… points)` ，将时间点同步写入TSDB。详情请参见将时间点同步写入TSDB。
`List<QueryResult>`	`query(Query query)`，查询数据方法。详情请参见查询数据方法。
`void`	`query(Query query, QueryCallback callback)`，查询数据方法。详情请参见查询数据方法。
`List<String>`	`suggest(Suggest type, String prefix, int max)` ，查询符合条件的metric列表数据。详情请参见查询符合条件的metric列表数据。
`int`	`ttl()` 获取ttl数值的方法。单位：秒。详情请参见获取ttl数值的方法。
`void`	`ttl(int lifetime)` 获取ttl数值的方法。单位：秒。详情请参见获取ttl数值的方法。
`void`	`ttl(int lifetime,TimeUnit unit)` 获取ttl数值的方法。单位：秒。详情请参见获取ttl数值的方法。

关闭TSDB客户端

close
```
public void close() throws IOException
```
抛出：
IOException
close
```
public void close(boolean force) throws IOException
```
从接口复制的说明：TSDB关闭TSDB实例。该方法在程序结束前调用。
参数：
force - true or false
抛出：
IOException - exception

删除数据

delete
```
public void delete(Query query) throws HttpUnknowStatusException
```
从接口复制的说明： TSDB删除方法，该方法尚未生效。
参数：
query - query
抛出：
HttpUnknowStatusException - Exception
deleteData
```
public void deleteData(String metric, Date startDate, Date endDate)
```
从接口复制的说明： TSDB指定Metric，指定时间范围内的数据都删除。
参数：
metric - metric name
startDate - start date
endDate - end date
deleteData
```
public void deleteData(String metric, long startTime, long endTime)
```
参数：
metric - metric
startTime - start timestamp
endTime - end timestamp

删除时间线

deleteMeta
```
public void deleteMeta(String metric，Map<String,String> tags)
```
从接口复制的说明：TSDB删除时间线数据。
参数：
metric - Metric，度量名称，指标名称
tags - 以Map表示的Tag键值对。
deleteMeta
```
public void deleteMeta(Timeline timeline)
```
从接口复制的说明： TSDB删除时间线数据。
参数：
timeline - Timeline 时间线类的实例。

获取Tag相关信息

dumpMeta

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

从接口复制的说明： TSDB 获取符合条件的Tag列表

参数：: tagkey - Tag的名称; tagValuePrefix - Tag值的前缀; max - 最大数量
返回：: the List of the TagResult

查询数据

last

public List<QueryResult> last(Query query, int num) throws HttpUnknowStatusException

参数：: query - Query 查询类实例。; num - 需要的查询结果中时间线上最后点的个数
返回：: 查询结果列表
抛出：: HttpUnknowStatusException - Exception

查询某个时间线上的最后一个值

lastdp
```
public List<LastDPValue> lastdp(Collection<Timeline> timelines) throws HttpUnknowStatusException
```
从接口复制的说明： TSDB 获取指定时间线上的最后一个数据点。
参数：
timelines - Timelines实例。
返回：
List
抛出：
HttpUnknowStatusException - Exception
lastdp
```
public List<LastDPValue> lastdp(Timeline… timelines)                        throws HttpUnknowStatusException
```
从接口复制的说明： TSDB 获取指定时间线上的最后一个数据点。
参数：
timelines - 时间线的值。
返回：
List
抛出：
HttpUnknowStatusException - Exception

将时间点异步写入TSDB

put
```
public void put(Point… points)
```
从接口复制的说明： TSDB 异步写时间点
参数：
points - 时间点集合
put
```
public void put(Point point)
```
从接口复制的说明： TSDB 异步写数据
参数：
point - 时间点

将时间点同步写入TSDB

putSync
```
public <T extends Result> T putSync(Collection<Point> points, Class<T> resultType)
```
从接口复制的说明： TSDB 同步写入方法
类型参数：
T - Result.class, SummaryResult.class, DetailsResult.class
参数：
points - 时间点的集合
resultType - 结果类型
返回：
Result实例。
putSync
```
public <T extends Result> T putSync(Class<T> resultType,                                Point… points)
```
从接口复制的说明： TSDB 同步写方法
类型参数：
T - Result.class, SummaryResult.class, DetailsResult.class
参数：
resultType - 结果类型
points - 时间点集合
返回：
Result
putSync
```
public Result putSync(Collection<Point> points)
```
从接口复制的说明： TSDB 同步写入时间点
参数：
points - 时间点数量
返回：
Result实例。该对象无实际作用，只是用来表示方法返回了。
putSync
```
public <T extends Result> T putSync(Class<T> resultType,                                Collection<Point> points)
```
从接口复制的说明： TSDB同步写
类型参数：
T - Result.class, SummaryResult.class, DetailsResult.class
参数：
resultType - 结果类型
points - 时间点集合
返回：
Result
putSync
```
public Result putSync(Point… points)
```
从接口复制的说明： TSDB 同步写时间点
指定者：
putSync 在接口中 TSDB
参数：
points - 时间点集合
返回：
Result

查询数据方法

query
```
public List<QueryResult> query(Query query)
```
从接口复制的说明： TSDB 查询数据
参数：
query - Query 查询类实例
返回：
result：QueryResult 查询结果类的实例。
query
```
public void query(Query query, QueryCallback callback)
```
从接口复制的说明： TSDB 异步查询方法，查询结果在回调中返回。
参数：
query - Query 查询类实例
callback - 查询回调接口的实例。查询结果会在回调方法中异步返回。

查询符合条件的metric列表数据

suggest
```
public List<String> suggest(Suggest type, String prefix, int max)
```
从接口复制的说明： TSDB suggest method
参数：
type - 数据类型
prefix - 前缀
max - 最大数量
返回：
result

获取ttl数值的方法

ttl
```
public int ttl()
```
从接口复制的说明： TSDB 获取TTL数值。单位：秒
返回：
ttl值，单位为秒。
ttl
```
public void ttl(int lifetime)
```
从接口复制的说明： TSDB 设置TTL数值。
参数：
lifetime - ttl的数值。单位为秒。
ttl
```
public void ttl(int lifetime, TimeUnit unit)
```
参数：
lifetime - ttl的数值。
unit - ttl的单位。