Jump to

• Request
• Response

Check the Syntax of a SQL Statement

get

/20190828/query/summarize

Check the syntax and return a brief summary of a SQL statement.

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

A summary of the SQL statement.

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

Type: object

Information derived from parsing a NoSQL SQL statement.

Show Source

• indexName(optional): string
  The index name from the SQL statement, if present.
• isIfExists(optional): boolean
  True if the statement includes "IF EXISTS."
• isIfNotExists(optional): boolean
  True if the statement includes "IF NOT EXISTS."
• operation(optional): string
  Allowed Values: [ "CREATE_TABLE", "ALTER_TABLE", "DROP_TABLE", "CREATE_INDEX", "DROP_INDEX", "SELECT", "UPDATE", "INSERT", "DELETE" ]

  The operation represented in the statement, e.g. CREATE_TABLE.
• syntaxError(optional): string
  If present, indicates a syntax error in the statement.
• tableName(optional): string
  The table name from the SQL statement.

{
    "description":"Information derived from parsing a NoSQL SQL statement.",
    "properties":{
        "operation":{
            "type":"string",
            "description":"The operation represented in the statement, e.g. CREATE_TABLE.\n",
            "enum":[
                "CREATE_TABLE",
                "ALTER_TABLE",
                "DROP_TABLE",
                "CREATE_INDEX",
                "DROP_INDEX",
                "SELECT",
                "UPDATE",
                "INSERT",
                "DELETE"
            ]
        },
        "tableName":{
            "type":"string",
            "description":"The table name from the SQL statement."
        },
        "indexName":{
            "type":"string",
            "description":"The index name from the SQL statement, if present."
        },
        "isIfExists":{
            "type":"boolean",
            "description":"True if the statement includes \"IF EXISTS.\""
        },
        "isIfNotExists":{
            "type":"boolean",
            "description":"True if the statement includes \"IF NOT EXISTS.\""
        },
        "syntaxError":{
            "type":"string",
            "description":"If present, indicates a syntax error in the statement."
        }
    }
}

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