Class LoadSqlTuningSetDetails


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20201101")
    public final class LoadSqlTuningSetDetails
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The details required to load the Sql statements into the Sql tuning set.

    It takes either credentialDetails or databaseCredential. It’s recommended to provide databaseCredential
    Note: Objects should always be created or deserialized using the LoadSqlTuningSetDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the LoadSqlTuningSetDetails.Builder, which maintain a set of all explicitly set fields called LoadSqlTuningSetDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getShowSqlOnly

        public Integer getShowSqlOnly()
        Flag to indicate whether to create the Sql tuning set or just display the plsql used to create Sql tuning set.
        Returns:
        the value
      • getOwner

        public String getOwner()
        The owner of the Sql tuning set.
        Returns:
        the value
      • getName

        public String getName()
        The name of the Sql tuning set.
        Returns:
        the value
      • getBasicFilter

        public String getBasicFilter()
        Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW.

        User could use any combination of the following columns with appropriate values as Sql predicate Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C

        Returns:
        the value
      • getResultPercentage

        public Double getResultPercentage()
        Specifies a filter that picks the top n% according to the supplied ranking measure.

        Note that this parameter applies only if one ranking measure is supplied.

        Returns:
        the value
      • getResultLimit

        public Integer getResultLimit()
        The top limit Sql from the filtered source, ranked by the ranking measure.
        Returns:
        the value
      • getRankingMeasure1

        public RankingMeasure getRankingMeasure1()
        Specifies an ORDER BY clause on the selected Sql.

        User can specify upto three ranking measures.

        Returns:
        the value
      • getRankingMeasure2

        public RankingMeasure getRankingMeasure2()
        Specifies an ORDER BY clause on the selected Sql.

        User can specify upto three ranking measures.

        Returns:
        the value
      • getRankingMeasure3

        public RankingMeasure getRankingMeasure3()
        Specifies an ORDER BY clause on the selected Sql.

        User can specify upto three ranking measures.

        Returns:
        the value
      • getTotalTimeLimit

        public Integer getTotalTimeLimit()
        Defines the total amount of time, in seconds, to execute.
        Returns:
        the value
      • getRepeatInterval

        public Integer getRepeatInterval()
        Defines the amount of time, in seconds, to pause between sampling.
        Returns:
        the value
      • getCaptureMode

        public LoadSqlTuningSetDetails.CaptureMode getCaptureMode()
        Specifies the capture mode.

        Note that this parameter is applicable only for UPDATE and MERGE capture options. Capture mode can take one of the following values - MODE_REPLACE_OLD_STATS Replaces statistics when the number of executions is greater than the number stored in the Sql tuning set - MODE_ACCUMULATE_STATS Adds new values to current values for Sql that is already stored. Note that this mode detects if a statement has been aged out, so the final value for a statistics is the sum of the statistics of all cursors that statement existed under.

        Returns:
        the value
      • getAttributeList

        public String getAttributeList()
        Specifies the list of Sql statement attributes to return in the result.

        Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. Attribute list can take one of the following values. TYPICAL - Specifies BASIC plus Sql plan (without row source statistics) and without object reference list (default). BASIC - Specifies all attributes (such as execution statistics and binds) except the plans. The execution context is always part of the result. ALL - Specifies all attributes. CUSTOM - Comma-separated list of the following attribute names. - EXECUTION_STATISTICS - BIND_LIST - OBJECT_LIST - SQL_PLAN - SQL_PLAN_STATISTICS Usage examples: 1. “attributeList”: “TYPICAL” 2. “attributeList”: “ALL” 3. “attributeList”: “EXECUTION_STATISTICS,OBJECT_LIST,SQL_PLAN”

        Returns:
        the value
      • getLoadOption

        public LoadSqlTuningSetDetails.LoadOption getLoadOption()
        Specifies which statements are loaded into the Sql tuning set.

        The possible values are. - INSERT (default) Adds only new statements. - UPDATE Updates existing the Sql statements and ignores any new statements. - MERGE Inserts new statements and updates the information of the existing ones.

        Returns:
        the value
      • getUpdateOption

        public LoadSqlTuningSetDetails.UpdateOption getUpdateOption()
        Specifies how existing Sql statements are updated.

        This parameter is applicable only if load_option is specified with UPDATE or MERGE as an option. Update option can take one of the following values. REPLACE (default) - Updates the statement using the new statistics, bind list, object list, and so on. ACCUMULATE - Combines attributes when possible (for example, statistics such as elapsed_time), otherwise replaces the existing values (for example, module and action) with the provided values. Following Sql statement attributes can be accumulated. elapsed_time buffer_gets direct_writes disk_reads row_processed fetches executions end_of_fetch_count stat_period active_stat_period

        Returns:
        the value
      • getUpdateAttributes

        public String getUpdateAttributes()
        Specifies the list of Sql statement attributes to update during a merge or update.

        Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. Update attributes can take one of the following values. NULL (default) - Specifies the content of the input cursor except the execution context. On other terms, it is equivalent to ALL without execution contexts such as module and action. BASIC - Specifies statistics and binds only. TYPICAL - Specifies BASIC with Sql plans (without row source statistics) and without an object reference list. ALL - Specifies all attributes, including the execution context attributes such as module and action. CUSTOM - List of comma separated attribute names to update EXECUTION_CONTEXT EXECUTION_STATISTICS SQL_BINDS SQL_PLAN SQL_PLAN_STATISTICS (similar to SQL_PLAN with added row source statistics) Usage examples: 1. “updateAttributes”: “TYPICAL” 2. “updateAttributes”: “BASIC” 3. “updateAttributes”: “EXECUTION_STATISTICS,SQL_PLAN_STATISTICS,SQL_PLAN” 4. “updateAttributes”: “EXECUTION_STATISTICS,SQL_PLAN”

        Returns:
        the value
      • getUpdateCondition

        public LoadSqlTuningSetDetails.UpdateCondition getUpdateCondition()
        Specifies when to perform the update.

        The procedure only performs the update when the specified condition is satisfied. The condition can refer to either the data source or destination. The condition must use the following prefixes to refer to attributes from the source or the destination: OLD \u2014 Refers to statement attributes from the SQL tuning set (destination). NEW \u2014 Refers to statement attributes from the input statements (source). NULL \u2014 No updates are performed.

        Returns:
        the value
      • getIsIgnoreNull

        public Boolean getIsIgnoreNull()
        Specifies whether to update attributes when the new value is NULL.

        If TRUE, then the procedure does not update an attribute when the new value is NULL. That is, do not override with NULL values unless intentional. Possible values - true or false

        Returns:
        the value
      • getCommitRows

        public Integer getCommitRows()
        Specifies whether to commit statements after DML.

        If a value is provided, then the load commits after each specified number of statements is inserted. If NULL is provided, then the load commits only once, at the end of the operation.

        Returns:
        the value
      • getBeginSnapshot

        public Long getBeginSnapshot()
        Defines the beginning AWR snapshot (non-inclusive).
        Returns:
        the value
      • getEndSnapshot

        public Long getEndSnapshot()
        Defines the ending AWR snapshot (inclusive).
        Returns:
        the value
      • getBaselineName

        public String getBaselineName()
        Specifies the name of the AWR baseline period.

        When loading the sql statements from AWR, following inputs has to be provided: beginSnapshot and endSnapshot OR baselineName

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel