Oracle | DBMS_KAFKA

Oracle DBMS_KAFKA_UTL Version 26ai

General Information

Library Note

Morgan's Library Page Header

The best Oracle News for FY2026

Oracle Database 26ai is now availble. If you haven't you downloaded already: Why?

Purpose Oracle Database Utilities supporting Access to Apache Kafka topics.

AUTHID CURRENT_USER

Dependencies

ALL_CREDENTIALS	DBMS_SESSION	JSON_KEY_LIST
ALL_DIRECTORIES	DBMS_STANDARD	JSON_OBJECT_T
ALL_TABLES	DBMS_STATS	PLITBLM
DBMS_ASSERT	DBMS_SYS_ERROR	USER_KAFKA_APPLICATIONS
DBMS_KAFKA	DBMS_UTILITY	USER_KAFKA_CLUSTERS
DBMS_KAFKA_ADM	DUAL	USER_KAFKA_OPS
DBMS_KAFKA_MD	JSON_ARRAY_T	USER_KAFKA_PARTITIONS
DBMS_LOB	JSON_ELEMENT_T	USER_VIEWS
DBMS_OUTPUT

Documented No

First Available 23ai

Security Model Owned by SYS with no privileges granted

Direct access to this package is prevented by an Accessible By clause.

Source {ORACLE_HOME}/rdbms/admin/prvtkafkaus.plb
{ORACLE_HOME}/rdbms/admin/prvtkafkaub.plb

Subprograms

ADD_APP_PARTITIONS_AUTO	CREATE_APP_AUTO
CHECK_APPLICATION_NAME	CREATE_PARTITION_VIEW
CHECK_APPLICATION_TYPE	DROP_UNUSED_PARTITIONS_VIEW
CHECK_APPLICATION_TYPE_SUPPORTED	DROP_VIEWS_TABLES_LOCATIONS
CHECK_APPLICATION_TYPE_SUPPORTED_BY_VIEW	FORMAT_CP_NAME
CHECK_BOOTSTRAP_SERVERS	FORMAT_VIEW_PREFIX
CHECK_CLUSTER_ACCESS_DIRECTORY	GET_APPLICATION_DATA
CHECK_CLUSTER_DIRECTORY	GET_LOAD_COLUMNS
CHECK_CLUSTER_ID	GET_PARTITION_COUNT
CHECK_CLUSTER_NAME	PARSE_OBJECT_NAME
CHECK_CREDENTIAL_NAME	SET_DBMS_KAFKA_CONTEXT
CHECK_KAFKA_PROVIDER	SET_TRACING
CHECK_OPTIONS	TARGET_TABLE_EXISTS
CHECK_SQL_NAME_FRAGMENT	VALIDATE_KAFKA_VIEW
CHECK_TOPIC_NAME	VALIDATE_TEMP_TABLE

ADD_APP_PARTITIONS_AUTO (new 23ai)

Undocumented dbms_kafka_utl.add_app_partitions_auto( p_cluster_name IN VARCHAR2, p_cluster_id IN VARCHAR2, p_application_name IN VARCHAR2, p_topic_name IN VARCHAR2, p_options IN sys.json_object_t, p_num_views IN NUMBER, p_num_partitions IN NUMBER, p_application_type IN VARCHAR2, p_new_partition_count IN NUMBER, p_inline_exttab IN BOOLEAN);

TBD

CHECK_APPLICATION_NAME (new 23ai)

Undocumented dbms_kafka_utl.check_application_name(p_param_value IN VARCHAR2) RETURN VARCHAR2;

TBD

CHECK_APPLICATION_TYPE (new 23ai)

Undocumented dbms_kafka_utl.check_application_type(p_param_value IN VARCHAR2);

TBD

CHECK_APPLICATION_TYPE_SUPPORTED (new 23ai)

Undocumented dbms_kafka_utl.check_application_type_supported( p_cluster_name IN VARCHAR2, p_application_name IN VARCHAR2, p_application_type IN VARCHAR2, p_application_type2 IN VARCHAR2);

TBD

CHECK_APPLICATION_TYPE_SUPPORTED_BY_VIEW (new 23ai)

Undocumented dbms_kafka_utl.check_application_type_supported_by_view( p_view_name IN VARCHAR2, p_application_type IN VARCHAR2, p_application_type2 IN VARCHAR2);

TBD

CHECK_BOOTSTRAP_SERVERS (new 23ai)

Undocumented dbms_kafka_utl.check_bootstrap_servers(p_bootstrap_servers IN VARCHAR2);

TBD

CHECK_CLUSTER_ACCESS_DIRECTORY (new 23ai)

Undocumented dbms_kafka_utl.check_cluster_access_directory(p_param_value IN VARCHAR2) RETURN VARCHAR2;

TBD

CHECK_CLUSTER_DIRECTORY (new 23ai)

Undocumented dbms_kafka_utl.check_cluster_directory( p_param_value IN VARCHAR2, p_err_msg_prefix IN VARCHAR2) RETURN VARCHAR2;

TBD

CHECK_CLUSTER_ID (new 23ai)

Undocumented dbms_kafka_utl.check_cluster_id( p_param_value IN VARCHAR2, p_include_state_check IN BOOLEAN) RETURN VARCHAR2;

TBD

CHECK_CLUSTER_NAME (new 23ai)

Undocumented

Overload 1 dbms_kafka_utl.check_cluster_name(p_param_value IN VARCHAR2) RETURN VARCHAR2;

TBD

