类全名：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)

方法概要


限定符和类型	方法和说明
`void`	`close()` 关闭TSDB客户端。
`void`	`close(boolean force)` 关闭TSDB客户端。
`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)` 查询数据方法。
`<QueryResult>`	`lastdp(Collection<Timeline> timelines)` 返回某个时间线上的最后一个值。
`List<LastDPValue>`	`lastdp(Timeline… timelines)`返回某个时间线上的最后一个值。
`void`	`put(Point… points)` 异步的将时间点写入TSDB。
`void`	`put(Point point)` 异步的将时间点写入TSDB。
`<T extends Result>T`	`putSync(Class<T> resultType, Collection<Point> points)` 同步的将时间点写入TSDB。
`<T extends Result>T`	`putSync(Class<T> resultType, Point… points)` 同步的将时间点写入TSDB。
`Result`	`putSync(Collection<Point> points)` 同步的将时间点写入TSDB。
`<T extends Result>T`	`putSync(Collection<Point> points, Class<T> resultType)` 同步的将时间点写入TSDB。
`Result`	`putSync(Point… points)`同步的将时间点写入TSDB。
`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

构造器详细资料

TSDBClient

public TSDBClient(TSDBConfig config) throws HttpClientInitException

抛出：HttpClientInitException

关闭TSDB客户端

close
```
public void close() throws IOException
```
指定者:

close在接口中Closeable

指定者:

close在接口中AutoCloseable

抛出:

IOException

关闭TSDB客户端

close
```
public void close(boolean force) throws IOException
```
从接口复制的说明: TSDB关闭TSDB实例。该方法在程序结束前调用。

指定者:

close在接口中TSDB

参数:

force - true or false

抛出:

IOException - exception

数据删除方法

delete
```
public void delete(Query query) throws HttpUnknowStatusException
```
从接口复制的说明: TSDB删除方法，该方法尚未生效。

指定者:

delete在接口中TSDB

参数:

query - query

抛出:

HttpUnknowStatusException - Exception

删除数据

deleteData
```
public void deleteData(String metric, Date startDate, Date endDate)
```
从接口复制的说明: TSDB指定Metric，指定时间范围内的数据都删除。

指定者:

deleteData在接口中TSDB

参数:

metric - metric name

startDate - start date

endDate - end date

删除数据

deleteData
```
public void deleteData(String metric, long startTime, long endTime)
```
指定者:

deleteData在接口中TSDB

参数:

metric - metric

startTime - start timestamp

endTime - end timestamp

删除时间线

deleteMeta
```
public void deleteMeta(String metric，Map<String,String> tags)
```
从接口复制的说明: TSDB删除时间线数据。

指定者:

deleteMeta在接口中TSDB

参数:

metric - Metric，度量名称，指标名称

tags - 以Map表示的Tag键值对。

删除时间线

deleteMeta
```
public void deleteMeta(Timeline timeline)
```
从接口复制的说明: TSDB删除时间线数据。/div>

指定者:

deleteMeta在接口中TSDB

参数:

timeline - Timeline 时间线类的实例。

获取Tag相关信息

dumpMeta
```
public List<TagResult> dumpMeta(String tagkey, String tagValuePrefix, int max)
```
从接口复制的说明: TSDB 获取符合条件的Tag列表

指定者:

dumpMeta在接口中TSDB

参数:

tagkey - Tag的名称

tagValuePrefix - Tag值的前缀

max - 最大数量

返回:

the List of the TagResult

查询数据方法

last
```
public List<QueryResult> last(Query query, int num) throws HttpUnknowStatusException
```
指定者:

last在接口中TSDB

参数:

query - Query 查询类实例。

num - 需要的查询结果中时间线上最后点的个数

返回:

查询结果列表

抛出:

HttpUnknowStatusException - Exception

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

lastdp
```
public List<LastDPValue> lastdp(Collection<Timeline> timelines) throws HttpUnknowStatusException
```
从接口复制的说明: TSDB 获取指定时间线上的最后一个数据点。

指定者:

lastdp在接口中TSDB

参数:

timelines - Timelines实例。

返回:

结果

抛出:

HttpUnknowStatusException - Exception

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

lastdp
```
public List<LastDPValue> lastdp(Timeline… timelines)                        throws HttpUnknowStatusException
```
从接口复制的说明: TSDB 获取指定时间线上的最后一个数据点。

指定者:

lastdp在接口中TSDB

参数:

timelines - 时间线的值。

返回:

List

抛出:

HttpUnknowStatusException - Exception

异步的将时间点写入TSDB

put
```
public void put(Point… points)
```
从接口复制的说明: TSDB 异步写时间点

指定者:

put在接口中TSDB

参数:

points - 时间点集合

异步的将时间点写入TSDB

put
```
public void put(Point point)
```
从接口复制的说明: TSDB 异步写数据

指定者:

put在接口中TSDB

参数:

point - 时间点

同步的将时间点写入TSDB

putSync
```
public <T extends Result> T putSync(Collection<Point> points, Class<T> resultType)
```
从接口复制的说明: TSDB 同步写入方法

指定者:

putSync在接口中TSDB

类型参数:

T - Result.class, SummaryResult.class, DetailsResult.class

参数:

points - 时间点的集合

resultType - 结果类型

返回:

Result实例。

同步的将时间点写入TSDB

putSync
```
public <T extends Result> T putSync(Class<T> resultType,                                Point… points)
```
从接口复制的说明: TSDB 同步写方法

指定者:

putSync在接口中TSDB

类型参数:

T - Result.class, SummaryResult.class, DetailsResult.class

参数:

resultType - 结果类型

points - 时间点集合

返回:

Result

同步的将时间点写入TSDB

putSync
```
public Result putSync(Collection<Point> points)
```
从接口复制的说明: TSDB 同步写入时间点

指定者:

putSync在接口中TSDB

参数:

points - 时间点数量

返回:

Result实例。该对象无实际作用，只是用来表示方法返回了。

同步的将时间点写入TSDB

putSync
```
public <T extends Result> T putSync(Class<T> resultType,                                Collection<Point> points)
```
从接口复制的说明: TSDB同步写

指定者:

putSync在接口中TSDB

类型参数:

T - Result.class, SummaryResult.class, DetailsResult.class

参数:

resultType - 结果类型

points - 时间点集合

返回:

Result

同步的将时间点写入TSDB

putSync
```
public Result putSync(Point… points)
```
从接口复制的说明: TSDB 同步写时间点

指定者:

putSync 在接口中 TSDB

参数:

points - 时间点集合

返回:

Result

查询数据方法

query
```
public List<QueryResult> query(Query query)
```
从接口复制的说明: TSDB 查询数据

指定者:

query在接口中TSDB

参数:

query - Query 查询类实例

返回:

result : QueryResult 查询结果类的实例。

查询数据方法

query
```
public void query(Query query, QueryCallback callback)
```
从接口复制的说明: TSDB 异步查询方法，查询结果在回调中返回。

指定者:

query 在接口中 TSDB

参数:

query - Query 查询类实例

callback - 查询回调接口的实例。查询结果会在回调方法中异步返回。

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

suggest
```
public List<String> suggest(Suggest type, String prefix, int max)
```
从接口复制的说明: TSDB suggest method

指定者:

suggest在接口中TSDB

参数:

type - 数据类型

prefix - 前缀

max - 最大数量

返回:

result

获取ttl数值的方法

ttl
```
public int ttl()
```
从接口复制的说明: TSDB 获取TTL数值。单位：秒

指定者:

ttl在接口中TSDB

返回:

ttl值，单位为秒。

设置ttl数值的方法

ttl
```
public void ttl(int lifetime)
```
从接口复制的说明: TSDB 设置TTL数值。

指定者:

ttl在接口中TSDB

参数:

lifetime - ttl的数值。单位为秒。

设置ttl数值的方法

ttl
```
public void ttl(int lifetime, TimeUnit unit)
```
指定者:

ttl在接口中TSDB

参数:

lifetime - ttl的数值。

unit - ttl的单位。