Oracle | DBMS_KAFKA

Oracle DBMS_KAFKA_ADM Version 26ai

General Information

Library Note

Morgan's Library Page Header

The best Oracle News for FY2026

Oracle Database 26ai will be available on generic Linux platforms in January and soon on AIX and Windows

Purpose Oracle Database Utilities supporting Access to Apache Kafka topics.

AUTHID DEFINER

Constants

Name	Data Type	Value
Cluster Definition States
STATE_CONNECTED	INTEGER	0
STATE_MAINTENANCE	INTEGER	1
STATE_BROKEN	INTEGER	2
STATE_DEREGISTERED	INTEGER	3
Kafka Connection Modes
CONNECTION_MODE_HI_THRU	VARCHAR2(15)	'high_throughput'
CONNECTION_MODE_LO_LAT	VARCHAR2(11)	'low_latency'
Kafka providers
KAFKA_PROVIDER_APACHE	VARCHAR2(6)	'APACHE'
KAFKA_PROVIDER_OSS	VARCHAR2(3)	'OSS'

Options
OPT_CONNECTION_MODE	VARCHAR2(30)	'connmode'

Data Types TYPE PROPERTIES_TYPE IS TABLE OF VARCHAR2(1000) INDEX BY VARCHAR2(1000);

Dependencies

DBMS_ASSERT	DBMS_LOB	JSON_ELEMENT_T
DBMS_KAFKA_APPLICATIONS	DBMS_STANDARD	JSON_KEY_LIST
DBMS_KAFKA_CLUSTERS	DBMS_SYS_ERROR	JSON_OBJECT_T
DBMS_KAFKA_INT	DUAL	PLITBLM
DBMS_KAFKA_UTL

Documented No

First Available 23ai

Pragmas PRAGMA SUPPLEMENTAL_LOG_DATA(default, NONE);

Security Model Owned by SYS with EXECUTE granted to the OSAK_ADMIN_ROLE role

Source {ORACLE_HOME}/rdbms/admin/dbmskafkaadm.sql
{ORACLE_HOME}/rdbms/admin/prvtkafkaadm.plb

Subprograms

CHECK_CLUSTER	DISABLE_CLUSTER	REGISTER_CLUSTER
DEREGISTER_CLUSTER	ENABLE_CLUSTER	UPDATE_CLUSTER_INFO

CHECK_CLUSTER (new 23ai)

Test Kafka cluster connectivity

Returns the cluster state or an exception dbms_kafka_adm.check_cluster(cluster_name IN VARCHAR2) RETURN INTEGER;

TBD

DEREGISTER_CLUSTER (new 23ai)

Deregister a Kafka cluster dbms_kafka_adm.deregister_cluster( cluster_name IN VARCHAR2, forced IN BOOLEAN DEFAULT FALSE);

TBD

DISABLE_CLUSTER (new 23ai)

Disable a Kafka cluster dbms_kafka_adm.disable_cluster(cluster_name IN VARCHAR2);

TBD

ENABLE_CLUSTER (new 23ai)

Enable a Kafka cluster dbms_kafka_adm.enable_cluster(cluster_name IN VARCHAR2);

TBD

REGISTER_CLUSTER (new 23ai)

Register a Kafka cluster dbms_kafka_adm.register_cluster( cluster_name IN VARCHAR2, bootstrap_servers IN VARCHAR2, kafka_provider IN VARCHAR2, cluster_access_dir IN VARCHAR2, credential_name IN VARCHAR2 DEFAULT NULL, cluster_config_dir IN VARCHAR2 DEFAULT NULL, cluster_description IN VARCHAR2 DEFAULT NULL, options IN CLOB DEFAULT NULL) RETURN INTEGER;

TBD

UPDATE_CLUSTER_INFO (new 23ai)

Update the bootstrap server and/or the options for the Kafka cluster dbms_kafka_adm.update_cluster_info( cluster_name IN VARCHAR2, bootstrap_servers IN VARCHAR2 DEFAULT NULL, options IN CLOB DEFAULT NULL);

TBD