Pre-General Availability: 2022-08-18. This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Jump to

• Request
• Response

Update query execution

put

/20210831/projects/{projectId}/queryExecutions/{queryExecutionId}

Request

Supported Media Types

• application/json

Path Parameters

• projectId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of Query Service project
• queryExecutionId: string
  unique query execution id

Header Parameters

• if-match(optional): string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  The client request ID for tracing.
• opc-retry-token(optional): string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Body ()

Query Execution update payload

Root Schema : UpdateQueryExecutionDetails

Type: object

Update the query execution details

Show Source

• name: string(x-obmcs-ascii-identifier)
  An optional way how to name the given query execution

{
    "type":"object",
    "required":[
        "name"
    ],
    "description":"Update the query execution details",
    "properties":{
        "name":{
            "type":"string",
            "format":"x-obmcs-ascii-identifier",
            "description":"An optional way how to name the given query execution"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : QueryExecution

Type: object

Description of the Query Execution (instance)

Show Source

• definedTags(optional): object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
• freeformTags(optional): object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• id: string
  resource unique id
• isResultAvailable: boolean
  is the result (still) available?
• lifecycleState: string
  Allowed Values: [ "ACCEPTED", "IN_PROGRESS", "CANCELING", "CANCELED", "UPDATING", "SUCCEEDED", "FAILED" ]

  The state of the query execution
• limits: object QueryExecutionLimits
  asynchronous query execution limits
• name: string
  query execution name
• sqlStatement: string
  executed sql statement
• statistics: object QueryExecutionStatistics
  asynchronous query execution status
• submittedBy: string
  ocid of subject who/which has submitted the query
• timeFinished(optional): string(date-time)
  query execution time finished

  Example: 2019-03-29T09:36:42.000Z
• timeStarted(optional): string(date-time)
  query execution time started

  Example: 2019-03-29T09:36:42.000Z
• timeSubmitted(optional): string(date-time)
  query execution time submission

  Example: 2019-03-29T09:36:42.000Z

{
    "type":"object",
    "description":"Description of the Query Execution (instance)",
    "required":[
        "id",
        "name",
        "lifecycleState",
        "statistics",
        "limits",
        "sqlStatement",
        "submittedBy",
        "isResultAvailable"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"resource unique id"
        },
        "name":{
            "type":"string",
            "description":"query execution name"
        },
        "lifecycleState":{
            "description":"The state of the query execution",
            "type":"string",
            "enum":[
                "ACCEPTED",
                "IN_PROGRESS",
                "CANCELING",
                "CANCELED",
                "UPDATING",
                "SUCCEEDED",
                "FAILED"
            ]
        },
        "submittedBy":{
            "type":"string",
            "description":"ocid of subject who/which has submitted the query"
        },
        "sqlStatement":{
            "type":"string",
            "description":"executed sql statement"
        },
        "timeSubmitted":{
            "type":"string",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z",
            "description":"query execution time submission"
        },
        "timeStarted":{
            "type":"string",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z",
            "description":"query execution time started"
        },
        "timeFinished":{
            "type":"string",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z",
            "description":"query execution time finished"
        },
        "isResultAvailable":{
            "type":"boolean",
            "description":"is the result (still) available?"
        },
        "statistics":{
            "$ref":"#/definitions/QueryExecutionStatistics"
        },
        "limits":{
            "$ref":"#/definitions/QueryExecutionLimits"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string type is supported.\n"
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string type is supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Nested Schema : QueryExecutionLimits

Type: object

asynchronous query execution limits

Show Source

• maxDataScannedInBytes: number(int64)
  max bytes scanned by query
• maxExecutionTimeInMillisec: number(int64)
  max time consumed by query execution in seconds
• maxOcpuHoursConsumed: number(int64)
  max CPU time consumed by the query in OCPU hours

{
    "type":"object",
    "required":[
        "maxDataScannedInBytes",
        "maxOcpuHoursConsumed",
        "maxExecutionTimeInMillisec"
    ],
    "description":"asynchronous query execution limits",
    "properties":{
        "maxDataScannedInBytes":{
            "type":"number",
            "format":"int64",
            "description":"max bytes scanned by query"
        },
        "maxOcpuHoursConsumed":{
            "type":"number",
            "format":"int64",
            "description":"max CPU time consumed by the query in OCPU hours"
        },
        "maxExecutionTimeInMillisec":{
            "type":"number",
            "format":"int64",
            "description":"max time consumed by query execution in seconds"
        }
    }
}

Nested Schema : QueryExecutionStatistics

Type: object

asynchronous query execution status

Show Source

• dataScannedInBytes: number(int64)
  bytes scanned by query
• executionTimeInMillisec: number(int64)
  time consumed by query execution in seconds
• ocpuHoursConsumed: number(int64)
  CPU time consumed by the query in OCPU hours
• rowsReturned(optional): number(int64)
  result rows returned by the query

{
    "type":"object",
    "required":[
        "dataScannedInBytes",
        "ocpuHoursConsumed",
        "executionTimeInMillisec"
    ],
    "description":"asynchronous query execution status",
    "properties":{
        "dataScannedInBytes":{
            "type":"number",
            "format":"int64",
            "description":"bytes scanned by query"
        },
        "ocpuHoursConsumed":{
            "type":"number",
            "format":"int64",
            "description":"CPU time consumed by the query in OCPU hours"
        },
        "executionTimeInMillisec":{
            "type":"number",
            "format":"int64",
            "description":"time consumed by query execution in seconds"
        },
        "rowsReturned":{
            "type":"number",
            "format":"int64",
            "description":"result rows returned by the query"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string type is supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string type is supported.\n"
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string type is supported.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

412 Response

Precondition failed

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

Back to Top