DataObjectStandardQuery

class oci.opsi.models.DataObjectStandardQuery(**kwargs)

Bases: DataObjectQuery

Information required to execute query on data objects. Query is given in standard SQL syntax providing flexibility to form complex queries such as queries with joins and nested queries.

Attributes:

QUERY_TYPE_STANDARD_QUERY

A constant which can be used with the query_type property of a DataObjectQuery.

QUERY_TYPE_TEMPLATIZED_QUERY

A constant which can be used with the query_type property of a DataObjectQuery.

bind_params

Gets the bind_params of this DataObjectQuery.

query_execution_timeout_in_seconds

Gets the query_execution_timeout_in_seconds of this DataObjectQuery.

query_type

[Required] Gets the query_type of this DataObjectQuery.

statement

Gets the statement of this DataObjectStandardQuery.

time_filters

Gets the time_filters of this DataObjectStandardQuery.

Methods:

__init__(**kwargs)

Initializes a new DataObjectStandardQuery object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

QUERY_TYPE_STANDARD_QUERY = 'STANDARD_QUERY'

A constant which can be used with the query_type property of a DataObjectQuery. This constant has a value of “STANDARD_QUERY”

QUERY_TYPE_TEMPLATIZED_QUERY = 'TEMPLATIZED_QUERY'

A constant which can be used with the query_type property of a DataObjectQuery. This constant has a value of “TEMPLATIZED_QUERY”

__init__(**kwargs)

Initializes a new DataObjectStandardQuery object with values from keyword arguments. The default value of the query_type attribute of this class is STANDARD_QUERY and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • query_type (str) – The value to assign to the query_type property of this DataObjectStandardQuery. Allowed values for this property are: “TEMPLATIZED_QUERY”, “STANDARD_QUERY”

  • bind_params (list[oci.opsi.models.DataObjectBindParameter]) – The value to assign to the bind_params property of this DataObjectStandardQuery.

  • query_execution_timeout_in_seconds (float) – The value to assign to the query_execution_timeout_in_seconds property of this DataObjectStandardQuery.

  • statement (str) – The value to assign to the statement property of this DataObjectStandardQuery.

  • time_filters (oci.opsi.models.DataObjectQueryTimeFilters) – The value to assign to the time_filters property of this DataObjectStandardQuery.

property bind_params

Gets the bind_params of this DataObjectQuery. List of bind parameters to be applied in the query.

Returns

The bind_params of this DataObjectQuery.

Return type

list[oci.opsi.models.DataObjectBindParameter]

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property query_execution_timeout_in_seconds

Gets the query_execution_timeout_in_seconds of this DataObjectQuery. Timeout (in seconds) to be set for the data object query execution.

Returns

The query_execution_timeout_in_seconds of this DataObjectQuery.

Return type

float

property query_type

[Required] Gets the query_type of this DataObjectQuery. Type of Query

Allowed values for this property are: “TEMPLATIZED_QUERY”, “STANDARD_QUERY”

Returns

The query_type of this DataObjectQuery.

Return type

str

property statement

Gets the statement of this DataObjectStandardQuery. SQL query statement with standard Oracle supported SQL syntax. - When Warehouse (e.g: Awr hub) data objects are queried, use the actual names of underlying data objects (e.g: tables, views) in the query. The same query that works through JDBC connection with the OperationsInsightsWarehouseUsers credentials will work here and vice-versa. SCHEMA.VIEW syntax can also be used here. - When OPSI data objects are queried, use name of the respective OPSI data object, just like how views are used in a query. Identifier of the OPSI data object cannot be used in the query.

Returns

The statement of this DataObjectStandardQuery.

Return type

str

property time_filters

Gets the time_filters of this DataObjectStandardQuery.

Returns

The time_filters of this DataObjectStandardQuery.

Return type

oci.opsi.models.DataObjectQueryTimeFilters