Jump to

• Request
• Response

Execute a Query

post

/20190828/query

Execute a SQL query.

Request

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

  Default Value: 1000
• page: string
  Minimum Length: 1

  Maximum Length: 1024

  The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Header Parameters

• opc-request-id: string
  The client request ID for tracing.

Body ()

SQL query statement and ancillary information.

Root Schema : QueryDetails

Type: object

All the information surrounding a query, including the query statement, limits, consistency, and so forth.

Show Source

• compartmentId: string
  Compartment OCID, to provide context for a table name in the given statement.
• consistency(optional): string
  Default Value: EVENTUAL

  Allowed Values: [ "EVENTUAL", "ABSOLUTE" ]

  Consistency requirement for a read operation.
• isPrepared(optional): boolean
  If true, the statement is a prepared statement.
• maxReadInKBs(optional): integer
  Default Value: 0

  A limit on the total amount of data read during this operation, in KB.
• statement: string
  A NoSQL SQL query statement; or a Base64-encoded prepared statement.
• timeoutInMs(optional): integer
  Default Value: 5000

  Timeout setting for the query.
• variables(optional): object variables
  Additional Properties Allowed: additionalProperties

  A map of prepared statement variables to values.

{
    "description":"All the information surrounding a query, including the query statement,\nlimits, consistency, and so forth.\n",
    "required":[
        "compartmentId",
        "statement"
    ],
    "properties":{
        "compartmentId":{
            "description":"Compartment OCID, to provide context for a table name in\nthe given statement.\n",
            "type":"string"
        },
        "statement":{
            "description":"A NoSQL SQL query statement; or a Base64-encoded prepared statement.\n",
            "type":"string"
        },
        "isPrepared":{
            "description":"If true, the statement is a prepared statement.",
            "type":"boolean"
        },
        "consistency":{
            "description":"Consistency requirement for a read operation.",
            "type":"string",
            "enum":[
                "EVENTUAL",
                "ABSOLUTE"
            ],
            "default":"EVENTUAL"
        },
        "maxReadInKBs":{
            "description":"A limit on the total amount of data read during this operation, in KB.\n",
            "type":"integer",
            "default":0
        },
        "variables":{
            "description":"A map of prepared statement variables to values.",
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "timeoutInMs":{
            "description":"Timeout setting for the query.",
            "type":"integer",
            "default":5000
        }
    }
}

Nested Schema : variables

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"A map of prepared statement variables to values.",
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

A map of prepared statement variables to values.

Nested Schema : additionalProperties

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

QueryResultCollection comprises an array of results and usage information.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• 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 : QueryResultCollection

Type: object

The result of a query.

Show Source

• items(optional): array items
  Array of objects representing query results.
• usage(optional): object RequestUsage
  The usage metrics for a request.

{
    "description":"The result of a query.",
    "properties":{
        "items":{
            "description":"Array of objects representing query results.",
            "type":"array",
            "items":{
                "description":"The map of values from a row.",
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        },
        "usage":{
            "$ref":"#/definitions/RequestUsage"
        }
    }
}

Nested Schema : items

Type: array

Array of objects representing query results.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

  The map of values from a row.

{
    "description":"Array of objects representing query results.",
    "type":"array",
    "items":{
        "description":"The map of values from a row.",
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

Nested Schema : RequestUsage

Type: object

The usage metrics for a request.

Show Source

• readUnitsConsumed(optional): integer
  Read Units consumed by this operation.
• writeUnitsConsumed(optional): integer
  Write Units consumed by this operation.

{
    "description":"The usage metrics for a request.",
    "properties":{
        "readUnitsConsumed":{
            "type":"integer",
            "description":"Read Units consumed by this operation."
        },
        "writeUnitsConsumed":{
            "type":"integer",
            "description":"Write Units consumed by this operation."
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"The map of values from a row.",
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

The map of values from a row.

Nested Schema : additionalProperties

Type: object

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 : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

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 : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

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 : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

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.
• retry-after: number(float)
  A decimal number representing the number of seconds the client should wait before polling this endpoint again.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

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 : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Default Response

Unknown 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 : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for\nprogrammatic parsing.\n",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Back to Top