SAP ABAP Class CL_MSS_RAT (MSSQL: Database monitor data provider interface)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-DB-MSS (Application Component) Microsoft SQL Server
     SMSS_TOOLS (Package) Utilities for MS SQL Server
Properties
Class CL_MSS_RAT  
Short Description MSSQL: Database monitor data provider interface    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SMSS_TOOLS   Utilities for MS SQL Server 
Created 20100804   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)
2 ADBC Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_MSS_RAT has no interface implemented.
Friends
Class CL_MSS_RAT has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 AUTH_ANALYZE Constant Private Type reference (TYPE) ACTIV_AUTH '71' Activity 20100805
2 AUTH_DISPLAY Constant Private Type reference (TYPE) ACTIV_AUTH '03' Activity 20100805
3 CONN Instance attribute Private Type reference (TYPE) MSSCONNDATA MSSQL multi-connect : Complete connection information 20100804
4 FINALO Instance attribute Private Type reference (TYPE) OSTRUCT_T Table of OSTRUCT_L 20100807
5 MT_CORRESPONDING Constant Public Type reference (TYPE) MAPTYPE_L '3' Use MOVE-CORRESPONDING to copy cell contents 20100804
6 MT_DEFAULT Constant Public Type reference (TYPE) MAPTYPE_L '0' Same as '1' if RESITAB is bound 20100804
7 MT_LEFTRIGHT Constant Public Type reference (TYPE) MAPTYPE_L '1' Map fields left to right, ignore surplus columns 20100804
8 MT_SYNTNAMES Constant Public Type reference (TYPE) MAPTYPE_L '4' Create synthetic filed names 20100804
9 MT_USEMAPPING Constant Public Type reference (TYPE) MAPTYPE_L '2' Map columns according to the MAPPING vector 20100804
10 RT_INPARS Constant Public Type reference (TYPE) C '1' RFCTRANS : input meta data 20100804
11 RT_RATFLAT Constant Public Type reference (TYPE) C '2' RFCTRANS : RAT with MSSSERIA input 20100804
12 RT_RATOLD Constant Public Type reference (TYPE) C '4' RFCTRANS : RAT with MSSSERIA, no CONN 20100804
13 RT_RATTYPED Constant Public Type reference (TYPE) C '3' RFCTRANS : RAT with INSTRUCT 20100804
14 SERI_STRUCT Constant Public Type reference (TYPE) SERI_TYPE 'STRUCT' Object serialization option (use SERI_* constants) 20100810
15 SERI_TABLE Constant Public Type reference (TYPE) SERI_TYPE 'TABLE' Object serialization option (use SERI_* constants) 20100810
16 TL Instance attribute Private Type reference (TYPE) TLIST_L sap_tf_tlist return structure 20100804
Methods
# Method Level Visibility Method type Description Created on
1 BUILD_N_EXEC Instance method Private Method Build the SQL statement, execute it, return the result ref 20100805
2 BUILD_OBINDER Instance method Private Method Create physical result set structure 20100807
3 CLOSE_DBCON Instance method Private Method Close database connection 20100805
4 CONSOLIDATE_O Instance method Private Method Rowset structure reconciliation and cleansing 20100806
5 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20100804
6 EXEC_PROVIDER Instance method Public Method Execute the data provider and return its result set 20100805
7 FILL_FCAT Instance method Private Method Convert OSTRUCT_T to an ALV field catalog 20100807
8 GET_INPUT_STRUCT Instance method Public Method Get structure of strongly typed input parameters 20100804
9 GET_OUTPUT_STRUCT Instance method Public Method Output structure metadata 20100806
10 GET_RS_METADATA Instance method Private Method Discover the ADBC rowset metadata 20100806
11 INST_TO_META Static method Public Method Discover the metadata representation for a struct or table 20100810
12 MAP_OSTRUCT Instance method Private Method Finalize mapping rules 20100806
13 META_TO_INST Static method Public Method Instantiate a struct or table from its metadata 20100810
14 OPEN_DBCON Instance method Private Method Open database connection 20100805
15 POP_RESULT Instance method Private Method Populate result table 20100806
16 READ_ISTRUCT Instance method Private Method Local DB call to read the input parameter metadata 20100804
17 READ_OSTRUCT Instance method Private Method Local DB call to read the anticipated result set metadata 20100805
18 READ_SQL_BATCH Instance method Private Method Read the source code of a SQL batch data provider 20110426
19 READ_TLIST Instance method Private Method Local DB call to read the RAT object metadata 20100805
20 SORT_RESULT Instance method Private Method Sort result set according to sap_tf_outcols' SORTIER 20101004
21 TYPE_ADBC_TO_DB Static method Private Method Convert the ADBC type to a T-SQL type 20120621
22 TYPE_DB_TO_DDIC Static method Public Method Convert the T-SQL type to an ABAP type 20100805
23 TYPE_DB_TO_TYPEDESC Static method Private Method Convert the T-SQL type to an ABAP RTTS descriptor 20120621
24 TYPE_TYPEDESC_TO_DB Static method Private Method Convert the ABAP RTTS descriptor to a T-SQL type 20120621
Events
Class CL_MSS_RAT has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 ISTRUCT_L Public See coding Input parameter metadata 20100804 BEGIN OF ISTRUCT_L , COLNAME(64) TYPE C , COLTYPE(64) TYPE C , COLLENGTH TYPE I , COLPREC TYPE I , COLSCALE TYPE I , COLID TYPE I , INITIO(1) TYPE C , DEFWERT(64) TYPE C , END OF ISTRUCT_L
2 ISTRUCT_T Public See coding Table of ISTRUCT_L 20100804 ISTRUCT_T TYPE STANDARD TABLE OF ISTRUCT_L
3 MAPPING_L Public See coding Mapping the RAT result set (source) to the internal table 20100804 BEGIN OF MAPPING_L , COLSORC TYPE I , NAMSORC(40) TYPE C , COLTARG TYPE I , NAMTARG(40) TYPE C , END OF MAPPING_L
4 MAPPING_T Public See coding Table type for result set mapping 20100804 MAPPING_T TYPE STANDARD TABLE OF MAPPING_L
5 MAPTYPE_L Public See coding Mapping type (only use MT_ constants) 20100804 MAPTYPE_L(1) TYPE C
6 OSTRUCT_L Public See coding Output rowset structure 20100804 BEGIN OF OSTRUCT_L , COLNAME(64) TYPE C , LONGNAME(255) TYPE C , COLTYPE(64) TYPE C , COLLENGTH TYPE I , COLPREC TYPE I , COLSCALE TYPE I , COLID TYPE I , CLOBJECT(64) TYPE C , CLPARAM(64) TYPE C , SORTIER TYPE I , HIDDEN(1) TYPE C , END OF OSTRUCT_L
7 OSTRUCT_T Public See coding Table of OSTRUCT_L 20100804 OSTRUCT_T TYPE STANDARD TABLE OF OSTRUCT_L
8 SERI_TYPE Public See coding Object serialization option (use SERI_* constants) 20100810 SERI_TYPE(10) TYPE C
9 TLIST_L Public See coding sap_tf_tlist return structure 20100804 BEGIN OF TLIST_L , HIERARCHY(30) TYPE C , OBJNAME(64) TYPE C , OBJTYPE(1) TYPE C , ACTVT(2) TYPE N , HIDDEN(1) TYPE C , NRKEYS TYPE I , PTYPE(10) TYPE C , DESCRIPT(80) TYPE C , END OF TLIST_L
Method Signatures

