REST API for Oracle Query Service

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.

Get Object Schema

post

/20210831/projects/{projectId}/n/{namespace}/b/{bucketName}/o/{objectName}/actions/getObjectSchema

Get schema of the given object.

Request

Path Parameters

bucketName: string

Minimum Length: 1

Maximum Length: 255

The name of Object Store bucket
namespace: string

Minimum Length: 1

Maximum Length: 255

The name of Object Store namespace
objectName: string

Minimum Length: 1

Maximum Length: 255

The name of object
projectId: string

Minimum Length: 1

Maximum Length: 255

The OCID of Query Service project

Header Parameters

opc-request-id: string

The client request ID for tracing.

Response

Supported Media Types

application/json

200 Response

Retrieves a schema of the given object.

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.

Root Schema : ObjectSchema

Type: object

Result set with object schema

Show Source

fieldsCollection: object FieldsCollection

A list of fields that make up the schema.
probingDetails(optional): object ProbingDetails

Probing details about particular object. The probing details may vary between different file types of the object. Typical probing details are: file type and compression.

{
    "type":"object",
    "description":"Result set with object schema",
    "required":[
        "fieldsCollection"
    ],
    "properties":{
        "fieldsCollection":{
            "$ref":"#/definitions/FieldsCollection"
        },
        "probingDetails":{
            "$ref":"#/definitions/ProbingDetails"
        }
    }
}

Nested Schema : FieldsCollection

Type: object

A list of fields that make up the schema.

Show Source

items: array items

A list of fields that make up the schema.

{
    "type":"object",
    "description":"A list of fields that make up the schema.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"A list of fields that make up the schema.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/FieldSchema"
            }
        }
    }
}

Nested Schema : ProbingDetails

Type: object

Probing details about particular object. The probing details may vary between different file types of the object. Typical probing details are: file type and compression.

Show Source

compressionType: string

Allowed Values: [ "NONE", "UNKNOWN", "ZIP", "GZIP", "BZIP2", "BZIP2_INTERNAL", "ZSTD", "LZO", "LZ4", "SNAPPY", "SNAPPY_INTERNAL" ]

Compression type of the object obtained via probing. All the *_INTERNAL values are related to Avro filetype only and it means that the given compression is used as an internal codec. Additionally, the filetype can't be compressed in a standard way as a file (eg. via bzip2 utility).
csvProbingDetails(optional): object CsvProbingDetails

Probing details specific to objects in the CSV format. Those can be used as hints for data processing in downstream business logic.
fileType: string

Allowed Values: [ "UNKNOWN", "CSV", "JSON", "PARQUET", "AVRO", "ORC" ]

File type of the object obtained via probing.

{
    "type":"object",
    "description":"Probing details about particular object. The probing details may vary between\ndifferent file types of the object. Typical probing details are: file type\nand compression.\n",
    "required":[
        "fileType",
        "compressionType"
    ],
    "properties":{
        "fileType":{
            "description":"File type of the object obtained via probing.\n",
            "type":"string",
            "enum":[
                "UNKNOWN",
                "CSV",
                "JSON",
                "PARQUET",
                "AVRO",
                "ORC"
            ]
        },
        "compressionType":{
            "description":"Compression type of the object obtained via probing. All the *_INTERNAL values are\nrelated to Avro filetype only and it means that the given\ncompression is used as an internal codec. Additionally, the filetype can't\nbe compressed in a standard way as a file (eg. via bzip2 utility).\n",
            "type":"string",
            "enum":[
                "NONE",
                "UNKNOWN",
                "ZIP",
                "GZIP",
                "BZIP2",
                "BZIP2_INTERNAL",
                "ZSTD",
                "LZO",
                "LZ4",
                "SNAPPY",
                "SNAPPY_INTERNAL"
            ]
        },
        "csvProbingDetails":{
            "$ref":"#/definitions/CsvProbingDetails"
        }
    }
}

Nested Schema : items

Type: array

A list of fields that make up the schema.

Show Source

Array of: object FieldSchema

