net.opentsdb.core

Class TSQuery

java.lang.Object

net.opentsdb.core.TSQuery

public final class TSQuery
extends Object

Parameters and state to query the underlying storage system for timeseries data points. When setting up a query, use the setter methods to store user information such as the start time and list of queries. After setting the proper values, call the validateAndSetQuery() method to validate the request. If required information is missing or cannot be parsed it will throw an exception. If validation passes, use buildQueries(TSDB) to compile the query into Query objects for processing. Note: If using POJO deserialization, make sure to avoid setting the start_time and end_time fields.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
TSQuery() Default constructor necessary for POJO de/serialization

Method Summary

Methods

Modifier and Type	Method and Description
Query[]	buildQueries(TSDB tsdb) Compiles the TSQuery into an array of Query objects for execution.
long	endTime()
String	getEnd()
boolean	getGlobalAnnotations()
boolean	getMsResolution()
boolean	getNoAnnotations()
Map<String,ArrayList<String>>	getOptions()
boolean	getPadding()
List<TSSubQuery>	getQueries()
boolean	getShowTSUIDs()
String	getStart()
String	getTimezone()
void	setEnd(String end) Optionally sets the end time for all queries.
void	setGlobalAnnotations(boolean with_global)
void	setMsResolution(boolean ms_resolution)
void	setNoAnnotations(boolean no_annotations)
void	setOptions(HashMap<String,ArrayList<String>> options)
void	setPadding(boolean padding)
void	setQueries(ArrayList<TSSubQuery> queries)
void	setShowTSUIDs(boolean show_tsuids)
void	setStart(String start) Sets the start time for further parsing.
void	setTimezone(String timezone)
long	startTime()
String	toString()
void	validateAndSetQuery() Runs through query parameters to make sure it's a valid request.

Methods inherited from class java.lang.Object

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

Constructor Detail

TSQuery

public TSQuery()

Default constructor necessary for POJO de/serialization

Method Detail

validateAndSetQuery

public void validateAndSetQuery()

Runs through query parameters to make sure it's a valid request. This includes parsing relative timestamps, verifying that the end time is later than the start time (or isn't set), that one or more metrics or TSUIDs are present, etc. If no exceptions are thrown, the query is considered valid. Warning: You must call this before passing it on for processing as it sets the start_time and end_time fields as well as sets the TSSubQuery fields necessary for execution.

Throws:

IllegalArgumentException - if something is wrong with the query

buildQueries

public Query[] buildQueries(TSDB tsdb)

Compiles the TSQuery into an array of Query objects for execution. If the user has not set a down sampler explicitly, and they don't want millisecond resolution, then we set the down sampler to 1 second to handle situations where storage may have multiple data points per second.

Parameters:

tsdb - The tsdb to use for TSDB.newQuery()

Returns:

An array of queries

toString

public String toString()

Overrides:

toString in class Object

startTime

public long startTime()

Returns:

the parsed start time for all queries

endTime

public long endTime()

Returns:

the parsed end time for all queries

getStart

public String getStart()

Returns:

the user given, raw start time

getEnd

public String getEnd()

Returns:

the user given, raw end time

getTimezone

public String getTimezone()

Returns:

the user supplied timezone

getOptions

public Map<String,ArrayList<String>> getOptions()

Returns:

a map of serializer options

getPadding

public boolean getPadding()

Returns:

whether or not the user wants padding

getNoAnnotations

public boolean getNoAnnotations()

Returns:

whether or not to supress annotatino output

getGlobalAnnotations

public boolean getGlobalAnnotations()

Returns:

whether or not to load global annotations for the time range

getShowTSUIDs

public boolean getShowTSUIDs()

Returns:

whether or not to display TSUIDs with the results

getQueries

public List<TSSubQuery> getQueries()

Returns:

the list of sub queries

getMsResolution

public boolean getMsResolution()

Returns:

whether or not the requestor wants millisecond resolution

setStart

public void setStart(String start)

Sets the start time for further parsing. This can be an absolute or relative value. See DateTime.parseDateTimeString(java.lang.String, java.lang.String) for details.

Parameters:

start - A start time from the user

setEnd

public void setEnd(String end)

Optionally sets the end time for all queries. If not set, the current system time will be used. This can be an absolute or relative value. See DateTime.parseDateTimeString(java.lang.String, java.lang.String) for details.

Parameters:

end - An end time from the user

setTimezone

public void setTimezone(String timezone)

Parameters:

timezone - an optional timezone for date parsing

setOptions

public void setOptions(HashMap<String,ArrayList<String>> options)

Parameters:

options - a map of options to pass on to the serializer

setPadding

public void setPadding(boolean padding)

Parameters:

padding - whether or not the query should include padding

setNoAnnotations

public void setNoAnnotations(boolean no_annotations)

Parameters:

no_annotations - whether or not to suppress annotation output

setGlobalAnnotations

public void setGlobalAnnotations(boolean with_global)

Parameters:

with_global - whether or not to load global annotations

setShowTSUIDs

public void setShowTSUIDs(boolean show_tsuids)

Parameters:

show_tsuids - whether or not to show TSUIDs in output

setQueries

public void setQueries(ArrayList<TSSubQuery> queries)

Parameters:

queries - a list of TSSubQuery objects to store

setMsResolution

public void setMsResolution(boolean ms_resolution)

Parameters:

ms_resolution - whether or not the user wants millisecond resolution