Method BUILD_N_EXEC 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 Database Connection 20100805
2 Importing DBSCHEMA Call by reference Type reference (TYPE) MSSCONNDATA-DBSCHEMA MSSQL Multiconnect : Object source schema 20100805
3 Importing INSTRUCT Call by reference Object reference (TYPE REF TO) DATA Structure with typed input parameters 20100805
4 Exporting RS_REF Call by reference Object reference (TYPE REF TO) CL_SQL_RESULT_SET Resulting Set of an SQL Query 20100805
5 Importing TLIST Call by reference Type reference (TYPE) TLIST_L sap_tf_tlist return structure 20100805
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100805

Method BUILD_OBINDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FINALO Call by reference Type reference (TYPE) OSTRUCT_T Table of OSTRUCT_L 20100807
2 Exporting LDESCR Call by reference Object reference (TYPE REF TO) CL_ABAP_STRUCTDESCR Runtime Type Services 20100810
3 Exporting OBINDER Value transfer Object reference (TYPE REF TO) DATA Refernece to result table 20100807
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20110211

Method CLOSE_DBCON Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CON_REF Call by reference Object reference (TYPE REF TO) CL_SQL_CONNECTION Database Connection 20100805
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100805

Method CONSOLIDATE_O Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting FINALO Call by reference Type reference (TYPE) OSTRUCT_T Merged metadata 20100806
2 Importing MAPTYPE Call by reference Type reference (TYPE) MAPTYPE_L Mapping type (only use MT_ constants) 20100806
3 Importing MDSTRUCT Call by reference Type reference (TYPE) OSTRUCT_T Metadata of ADBC rowset 20100806
4 Importing OSTRUCT Call by reference Type reference (TYPE) OSTRUCT_T Metadata from sap_tf_outcols 20100806

Method CONSOLIDATE_O on class CL_MSS_RAT has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CURRCON Call by reference Type reference (TYPE) MSSCONNDATA MSSQL multi-connect : Complete connection information 20100804
2 Importing OBJNAME Call by reference Type reference (TYPE) TLIST_L-OBJNAME sap_tf_tlist return structure 20100804

