SAP ABAP Class CL_SQL_METADATA (Method to Describe DB Objects)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB-DBI (Application Component) DB-Independent Database Interface
     ⤷ SDB_ADBC (Package) ABAP Database Call Interface (Dynamic SQL)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SQL_METADATA_ADA	Implements CL_SQL_METADATA for SAPDB	20010619
2	Inheritance (c INHERITING FROM c_ref)	CL_SQL_METADATA_DB2	DB2: Implementation of IF CL_SQL_METADATA	20020610
3	Inheritance (c INHERITING FROM c_ref)	CL_SQL_METADATA_DB4	DB4: Implementation of IF CL_SQL_METADATA	20010628
4	Inheritance (c INHERITING FROM c_ref)	CL_SQL_METADATA_DB6	DB6: Implementation of IF CL_SQL_METADATA	20010622
5	Inheritance (c INHERITING FROM c_ref)	CL_SQL_METADATA_HDB	Implements CL_SQL_METADATA for PTI	20091127
6	Inheritance (c INHERITING FROM c_ref)	CL_SQL_METADATA_MSS	Method to Describe DB Objects	20010628
7	Inheritance (c INHERITING FROM c_ref)	CL_SQL_METADATA_ORA	Implements CL_SQL_METADATA for Oracle	20010521
8	Inheritance (c INHERITING FROM c_ref)	CL_SQL_METADATA_SYB	Method to Describe DB Objects	20100727

Properties

Class	CL_SQL_METADATA
Short Description	Method to Describe DB Objects
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SDB_ADBC	ABAP Database Call Interface (Dynamic SQL)
Created	20010518	SAP
Last change	20010518	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)

Interfaces

Class CL_SQL_METADATA has no interface implemented.

Friends

Class CL_SQL_METADATA has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_REF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20010518
2	C_LOWERCASE_IDENTIFIER	Constant	Public	☐	Type reference (TYPE)	ADBC_IDENTIFIER_STORE_METHOD	'L'		20010523
3	C_MIXEDCASE_IDENTIFIER	Constant	Public	☐	Type reference (TYPE)	ADBC_IDENTIFIER_STORE_METHOD	'M'		20010523
4	C_TABLE_TYPE_SYNONYM	Constant	Public	☐	Type reference (TYPE)	ADBC_TABLE_TYPE	'S'		20010619
5	C_TABLE_TYPE_TABLE	Constant	Public	☐	Type reference (TYPE)	ADBC_TABLE_TYPE	'T'		20010605
6	C_TABLE_TYPE_VIEW	Constant	Public	☐	Type reference (TYPE)	ADBC_TABLE_TYPE	'V'		20010605
7	C_UPPERCASE_IDENTIFIER	Constant	Public	☐	Type reference (TYPE)	ADBC_IDENTIFIER_STORE_METHOD	'U'		20010523

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20010518
2	GET_COLUMNS	Instance method	Public	Method	Supplies All Columns of Table	20010518
3	GET_CONNECTION	Instance method	Public	Method	Supplies the DB Connection That Creates the Metadata Object	20010522
4	GET_IDENTIFIER_STORE_METHOD	Instance method	Public	Method	Describes Storage Form of Identifiers in DB Catalog	20010523
5	GET_INDEX_INFO	Instance method	Public	Method	Supplies All Indices of Table	20010518
6	GET_PRIMARY_KEYS	Instance method	Public	Method	Returns the Primary Key Fields of a Table	20010904
7	GET_SCHEMAS	Instance method	Public	Method	Supplies All DB Schemas for Specified Selection Criteria	20010605
8	GET_TABLES	Instance method	Public	Method	Supplies All Tables for Specified Selection Criteria	20010518
9	GET_VIEWTEXT	Instance method	Public	Method	Supplies Defined Text of DB View	20010607
10	TRF_RGTAB_TO_SQLEXPR	Instance method	Protected	Method	Creates an SQL Expression from a Range Table	20010606
11	TRF_RG_TO_SQLCOND	Instance method	Private	Method	Creates an SQL Condition from a Range Table	20010606

Events

Class CL_SQL_METADATA has no event.

Types

Class CL_SQL_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	CON_REF	Call by reference	☑	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Datenbankverbindung	20010518

#	Exception	Resumable	Description	Created on
1	CX_PARAMETER_INVALID	☐	Oberklasse für Parameterfehler	20010522

