SAP ABAP Class CL_DBA_SQL_FORMATTER (SQL Formatter Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB (Application Component) Database Interface, Database Platforms
     ⤷ SDBA_COMMON (Package) Cross-Platform DBA cockpit objects

Properties

Class	CL_DBA_SQL_FORMATTER
Short Description	SQL Formatter Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SDBA_COMMON	Cross-Platform DBA cockpit objects
Created	20070228	SAP
Last change	20140121	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_DBA_SQL_FORMATTER has no interface implemented.

Friends

Class CL_DBA_SQL_FORMATTER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACTION_INDENT_NL	Constant	Private	☐	Type reference (TYPE)	FLAG	'I'	General Flag	20070228
2	ACTION_NEWLINE	Constant	Private	☐	Type reference (TYPE)	FLAG	'N'	General Flag	20070228
3	BRACKET_INDENT_SIZE	Constant	Private	☐	Type reference (TYPE)	I	4		20070301
4	DBSYS	Static Attribute	Private	☐	Type reference (TYPE)	DBCON_DBMS		Database system	20111103
5	DIAGDATA	Static Attribute	Private	☐	Type reference (TYPE)	DIAG_TAB			20130311
6	DIAGMODE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130307
7	INDENT_FACTOR	Static Attribute	Private	☐	Type reference (TYPE)	I			20070228
8	KEYWORD_INDENT_SIZE	Static Attribute	Private	☐	Type reference (TYPE)	I	8		20070301
9	KEY_TAB	Static Attribute	Private	☐	See coding				20070228
10	MAX_OUTPUT_LENGTH	Static Attribute	Private	☐	Type reference (TYPE)	I			20070228
11	OUTPUT	Static Attribute	Private	☐	Type reference (TYPE)	DB6_STRING_TAB			20070228
12	STMT_TAB	Static Attribute	Private	☐	Type reference (TYPE)	DB6_STRING_TAB			20070228

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPEND_RESPECTING_LINE_LENGTH	Static method	Private	Method	append word respecting max. allowed length of one line	20070228
2	APPEND_TO_OUTPUT	Static method	Private	Method		20070301
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20070228
4	EQUALSIGNORECASE	Static method	Private	Method		20110127
5	FORMAT_SINGLE_STMT	Static method	Private	Method		20070228
6	FORMAT_STATEMENT	Static method	Public	Method		20070228
7	FORMAT_STATEMENT_WD	Static method	Public	Method	Format Statement for WD output	20071005
8	GET_DIAGDATA	Static method	Public	Method		20130311
9	GET_INDENT_STRING	Static method	Private	Method		20130311
10	SET_INDENT	Static method	Private	Method		20130311

Events

Class CL_DBA_SQL_FORMATTER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	DIAG_TAB	Public	See coding			20130311	diag_tab type standard table of diag_tab_entry
2	DIAG_TAB_ENTRY	Public	See coding			20130311	begin of diag_tab_entry, recursion_level type i, indent_factor type i, local_bracket_level type i, from_clause_processed type abap_bool, outer_from_clause_processed type abap_bool, current_line type string, end of diag_tab_entry
3	KEY_TAB_ENTRY	Private	See coding			20070228	begin of key_tab_entry, keyword type string, action type flag, indent_weight type i, end of key_tab_entry

Method Signatures

Method APPEND_RESPECTING_LINE_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LINE_IN	Call by reference	☐	Type reference (TYPE)	STRING			20070228
2	Returning	LINE_OUT	Value transfer	☐	Type reference (TYPE)	STRING			20070228
3	Importing	WORD	Call by reference	☐	Type reference (TYPE)	CLIKE			20070228

Method APPEND_RESPECTING_LINE_LENGTH on class CL_DBA_SQL_FORMATTER has no exception.

Method APPEND_TO_OUTPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LINE	Call by reference	☐	Type reference (TYPE)	STRING			20070301

Method APPEND_TO_OUTPUT on class CL_DBA_SQL_FORMATTER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_DBA_SQL_FORMATTER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_DBA_SQL_FORMATTER has no exception.

Method EQUALSIGNORECASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EQUALS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20110127
2	Importing	STR1	Call by reference	☐	Type reference (TYPE)	STRING			20110127
3	Importing	STR2	Call by reference	☐	Type reference (TYPE)	STRING			20110127

Method EQUALSIGNORECASE on class CL_DBA_SQL_FORMATTER has no exception.

Method FORMAT_SINGLE_STMT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NEXT_TABIX	Value transfer	☐	Type reference (TYPE)	I			20070228
2	Importing	OUTER_FROM_CLAUSE_PROCESSED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130311
3	Importing	RECURSION_LEVEL	Call by reference	☐	Type reference (TYPE)	I			20130311
4	Importing	STMT_TABIX	Call by reference	☐	Type reference (TYPE)	I			20070228

Method FORMAT_SINGLE_STMT on class CL_DBA_SQL_FORMATTER has no exception.

Method FORMAT_STATEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	FORMATTED_STMT	Value transfer	☐	Type reference (TYPE)	DB6_STRING_TAB		DB6: List of single CLP commands	20070228
2	Importing	OP_DBSYS	Call by reference	☑	Type reference (TYPE)	DBCON_DBMS			20111103
3	Importing	OP_DIAGMODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130307
4	Importing	OP_INDENT_SIZE	Call by reference	☐	Type reference (TYPE)	I	7		20070228
5	Importing	OP_MAX_OUTPUT_LENGTH	Call by reference	☐	Type reference (TYPE)	I	200		20070228
6	Importing	RAW_STMT	Call by reference	☐	Type reference (TYPE)	STRING			20070228

Method FORMAT_STATEMENT on class CL_DBA_SQL_FORMATTER has no exception.

Method FORMAT_STATEMENT_WD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	FORMATTED_STATEMENT	Value transfer	☐	Type reference (TYPE)	STRING			20071005
2	Importing	HIGHLIGHT_KEYWORDS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20071005
3	Importing	OP_DBSYS	Call by reference	☑	Type reference (TYPE)	DBCON_DBMS			20111103
4	Importing	OP_INDENT_SIZE	Call by reference	☐	Type reference (TYPE)	I	7		20071005
5	Importing	OP_MAX_OUTPUT_LENGTH	Call by reference	☐	Type reference (TYPE)	I	200		20071005
6	Importing	RAW_STMT	Call by reference	☐	Type reference (TYPE)	STRING			20071005

Method FORMAT_STATEMENT_WD on class CL_DBA_SQL_FORMATTER has no exception.

Method GET_DIAGDATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DATA	Value transfer	☐	Type reference (TYPE)	DIAG_TAB			20130311

Method GET_DIAGDATA on class CL_DBA_SQL_FORMATTER has no exception.

Method GET_INDENT_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FACTOR	Call by reference	☐	Type reference (TYPE)	I			20130311
2	Returning	IDENT_STR	Value transfer	☐	Type reference (TYPE)	STRING			20130311

Method GET_INDENT_STRING on class CL_DBA_SQL_FORMATTER has no exception.

Method SET_INDENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEW_INDENT	Call by reference	☐	Type reference (TYPE)	I			20130311

Method SET_INDENT on class CL_DBA_SQL_FORMATTER has no exception.

History

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