DatabaseToolsSqlReport

class oci.database_tools.models.DatabaseToolsSqlReport(**kwargs)

Bases: object

Allows generating a summary of SQL query execution details for database operations.

Attributes:

LIFECYCLE_STATE_ACTIVE	A constant which can be used with the lifecycle_state property of a DatabaseToolsSqlReport.
LIFECYCLE_STATE_DELETED	A constant which can be used with the lifecycle_state property of a DatabaseToolsSqlReport.
TYPE_ORACLE_DATABASE	A constant which can be used with the type property of a DatabaseToolsSqlReport.
columns	Gets the columns of this DatabaseToolsSqlReport.
compartment_id	[Required] Gets the compartment_id of this DatabaseToolsSqlReport.
defined_tags	Gets the defined_tags of this DatabaseToolsSqlReport.
description	Gets the description of this DatabaseToolsSqlReport.
display_name	[Required] Gets the display_name of this DatabaseToolsSqlReport.
freeform_tags	Gets the freeform_tags of this DatabaseToolsSqlReport.
id	[Required] Gets the id of this DatabaseToolsSqlReport.
instructions	Gets the instructions of this DatabaseToolsSqlReport.
lifecycle_details	Gets the lifecycle_details of this DatabaseToolsSqlReport.
lifecycle_state	[Required] Gets the lifecycle_state of this DatabaseToolsSqlReport.
locks	Gets the locks of this DatabaseToolsSqlReport.
purpose	Gets the purpose of this DatabaseToolsSqlReport.
source	[Required] Gets the source of this DatabaseToolsSqlReport.
system_tags	Gets the system_tags of this DatabaseToolsSqlReport.
time_created	[Required] Gets the time_created of this DatabaseToolsSqlReport.
time_updated	[Required] Gets the time_updated of this DatabaseToolsSqlReport.
type	[Required] Gets the type of this DatabaseToolsSqlReport.
variables	Gets the variables of this DatabaseToolsSqlReport.

Methods:

__init__(**kwargs)	Initializes a new DatabaseToolsSqlReport 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.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DatabaseToolsSqlReport. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DatabaseToolsSqlReport. This constant has a value of “DELETED”

TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'

A constant which can be used with the type property of a DatabaseToolsSqlReport. This constant has a value of “ORACLE_DATABASE”

__init__(**kwargs)

Initializes a new DatabaseToolsSqlReport object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• DatabaseToolsSqlReportOracleDatabase

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• id (str) – The value to assign to the id property of this DatabaseToolsSqlReport.

• type (str) – The value to assign to the type property of this DatabaseToolsSqlReport. Allowed values for this property are: “ORACLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsSqlReport.

• display_name (str) – The value to assign to the display_name property of this DatabaseToolsSqlReport.

• description (str) – The value to assign to the description property of this DatabaseToolsSqlReport.

• source (str) – The value to assign to the source property of this DatabaseToolsSqlReport.

• purpose (str) – The value to assign to the purpose property of this DatabaseToolsSqlReport.

• instructions (str) – The value to assign to the instructions property of this DatabaseToolsSqlReport.

• variables (list[oci.database_tools.models.DatabaseToolsSqlReportVariable]) – The value to assign to the variables property of this DatabaseToolsSqlReport.

• columns (list[oci.database_tools.models.DatabaseToolsSqlReportColumn]) – The value to assign to the columns property of this DatabaseToolsSqlReport.

• lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsSqlReport. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsSqlReport.

• time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsSqlReport.

• time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsSqlReport.

• defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsSqlReport.

• freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsSqlReport.

• system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsSqlReport.

• locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsSqlReport.

property columns

Gets the columns of this DatabaseToolsSqlReport. Descriptive information on columns referenced in the Database Tools SQL Report source.

Returns

The columns of this DatabaseToolsSqlReport.

Return type

list[oci.database_tools.models.DatabaseToolsSqlReportColumn]

property compartment_id

[Required] Gets the compartment_id of this DatabaseToolsSqlReport. The OCID of the compartment containing the Database Tools SQL report.

Returns

The compartment_id of this DatabaseToolsSqlReport.

Return type

str

property defined_tags

Gets the defined_tags of this DatabaseToolsSqlReport. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this DatabaseToolsSqlReport.

Return type

dict(str, dict(str, object))

property description

Gets the description of this DatabaseToolsSqlReport. A description of the SQL report.

Returns

The description of this DatabaseToolsSqlReport.

Return type

str

property display_name

[Required] Gets the display_name of this DatabaseToolsSqlReport. A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.

Returns

The display_name of this DatabaseToolsSqlReport.

Return type

str

property freeform_tags

Gets the freeform_tags of this DatabaseToolsSqlReport. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this DatabaseToolsSqlReport.

Return type

dict(str, 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.

property id

[Required] Gets the id of this DatabaseToolsSqlReport. The OCID of the Database Tools SQL report.

Returns

The id of this DatabaseToolsSqlReport.

Return type

str

property instructions

Gets the instructions of this DatabaseToolsSqlReport. Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.

Returns

The instructions of this DatabaseToolsSqlReport.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this DatabaseToolsSqlReport. A message describing the current state in more detail.

Returns

The lifecycle_details of this DatabaseToolsSqlReport.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DatabaseToolsSqlReport. The current state of the Database Tools SQL report.

Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this DatabaseToolsSqlReport.

Return type

str

property locks

Gets the locks of this DatabaseToolsSqlReport. Locks associated with this resource.

Returns

The locks of this DatabaseToolsSqlReport.

Return type

list[oci.database_tools.models.ResourceLock]

property purpose

Gets the purpose of this DatabaseToolsSqlReport. Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.

Returns

The purpose of this DatabaseToolsSqlReport.

Return type

str

property source

[Required] Gets the source of this DatabaseToolsSqlReport. SQL query executed to generate the report.

Returns

The source of this DatabaseToolsSqlReport.

Return type

str

property system_tags

Gets the system_tags of this DatabaseToolsSqlReport. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this DatabaseToolsSqlReport.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this DatabaseToolsSqlReport. The time the Database Tools SQL report was created. An RFC3339 formatted datetime string.

Returns

The time_created of this DatabaseToolsSqlReport.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this DatabaseToolsSqlReport. The time the Database Tools SQL report was updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this DatabaseToolsSqlReport.

Return type

datetime

property type

[Required] Gets the type of this DatabaseToolsSqlReport. The Database Tools SQL report type.

Allowed values for this property are: “ORACLE_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this DatabaseToolsSqlReport.

Return type

str

property variables

Gets the variables of this DatabaseToolsSqlReport. Variables referenced in the Database Tools SQL Report source.

Returns

The variables of this DatabaseToolsSqlReport.

Return type

list[oci.database_tools.models.DatabaseToolsSqlReportVariable]