US 7,082,455 B2Grant
Method and apparatus of parameter passing of structured data for stored procedures in a content management system
Issue Date:2006-07-25
•26 Claims
•6 Drawing Sheets
Abstract
A content management system is provided including a server computer and a client computer. The server includes a data repository and a stored procedure. The disclosed methodology provides a way of handling parameter passing of structured data for stored procedures in the system. The system is capable of both encoding data into a structured data format and decoding data from the structured data format. The structured data format employs a binary large object (BLOB) and character large object (CLOB) to achieve handling of fixed length binary data and variable length character data. Advantageously, the stored procedure interface need not be rewritten and customized for each stored procedure in the server.
Metadata
Assignee
- International Business Machines Corporation
Inventors
- Tawei Hu
- James J. Lin
- Kenneth C. Nelson
- Alan T. Yaung
- Randy Richardt
- Lily L. Liang
- Ed Gallagher
- Dwayne L. Richardson
Application Information
Application Number:US 10/128,260
Filing Date:2002-04-23
Priority Date:2002-04-23
Art Unit:2141
Classifications
IPC:
G06F15/16G06F13/00
Patent Drawings (6 sheets)
Description
Background
[0001] The disclosures herein relate generally to content management systems and more particularly to addressing problems associated with the lack of handling of structured data by stored procedures.
[0002] Modem computer database environments such as shown in FIG. 1 often include a client computer system connected to a server computer system containing one or more data repositories (such as relational database management systems—RDBMS). One or more stored procedures are stored in the server computer system. Each stored procedure, when executed, interacts with and performs database operations (such as a database query) on one or more of the database repositories.
[0003] Stored procedures in a content management system typically only handle primitive data types such as integer, long, binary large object (BLOB) and character large object (CLOB) in the parameter passing carried out by the procedure's interface (API). The interface of the conventional stored procedure does not provide parameter passing of structured data with variable length data such as 1) an array of integers; 2) an array of character strings, or 3) an array of mixed data types.
[0004] Some content management software is based on a set of stored procedures that interact with database servers, such as DB2 servers, for example. These stored procedures do not pass structured data and this can present a problem in many applications.
[0005] What is needed is a mechanism and methodology for handling parameter passing of structured data for stored procedures in a client-server content management system.
Summary
[0006] Accordingly, a method of communicating data between a stored procedure in a server and a client is disclosed which includes calling, by the stored procedure, a utility interface program in the server. The utility interface program encodes the data in a structured data format including a plurality of elements. The encoded data is transmitted by the server in the structured data format to the client. The client receives the encoded data and calls the utility interface program in the server to decode the encoded data. In one embodiment of the disclosed methodology, the structured data format includes a binary large object (BLOB) and a character large object (CLOB) to enable handling of both binary data and variable length character strings.
[0007] A principal advantage of the embodiment disclosed herein is the ability to handle parameter passing of structured data between a stored procedure and a client system.
Brief Description of the Drawings
[0008] FIG. 1 is a block diagram of a conventional content management system.
[0009] FIG. 2 is a block diagram of the disclosed content management system which features the ability to handle parameter passing of structured data.
[0010] FIG. 3 is a representation of the binary structured data format employed in one operational embodiment of the disclosed content management system and methodology.
[0011] FIG. 4 is a representation of the character structured data format employed in another operational embodiment of the disclosed content management system and methodology.
[0012] FIG. 5 is a representation of the mixed binary and character structured data format employed in yet another embodiment of the disclosed content management system and methodology.
Detailed Description
[0013] FIG. 2 depicts the disclosed content management system 100 in block diagram form. Content management system 100 is typically implemented in a server computer 102 which includes a database repository 105. One type of database which may be used in database repository 105 is a relational database system (RDBS) although other types of database structures may be employed as well. In actual practice, multiple database repositories 105 may be employed in content management system 100.
[0014] The disclosed methodology for handling parameter passing of structured data for store procedures in a content management system is now discussed. Content management system 100 includes at least one stored procedure 110 which is connected via its interface 115 to a client computer 120. The disclosed method involves communication of data between stored procedure 110 and client 120. An orthogonal data format provides a foundation for handling structured data communication including binary data, character data and mixed (binary and character) data.
[0015] The method includes an encoding process and a decoding process. The encoding process builds a data format for input parameters with structured data of stored procedure 110. In other words, a data format for parameter passing is constructed. The decoding process parses the data format for output parameters with structured data of stored procedure 110.
[0016] Stored procedures are often used to provide queries to a database repository. However, in the disclosed methodology, stored procedures can perform different functions. More particularly, when server 100 desires to transmit data to client 120, an encode/decode utility located in stored procedure 110 or its interface 115 is called. The utility acts as an encoder to encode the data in a BLOB/CLOB pair (binary large object/character large object pair) which is transmitted via interface 115 to client 120. In actual practice, the utility interface program may be located in interface 115 where it can be called by either stored procedure 110 or client 120. When client 120 receives the BLOB/CLOB pair, client 120 calls the utility interface program associated with the stored procedure, and the utility decodes the BLOB/CLOB pair to restore the original data for use by client 120.
[0017] Conversely, when client 120 desires to transmit data to stored procedure 110 of server 100, client 120 calls the utility interface program which encodes the data into the BLOB/CLOB pair which is then sent along to the stored procedure. The stored procedure can then decode the data as before. From the above, it will be appreciated that the utility can perform a bidirectional encode/decode operation depending on the circumstances. Either the stored procedure or the client can call the utility for encoding and decoding operations. Advantageously, the BLOB/CLOB pair data format employed by the utility enables communication of many kinds of data including structured data with variable length data such as integer arrays, character string arrays, binary data, character data and arrays of mixed data types (binary and character data).
[0018] Each piece of data which is to be built (encoded) or parsed (decoded) is placed in a BLOB/CLOB as an element. An element is composed of an element ID, a data type, a length and a value. The element ID identifies the element. For example, the element ID may be a component ID, a customer number or an account number. The data type describes the particular type of data, for example, binary, character or mixed. The length denotes the length of the data value to be passed between the stored procedure and client or vice versa. For integer types of data the length is fixed; however, for character data the length depends on the length of the particular string to be passed. The value represents the actual value to be passed.
[0019] Each part of the element is stored in the BLOB or CLOB. Element ID, the data type and the length are stored as a header in the BLOB. It is acceptable to store the value in either the BLOB or CLOB depending on the data type. In other words, the BLOB is used to store header data and binary data, whereas the CLOB is used to store character data. In the particular embodiment shown in the drawings subsequently discussed, a header contains an element ID (a 2 byte integer), a data type (a 2 byte integer) and a length (a 4 byte integer).
[0020] Three operational scenarios are now discussed with reference to FIGS. 3 , 4 and 5 respectively. More particularly, FIG. 3 shows the data structure employed for binary only data structures. FIG. 4 illustrates the data structure for character data only data structures. FIG. 5 depicts the data structure for mixed binary and character data structures.
[0021] Returning to the binary data scenario data structure of FIG. 3 , BLOB 200 includes elements 201 and 202. Element 201 includes header 201′ and binary data 201″, while element 202 includes header 202′ and binary data 202″. Header 201′ includes a 2 byte ELEMENT ID field for element 201, a 2 byte DATA TYPE field to indicate the data type of the binary data of element 201 as well as a LENGTH field to indicate the length of the binary data (4 bytes in this example). Element 202 is stored in BLOB 200 in a similar fashion to element 201 as shown. CLOB 205 is a null string in this example.
[0022] FIG. 4 depicts the data structure employed in a character data scenario. Element 301 includes a header 301′ and a character data field 301″ which includes the actual character data. Header 301′ includes an ELEMENT ID field, a DATA TYPE field and a LENGTH field for element 301 as shown. Similar headers (302′, 303′ and 304′) are provided for elements 302, 303 and 304, respectively. Header 301′ of element 301 and the headers associated with the other elements 302, 303 and 304 are stored in BLOB 300 while character data (CHAR DATA 302″, CHAR DATA 303″ and CHAR DATA 304″) are stored in CLOB 305.
[0023] FIG. 5 illustrates the data structure employed in the mixed binary and character data scenario. In this example, data element 401 includes header 401′ in a HEADER field and binary data 401″ in a BINARY DATA field. More specifically, header 401′ includes an element ID for element 401 in an ELEMENT ID field. Header 401′ also includes the type of the binary data in a DATA TYPE field and the length of the binary data in a LENGTH field as shown. It is noted that the BINARY DATA field 401′ contains the actual value of the binary data for element 401. Both header 401′ and the actual binary data 401″ of element 401 are stored in BLOB 400.
[0024] The other type of mixed data for which the data structure of FIG. 5 provides is character data, such as the character elements 402 and 403 illustrated. By way of example, character element 402 includes both a header 402′ in a HEADER field and the actual character data 402″ in a CHAR DATA field. Header 402′ includes an ELEMENT ID field for storing the element ID of element 402, a DATA TYPE field for storing the data type of element 402 and a LENGTH field for storing the length of element 402. The header 402′ of element 402 is stored in BLOB 400 while the character data 402″ is stored in the CLOB. The topology of character element 403 is analogous to the topology of character element 402 as shown in FIG. 5 .
[0025] Returning now to FIG. 2 , the stored procedure's utility interface program 115 provides two functions, namely a build function to take in specific types of data and pack the data into a BLOB portion and a CLOB portion. This build function is an encoding function. Interface 115 also provides a parse function to retrieve data from the BLOB and CLOB portions. This parse function is a decoding function. The encoding and decoding is performed by the aforementioned utility program associated with interface 115. Standard database mechanisms to pass parameters to stored procedures can be used to pass the BLOB and CLOB to and from stored procedure 110. Stored procedure 110 is capable of supporting variable length parameters by using the described BLOB CLOB pair data arrangement depicted in FIGS. 3–5 .
[0026] In one embodiment, interface 115 supports the following data types: sqlint16, sqlint32, sqlint64, double, character and binary data types. These data types are supported as either NULLable or nonNULLable. When the utility program encodes or builds the BLOB and CLOB, the data type is specified. When parsing or decoding, the data type is also specified to the utility program. If the date type upon encode does not equal the data type upon decode, the utility program returns an error. An exception to this error rule is that a nonNULLable data type can be built into the BLOB and CLOB and can be parsed as a NULLable data type. This is valid because nonNULLable is a subset of NULLable.
[0027] One example of the above mentioned utility interface program 115 that can be used for the encoding and decoding functions is now described with reference to a C language implementation. The utility uses a structure to hold all of the information with respect to the BLOB and CLOB. The structure is declared and initialized using one of the initialization routines discussed below. In actual practice, there are two different types of initialization, namely one for encoding and one for decoding. The structure is passed to other routines in the utility and is used for manipulating the data in the BLOB and CLOB. One structure which is acceptable is:
[0028]
The utility program includes a number of routines to initialize the structure. These routines are given below along with comments which describe the specific purpose of each routine: The acronym “SP” refers to stored procedure 110 and “API” refers to application program interface.
| typedefstruct _ICMPARMLOB_STRUCT | |
| { | |
| sqluint16 sByteOrder; | |
| sqluint32 lClobLength; | |
| sqluint32 lClobOffset; | |
| char * pClob; | |
| sqluint32 lBlobLength; | |
| sqluint32 lBlobOffset; | |
| char * pBlob; | |
| } ICMPARMLOB_STRUCT; | |
The utility program includes a number of routines to initialize the structure. These routines are given below along with comments which describe the specific purpose of each routine: The acronym “SP” refers to stored procedure 110 and “API” refers to application program interface.
[0029]
The utility program includes additional functions which are used to handle freeing of memory and to prepare the BLOB and CLOB to be sent between stored procedure 110 and client 120. In actual practice, a memory freeing routine is only needed after the build or encoding because in the decoding or parsing, BLOB and CLOB data is used directly from a host variable used to pass the data. A “prepare to send” routine is called to set the data length properly in the BLOB before it is sent between client 120 and stored procedure 110. These routines are now presented below:
| // . . . This routine is called by API or SP to create a CLOB/BLOB structure in which to | ||
| store data | ||
| sqlint32 ICMParmInitForBuild(ICMPARMLOB_STRUCT * pParms); | ||
| // . . . This routine is used by APIs which call SPs that return the CLOB and BLOB to | ||
| // make sure the output buffer is large enough to handle the data returned. | ||
| sqlint32 ICMParmInitForBuildWithSize(ICMPARMLOB_STRUCT * pParms, | ||
| sqluint32 | size); | |
| // . . . This routine is used by APIs which call SPs that return the CLOB and BLOB to | ||
| // make sure the output buffer is large enough to handle the data returned. | ||
| // This function is used when nothing is put into the BLOB/CLOB when it is | ||
| // sent to the SP, but results are returned from the SP. | ||
| sqlint32 ICMParmInitForOutput(ICMPARMLOB_STRUCT * pParms, | ||
| sqluint32 | size); | |
| // . . . Initialize CLOB/BLOB to pass a NULL CLOB/BLOB | ||
| sqlint32 ICMParmInitNULL(ICMPARMLOB_STRUCT * pParms); | ||
| // . . . Called from SP to initialize CLOB/BLOB structure | ||
| sqlint32 ICMParmInitForParse(ICMPARMLOB_STRUCT * pParms, | ||
| char | * pClob, | |
| char | * pBlob); | |
| // Called from API to initialize CLOB/BLOB structure returned from SP | ||
| sqlint32 ICMParmInitForParseAPI(ICMPARMLOB_STRUCT * pParms, | ||
| char | * pClob, | |
| char | * pBlob); | |
The utility program includes additional functions which are used to handle freeing of memory and to prepare the BLOB and CLOB to be sent between stored procedure 110 and client 120. In actual practice, a memory freeing routine is only needed after the build or encoding because in the decoding or parsing, BLOB and CLOB data is used directly from a host variable used to pass the data. A “prepare to send” routine is called to set the data length properly in the BLOB before it is sent between client 120 and stored procedure 110. These routines are now presented below:
-
- [0030] //..This “freeing of memory” routine frees memory allocated for CLOB/BLOB (only needed after building)
- [0031] sqlint32 ICMParmnFree(ICMPARMLOB_STRUCT*pparms);
- [0032] //..This “prepare to send” routine sets the sizes for the CLOB and BLOB correctly, (must be called before
- [0033] // the CLOB and BLOB are passed into or returned from a SP) sqlint32 ICMParmPrepareToSend(ICMPARMLOB_STRUCT*pParms);
The utility program associated with interface 115 also provides a set of constants for the data types supported. It is important that these constants remain consistent among the implementations of the interface. The list of constants is provided below for one embodiment of the disclosed methodology.
[0034]
The utility program (here a C interface) provides one routine to build or encode the BLOB CLOB and two routines to parse or decode the BLOB CLOB. These routines take in variable parameter lists to advantageously allow many values to be handled in a single call. In one embodiment, each routine takes in the BLOB/CLOB structure, a structure containing log information and a repeating list of elements. As discussed earlier, each element includes an element ID, a data type, a length, and the actual data value which may be either binary or character data. More specifically, element ID's are declared in lspdef.h. The data type is one of the constants referenced above. The value can be a pointer to the actual data value. The data type varies according to whether binary, character or mixed data is being manipulated. In more detail:
| typedef enum { | |
| PARM_TYPE_CHAR = 1, | |
| PARM_TYPE_SHORT, | |
| PARM_TYPE_LONG, | |
| PARM_TYPE_BINARY, | |
| PARM_TYPE_DOUBLE, | |
| PARM_TYPE_BIGINT, | |
| PARM_TYPE_MAX | |
| } PARM_TYPE; | |
| typedef enum { | |
| PARM_TYPE_CHAR_NULLABLE = 501, | |
| PARM_TYPE_SHORT_NULLABLE, | |
| PARM_TYPE_LONG_NULLABLE, | |
| PARM_TYPE_BINARY_NULLABLE, | |
| PARM_TYPE_DOUBLE_NULLABLE, | |
| PARM_TYPE_BIGINT_NULLABLE, | |
| PARM_TYPE_MAX_NULLABLE | |
| } PARM_TYPE_NULLABLE; | |
The utility program (here a C interface) provides one routine to build or encode the BLOB CLOB and two routines to parse or decode the BLOB CLOB. These routines take in variable parameter lists to advantageously allow many values to be handled in a single call. In one embodiment, each routine takes in the BLOB/CLOB structure, a structure containing log information and a repeating list of elements. As discussed earlier, each element includes an element ID, a data type, a length, and the actual data value which may be either binary or character data. More specifically, element ID's are declared in lspdef.h. The data type is one of the constants referenced above. The value can be a pointer to the actual data value. The data type varies according to whether binary, character or mixed data is being manipulated. In more detail:
[0035]
The utility program or C interface includes a parse routine which handles NULL values. This functionality is needed to process NULLable data types. The parse routine returns an indicator for each element that indicates whether the particular value is NULL. More specifically, the indicator is set to −1 if the value is NULL. In the build routine, the length is set to −1 to indicate a NULL value.
A representative parse routine for handling NULL values is given below:
| //********************************************************************** | ||
| // Ispdef.h Element ID definition | ||
| //********************************************************************** | ||
| #define ID_ACCESS_DATA 10 | ||
| #define ID_ACCESS_DLL_NAME 11 | ||
| #define ID_ACCESS_MOD_NAME 12 | ||
| #define ID_ACCESS_MOD_STATUS 13 | ||
| #define ID_ACCESS_TOKEN_TYPE 14 | ||
| #define ID_ACTION 15 | ||
| #define ID_ATTRIBUTE_ID 16 | ||
| #define ID_ATTR_FLAGS 17 | ||
| #define ID_ATTRIBUTE_LENGTH 18 | ||
| #define ID_ATTRIBUTE_TYPE 19 | ||
| #define ID_ATTRIBUTE_VALUE 20 | ||
| #define ID_CCSID 21 | ||
| #define ID_CHECK_IN 22 | ||
| #define ID_CHECK_OUT 23 | ||
| #define ID_CHILD_ITEMID 24 | ||
| #define ID_CHILD_LINK_TYPE 25 | ||
| #define ID_COLLNAME 26 | ||
| #define ID_COLL_CODE 27 | ||
| #define ID_COLUMN_NAME 28 | ||
| #define ID_COMMIT_COUNT 29 | ||
| #define ID_COMPONENT_DEFAULT_TYPE 30 | ||
| #define ID_COMPONENT_DEFAULT_VALUE 31 | ||
| #define ID_COMPONENT_DELETE_RULE 32 | ||
| #define ID_COMPONENT_ID 33 | ||
| #define ID_COMPONENT_MINIMUM_VALUE 34 | ||
| #define ID_COMPONENT_MAXIMUM_VALUE 35 | ||
| #define ID_COMPOSITE_ATTR_ID 36 | ||
| #define ID_COMPTYPE_ID 37 | ||
| #define ID_COMP_VIEW_ID 38 | ||
| #define ID_COMP_VIEW_NAME 39 | ||
| #define ID_DELETE_CHILD 40 | ||
| #define ID_DELETE_PARENT 41 | ||
| #define ID_DETAIL 42 | ||
| #define ID_ENCRYPTION_KEY 43 | ||
| #define ID_EXTOBJNAME 44 | ||
| #define ID_FORCE_DELETE 45 | ||
| #define ID_FORMAT 46 | ||
| #define ID_HOSTNAME 47 | ||
| #define ID_INDEX_DIR 48 | ||
| #define ID_INDEX_NAME 49 | ||
| #define ID_INDEX_TO_PARENT_ITEM 50 | ||
| #define ID_INETADDR_NAME 51 | ||
| #define ID_ITEM_ERRFLAG 52 | ||
| #define ID_ITEM_ID 53 | ||
| #define ID_ITEM_REQ_NUM 54 | ||
| #define ID_ITEM_TYPE_ID 55 | ||
| #define ID_ITEMTYPE_CLASS_ID 56 | ||
| #define ID_LANGUAGE_CODE 57 | ||
| #define ID_LEVEL 58 | ||
| #define ID_LIBRARY_ID 59 | ||
| #define ID_LINKTYPE_ID 60 | ||
| #define ID_LINK_ITEMID 61 | ||
| #define ID_LINK_OPTION 62 | ||
| #define ID_LINK_TYPE_CODE 63 | ||
| #define ID_MIN_CHANGES 64 | ||
| #define ID_MODEL_CCSID 65 | ||
| #define ID_MODEL_FILE 66 | ||
| #define ID_MODEL_NAME 67 | ||
| #define ID_NUM_CHILD_TYPES 68 | ||
| #define ID_NUM_OF_ATTRS 69 | ||
| #define ID_NUM_OF_COMPS 70 | ||
| #define ID_NUM_OF_COMPTYPE 71 | ||
| #define ID_NUM_OF_COMP_ID 72 | ||
| #define ID_NUM_OF_INVAL_ITEM 73 | ||
| #define ID_NUM_OF_ITEM_ID 74 | ||
| #define ID_NUM_OF_SECTOKEN 75 | ||
| #define ID_NUM_OF_URL 76 | ||
| #define ID_PARENTCOMP_ID 77 | ||
| #define ID_PARENT_COMPTYPE_ID 78 | ||
| #define ID_PARENT_ITEMID 79 | ||
| #define ID_PARENT_ITEM_TYPE_ID 80 | ||
| #define ID_PARENT_LINK_TYPE 81 | ||
| #define ID_PARENT_TYPE_ID 82 | ||
| #define ID_PORT 83 | ||
| #define ID_PREFETCH_COLLNAME 84 | ||
| #define ID_PRIVDEF_ID 85 | ||
| #define ID_PROTOCOL 86 | ||
| #define ID_RESOURCE_LENGTH 87 | ||
| #define ID_RM_CODE 88 | ||
| #define ID_SCHEMA_NAME 89 | ||
| #define ID_SEARCH_PARM_MAXRES 90 | ||
| #define ID_SEARCH_PARM_TIMEOUT 91 | ||
| #define ID_SECURITY_TOKEN 92 | ||
| #define ID_SEMANTIC_TYPE 93 | ||
| #define ID_SEQUENCE_NUMBER 94 | ||
| #define ID_SOURCE_ITEMID 95 | ||
| #define ID_STRUCT 96 | ||
| #define ID_TARGET_ITEMID 97 | ||
| #define ID_TARGET_TABLE_NAME 98 | ||
| #define ID_TEXT_SEARCH_FLAG 99 | ||
| #define ID_TIEREFFLAG 100 | ||
| #define ID_UDF_NAME 101 | ||
| #define ID_UDF_SCHEMA 102 | ||
| #define ID_UPDATE_FREQ 103 | ||
| #define ID_URL_ADDRESS 104 | ||
| #define ID_USER_ID 105 | ||
| #define ID_VERSION_FLAG 106 | ||
| #define ID_VERSION_ID 107 | ||
| #define ID_WORKING_DIR 108 | ||
| #define ID_LINK_TYPE 109 | ||
| #define ID_SEQUENCE_NUM 110 | ||
| #define ID_ATTR 111 | ||
| #define ID_COMPATTR 112 | ||
| #define ID_INDEXORDER 113 | ||
| #define ID_NUM_OF_ITEMTYPE 114 | ||
| #define ID_USERID_LENGTH 115 | ||
| #define ID_NUM_OF_LEVEL 116 | ||
| #define ID_ACTIONDEF_ID 117 | ||
| #define ID_PROMPT_FLAG 118 | ||
| #define ID_SEQUENCE 119 | ||
| #define ID_PROMPT 120 | ||
| #define ID_NAME 121 | ||
| #define ID_VALUE 122 | ||
| #define ID_XDO_SYSTEMTYPE 123 | ||
| #define ID_XDO_COMPILEOP 124 | ||
| #define ID_XDO_CPPXDOFACT 125 | ||
| #define ID_ITVIEW_ID 126 | ||
| #define ID_SEARCH_PARM_ORDER 127 | ||
| #define ID_QUERYSTRING 128 | ||
| #define ID_COMP_TYPE_ID 129 | ||
| #define ID_CONSTRAINT_NAME 130 | ||
| #define ID_DELETE_RULE 131 | ||
| #define ID_UPDATE_RULE 132 | ||
| #define ID_FOREIGN_KEY_PART 133 | ||
| #define ID_FOREIGN_KEY_ACTION 134 | ||
| #define ID_COLUMN_SEQ 135 | ||
| #define ID_ACL_CODE 136 | ||
| #define ID_PRIV_FLAG 137 | ||
| #define ID_ITEM_TYPE_VIEW_ID 138 | ||
| #define ID_OPERATOR 139 | ||
| #define ID_COMPARE_VALUE 140 | ||
| #define ID_TRANID_ID 141 | ||
| #define ID_TRANSTATUS_ID 142 | ||
| #define ID_RMACCESSTYPE_ID 143 | ||
| #define ID_REPTYPE_ID 144 | ||
| #define ID_CREATED_ID 145 | ||
| #define ID_RESOURCE_FLAG 146 | ||
| #define ID_REMOVEFROMAUTOFLDR_ID 147 | ||
| #define ID_VERSION_CONTROL 148 | ||
| #define ID_PARTNUM 149 | ||
| #define ID_NUM_OF_PARTS 150 | ||
| #define ID_COLL_NAME 151 | ||
| #define ID_PREFETCH_COLL_NAME 152 | ||
| #define ID_RESOURCE_NUM 153 | ||
| #define ID_RSRCNUM_VERSION_ID 154 | ||
| #define ID_TOKEN_OPTION 155 | ||
| #define ID_PRIVSET_CODE 156 | ||
| #define ID_TIMESTAMP 157 | ||
| #define ID_RMFLAGS 158 | ||
| #define ID_PRIMARY_RMCODE 159 | ||
| #define ID_PRIMARY_SMSCOLL 160 | ||
| #define ID_REPL_RMCODE 161 | ||
| #define ID_REPL_SMSCOLL 162 | ||
| #define ID_SEARCH_PARM_XQPE 163 | ||
| #define ID_INPUT_OPTION 164 | ||
| //********************************************************************** | ||
| sqlint32 ICMParmParse(ICMPARMLOB_STRUCT * pParms, | ||
| sqlint16 | sElementId, // . . . Begin Repeating | |
| sqluint16 | sDataType, | |
| sqlint32 | 1Length, | |
| void | *pValue, | |
| . . .); | ||
| sqlint32 ICMParmBuild(ICMPARMLOB_STRUCT * pParms, | ||
| sqlint16 | sElementId, // . . . Begin Repeating | |
| sqluint16 | sDataType, | |
| sqlint32 | 1Length, | |
| void | *pValue, | |
| . . .) | ||
The utility program or C interface includes a parse routine which handles NULL values. This functionality is needed to process NULLable data types. The parse routine returns an indicator for each element that indicates whether the particular value is NULL. More specifically, the indicator is set to −1 if the value is NULL. In the build routine, the length is set to −1 to indicate a NULL value.
A representative parse routine for handling NULL values is given below:
[0036]
| sqlint32 ICMParmParseNullable(ICMPARMLOB_STRUCT * pParms, | ||
| sqlint16 | sElementId, | |
| sqluint16 | sDataType, | |
| sqlint32 | 1Length, | |
| sqlint16 | * sIndicator, | |
| void | * pValue, | |
| . . . ); | ||
[0037]
| A representative build (encoding) code is given below: | ||
| ICMPARMLOB_STRUCT parms; | // declare a ICMPARAMLOB_STRUCT structure | |
| ICMPARMLOB_STRUCT *pParms = &parms; | // declare a pointer to the structure | |
| long rc= 0 ; | // declare the return code variable | |
| char DataValue[17]; | // declare a character array | |
| char * pDataValue = &DataValue; | // declare a pointer to the array | |
| // Parse the structure and get the data value | ||
| rc = ICMParmParse(pParms, | // pointer to ICMPARMLOB_STRUCT structure | |
| ID_CHECK_IN, | // Element ID | |
| PARM_TYPE_CHAR, | // character type 17, | |
| pDataValue, | // data value | |
| ICM_PARMLIST_END); | // marker to indicate the end of parameter | |
| A representative parsing (decoding) code is given below: | ||
| ICMPARMLOB_STRUCT parms; | // declare a ICMPARAMLOB_STRUCT structure | |
| ICMPARMLOB_STRUCT *pParms = &parms; | // declare a pointer to the structure | |
| long rc= 0 ; | // declare the return code variable | |
| char DataValue[17]; | // declare a character array | |
| char * pDataValue = &DataValue; | // declare a pointer to the array | |
| strcpy(pDataValue, “DATASTRING100000”); | // pass in the data | |
| // Build the structure with the given data value | ||
| rc = ICMParmBuild (pParms, | // pointer to ICMPARMLOB_STRUCT structure | |
| ID_CHECK_IN, | // Element ID | |
| PARM_TYPE_CHAR, | // character type 17, | |
| pDataValue, | // data value | |
| ICM_PARMLIST_END); | // marker to indicate the end | |
[0038] The content management system can be stored on virtually any computer-readable storage media, such as CD, DVD and other magnetic and optical media in either compressed or non-compressed form. Of course, it can also be stored on a server computer system or other information handling system.
[0039] As can be seen, a principal advantage of the disclosed methodology and apparatus is to provide for parameter passing of structured data for stored procedures in a content management system. Desirably, structured data with variable length such as an array of integers, an array of character strings, or an array of mixed data types are all accommodated in the disclosed interface between a stored procedure in a server and a client system. Without the disclosed methodology, each stored procedure in the content management system server would generally require interface customization to meet its special needs in parameter passing. The disclosed technology advantageously obviates this problem. It should be understood that while one representative stored procedure has been discussed with reference to the disclosed content management system, in actual practice the server of the system can contain multiple stored procedures and multiple clients employing the disclosed methodology can be coupled to the server.
[0040] Although illustrative embodiments have been shown and described, a wide range of modification, change and substitution is contemplated in the foregoing disclosure and in some instances, some features of an embodiment may be employed without a corresponding use of other features. Accordingly, it is appropriate that the appended claims be construed broadly and in a manner consistent with the scope of the embodiments disclosed herein.
Claims
Certificate of Correction present
The claims shown below may not include correction changes. Use the corrected PDF for authoritative text.
What is claimed is:
1. A method of communicating one or more pieces of data between a stored procedure in a server and a client connected to the server, the method comprising:
calling a utility interface program in the server to encode the one or more pieces of data, the utility interface program being called by the stored procedure;
encoding the one or more pieces of data into a binary large object (BLOB)/character large object (CLOB) pair using the utility interface program, each of the one or more pieces of data corresponding to an element in the BLOB/CLOB pair; and
transmitting the BLOB/CLOB pair to the client.
2. The method of claim 1, further comprising: receiving the BLOB/CLOB pair at the client; and calling the utility interface program in the server to decode the BLOB/CLOB pair, the utility interface program being called by the client.
3. The method of claim 1, wherein the one or more pieces of data are encoded into the BLOB/CLOB pair irrespective of whether the one or more pieces of data include only binary data, only character data, or a mixture of binary and character data.
4. The method of claim 1, wherein the one or more pieces of data include an array of integers.
5. The method of claim 1, wherein the one or more pieces of data include an array of character strings.
6. The method of claim 1, wherein the one or more pieces of data include an array of mixed data types.
7. The method of claim 1, wherein the one or more pieces of data are of variable length.
8. The method of claim 1, wherein each element in the BLOB/CLOB pair includes an element ID a data type, a data length, and a data value.
9. The method of claim 1, wherein the BLOB/CLOB pair is orthogonal.
10. A method of communicating one or more pieces of data between a client and a stored procedure in a server connected to the method comprising:
calling a utility interface program in the server to encode the one or more pieces of data, the utility interface program being called by the client;
encoding the one or more pieces of data into a binary large object (BLOB)/character large object (CLOB) pair using the utility interface program, each of the one or more pieces of data corresponding to an element in the BLOB/CLOB pair; and
transmitting the BLOB/CLOB pair to the stored procedure.
11. The method of claim 10, further comprising:
receiving the BLOB/CLOB pair, the BLOB/CLOB pair being received by the stored procedure; and
calling the utility interface program in the server to decode the BLOB/CLOB pair, the utility interface program being called by the stored procedure.
12. The method of claim 10, wherein the one or more pieces of data are encoded into the BLOB/CLOB pair irrespective of whether the one or more pieces of data include only binary data, only character data, or a mixture of binary and character data.
13. The method of claim 10, wherein the one or more pieces of data include an array of integers.
14. The method of claim 10, wherein the one or more pieces of data include an array of character strings.
15. The method of claim 10, wherein the one or more pieces of data include an array of mixed data types.
16. The method of claim 10, wherein the one or more pieces of data are of variable length.
17. The method of claim 10, wherein element in the BLOB/CLOB pair includes an element ID a data type, a data length, and a data value.
18. The method of claim 10, wherein the BLOB/CLOB pair is orthogonal.
19. A content management system comprising:
a client; and
a server connected to the client, the server being responsive to the client, wherein the server includes:
a database repository,
a stored procedure, which when executed, interacts with and performs database operations on the database repository, and
a utility interface program, which when called by the stored procedure, encodes one or more pieces of data from the stored procedure into a binary large object (BLOB)/character large object (CLOB) pair, each of the one or more pieces of data corresponding to an element in the BLOB/CLOB pair.
20. The content management system of claim 19, wherein the one or more pieces of data are encoded into the BLOB/CLOB pair irrespective of whether the one or more pieces of data include only binary data, only character data, or a mixture of binary and character data.
21. A content management system comprising:
a client; and
a server connected to the client the server being responsive to the client, wherein the server includes:
a database repository,
a stored procedure, which when executed, interacts with and performs database operations on the database repository, and
a utility interface program, which when called by the client, encodes one or more pieces of data from the client into a binary large object (BLOB)/character large object (CLOB) pair, each of the one or more pieces of data corresponding to an element in the BLOB/CLOB pair.
22. The content management system of claim 21, wherein the one or more pieces of data are encoded into the BLOB/CLOB pair irrespective of whether the one or more pieces of data include only binary data, only character data, or a mixture of binary and character data.
23. The content management system of claim 21, wherein, in response to receiving the BLOB/CLOB pair the stored procedure calls the utility interface program to decode the BLOB/CLOB pair.
24. A computer program product for communicating one or more pieces of data between a stored procedure in a server and a client connected to the server, the computer program product including a computer readable medium comprising a plurality of computer executable instructions for:
calling a utility interface program in the server to encode the one or more pieces of data the utility interface program being called by the stored procedure;
encoding the one or more pieces of data into a binary large object (BLOB)/character large object (CLOB) pair using the utility interface program, each of the one or more pieces of data corresponding to an element in the BLOB/CLOB pair; and
transmitting the BLOB/CLOB pair to the client.
25. The computer program product of claim 24, wherein the computer readable medium is an optical disk.
26. The computer program product of claim 24, wherein the computer readable medium is a magnetic disk.
Patent Citations (54)
| Patent | Date | Inventor | Cited By |
|---|---|---|---|
| US4751740(A) | 1988-06-01 | Wright | Applicant |
| US4969091(A) | 1990-11-01 | Muller | Applicant |
| US5615337(A) | 1997-03-01 | Zimowski et al. | Applicant |
| US5632015(A) | 1997-05-01 | Zimowski et al. | Examiner |
| US5644768(A) | 1997-07-01 | Periwal et al. | Applicant |
| US5742810(A) | 1998-04-01 | Ng et al. | Applicant |
| US5774719(A) | 1998-06-01 | Bowen | Applicant |
| US5778398(A) | 1998-07-01 | Nagashima et al. | Applicant |
| US5799310(A) | 1998-08-01 | Anderson et al. | Applicant |
| US5819252(A) | 1998-10-01 | Benson et al. | Applicant |
| US5862378(A) | 1999-01-01 | Wang et al. | Applicant |
| US5875332(A) | 1999-02-01 | Wang et al. | Applicant |
| US5892902(A) | 1999-04-01 | Clark | Applicant |
| US5940616(A) | 1999-08-01 | Wang | Applicant |
| US6012067(A) | 2000-01-01 | Sarkar | Applicant |
| US6016394(A) | 2000-01-01 | Walker | Applicant |
| US6047291(A) | 2000-04-01 | Anderson et al. | Applicant |
| US6055637(A) | 2000-04-01 | Hudson et al. | Applicant |
| US6063133(A) | 2000-05-01 | Li et al. | Applicant |
| US6065117(A) | 2000-05-01 | White | Applicant |
| US6067414(A) | 2000-05-01 | Wang et al. | Applicant |
| US6073168(A) | 2000-06-01 | Mighdoll et al. | Examiner |
| US6088524(A) | 2000-07-01 | Levy et al. | Applicant |
| US6104393(A) | 2000-08-01 | Santos-Gomez | Applicant |
| US6128621(A) | 2000-10-01 | Weisz | Applicant |
| US6148342(A) | 2000-11-01 | Ho | Applicant |
| US6161182(A) | 2000-12-01 | Nadooshan | Applicant |
| US6167405(A) | 2000-12-01 | Rosensteel, Jr. et al. | Applicant |
| US6173400(B1) | 2001-01-01 | Perlman et al. | Applicant |
| US6219826(B1) | 2001-04-01 | De Pauw et al. | Applicant |
| US6233586(B1) | 2001-05-01 | Chang et al. | Applicant |
| US6249822(B1) | 2001-06-01 | Kays, Jr. et al. | Examiner |
| US6263313(B1) | 2001-07-01 | Milsted et al. | Applicant |
| US6263342(B1) | 2001-07-01 | Chang et al. | Applicant |
| US6272488(B1) | 2001-08-01 | Chang et al. | Applicant |
| US6279111(B1) | 2001-08-01 | Jensenworth et al. | Applicant |
| US6282649(B1) | 2001-08-01 | Lambert et al. | Applicant |
| US6289344(B1) | 2001-09-01 | Braia et al. | Applicant |
| US6289458(B1) | 2001-09-01 | Garg et al. | Applicant |
| US6292936(B1) | 2001-09-01 | Wang | Applicant |
| US6308274(B1) | 2001-10-01 | Swift | Applicant |
| US6314449(B1) | 2001-11-01 | Gallagher et al. | Applicant |
| US6327629(B1) | 2001-12-01 | Wang et al. | Applicant |
| US6338056(B1) | 2002-01-01 | Dessloch et al. | Applicant |
| US6339777(B1) | 2002-01-01 | Attaluri et al. | Applicant |
| US6343286(B1) | 2002-01-01 | Lee et al. | Applicant |
| US6751798(B1) | 2004-06-01 | Schofield | Examiner |
| US6751799(B1) | 2004-06-01 | Kays et al. | Examiner |
| US6845392(B1) | 2005-01-01 | Koontz et al. | Examiner |
| US2001/0002486(A1) | 2001-05-01 | Kocher et al. | Applicant |
| US2001/0008015(A1) | 2001-07-01 | Vu et al. | Applicant |
| US2001/0019614(A1) | 2001-09-01 | Madoukh | Applicant |
| US2003/0200256(A1) | 2003-10-01 | Hu et al. | Examiner |
| WO99/22362 | 1999-05-01 | Applicant |
Non-Patent Literature (5)
- Jeonghee Kim, Taissok Han, and Suk Kyoon Lee, “Visualization of Path Expressions in a Visual Object-Oriented Database Query Language,” (2 pages).Applicant
- Chien-I Lee, Ye-In Chang, and Wei-Pang Yang, “Design Of A New Indexing Organization For A Class-Aggregation Hierarchy In Object-Oriented Databases”, Journal of Information Science and Engineering 15, 1999, pp. 217-241, Taiwan.Applicant
- Jörn W. Janneck and Martin Naedele, “Modeling Hierarchical and Recursive Structures Using Parametric Petri Nets.” Computer Engineering and Networks Laboratory, Swiss Federal Institute of Technology Zurich, pp. 445-452.Applicant
- Akira Kawaguchi, Daniel Lieuwen, Inderpal Mumick, Kenneth Ross, “Implementing Incremental View Maintenance in Nested Data Models” Database Programming Languages, 6th International Workshop, DBPL-6, Aug. 18-20, 1997 Proceedings, pp. 203-221.Applicant
- Li Tian-Zhu, “Normalization of Nested Structure for Complex Objects” in Chinese, Journal of Software, vol. 9, No. 5, p. 390-396, May 1998, (with English Abstract).Applicant