Method GET_COLUMNS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	COLUMN_TAB	Call by reference	☐	Type reference (TYPE)	ADBC_TABCOL_DESCR_TAB		Tabelle mit Spaltendeskriptoren	20010521
2	Importing	SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Datenbankschema	20010607
3	Importing	TABLE_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Tabellenname	20010521

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐	Ausnahmeklasse für SQL Fehler	20010521

Method GET_CONNECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CON_REF	Value transfer	☐	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Datenbankverbindung	20010522

Method GET_CONNECTION on class CL_SQL_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	STORE_METHOD	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20010523

Method GET_IDENTIFIER_STORE_METHOD on class CL_SQL_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	INDEX_INFO_TAB	Call by reference	☐	Type reference (TYPE)	ADBC_INDEX_DESCR_TAB		Interne Tabelle mit Index-Deskriptoren	20010521
2	Importing	INDEX_NAME	Call by reference	☑	Type reference (TYPE)	ADBC_NAME		Indexname	20010606
3	Importing	SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Datenbankschema	20010607
4	Importing	TABLE_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Tabellenname	20010521

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐	Ausnahmeklasse für SQL Fehler	20010521

Method GET_PRIMARY_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PRIMARY_KEY_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Name des Primärschlüssels	20010904
2	Exporting	PRIMARY_KEY_TAB	Call by reference	☐	Type reference (TYPE)	ADBC_COLUMN_TAB		Tabelle mit Sclüsselfeldern	20010904
3	Importing	SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Datenbankschema	20010904
4	Importing	TABLE_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Tabellenname	20010904

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐	Ausnahmeklasse für SQL Fehler	20010904

Method GET_SCHEMAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SCHEMA_RGTAB	Call by reference	☑	Type reference (TYPE)	ADBC_NAME_RGTAB		Range-Tabelle zur Eingrenzung von Schemata	20010606
2	Exporting	SCHEMA_TAB	Call by reference	☐	Type reference (TYPE)	ADBC_SCHEMA_TAB		Tabelle der selektierten Schemata	20010605

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐	Ausnahmeklasse für SQL Fehler	20010605

Method GET_TABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SCHEMA_RGTAB	Call by reference	☑	Type reference (TYPE)	ADBC_NAME_RGTAB		Datenbankschema	20010606
2	Exporting	TABLE_DESCR_TAB	Call by reference	☐	Type reference (TYPE)	ADBC_TABLE_DESCR_TAB		Interne Tabelle mit den selektierten Tabellen	20010605
3	Importing	TABLE_RGTAB	Call by reference	☑	Type reference (TYPE)	ADBC_NAME_RGTAB		Rangetabelle zur Eingrenzung von Tabellen	20010606
4	Importing	TABLE_TYPES	Call by reference	☑	Type reference (TYPE)	STRING		Liste von Tabellentypen	20010605

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐	Ausnahmeklasse für SQL Fehler	20010521

Method GET_VIEWTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SCHEMA_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Datenbankschema	20010607
2	Returning	TEXT	Value transfer	☐	Type reference (TYPE)	STRING		Viewtext	20010607
3	Importing	VIEW_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Viewname	20010607

#	Exception	Resumable	Description	Created on
1	CX_SQL_EXCEPTION	☐	Ausnahmeklasse für SQL Fehler	20010607

Method TRF_RGTAB_TO_SQLEXPR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COLUMN_COND	Value transfer	☐	Type reference (TYPE)	STRING		SQL Bedingung	20010606
2	Importing	COLUMN_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Name des DB-Feldes	20010606
3	Importing	NAME_RGTAB	Call by reference	☐	Type reference (TYPE)	ADBC_NAME_RGTAB		Range für Tabelle	20010606

Method TRF_RGTAB_TO_SQLEXPR on class CL_SQL_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	COLUMN_NAME	Call by reference	☐	Type reference (TYPE)	ADBC_NAME		Name des DB-Feldes	20010606
2	Importing	RANGE_COND	Call by reference	☐	Type reference (TYPE)	ADBC_NAME_RG		Zeile einer Rangetabelle	20010606
3	Returning	SIMPLE_COND	Value transfer	☐	Type reference (TYPE)	STRING		Einfacher Feldvergleich	20010606

Method TRF_RG_TO_SQLCOND on class CL_SQL_METADATA has no exception.

History

Last changed by/on	SAP	20010518
SAP Release Created in	620