Class SqlTuningTaskSqlExecutionPlanStep


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20201101")
    public final class SqlTuningTaskSqlExecutionPlanStep
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A step in the SQL execution plan.
    Note: Objects should always be created or deserialized using the SqlTuningTaskSqlExecutionPlanStep.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 SqlTuningTaskSqlExecutionPlanStep.Builder, which maintain a set of all explicitly set fields called SqlTuningTaskSqlExecutionPlanStep.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).
    • Constructor Detail

      • SqlTuningTaskSqlExecutionPlanStep

        @Deprecated
        @ConstructorProperties({"planHashValue","stepId","parentStepId","position","operation","options","optimizerMode","cost","cardinality","bytes","cpuCost","ioCost","tempSpace","time","objectNode","objectOwner","objectName","objectPosition","objectType","partitionStart","partitionStop","partitionId","remarks","numberOfSearchColumn","other","otherTag","attribute","accessPredicates","filterPredicates"})
        public SqlTuningTaskSqlExecutionPlanStep​(Long planHashValue,
                                                 Integer stepId,
                                                 Integer parentStepId,
                                                 Integer position,
                                                 String operation,
                                                 String options,
                                                 String optimizerMode,
                                                 Double cost,
                                                 Long cardinality,
                                                 Long bytes,
                                                 Double cpuCost,
                                                 Double ioCost,
                                                 Long tempSpace,
                                                 Long time,
                                                 String objectNode,
                                                 String objectOwner,
                                                 String objectName,
                                                 Integer objectPosition,
                                                 String objectType,
                                                 String partitionStart,
                                                 String partitionStop,
                                                 Integer partitionId,
                                                 String remarks,
                                                 Integer numberOfSearchColumn,
                                                 String other,
                                                 String otherTag,
                                                 String attribute,
                                                 String accessPredicates,
                                                 String filterPredicates)
        Deprecated.
    • Method Detail

      • getPlanHashValue

        public Long getPlanHashValue()
        The numerical representation of the SQL execution plan.
        Returns:
        the value
      • getStepId

        public Integer getStepId()
        The identification number of a step in the SQL execution plan.

        This is unique within the SQL execution plan. This is not the OCID.

        Returns:
        the value
      • getParentStepId

        public Integer getParentStepId()
        The ID of the next step that operates on the results of this step.

        This is not the OCID.

        Returns:
        the value
      • getPosition

        public Integer getPosition()
        The order of processing for steps with the same parent ID.
        Returns:
        the value
      • getOperation

        public String getOperation()
        The name of the operation performed at this step.
        Returns:
        the value
      • getOptions

        public String getOptions()
        The options used for the operation performed at this step.
        Returns:
        the value
      • getOptimizerMode

        public String getOptimizerMode()
        The current mode of the optimizer, such as all_rows, first_rows_n (where n = 1, 10, 100, 1000, and so on).
        Returns:
        the value
      • getCost

        public Double getCost()
        The cost of the current operation estimated by the cost-based optimizer (CBO).
        Returns:
        the value
      • getCardinality

        public Long getCardinality()
        The number of rows returned by the current operation (estimated by the CBO).
        Returns:
        the value
      • getBytes

        public Long getBytes()
        The number of bytes returned by the current operation.
        Returns:
        the value
      • getCpuCost

        public Double getCpuCost()
        The CPU cost of the current operation.
        Returns:
        the value
      • getIoCost

        public Double getIoCost()
        The I/O cost of the current operation.
        Returns:
        the value
      • getTempSpace

        public Long getTempSpace()
        The temporary space usage (in bytes) of the operation (sort or hash-join) as estimated by the CBO.
        Returns:
        the value
      • getTime

        public Long getTime()
        The elapsed time (in seconds) of the operation as estimated by the CBO.
        Returns:
        the value
      • getObjectNode

        public String getObjectNode()
        The name of the database link used to reference the object.
        Returns:
        the value
      • getObjectOwner

        public String getObjectOwner()
        The owner of the object.
        Returns:
        the value
      • getObjectName

        public String getObjectName()
        The name of the object.
        Returns:
        the value
      • getObjectPosition

        public Integer getObjectPosition()
        The numbered position of the object name in the original SQL statement.
        Returns:
        the value
      • getObjectType

        public String getObjectType()
        The descriptive modifier that further describes the type of object.
        Returns:
        the value
      • getPartitionStart

        public String getPartitionStart()
        A step may get data from a range of partitions of a partitioned object, such as table or index, based on predicates and sorting order.

        The partionStart is the starting partition of the range. The partitionStop is the ending partition of the range.

        Returns:
        the value
      • getPartitionStop

        public String getPartitionStop()
        A step may get data from a range of partitions of a partitioned object, such as table or index, based on predicates and sorting order.

        The partionStart is the starting partition of the range. The partitionStop is the ending partition of the range.

        Returns:
        the value
      • getPartitionId

        public Integer getPartitionId()
        The ID of the step in the execution plan that has computed the pair of values of partitionStart and partitionStop.
        Returns:
        the value
      • getRemarks

        public String getRemarks()
        The place for comments that can be added to the steps of the execution plan.
        Returns:
        the value
      • getNumberOfSearchColumn

        public Integer getNumberOfSearchColumn()
        Number of index columns with start and stop keys (that is, the number of columns with matching predicates).
        Returns:
        the value
      • getOther

        public String getOther()
        Information about parallel execution servers and parallel queries
        Returns:
        the value
      • getOtherTag

        public String getOtherTag()
        Describes the function of the SQL text in the OTHER column.
        Returns:
        the value
      • getAttribute

        public String getAttribute()
        The text string identifying the type of execution plan.
        Returns:
        the value
      • getAccessPredicates

        public String getAccessPredicates()
        The predicates used to locate rows in an access structure.

        For example, start or stop predicates for an index range scan.

        Returns:
        the value
      • getFilterPredicates

        public String getFilterPredicates()
        The predicates used to filter rows before producing them.
        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