A field schema decribes a particular field in the object schema. It contains at least a name and a data type, but potentially can be extended with some additional or more complex properties.

{
    "description":"A list of fields that make up the schema.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/FieldSchema"
    }
}

Nested Schema : FieldSchema

Type: object

A field schema decribes a particular field in the object schema. It contains at least a name and a data type, but potentially can be extended with some additional or more complex properties.

Show Source

additionalFlags(optional): object AdditionalFlags

Additional flags which further clarifies the primary and logical types, or provide data type constraints.
dataType: string

Allowed Values: [ "BOOLEAN", "INT", "LONG", "FLOAT", "DOUBLE", "BYTES", "STRING", "ENUM", "ARRAY", "MAP", "FIXED" ]

Data type of the field. Possible values include STRING, INTEGER, ...
fieldName: string

Minimum Length: 1

Maximum Length: 255

Name of the field
logicalType(optional): string

Allowed Values: [ "DECIMAL", "UUID", "DATE", "TIME_MILLIS", "TIME_MICROS", "TIMESTAMP_MILLIS", "TIMESTAMP_MICROS", "LOCAL_TIMESTAMP_MILLIS", "LOCAL_TIMESTAMP_MICROS", "DURATION" ]

Logical data type of the field which extends or clarifies the primary data type.
oracleType(optional): string

Minimum Length: 1

Maximum Length: 255

Oracle DB data type of the field which extends or clarifies the primary data type.

