com.quantum.dxi.rest.dar

Class SqlStats

java.lang.Object

BaseTimeSeries

com.quantum.dxi.rest.dar.SqlStats

public class SqlStats
extends BaseTimeSeries

The SqlStats resource represents SQL time series data for the system. The SqlStats interfaces includes services for getting data series from SQL databases on the system. For getting SQL databases metadata (database, table and column names) please refer to the Sql web service.

The schema that defines the SqlStats resource is defined below.

 
    <xs:element name="TimedLongs">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="T" type="xs:long">
                    <xs:annotation>
                        <xs:documentation>Offset from Base Time</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="V1" type="xs:long">
                    <xs:annotation>
                        <xs:documentation>Value for Id 1</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="V2" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Value for Id 2</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="V3" type="xs:long" minOccurs="0"/>
                <xs:element name="V4" type="xs:long" minOccurs="0"/>
                <xs:element name="V5" type="xs:long" minOccurs="0"/>
                <xs:element name="V6" type="xs:long" minOccurs="0"/>
                <xs:element name="V7" type="xs:long" minOccurs="0"/>
                <xs:element name="V8" type="xs:long" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="LongSeries">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="IdentifierList" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>Comma seperated list of Ids</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="TotalCount" type="xs:long"/>
                <xs:element name="BaseTime" type="xs:long"/>
                <xs:element ref="TimedLongs" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
SqlStats()

Method Summary

Modifier and Type	Method and Description
LongSeries	getSingleTrendSeries(javax.servlet.http.HttpServletRequest request, java.lang.String database, java.lang.String table, java.lang.String series, java.lang.String filterString) GET /rest/SqlStats/{database}/{table}/{series}
LongSeries	getTrendSeries(javax.servlet.http.HttpServletRequest request, java.lang.String database, java.lang.String table, java.lang.String filterString, java.lang.String ids) GET /rest/SqlStats/{database}/{table}

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlStats

public SqlStats()

Method Detail

getSingleTrendSeries

public LongSeries getSingleTrendSeries(@Context
                                       javax.servlet.http.HttpServletRequest request,
                                       java.lang.String database,
                                       java.lang.String table,
                                       java.lang.String series,
                                       java.lang.String filterString)

GET /rest/SqlStats/{database}/{table}/{series}

Get the SQL statistics for a single data series from the database identified by {database}, from the table specified by {table}, for the data series identified by {series}. The data series is represented by a single named column in the database table.

{database}: Use the GET /rest/Sql request to retrieve the list of valid database names.

The {table} is the table name in the database. Tables are created dynamically as the corresponding resources are created and enabled on the system. For example, a table will be created in the ShareIngest database when a new Share or Partition is created and begins ingesting data. Use the GET /rest/Sql/Tables/{database} request to find out what tables are present in a specific database.

{series} parameter allows to narrow the results to a specific data series (SQL table column). Use the GET /rest/Sql/DataColumns/{database}/{table} request to retrieve the list of SQL column names for a specific SQL database/table.

getSingleTrendSeries supports the table query parameters for filtering. The only supported filter column is "Time".

Response Entity type: <xs:element name="LongSeries">

Since:

1.1

See Also:

Sql

getTrendSeries

public LongSeries getTrendSeries(@Context
                                 javax.servlet.http.HttpServletRequest request,
                                 java.lang.String database,
                                 java.lang.String table,
                                 java.lang.String filterString,
                                 java.lang.String ids)

GET /rest/SqlStats/{database}/{table}

Get the SQL statistics for multiple data series from a single database identified by {database}, from the table specified by {table}.

{database}: Use the GET /rest/Sql request to retrieve the list of valid database names.

The {table} is the table name in the database. Tables are created dynamically as the corresponding resources are created and enabled on the system. For example, a table will be created in the ShareIngest database when a new Share or Partition is created and begins ingesting data. Use the GET /rest/Sql/Tables/{database} request to find out what tables are present in a specific database.

Requested data series names are specified as a comma-separated list, passed in via the ids query parameter, e.g.:

?ids=series1,series2,seriesN

If the ids query parameter is not present, all data series are returned. Data series are represented by columns in the database table. Use the GET /rest/Sql/DataColumns/{database}/{table} request to retrieve the list of SQL column names for a specific SQL database/table.

getTrendSeries supports the table query parameters for filtering. The only supported filter column is "Time".

Response Entity type: <xs:element name="LongSeries">

Since:

1.1

See Also:

Sql