Overload 2 dbms_kafka_utl.check_cluster_name( p_param_value IN VARCHAR2, p_cluster_name OUT VARCHAR2, p_cluster_id OUT VARCHAR2, p_include_state_check IN BOOLEAN);

TBD

CHECK_CREDENTIAL_NAME (new 23ai)

Undocumented dbms_kafka_utl.check_credential_name(p_param_value IN VARCHAR2) RETURN VARCHAR2;

TBD

CHECK_KAFKA_PROVIDER (new 23ai)

Undocumented dbms_kafka_utl.check_kafka_provider(p_param_value IN VARCHAR2);

TBD

CHECK_OPTIONS (new 23ai)

Undocumented dbms_kafka_utl.check_options( p_options IN CLOB, p_allow_debug_options IN BOOLEAN, p_json_options OUT sys.json_object_t);

TBD

CHECK_SQL_NAME_FRAGMENT (new 23ai)

Undocumented dbms_kafka_utl.check_sql_name_fragment( p_param_name IN VARCHAR2, p_param_value IN VARCHAR2) RETURN VARCHAR2;

TBD

CHECK_TOPIC_NAME (new 23ai)

Undocumented dbms_kafka_utl.check_topic_name( p_param_name IN VARCHAR2, p_param_value IN VARCHAR2);

TBD

CREATE_APP_AUTO (new 23ai)

Undocumented dbms_kafka_utl.create_app_auto( p_cluster_name IN VARCHAR2, p_cluster_id IN VARCHAR2, p_application_name IN VARCHAR2, p_topic_name IN VARCHAR2, p_options IN sys.json_object_t, p_view_count IN NUMBER, p_partition_count IN NUMBER, p_requested_view_count IN NUMBER, p_application_type IN VARCHAR2, p_inline_exttab IN BOOLEAN);

TBD

CREATE_PARTITION_VIEW (new 23ai)

Undocumented dbms_kafka_utl.create_partition_view( p_cluster_id IN VARCHAR2, p_cluster_name IN VARCHAR2, p_created OUT BOOLEAN);

TBD

DROP_UNUSED_PARTITIONS_VIEW (new 23ai)

Undocumented dbms_kafka_utl.drop_unused_partitions_view(p_cluster_id IN VARCHAR2);

TBD

DROP_VIEWS_TABLES_LOCATIONS (new 23ai)

Undocumented dbms_kafka_utl.drop_views_tables_locations( p_cluster_id IN VARCHAR2, p_application_name IN VARCHAR2, p_inline_exttab IN BOOLEAN);

TBD

FORMAT_CP_NAME (new 23ai)

Undocumented dbms_kafka_utl.format_cp_name(p_cluster_name IN VARCHAR2) RETURN VARCHAR2;

SELECT dbms_kafka_utl.format_cp_name('CNAME');

             *

      ORA-06553: PLS-904: insufficient privilege to access object DBMS_KAFKA_UTL

FORMAT_VIEW_PREFIX (new 23ai)

Undocumented dbms_kafka_utl.format_view_prefix( p_cluster_name IN VARCHAR2, p_application_name IN VARCHAR2) RETURN VARCHAR2;

SELECT 
      dbms_kafka_utl.format_view_prefix('CNAME', 'ANAME');

             *

      ORA-06553: PLS-904: insufficient privilege to access object DBMS_KAFKA_UTL

GET_APPLICATION_DATA (new 23ai)

Undocumented dbms_kafka_utl.get_application_data( p_cluster_id IN VARCHAR2, p_application_name IN VARCHAR2, p_topic_name OUT VARCHAR2, p_options OUT sys.json_object_t, p_num_view OUT NUMBER, p_num_partitions OUT NUMBER, p_application_type OUT VARCHAR2);

TBD

GET_LOAD_COLUMNS (new 23ai)

Undocumented dbms_kafka_utl.get_load_columns( p_target_table IN VARCHAR2, p_load_columns OUT CLOB);

TBD

GET_PARTITION_COUNT (new 23ai)

Undocumented dbms_kafka_utl.get_partition_count( p_cluster_id IN VARCHAR2, p_cluster_name IN VARCHAR2, p_topic_name IN VARCHAR2) RETURN NUMBER;

TBD

PARSE_OBJECT_NAME (new 23ai)

Undocumented dbms_kafka_utl.parse_object_name( p_name IN VARCHAR2, p_schema_name OUT VARCHAR2, p_object_name OUT VARCHAR2);

TBD

SET_DBMS_KAFKA_CONTEXT (new 23ai)

Undocumented dbms_kafka_utl.set_dbms_kafka_count( p_view_name IN VARCHAR2, p_flag IN NUMBER);

TBD

SET_TRACING (new 23ai)

Undocumented dbms_kafka_utl.set_tracing( p_cluster_id IN VARCHAR2, p_cluster_name IN VARCHAR2, p_application_name IN VARCHAR2, p_enable IN BOOLEAN);

TBD

TARGET_TABLE_EXISTS (new 23ai)

Undocumented dbms_kafka_utl.target_table_exists(p_table_name IN VARCHAR2) RETURN VARCHAR2;

TBD

VALIDATE_KAFKA_VIEW (new 23ai)

Undocumented dbms_kafka_utl.validate_kafka_view(p_view_name IN VARCHAR2) RETURN VARCHAR2;

TBD

VALIDATE_TEMP_TABLE (new 23ai)

Undocumented dbms_kafka_utl.validate_temp_table(p_temp_table_name IN VARCHAR2) RETURN VARCHAR2;

TBD