com.quantum.dxi.rest.dar

Class Sql

java.lang.Object

Base

com.quantum.dxi.rest.dar.Sql

public class Sql
extends Base

The Sql resource represents information about the DAR SQL databases on the system. The Sql interface includes services for getting SQL metadata from the databases, including database names, database table names, and data series names (represented by table columns) for each database. For getting actual data from SQL databases please refer to the SqlStats web service.

The schema that defines the Sql resource is defined below.

 

    <xs:element name="Scalar" type="ScalarType"/>
    <xs:complexType name="ScalarType">
        <xs:sequence>
            <xs:element name="Name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
    <xs:element name="StringListScalar" type="StringListScalarType"/>
    <xs:complexType name="StringListScalarType">
        <xs:complexContent>
            <xs:extension base="ScalarType">
                <xs:sequence>
                    <xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
 
 

Constructor Summary

Constructors

Constructor and Description
Sql()

Method Summary

Modifier and Type	Method and Description
StringListScalarType	getDatabases(javax.servlet.http.HttpServletRequest request, java.lang.String errorType) GET /rest/Sql
StringListScalarType	getDataColumns(javax.servlet.http.HttpServletRequest request, java.lang.String database, java.lang.String tableName, java.lang.String errorType) GET /rest/Sql/DataColumns/{database}/{table}
StringListScalarType	getDataSources(javax.servlet.http.HttpServletRequest request, java.lang.String database, java.lang.String errorType) GET /rest/Sql/Tables/{database}

Methods inherited from class java.lang.Object

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

Constructor Detail

Sql

public Sql()

Method Detail

getDatabases

public StringListScalarType getDatabases(@Context
                                         javax.servlet.http.HttpServletRequest request,
                                         java.lang.String errorType)

GET /rest/Sql

Get the list of SQL database names on the system. These names are the list of valid values to use for the {database} path element for the /rest/SqlStats web services.

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

Since:

1.1

See Also:

SqlStats

getDataSources

public StringListScalarType getDataSources(@Context
                                           javax.servlet.http.HttpServletRequest request,
                                           java.lang.String database,
                                           java.lang.String errorType)

GET /rest/Sql/Tables/{database}

Get the list of SQL database table names for a SQL database on the system. These names are the list of valid values to use for the {table} path element for the /rest/SqlStats web services, in conjunction with this {database} path element.

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

Since:

1.1

See Also:

SqlStats

getDataColumns

public StringListScalarType getDataColumns(@Context
                                           javax.servlet.http.HttpServletRequest request,
                                           java.lang.String database,
                                           java.lang.String tableName,
                                           java.lang.String errorType)

GET /rest/Sql/DataColumns/{database}/{table}

Get the list of SQL column names for a SQL database/table on the system. Each column represents a named data series. These names are the list of valid values to use for the {series} path element for the /rest/SqlStats web services, in conjunction with this {database} path element.

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

Since:

1.1

See Also:

SqlStats