SAP ABAP Class CL_RSDBC_METADATA (Method to Describe DB Objects)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-WHM-DST (Application Component) Data Staging
     ⤷ RSDL (Package) BW: DB Connect - SDK Connect

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSDBC_METADATA_HANA_SDA	HANA Smart Data Access	20130806
2	Inheritance (c INHERITING FROM c_ref)	CL_RSDBC_METADATA_HDB	SQL Metadata with long names for HDB	20130716

Properties

Class	CL_RSDBC_METADATA
Short Description	Method to Describe DB Objects
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	RSDL	BW: DB Connect - SDK Connect
Created	20130715	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ADBC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	RSDBC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSDBC_METADATA has no interface implemented.

Friends

Class CL_RSDBC_METADATA has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_LOWERCASE_IDENTIFIER	Constant	Public	☐	Type reference (TYPE)	ADBC_IDENTIFIER_STORE_METHOD	'L'		20130715
2	C_MIXEDCASE_IDENTIFIER	Constant	Public	☐	Type reference (TYPE)	ADBC_IDENTIFIER_STORE_METHOD	'M'		20130715
3	C_TABLE_TYPE_MONITOR	Constant	Public	☐	Type reference (TYPE)	ADBC_TABLE_TYPE	'M'		20130715
4	C_TABLE_TYPE_REMOTE	Constant	Public	☐	Type reference (TYPE)	ADBC_TABLE_TYPE	'R'		20130715
5	C_TABLE_TYPE_SYNONYM	Constant	Public	☐	Type reference (TYPE)	ADBC_TABLE_TYPE	'S'		20130715
6	C_TABLE_TYPE_TABLE	Constant	Public	☐	Type reference (TYPE)	ADBC_TABLE_TYPE	'T'		20130715
7	C_TABLE_TYPE_VIEW	Constant	Public	☐	Type reference (TYPE)	ADBC_TABLE_TYPE	'V'		20130715
8	C_UPPERCASE_IDENTIFIER	Constant	Public	☐	Type reference (TYPE)	ADBC_IDENTIFIER_STORE_METHOD	'U'		20130715
9	O_R_SQL_METADATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SQL_METADATA		Method to Describe DB Objects	20130715

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20130715
2	ENHANCE_COLUMN	Static method	Public	Method		20130822
3	FACTORY	Static method	Public	Method		20130715
4	GET_COLUMNS	Instance method	Public	Method	Supplies All Columns of Table	20130715
5	GET_CONNECTION	Instance method	Public	Method	Supplies the DB Connection That Creates the Metadata Object	20130715
6	GET_IDENTIFIER_STORE_METHOD	Instance method	Public	Method	Describes Storage Form of Identifiers in DB Catalog	20130715
7	GET_INDEX_INFO	Instance method	Public	Method		20130715
8	GET_PRIMARY_KEYS	Instance method	Public	Method	Returns the Primary Key Fields of a Table	20130715
9	GET_SCHEMAS	Instance method	Public	Method	Supplies All DB Schemas for Specified Selection Criteria	20130715
10	GET_TABLES	Instance method	Public	Method	Supplies All Tables for Specified Selection Criteria	20130715
11	GET_VIEWTEXT	Instance method	Public	Method	Supplies Defined Text of DB View	20130715
12	MOVE_NAME	Static method	Protected	Method		20130715
13	MOVE_RANGE	Static method	Protected	Method		20130715
14	TRF_RGTAB_TO_SQLEXPR	Instance method	Protected	Method		20130716
15	TRF_RG_TO_SQLCOND	Instance method	Protected	Method		20130716

Events

Class CL_RSDBC_METADATA has no event.

Types

Class CL_RSDBC_METADATA has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_CONNECTION	Call by reference	☑	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20130715

#	Exception	Resumable	Description	Created on
1	CX_PARAMETER_INVALID	☐	Superclass for Parameter Error	20130715

Method ENHANCE_COLUMN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_COLUMN	Call by reference	☐	Type reference (TYPE)	RSDBC_S_FIE			20130822
2	Importing	I_BIGINT_INT8	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Boolean	20130912

Method ENHANCE_COLUMN on class CL_RSDBC_METADATA has no exception.