{
    "type":"object",
    "description":"A field schema decribes a particular field in the object schema.\nIt contains at least a name and a data type, but potentially can be\nextended with some additional or more complex properties.\n",
    "required":[
        "fieldName",
        "dataType"
    ],
    "properties":{
        "fieldName":{
            "description":"Name of the field",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "dataType":{
            "description":"Data type of the field. Possible values include STRING, INTEGER, ...",
            "type":"string",
            "enum":[
                "BOOLEAN",
                "INT",
                "LONG",
                "FLOAT",
                "DOUBLE",
                "BYTES",
                "STRING",
                "ENUM",
                "ARRAY",
                "MAP",
                "FIXED"
            ]
        },
        "logicalType":{
            "description":"Logical data type of the field which extends or clarifies the primary data type.",
            "type":"string",
            "enum":[
                "DECIMAL",
                "UUID",
                "DATE",
                "TIME_MILLIS",
                "TIME_MICROS",
                "TIMESTAMP_MILLIS",
                "TIMESTAMP_MICROS",
                "LOCAL_TIMESTAMP_MILLIS",
                "LOCAL_TIMESTAMP_MICROS",
                "DURATION"
            ]
        },
        "oracleType":{
            "description":"Oracle DB data type of the field which extends or clarifies the primary data type.",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "x-example":{
                "application-json":"{\n  \"oracleType\": \"VARCHAR2(4000 BYTE)\"\n}\n"
            }
        },
        "additionalFlags":{
            "$ref":"#/definitions/AdditionalFlags"
        }
    }
}

Nested Schema : AdditionalFlags

Type: object

Additional flags which further clarifies the primary and logical types, or provide data type constraints.

Show Source

arrayType(optional): string

A type of array values, can be used only with the array logical type.
decimalPrecision(optional): integer(int32)

An integer representing the (maximum) precision of decimals stored in this type, can be used only with the decimal logical type
decimalScale(optional): integer(int32)

An integer representing the scale, can be used only with the decimal logical type.
defaultValue(optional): string

Minimum Length: 1

Maximum Length: 255

A default value of the given type.
enumConstants(optional): array enumConstants

A list of string constants for a particular enum, can be used only with the enum logical type.
fixedSize(optional): integer(int32)

Length of the fixed-sized string, can be used only with the fixed logical type.
isNullable(optional): boolean

Default Value: true

Marks a type as nullable. The default value is true and as such it's necessary explicitly state only if the type is not nullable.
mapValueType(optional): string

Allowed Values: [ "BOOLEAN", "INT", "LONG", "FLOAT", "DOUBLE", "BYTES", "STRING" ]

A type of map values, can be used only with the map logical type.
stringSize(optional): integer(int32)

An integer representing the (maximum) size of string stored in this type, can be used only with the string data type

{
    "type":"object",
    "description":"Additional flags which further clarifies the primary and logical types,\nor provide data type constraints.\n",
    "properties":{
        "isNullable":{
            "description":"Marks a type as nullable. The default value is true and as such it's necessary explicitly state only if the type is not nullable.\n",
            "type":"boolean",
            "default":true
        },
        "defaultValue":{
            "description":"A default value of the given type.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "decimalScale":{
            "description":"An integer representing the scale, can be used only with the decimal logical type.",
            "type":"integer",
            "format":"int32"
        },
        "decimalPrecision":{
            "description":"An integer representing the (maximum) precision of decimals stored in this type,\ncan be used only with the decimal logical type\n",
            "type":"integer",
            "format":"int32"
        },
        "stringSize":{
            "description":"An integer representing the (maximum) size of string stored in this type,\ncan be used only with the string data type\n",
            "type":"integer",
            "format":"int32"
        },
        "enumConstants":{
            "description":"A list of string constants for a particular enum, can be used only with the enum logical type.\n",
            "type":"array",
            "items":{
                "type":"string"
            },
            "x-example":{
                "application-json":"{\n  \"enumConstants\": [\"GOLD\", \"SILVER\", \"IRON\"]\n}\n"
            }
        },
        "arrayType":{
            "description":"A type of array values, can be used only with the array logical type.\n",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/AdditionalFlags/mapValueType"
        },
        "mapValueType":{
            "description":"A type of map values, can be used only with the map logical type.\n",
            "type":"string",
            "enum":[
                "BOOLEAN",
                "INT",
                "LONG",
                "FLOAT",
                "DOUBLE",
                "BYTES",
                "STRING"
            ]
        },
        "fixedSize":{
            "description":"Length of the fixed-sized string, can be used only with the fixed logical type.\n",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : enumConstants

Type: array

A list of string constants for a particular enum, can be used only with the enum logical type.

Show Source

Array of: string

{
    "description":"A list of string constants for a particular enum, can be used only with the enum logical type.\n",
    "type":"array",
    "items":{
        "type":"string"
    },
    "x-example":{
        "application-json":"{\n  \"enumConstants\": [\"GOLD\", \"SILVER\", \"IRON\"]\n}\n"
    }
}

Nested Schema : CsvProbingDetails

Type: object

Probing details specific to objects in the CSV format. Those can be used as hints for data processing in downstream business logic.

Show Source

areSkipRows(optional): boolean

Default Value: false

A boolean flag wheater the csv file contains skippable rows.
dateFormat(optional): string

Minimum Length: 1

Maximum Length: 255

A suggested hint for date parsing, a pattern for date format. See the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html

Example: MM-DD-YYYYBC MM-DD-YYYY YYYYMMDD HHMISS YYMMDD HHMISS YYYY.DDD YYYY-MM-DD
fieldDelimiter(optional): string

Minimum Length: 1

Maximum Length: 255

A delimiter of CSV values.

{
    "type":"object",
    "description":"Probing details specific to objects in the CSV format. Those can be used as hints\nfor data processing in downstream business logic.\n",
    "properties":{
        "fieldDelimiter":{
            "description":"A delimiter of CSV values.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "areSkipRows":{
            "description":"A boolean flag wheater the csv file contains skippable rows.",
            "type":"boolean",
            "default":false
        },
        "dateFormat":{
            "description":"A suggested hint for date parsing, a pattern for date format.\nSee the Format Models reference: https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/Format-Models.html\n",
            "example":"MM-DD-YYYYBC\nMM-DD-YYYY\nYYYYMMDD HHMISS\nYYMMDD HHMISS\nYYYY.DDD\nYYYY-MM-DD\n",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    }
}

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.

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.

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.

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

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.

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.

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

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.

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