Method CONSTRUCTOR on class CL_MSS_RAT has no exception.

Method EXEC_PROVIDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INSTRUCT Call by reference Object reference (TYPE REF TO) DATA Structure with typed input parameters 20100805
2 Importing MAPPING Call by reference Type reference (TYPE) MAPPING_T Table type for result set mapping 20100805
3 Importing MAPTYPE Call by reference Type reference (TYPE) MAPTYPE_L '0' Mapping type (only use MT_ constants) 20100805
4 Changing RESITAB Call by reference Object reference (TYPE REF TO) DATA Result table pointer (may be null) 20100805
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100805

Method FILL_FCAT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FCAT Value transfer Type reference (TYPE) LVC_T_FCAT Field Catalog for List Viewer Control 20100807
2 Importing FINALO Call by reference Type reference (TYPE) OSTRUCT_T Table of OSTRUCT_L 20100807
3 Importing TLIST Call by reference Type reference (TYPE) TLIST_L sap_tf_tlist return structure 20100807
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100807

Method GET_INPUT_STRUCT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INPARAMS Call by reference Object reference (TYPE REF TO) DATA Old-style linear list of parameter values 20100804
2 Exporting INSTRUCT Value transfer Object reference (TYPE REF TO) DATA Structure with strongly typed parameters 20100804
3 Exporting IPLIST Call by reference Type reference (TYPE) ISTRUCT_T Table of ISTRUCT_L 20100811
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100804

Method GET_OUTPUT_STRUCT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting FCAT Call by reference Type reference (TYPE) LVC_T_FCAT Field Catalog for List Viewer Control 20100806
2 Exporting RESTRUCT Call by reference Type reference (TYPE) OSTRUCT_T Table of OSTRUCT_L 20100806
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100806

Method GET_RS_METADATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting MDSTRUCT Call by reference Type reference (TYPE) OSTRUCT_T Table of OSTRUCT_L 20100806
2 Importing RS_REF Call by reference Object reference (TYPE REF TO) CL_SQL_RESULT_SET Resulting Set of an SQL Query 20100806
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100806

Method INST_TO_META Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INST Call by reference Object reference (TYPE REF TO) DATA Structure or table 20100810
2 Exporting META Call by reference Object reference (TYPE REF TO) DATA ISTRUCT_T or OSTRUCT_T 20100810
3 Importing OPTION Call by reference Type reference (TYPE) SERI_TYPE Object serialization option (use SERI_* constants) 20100810
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100810

Method MAP_OSTRUCT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FINALO Call by reference Type reference (TYPE) OSTRUCT_T Table of OSTRUCT_L 20100806
2 Exporting IS_IDENT Call by reference Type reference (TYPE) ABAP_BOOL No mapping necessary ? 20100806
3 Changing MAPPING Call by reference Type reference (TYPE) MAPPING_T Table type for result set mapping 20100806
4 Importing MAPTYPE Call by reference Type reference (TYPE) MAPTYPE_L Mapping type (only use MT_ constants) 20100806
5 Importing RESITAB Call by reference Object reference (TYPE REF TO) DATA Output table - ref may be empty 20100806
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100806

Method META_TO_INST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting INST Call by reference Object reference (TYPE REF TO) DATA Structure or table 20100810
2 Importing META Call by reference Object reference (TYPE REF TO) DATA ISTRUCT_T or OSTRUCT_T 20100810
3 Importing OPTION Call by reference Type reference (TYPE) SERI_TYPE Object serialization option (use SERI_* constants) 20100810
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100811

Method OPEN_DBCON 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 Database Connection 20100805
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100805

Method POP_RESULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_IDENT Call by reference Type reference (TYPE) ABAP_BOOL 20100807
2 Importing MAPPING Call by reference Type reference (TYPE) MAPPING_T Table type for result set mapping 20100807
3 Importing OBINDER Call by reference Object reference (TYPE REF TO) DATA Physical result set structure 20100807
4 Changing RESITAB Call by reference Object reference (TYPE REF TO) DATA Result table 20100807
5 Importing RS_REF Call by reference Object reference (TYPE REF TO) CL_SQL_RESULT_SET Resulting Set of an SQL Query 20100807
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100807

Method READ_ISTRUCT 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 Database Connection 20100804
2 Importing DBSCHEMA Call by reference Type reference (TYPE) MSSCONNDATA-DBSCHEMA MSSQL Multiconnect : Object source schema 20100804
3 Exporting ISTRUCT Call by reference Type reference (TYPE) ISTRUCT_T Table of ISTRUCT_L 20100804
4 Importing TLIST Call by reference Type reference (TYPE) TLIST_L sap_tf_tlist return structure 20100805
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100804

