SAP ABAP Class CL_ORA_ADBC_CMD (Oracle utility class to execute common ADBC queries)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-MON-ORA (Application Component) Oracle Database Monitors
     ⤷ S_ORA_COCKPIT (Package) DBACockpit: Oracle Monitors

Properties

Class	CL_ORA_ADBC_CMD
Short Description	Oracle utility class to execute common ADBC queries
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ORA_COCKPIT	DBACockpit: Oracle Monitors
Created	20090624	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_ORA_ADBC_CMD has no interface implemented.

Friends

Class CL_ORA_ADBC_CMD has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONNECTION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20110504
2	IMPORTED_CONNECTION	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	connection object was imported or self created	20120416
3	QUERY	Instance attribute	Private	☐	Type reference (TYPE)	STRING		the query string	20110504
4	RESULT_SET	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SQL_RESULT_SET		returned result set	20110504
5	SQL_EXCEPTION	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CX_SQL_EXCEPTION		Exception Class for SQL Error	20120424
6	STATEMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SQL_STATEMENT		Used database statement	20110504
7	SUCCESSFUL	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	statement was successful	20120416

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE	Instance method	Public	Method	Closes the result set and connection if given by name	20110504
2	CLOSE_CONNECTION	Static method	Private	Method	Closes the given connection	20091009
3	CONSTRUCTOR	Instance method	Private	Constructor	Create the object	20110504
4	CREATE	Static method	Public	Method	Creates a new object of this class	20110504
5	EXECUTE_QUERY	Static method	Public	Method	Executes a given SQL SELECT or DESCRIBE operation	20091009
6	EXECUTE_UPDATE	Static method	Public	Method	Executes an INSERT, UPDATE or DELETE query	20091009
7	GET_RESULT_LINE	Instance method	Public	Method	Get one line of the result into a variable or structure	20110504
8	GET_RESULT_SET	Instance method	Public	Method	complete result set for complex processing	20110505
9	GET_RESULT_TABLE	Instance method	Public	Method	Append the result to an internal table	20110504
10	INIT_RESULT_SET	Instance method	Private	Method	creates or returns existing result set	20110504
11	INIT_STATEMENT	Instance method	Private	Method	creates or returns existing statement	20110504
12	OPEN_CONNECTION	Static method	Private	Method	Opens an Oracle DB connection	20091009
13	READ_TEXT_FILE	Static method	Public	Method	Reads a text file in the oracle server file system	20091009
14	SET_PARAM	Instance method	Public	Method	Set input parameters in order of apperance	20110504
15	SET_QUERY	Instance method	Public	Method	Set the query including ? for parameters	20110504

Events

Class CL_ORA_ADBC_CMD has no event.

Types

Class CL_ORA_ADBC_CMD has no local type.

Method Signatures

Method CLOSE Signature

Method CLOSE on class CL_ORA_ADBC_CMD has no parameter.
Method CLOSE on class CL_ORA_ADBC_CMD has no exception.

Method CLOSE_CONNECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONNECTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20091009
2	Returning	R_DONE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20091009

Method CLOSE_CONNECTION on class CL_ORA_ADBC_CMD has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONNECTION	Call by reference	☑	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20110504
2	Importing	I_IMPORTED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120416
3	Importing	I_SQL_EXCEPTION	Call by reference	☑	Object reference (TYPE REF TO)	CX_SQL_EXCEPTION		Exception Class for SQL Error	20120424

Method CONSTRUCTOR on class CL_ORA_ADBC_CMD has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONNECTION	Call by reference	☑	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20120416
2	Importing	I_CON_NAME	Call by reference	☐	Type reference (TYPE)	DBCON_NAME	'DEFAULT'	Logical name for a database connection	20110504
3	Returning	RO_ORA_ADBC_CMD	Value transfer	☐	Object reference (TYPE REF TO)	CL_ORA_ADBC_CMD		Oracle utility class to execute common ADBC queries	20110504

Method CREATE on class CL_ORA_ADBC_CMD has no exception.

