DataObjectTemplatizedQuery¶

class oci.opsi.models.DataObjectTemplatizedQuery(**kwargs)¶

Bases: oci.opsi.models.data_object_query.DataObjectQuery

Information required in a structured template to form and execute query on a data object.

Attributes

`QUERY_TYPE_STANDARD_QUERY`	str(object=’’) -> str
`QUERY_TYPE_TEMPLATIZED_QUERY`	str(object=’’) -> str
`bind_params`	Gets the bind_params of this DataObjectQuery.
`from_clause`	Gets the from_clause of this DataObjectTemplatizedQuery.
`group_by_list`	Gets the group_by_list of this DataObjectTemplatizedQuery.
`having_conditions_list`	Gets the having_conditions_list of this DataObjectTemplatizedQuery.
`order_by_list`	Gets the order_by_list of this DataObjectTemplatizedQuery.
`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.
`select_list`	Gets the select_list of this DataObjectTemplatizedQuery.
`time_filters`	Gets the time_filters of this DataObjectTemplatizedQuery.
`where_conditions_list`	Gets the where_conditions_list of this DataObjectTemplatizedQuery.

Methods

`__init__`(**kwargs)	Initializes a new DataObjectTemplatizedQuery 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'¶

QUERY_TYPE_TEMPLATIZED_QUERY = 'TEMPLATIZED_QUERY'¶

__init__(**kwargs)¶

Initializes a new DataObjectTemplatizedQuery object with values from keyword arguments. The default value of the query_type attribute of this class is TEMPLATIZED_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 DataObjectTemplatizedQuery. 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 DataObjectTemplatizedQuery.
query_execution_timeout_in_seconds (float) – The value to assign to the query_execution_timeout_in_seconds property of this DataObjectTemplatizedQuery.
select_list (list[str]) – The value to assign to the select_list property of this DataObjectTemplatizedQuery.
from_clause (str) – The value to assign to the from_clause property of this DataObjectTemplatizedQuery.
where_conditions_list (list[str]) – The value to assign to the where_conditions_list property of this DataObjectTemplatizedQuery.
group_by_list (list[str]) – The value to assign to the group_by_list property of this DataObjectTemplatizedQuery.
having_conditions_list (list[str]) – The value to assign to the having_conditions_list property of this DataObjectTemplatizedQuery.
order_by_list (list[str]) – The value to assign to the order_by_list property of this DataObjectTemplatizedQuery.
time_filters (oci.opsi.models.DataObjectQueryTimeFilters) – The value to assign to the time_filters property of this DataObjectTemplatizedQuery.

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]

from_clause¶

Gets the from_clause of this DataObjectTemplatizedQuery. Unique data object name that will be added into the FROM clause of the query, just like a view name in FROM clause. - Use actual name of the data objects (e.g: tables, views) in case of Warehouse (e.g: Awr hub) data objects query. SCHEMA.VIEW name syntax can also be used here. e.g: SYS.DBA_HIST_SNAPSHOT or DBA_HIST_SNAPSHOT - Use name of the data object (e.g: SQL_STATS_DO) in case of OPSI data objects. Identifier of the OPSI data object cannot be used here.

Returns:	The from_clause of this DataObjectTemplatizedQuery.
Return type:	str

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.

group_by_list¶

Gets the group_by_list of this DataObjectTemplatizedQuery. List of items to be added into the GROUP BY clause of the query; items will be added with comma separation.

Returns:	The group_by_list of this DataObjectTemplatizedQuery.
Return type:	list[str]

having_conditions_list¶

Gets the having_conditions_list of this DataObjectTemplatizedQuery. List of items to be added into the HAVING clause of the query; items will be added with AND separation.

Returns:	The having_conditions_list of this DataObjectTemplatizedQuery.
Return type:	list[str]

order_by_list¶

Gets the order_by_list of this DataObjectTemplatizedQuery. List of items to be added into the ORDER BY clause of the query; items will be added with comma separation.

Returns:	The order_by_list of this DataObjectTemplatizedQuery.
Return type:	list[str]

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

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

select_list¶

Gets the select_list of this DataObjectTemplatizedQuery. List of items to be added into the SELECT clause of the query; items will be added with comma separation.

Returns:	The select_list of this DataObjectTemplatizedQuery.
Return type:	list[str]

time_filters¶

Gets the time_filters of this DataObjectTemplatizedQuery.

Returns:	The time_filters of this DataObjectTemplatizedQuery.
Return type:	oci.opsi.models.DataObjectQueryTimeFilters

where_conditions_list¶

Gets the where_conditions_list of this DataObjectTemplatizedQuery. List of items to be added into the WHERE clause of the query; items will be added with AND separation. Item can contain a single condition or multiple conditions. Single condition e.g: “optimizer_mode=’mode1’” Multiple conditions e.g: (module=’module1’ OR module=’module2’)

Returns:	The where_conditions_list of this DataObjectTemplatizedQuery.
Return type:	list[str]