Method FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_CONNECTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20130715
2	Returning	R_R_METADATA	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSDBC_METADATA		Method to Describe DB Objects	20130715

Method FACTORY on class CL_RSDBC_METADATA has no exception.

Method GET_COLUMNS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_COLUMN	Call by reference	☐	Type reference (TYPE)	RSDBC_T_FIE		Table with Column Headings	20130715
2	Importing	I_SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		Database Schema	20130715
3	Importing	I_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		Table Name	20130715

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

Method GET_CONNECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_CONNECTION	Value transfer	☐	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20130715

Method GET_CONNECTION on class CL_RSDBC_METADATA has no exception.

Method GET_IDENTIFIER_STORE_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STORE_METHOD	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20130715

Method GET_IDENTIFIER_STORE_METHOD on class CL_RSDBC_METADATA has no exception.

Method GET_INDEX_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_INDEX	Call by reference	☐	Type reference (TYPE)	RSDBC_T_INDEX			20130715
2	Importing	I_INDEX_NAME	Call by reference	☑	Type reference (TYPE)	RSDBC_NAME			20130715
3	Importing	I_SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME			20130715
4	Importing	I_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME			20130715

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐		20130715

Method GET_PRIMARY_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_PRIMARY_KEY_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		Name of Primary Key	20130715
2	Exporting	E_T_PRIMARY_KEY	Call by reference	☐	Type reference (TYPE)	RSDBC_T_SCHEMAS		Table with Key Fields	20130715
3	Importing	I_SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		Database Schema	20130715
4	Importing	I_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		Table Name	20130715

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

Method GET_SCHEMAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_SCHEMA	Call by reference	☐	Type reference (TYPE)	RSDBC_T_SCHEMAS		Table of Selected Schemas	20130715
2	Importing	I_RT_SCHEMA	Call by reference	☑	Type reference (TYPE)	RSDBC_RT_NAME		Range Table to Delimit Schemas	20130715

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

Method GET_TABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_TAB	Call by reference	☐	Type reference (TYPE)	RSDBC_T_TAB		Internal Table with Selected Tables	20130715
2	Importing	I_RT_SCHEMA	Call by reference	☑	Type reference (TYPE)	RSDBC_RT_NAME		Database Schema	20130715
3	Importing	I_RT_TABLE	Call by reference	☑	Type reference (TYPE)	RSDBC_RT_NAME		Range Table To Delimit Tables	20130715
4	Importing	I_TABLE_TYPES	Call by reference	☑	Type reference (TYPE)	STRING		List of Table Types	20130715

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

Method GET_VIEWTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		Database Schema	20130715
2	Importing	I_VIEW_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		View Name	20130715
3	Returning	R_TEXT	Value transfer	☐	Type reference (TYPE)	STRING		View text	20130715

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

Method MOVE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ANY	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20130715
2	Returning	R_NAME	Value transfer	☐	Type reference (TYPE)	ADBC_NAME			20130715

Method MOVE_NAME on class CL_RSDBC_METADATA has no exception.

Method MOVE_RANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_RT_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_RT_NAME			20130715
2	Returning	R_RT_NAME	Value transfer	☐	Type reference (TYPE)	ADBC_NAME_RGTAB			20130715

Method MOVE_RANGE on class CL_RSDBC_METADATA has no exception.

Method TRF_RGTAB_TO_SQLEXPR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COLUMN_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		Name of the DB field	20130716
2	Importing	I_RT_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_RT_NAME		Range of Table	20130716
3	Returning	R_COLUMN_COND	Value transfer	☐	Type reference (TYPE)	STRING		SQL Condition	20130716

Method TRF_RGTAB_TO_SQLEXPR on class CL_RSDBC_METADATA has no exception.

Method TRF_RG_TO_SQLCOND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COLUMN_NAME	Call by reference	☐	Type reference (TYPE)	RSDBC_NAME		Name of the DB field	20130716
2	Importing	I_R_RANGE_COND	Call by reference	☐	Type reference (TYPE)	RSDBC_R_NAME		Row of Range Table	20130716
3	Returning	R_SIMPLE_COND	Value transfer	☐	Type reference (TYPE)	STRING		Simple Field Comparison	20130716

Method TRF_RG_TO_SQLCOND on class CL_RSDBC_METADATA has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	740