Method EXECUTE_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CON_NAME	Call by reference	☐	Type reference (TYPE)	DBCON_NAME	'DEFAULT'	Logical name for a database connection	20091009
2	Importing	I_LIMIT	Call by reference	☑	Type reference (TYPE)	I			20091009
3	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20091009
4	Importing	I_RESULT_STRUCT	Call by reference	☑	Type reference (TYPE)	DATA			20091009
5	Importing	I_RESULT_TABLE	Call by reference	☑	Type reference (TYPE)	ANY TABLE			20091009
6	Returning	R_SUCCESSFUL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20091009

Method EXECUTE_QUERY on class CL_ORA_ADBC_CMD has no exception.

Method EXECUTE_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CON_NAME	Call by reference	☐	Type reference (TYPE)	DBCON_NAME			20091009
2	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20091009
3	Returning	R_CHANGES	Value transfer	☐	Type reference (TYPE)	I		No. of changes done by the statement	20091009

Method EXECUTE_UPDATE on class CL_ORA_ADBC_CMD has no exception.

Method GET_RESULT_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LINE	Call by reference	☐	Type reference (TYPE)	DATA			20110504
2	Returning	RO_ORA_ADBC_CMD	Value transfer	☐	Object reference (TYPE REF TO)	CL_ORA_ADBC_CMD		Oracle utility class to execute common ADBC queries	20110504

Method GET_RESULT_LINE on class CL_ORA_ADBC_CMD has no exception.

Method GET_RESULT_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OUT_PARAM	Call by reference	☑	Type reference (TYPE)	DATA			20110505
2	Returning	RO_RESULT_SET	Value transfer	☐	Object reference (TYPE REF TO)	CL_SQL_RESULT_SET		Resulting Set of an SQL Query	20110505

Method GET_RESULT_SET on class CL_ORA_ADBC_CMD has no exception.

Method GET_RESULT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LIMIT	Call by reference	☑	Type reference (TYPE)	I		Limit the number of rows fetched	20110504
2	Importing	I_TABLE	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20110504
3	Returning	RO_ORA_ADBC_CMD	Value transfer	☐	Object reference (TYPE REF TO)	CL_ORA_ADBC_CMD		Oracle utility class to execute common ADBC queries	20110504

Method GET_RESULT_TABLE on class CL_ORA_ADBC_CMD has no exception.

Method INIT_RESULT_SET Signature

Method INIT_RESULT_SET on class CL_ORA_ADBC_CMD has no parameter.
Method INIT_RESULT_SET on class CL_ORA_ADBC_CMD has no exception.

Method INIT_STATEMENT Signature

Method INIT_STATEMENT on class CL_ORA_ADBC_CMD has no parameter.
Method INIT_STATEMENT on class CL_ORA_ADBC_CMD has no exception.

Method OPEN_CONNECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CON_NAME	Call by reference	☐	Type reference (TYPE)	DBCON_NAME	'DEFAULT'	Logical name for a database connection	20091009
2	Returning	R_CONNECTION	Value transfer	☐	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20091009

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐	Exception Class for SQL Error	20091009

Method READ_TEXT_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CON_NAME	Call by reference	☐	Type reference (TYPE)	DBCON_NAME	'DEFAULT'	Logical name for a database connection	20091009
2	Importing	I_IDENTIFIER	Call by reference	☐	Type reference (TYPE)	STRING			20091009
3	Returning	R_FILE_CONTENTS	Value transfer	☐	Type reference (TYPE)	STRING			20091009

Method READ_TEXT_FILE on class CL_ORA_ADBC_CMD has no exception.

Method SET_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PARAM	Call by reference	☐	Type reference (TYPE)	SIMPLE			20110504
2	Returning	RO_ORA_ADBC_CMD	Value transfer	☐	Object reference (TYPE REF TO)	CL_ORA_ADBC_CMD		Oracle utility class to execute common ADBC queries	20110504

Method SET_PARAM on class CL_ORA_ADBC_CMD has no exception.

Method SET_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		The query to be executed	20110504
2	Returning	RO_ORA_ADBC_CMD	Value transfer	☐	Object reference (TYPE REF TO)	CL_ORA_ADBC_CMD		Oracle utility class to execute common ADBC queries	20110504

Method SET_QUERY on class CL_ORA_ADBC_CMD has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	731