Oracle Cloud Infrastructure Documentation

Logging Search Common Types

DBMS_CLOUD_OCI_LOGGING_SEARCH_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOGGING_SEARCH_ERROR_T Type

Error response object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_LOGGING_SEARCH_FIELD_INFO_T Type

Contains field schema information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_field_info_t FORCE AUTHID CURRENT_USER IS OBJECT (
  field_name varchar2(32767),
  field_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_field_info_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_field_info_t (
    field_name varchar2,
    field_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

field_name

(required) Field name

field_type

(required) Field type - * `STRING`: A sequence of characters. * `NUMBER`: Numeric type which can be an integer or floating point. * `BOOLEAN`: Either true or false. * `ARRAY`: An ordered collection of values.

Allowed values are: 'STRING', 'NUMBER', 'BOOLEAN', 'ARRAY'

DBMS_CLOUD_OCI_LOGGING_SEARCH_SEARCH_LOGS_DETAILS_T Type

Search request object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_search_logs_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_start timestamp with time zone,
  time_end timestamp with time zone,
  search_query varchar2(32767),
  is_return_field_info number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_search_logs_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_search_logs_details_t (
    time_start timestamp with time zone,
    time_end timestamp with time zone,
    search_query varchar2,
    is_return_field_info number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_start

(required) Start filter log's date and time, in the format defined by RFC3339.

time_end

(required) End filter log's date and time, in the format defined by RFC3339.

search_query

(required) Query corresponding to the search operation. This query is parsed and validated before execution and should follow the specification. For more information on the query language specification, see Logging Query Language Specification.

is_return_field_info

(optional) Whether to return field schema information for the log stream specified in searchQuery.

DBMS_CLOUD_OCI_LOGGING_SEARCH_SEARCH_RESULT_T Type

A log search result entry.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_search_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
  data json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_search_result_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_search_result_t (
    data json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

data

(required) JSON blob containing the search entry with the projected fields.

DBMS_CLOUD_OCI_LOGGING_SEARCH_SEARCH_RESULT_SUMMARY_T Type

Summary of results.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_search_result_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  result_count number,
  field_count number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_search_result_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_search_result_summary_t (
    result_count number,
    field_count number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

result_count

(optional) Total number of search results.

field_count

(optional) Total number of field schema information.

DBMS_CLOUD_OCI_LOGGING_SEARCH_SEARCH_RESULT_TBL Type

Nested table type of dbms_cloud_oci_logging_search_search_result_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_search_result_tbl FORCE IS TABLE OF (dbms_cloud_oci_logging_search_search_result_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOGGING_SEARCH_FIELD_INFO_TBL Type

Nested table type of dbms_cloud_oci_logging_search_field_info_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_field_info_tbl FORCE IS TABLE OF (dbms_cloud_oci_logging_search_field_info_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOGGING_SEARCH_SEARCH_RESPONSE_T Type

Search response object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_logging_search_search_response_t FORCE AUTHID CURRENT_USER IS OBJECT (
  results dbms_cloud_oci_logging_search_search_result_tbl,
  fields dbms_cloud_oci_logging_search_field_info_tbl,
  summary dbms_cloud_oci_logging_search_search_result_summary_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_search_response_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_logging_search_search_response_t (
    results dbms_cloud_oci_logging_search_search_result_tbl,
    fields dbms_cloud_oci_logging_search_field_info_tbl,
    summary dbms_cloud_oci_logging_search_search_result_summary_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

results

(optional) List of search results

fields

(optional) List of log field schema information.

summary

(required)