Jump to

• Request
• Response

Prepare a SQL Statement

get

/20190828/query/prepare

Prepare a SQL statement for use in a query with variable substitution.

Request

Query Parameters

• compartmentId: string
  The ID of a table's compartment.
• statement: string
  A NoSQL SQL statement.

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

PreparedStatement

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

Type: object

The result of query preparation.

Show Source

• statement(optional): string(base64)
  A base64-encoded, compiled and parameterized version of a SQL statement.
• usage(optional): object RequestUsage
  The usage metrics for a request.

{
    "description":"The result of query preparation.",
    "properties":{
        "statement":{
            "description":"A base64-encoded, compiled and parameterized version of\na SQL statement.\n",
            "type":"string",
            "format":"base64"
        },
        "usage":{
            "$ref":"#/definitions/RequestUsage"
        }
    }
}

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."
        }
    }
}

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"
        }
    }
}

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