Method READ_OSTRUCT 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 Database Connection 20100805
2 Importing DBSCHEMA Call by reference Type reference (TYPE) MSSCONNDATA-DBSCHEMA MSSQL Multiconnect : Object source schema 20100805
3 Exporting OSTRUCT Call by reference Type reference (TYPE) OSTRUCT_T Table of OSTRUCT_L 20100805
4 Importing TLIST Call by reference Type reference (TYPE) TLIST_L sap_tf_tlist return structure 20100805
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100805

Method READ_SQL_BATCH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OBJNAME Value transfer Type reference (TYPE) TLIST_L-OBJNAME Data provider name 20110426
2 Returning QUERY Value transfer Type reference (TYPE) STRING SQL batch string 20110426
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20110426

Method READ_TLIST 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 Database Connection 20100805
2 Importing DBSCHEMA Call by reference Type reference (TYPE) MSSCONNDATA-DBSCHEMA MSSQL Multiconnect : Object source schema 20100805
3 Importing OBJNAME Call by reference Type reference (TYPE) TLIST_L-OBJNAME sap_tf_tlist return structure 20100805
4 Exporting TLIST Value transfer Type reference (TYPE) TLIST_L sap_tf_tlist return structure 20100805
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20100805

Method SORT_RESULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FINALO Call by reference Type reference (TYPE) OSTRUCT_T Table of OSTRUCT_L 20101004
2 Changing RESITAB Call by reference Object reference (TYPE REF TO) DATA Result table pointer 20101004

Method SORT_RESULT on class CL_MSS_RAT has no exception.

Method TYPE_ADBC_TO_DB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DECIMALS_IN Call by reference Type reference (TYPE) ADBC_RS_METADATA_DESCR-DECIMALS ADBC decimal positions 20120621
2 Importing LENGTH_IN Call by reference Type reference (TYPE) ADBC_RS_METADATA_DESCR-LENGTH ADBC data length 20120621
3 Exporting LENGTH_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLLENGTH Input parameter metadata 20120621
4 Exporting PREC_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLPREC Input parameter metadata 20120621
5 Exporting SCALE_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLSCALE Input parameter metadata 20120621
6 Importing TYPE_IN Call by reference Type reference (TYPE) ADBC_RS_METADATA_DESCR-DATA_TYPE ADBC type 20120621
7 Exporting TYPE_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLTYPE Input parameter metadata 20120621

Method TYPE_ADBC_TO_DB on class CL_MSS_RAT has no exception.

Method TYPE_DB_TO_DDIC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LENGTH_IN Call by reference Type reference (TYPE) ISTRUCT_L-COLLENGTH Input parameter metadata 20120620
2 Exporting LENGTH_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLLENGTH Input parameter metadata 20120620
3 Importing PREC_IN Call by reference Type reference (TYPE) ISTRUCT_L-COLPREC Input parameter metadata 20120620
4 Exporting PREC_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLPREC Input parameter metadata 20120620
5 Importing SCALE_IN Call by reference Type reference (TYPE) ISTRUCT_L-COLSCALE Input parameter metadata 20120620
6 Exporting SCALE_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLSCALE Input parameter metadata 20120620
7 Importing TYPE_IN Call by reference Type reference (TYPE) ISTRUCT_L-COLTYPE Input parameter metadata 20120620
8 Exporting TYPE_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLTYPE Input parameter metadata 20120620

Method TYPE_DB_TO_DDIC on class CL_MSS_RAT has no exception.

Method TYPE_DB_TO_TYPEDESC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LENGTH_IN Call by reference Type reference (TYPE) ISTRUCT_L-COLLENGTH Input parameter metadata 20120621
2 Importing PREC_IN Call by reference Type reference (TYPE) ISTRUCT_L-COLPREC Input parameter metadata 20120621
3 Exporting P_RESULT Call by reference Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20120621
4 Importing SCALE_IN Call by reference Type reference (TYPE) ISTRUCT_L-COLSCALE Input parameter metadata 20120621
5 Importing TYPE_IN Call by reference Type reference (TYPE) ISTRUCT_L-COLTYPE Input parameter metadata 20120621

Method TYPE_DB_TO_TYPEDESC on class CL_MSS_RAT has no exception.

Method TYPE_TYPEDESC_TO_DB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting LENGTH_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLLENGTH Input parameter metadata 20120621
2 Exporting PREC_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLPREC Input parameter metadata 20120621
3 Exporting SCALE_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLSCALE Input parameter metadata 20120621
4 Importing TYPE_IN Call by reference Object reference (TYPE REF TO) CL_ABAP_DATADESCR RTTS type 20120621
5 Exporting TYPE_OUT Call by reference Type reference (TYPE) ISTRUCT_L-COLTYPE Input parameter metadata 20120621

Method TYPE_TYPEDESC_TO_DB on class CL_MSS_RAT has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 703