INM GoldenGate - Integration New Media
Contents
1. SelectCount SelectCount rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success number of records in the selection Failure error code lt 0 Returns the number of record in the selection n Call Object gRS SelectCount if n gt 0 then Result callobject gRS Getselection literal else alert No records in the selection Please modify your Search criteria end if GetPosition SetCriteria SetCriteria rRSinstance Citerialist rRSinstance is an instance of script V12RemoteTable Citerialist is the list of criteria Success 0 Failure error code lt 0 One call toSet Criteria is used to build a search query Every criterion is stored in the list You can mix the criteria using Boolean operators at will GoldenGate Client Xtra Reference Manual 17 Example See also Syntax Parameters Return Description Grammar Citerialist Criteria Bool Expression Criteria Open Bracket Field Name Comparison op Expression Close Bracket Bool Expression Open Bracket Bool factor AND OR Bool factor AND OR Bool factor Close Bracket Bool factor NOT Criteria Bool Expression Comparison op lt Wt lt gt lt gt START CONTAINS Field Name name of a valid field Expression valid Lingo expression Open Bracket Close Bracket For example CallObject2. Parameters Return Description Example Success position of the current record Failure error code lt 0 Retrieves the position of the current record in the selection p Call Object gRS GetPosition n Call Object gRS SelectCount if p lt n then Call Obj ect gRS GoNext else Error handling end if SelectCount GetSelection GetSelection rRSinstance outputType from numRec fieldNames fieldDelimiter recordDelimiter rRSinstance is an instance of the Xtra GGRecordset output Type is LITERAL LIST or PROPERTYLIST from is the number of the first record to retrieve The default value is 1 numRec is the total number of records to retrieve The default value is all records If you need to explicitly specify all records and do not know the exact number of records in the selection pass a very large number as numRec or check the size of the selection with Select Count fieldNames is the lingo list of the names of fields to retrieve empty list means all fields fiel dDel i m ter is the character used to delimit fields if out put Type is LITERAL The default value is TAB If the specified output type is LIST or PROPERTYLIST f i el dDel imiter is ignored recordDeli miter is the character used to delimit records if the output Type is LITERAL The default value is RETURN If the specified output type is LIST or PROPERTYLIST fieldDelimiter isignored Succ
3. after new GGDBE successfully completes New returns a reference on the GGRecorset instance that you normally assign to a global variable Always check if New succeeded by calling Obj ect P gRS NewObject GGRecordSet ingredients New GGDBE AddRecord AddRecord rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success 0 Failure error code lt 0 Adds a record to the table It must be followed by one or more calls to Set Fi el ds and finally by Updat eRecord Callobject gRS AddRecord if GGStatus lt gt 0 then GoTo NotifyUser Call Object gRS SetField FirstName Eric Call Object gRS SetField LastName Cart man Call Object gRS UpdateRecord if GGStatus lt gt 0 then GoTo NotifyUser EditRecord SetField UpdateRecord DeleteRecord Del eteRecord rRSinstance RTinstance is an instance of the Xtra GGRecordSet Success 0 Failure error code lt 0 GoldenGate Client Xtra Reference Manual 11 Description Examples Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example See also Syntax Parameters Deletes the current record The record is immediately removed from the Server Call Obj ect gRS DeleteRecord EditRecord EditRecord rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success 0 Failure error code lt 0
4. date time and timestamp date year 2000 month 1 day 11 time hour 4 minute 30 second 0 timestamp year 2000 month 1 day 11 hour 4 minute 30 second 0 Note time is using 24h international standard Call Obj ect gRS EditRecord Call Object gRS SetField FirstName Wendy Call Object gRS SetField LastName Testaburger Call Object gRS SetField picture member picture media Call Obj ect gRS UpdateRecord if GGStatus lt gt 0 then GoTo NotifyUser EditRecord AddRecord UpdateRecord UpdateRecord Updat eRecord rRSi nstance rRSinstance is an instance of script GGRecordSet Success 0 Failure error code lt 0 Sends the newly added or modified current record to the Server Updat eRecord must be preceded by a first call to AddRecor d or EditRecord and a sequence of Set Fi el d If this command is used after an AddRecord the current selection will be replaced by the new record Call Obj ect gRS AddRecord Call Object gRS SetField FirstName Eric Call Obj ect gRS SetField LastName Cart man Call Obj ect gRS UpdateRecord if GGStatus lt gt 0 then GoTo NotifyUser EditRecord AddRecord GGSQLQueryRS Methods In each of the methods below r RSi nstance designates the GGRecordSet instance the method must act on GoldenGate Client Xtra Reference Manual 19 Syntax Parameters D
5. timestamp escape esc initiator ts timestamp value esc terminator esc initiator esc terminator date value years value date separator months value date separator days value time value hours value time separator minutes value time separator seconds value timestamp value date value timestamp separator time value date separator time separator timestamp separator The blank character years value digit digit digit digit months value digit digit days value digit digit hours value digit digit minutes value digit digit seconds value digit digit digit GoldenGate Client Xtra Reference Manual 29
6. dynamic parameter expression term expression term factor primary insert value dynamic parameter literal NULL USER letter lower case letter upper case letter literal character string literal lower case letter a b c d e f glh ilj k l min olplqalrisitiulv iwlxl yl Z order by clause ORDER BY sort specification sort specification primary column name dynamic parameter literal expression search condition boolean term OR search condition select list select sublist select sublist select list cannot contain parameters select sublist expression sort specification unsigned integer column name ASC DESC table identifier user defined name table name table identifier table reference table name table reference list table reference table reference term factor term factor unsigned integer digit upper case letter A B C D IE F IG IHI I JIKILIMINIO PIQIRISITIUIVIW IXIYIZ user defined name letter digit letter _ GoldenGate Client Xtra Reference Manual 28 Date Time and Timestamp Escape Sequences Notation d value ft value ts value grammar date time escape date escape time escape timestamp escape date escape esc initiator d date value esc terminator time escape esc initiator t time value esc terminator
7. gRS SetCriteria Price lt 1000 AND Destination Paris OR Destination London would find all tickets for Paris or for London that are cheaper than 1 000 CallObject gRS SetCriteria Price lt 1000 AND Destination ee Paris OR Price Don 900 AND Destination London would tickets for Paris that are cheaper than 1 000 or tickets for London that are cheaper than 900 Call Object gRS SetCriteria country Zimbabwe or country Ethiopia if GGStatus lt gt 0 then GoTo NotifyUser Call Obj ect gRS Select if GGStatus lt gt 0 then GoTo NotifyUser Select SetField SetField rRSinstance fieldName value rRSinstance is an instance of the Xtra GGRecordSet fiel dname is the name of the field in the current record that will store value val ve is the new value to store in fi el dName Success 0 Failure error code lt 0 Replaces the value in field f i el dName of the current record by val ue Calls to Set Fi el d must be preceded by a call toEdi t Record or GoldenGate Client Xtra Reference Manual 18 Examples See also Syntax Parameters Return Description Example See also AddRecord They must also be followed by a call to Updat eRecord Value is a string integer float date or media e g the media of member x Format for field types
8. selection and an error is signaled err Call Object gRS GoNext Go GoFirst GoLast GoPrevious GetPosition GoPrevious GoPrevious rRSinstance rRSinstance is an instance of the Xtra GGSQLQueryRS Success 0 Failure error code lt 0 Sets the record preceding the current record as the new current record If there is no previous record the current record remains the same i e the first of the selection and an error is signaled err Call Object gRS GoPrevious Go GoFirst GoLast GoNext GetPosition SelectCount SelectCount rRSinstance rRSinstance is an instance of the Xtra GGSQLQueryRS Success number of records in the selection Failure error code lt 0 GoldenGate Client Xtra Reference Manual 23 Description Returns the number of record in the selection Example n Call Object gRS SelectCount if n gt 0 then Result Call Object cx else message No records in the selection Search criteria end if Seealso GetPosition GetSelection literal Please modify your GoldenGate Client Xtra Reference Manual 24 4000 4010 4020 4050 4055 4060 4070 4080 4100 4110 4111 4112 4120 4140 4141 4142 4130 4160 4170 4180 4190 4200 4210 4220 4230 4240 Client side error codes The GoldenGate methods can return four different types of errors error code 1 This is the generic error code ret
9. Enables the current record to be modified Calling Edi t Record is mandatory before calls to Set Fi el d To actually send the modifications to the Server call Updat eRecord Call Object gRS EditRecord if GGStatus lt gt 0 then GoTo NotifyUser Call Object gRS SetField FirstName Wendy Call Object gRS SetField LastName Testaburger Call Object gRS UpdateRecord Error Checking GGError GGStatus AddRecord SetField UpdateRecord GetField GetField rRSinstance fieldName format rRSinstance is an instance of the Xtra GGRecordSet fiel dname is the name of the field who s value must be retrieved format isa valid formatting pattern for fields of type Integer Float and Date All the patterns defined in the V12 DBE User Manual Reading Fields of Type String Integer Float and Date are accepted Success the value of field f i el dName from the current record Failure error code lt 0 Retrieves the value of field f i el dName from the current record No network activity is initiated by Get Fi el d val Call Object gRS GetField price val Call Object gRS GetField price 9 99 val Call Object gRS GetField date dd mm yy GetSelection GetPosition Get Position rRSinstance rRSinstance is an instance of the Xtra GGRecordSet GoldenGate Client Xtra Reference Manual 12 Return Description Example See also Syntax
10. GoldenGate Client Xtra Reference Manual For Macromedia Authorware integration W new media Integration New Media Inc 2002 2007 09 11 Contents Contents Methods Reference Global Methods GGStatus GGError GGConnection Methods New SuspendDB ResumeDB GetUserList DisconnectUser GetDBOpenList GetDBList GGDBE Methods New GetStruct GGRecordSet Methods New AddRecord DeleteRecord EditRecord GetField GetPosition GetSelection Go GoFirst GoLast GoNext GoPrevious OrderBy Select SelectAll SelectCount SetCriteria Set Field oO W DOAN NN DD OUT UT WT WwW PRP RP FB RP RP RP RP ES ES Ea Fa RP aR Fa Fa F OO N NO UN OQ HBP BP T O N N N PE FY P GoldenGate Client Xtra Reference Manual UpdateRecord 19 GGSQLQueryRS Methods 19 New 20 GetField 20 GetPosition 20 GetSelection 21 Go 22 GoFirst 22 GoLast 22 GoNext 23 GoPrevious 23 SelectCount 23 Client side error codes 25 Supported SQL grammar 27 GoldenGate Client Xtra Reference Manual 4 Syntax Parameters Return Description Example See also Syntax Parameters Return Description Examples See also Methods Reference All the method names and parameters listed below are case insensitive Upper case characters are sometimes used for better legibility Global Methods GGStatus GGStatus Success 0 Failure error code lt 0 Check if the last command used succeeded or failed Err GG
11. Status If Err lt 0 then GoTo NotifyUser End if GGError page 5 GGError GGerror ErrorCode Error Code is the error code Success a string describing the error Failure error code lt 0 Retrieve a description of the error corresponding to ErrorCode or to the latest error Err GGStatus If Err lt 0 then errormessage GGerror End if GGStatus page 5 GoldenGate Client Xtra Reference Manual 5 Syntax Parameters Description Example See also Syntax Parameters Return Description Examples See also GGConnection Methods In each of the methods below r CXi nst ance designates the GGConnection instance the method must act on New newObj ect GGConnection server DString serverPortNumber userNameString userPasswordString server Dstring isthe IP number or address of GoldenGate Server Example 197 171 19 33 or QuizServer bisney com serverPortNumer is the IP port number on which the GoldenGate expects queries userNameString anduserPasswordString are account information used to log onto the server They must match one of the User Name Password sets defined on the GoldenGate Server If the Server accepts anonymous connections userName String can be GUEST and userPasswordString canbe ANONYMOUS Creates a GGConnecti on object This is the very first method to call in any project that uses GoldenGate Ne w returns a reference to the object created You typic
12. ally assign that reference to a global variable Ne w initiates a network connection Always check that New succeeded by calling 0bj ect P gCX NewObj ect GGConnection 194 19 171 40 2000 PizzaEater hunger Error Reference source not found New GGDBE SuspendDB SuspendDB rCXinstance DBName rCXinstance is an instance of the Xtra GGConnection DBName is the name of the Database to lock Success 0 Failure error code lt 0 Lock a database regular users can t access to this database anymore except if an administrator unlocks it This command is accessible only if the user has administrator privileges Call Object CX SuspendDB Pizza ResumeDB GoldenGate Client Xtra Reference Manual Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example See also Syntax Parameters Return ResumeDB ResumeDB rCXinstance DBName rCXinstance is an instance of script GGConnection DBName is the name of the Database to unlock Success 0 Failure error code lt 0 Unlock a database regular users can access to this database again if it was previously suspended This command is accessible only if the user has administrator privileges Call Object CX ResumeDB Pizza SuspendDB GetUserList Get UserList rCXinstance rCXinstance is an instance of script GGConnection Success the list of all use
13. ance fieldName sortOrder fieldName sortOrder rRSinstance is an instance of the Xtra GGRecordSet GoldenGate Client Xtra Reference Manual 15 Return Description Example See also Syntax Parameters Return Description Examples fiel dName is the name by which the selection must be sorted sort Order is the sort order by which the selection must be sorted Success 0 Failure error code lt 0 Sorts the selection according to values in field f i el dName sort Order is either ASCENDING or DESCENDING The default value is ASCENDING The first fieldname is mandatory It defines the primary key Subsequent fieldnames define secondary third etc keys Order By is convenient to call right after setting search criteria with Set Criteria to determine the sorting order of the resulting records Or der By must be followed by Sel ect orSelectAll If you don t call Order By before Sel ect or SelectAll GoldenGate uses the default index to build the selection the fastest possible Thus the resulting selection would be sorted according to that index Call Object gRS SetCriteria Age gt 20 if GGStatus lt gt 0 then GoTo NotifyUser Call Object gRS OrderBy FirstName Age DESCENDI NG if GGStatus lt gt 0 then GoTo NotifyUser Call Obj ect gRS Select if GGStatus lt gt 0 then GoTo NotifyUser SetCriteria Select SelectAll Se
14. de lt 0 Retrieves the value of field f i el dName from the current record No network activity is initiated by Get Fi el d val Call Object gRS GetField price val Call Object gRS GetField price 9 99 val Call Object gRS GetField date dd mm yy GetSelection GetPosition Get Position rRSinstance rRSinstance is an instance of the Xtra GGSQLQueryRS Success position of the current record Failure error code lt 0 GoldenGate Client Xtra Reference Manual 20 Description Example See also Syntax Parameters Return Description Example See also Retrieves the position of the current record in the selection p Call Object gRS GetPosition n Call Object gRS SelectCount if p lt n then CallObject gRS GoNext else message You are already on the last record of the selection end if SelectCount GetSelection GetSelection rRSinstance outputType from numRec fieldNames fieldDelimiter recordDelimiter rRSinstance is an instance of the Xtra GGSQLQueryRS output Type is LITERAL LIST or PROPERTYLIST from is the number of the first record to retrieve The default value is 1 numRec is the total number of records to retrieve The default value is all records If you need to explicitly specify all records and do not know the exact number of records in the selection pass a very large number as numR
15. ec or check the size of the selection with Select Count fiel dNames is the lingo list of the names of fields to retrieve empty list means all fields fiel dDel i m ter is the character used to delimit fields if out put Type is LITERAL The default value is TAB If the specified output type is LIST or PROPERTYLIST fi el dDel imiter is ignored recordDel imiter is the character used to delimit records if the out put Type is LITERAL The default value is RETURN If the specified output type is LIST or PROPERTYLIST fiel dDel im ter is ignored Success the selection Failure error code lt 0 Returns one or more records from the local selection as a string list or property list Get Sel ection offers a high degree of versatility thanks to the following parameters All but the first one and the second one the GGRecordSet instance and the output type are optional str Call Object gRS GetSelection alist Call Obj ect gRS GetSelection LIST 1 50 fld Call Object gRS GetSelection LITERAL 1 10 LastName FirstName RETURN GetField GoldenGate Client Xtra Reference Manual 21 Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example See also Go Gol rRSinstance pos rRSinstance is an instance of the Xtra GGSQLQueryRS
16. ecord err Call Obj ect gRS GoFirst Go GoLast GoNext GoPrevious GetPosition GoLast GoLast rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success 0 Failure error code lt 0 Sets the last record of the selection as the current record err Call Object gRS Golast GoldenGate Client Xtra Reference Manual 14 See also Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example See also Syntax Parameters Go GoFirst GoNext GoPrevious GetPosition GoNext GoNext rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success 0 Failure error code lt 0 Sets the record next to the current record as the new current record If there is no next record the current record remains the same i e the last of the selection and an error is signaled err Call Object gRS GoNext Go GoFirst GoLast GoPrevious GetPosition GoPrevious GoPrevious rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success 0 Failure error code lt 0 Sets the record preceding the current record as the new current record If there is no previous record the current record remains the same i e the first of the selection and an error is signaled err Call Object gRS GoPrevious Go GoFirst GoLast GoNext GetPosition OrderBy OrderBy rRSinst
17. erty list Error in the time property list Time stamp value should be expressed as a property list Error in the time stamp property list OrderBy parameters must be either field names or one of the symbols ascending or descending You must call EditRecord or AddRecord before SetField You must call EditRecord or AddRecord before UpdateRecord Unsupported type in SQL parameters list Expecting a media as parameter No fields have been set to update No current record The selection might be empty or you have tried to read a record that is not there Wrong year value It should be between 1 and 9999 Wrong month value It should be between 1 and 12 Wrong day value It should be between 1 and 31 Wrong hour value It should be between 0 and 24 Wrong minute value It should be between 0 and 59 Wrong second value It should be between 0 and 59 Wrong time format When hour is 24 the minute and second values should be 0 GoldenGate Client Xtra Reference Manual 26 Supported SQL grammar This grammar is based on Microsoft s ODBC grammar Statement statement create table statement delete statement searched drop table statement insert statement select statement update statement searched create table statement CREATE TABLE base table name column identifier data type column identifier data type delete statement searched DELETE FROM table name WHERE search condition drop table s
18. escription Example See also Syntax Parameters Return Description Example See also Syntax Parameters Return New NewObj ect GGSQLQueryRS rDBinstance SQLQuery SQL Params r DBi nst ance is an instance of the Xtra GGDBE SQL Quer y SQL query SQL Params list of SQL query parameters Creates a GGS QL Quer yRS Xtra instance This is typically done right after new GGDBE successfully completes New returns a reference on the GGSQLQuer yRS instance that you normally assign to a global variable Always check if New succeeded by calling Obj ect P SQL commands SELECT UPDATE DELETE and INSERT are supported The level of complexity of a query depends on the type of database For more information on the supported grammar of SQL see appendix 11 The queries are using parameters see example for more details gRS NewObj ect GGSQLQueryRS SELECT FROM ingredients WHERE name OR name tomatoe cheese New GGDBE GetField GetField rRSinstance fieldName format rRSinstance is an instance of the Xtra GGSQLQueryRS fiel dname is the name of the field who s value must be retrieved format isa valid formatting pattern for fields of type Integer Float and Date All the patterns defined in the V12 DBE User Manual Reading Fields of Type String Integer Float and Date are accepted Success the value of field f i el dName from the current record Failure error co
19. ess the selection Failure error code lt 0 Returns one or more records from the local selection as a string list or property list Get Sel ection offers a high degree of versatility thanks to the following parameters All but the first one and the second one the GGRecordSet instance and the output type are optional str Call Object gRS GetSelection alist Call Obj ect gRS GetSelection LIST 1 50 fld Call Object gRS GetSelection LITERAL 1 10 LastName FirstName RETURN GoldenGate Client Xtra Reference Manual 13 See also Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example GetField Go Gol rRSinstance pos rRSinstance is an instance of the Xtra GGRecordSet pos is the number of the destination record in the selection Success 0 Failure error code lt 0 Sets the current record to record number pos Regardless of what the current record is at a given instant invoking Go rRSinstance pos sets the current record to the pos of the selection err Call Object gRS Go 25 GoFirst GoLast GoNext GoPrevious GetPosition GoFirst GoFirst rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success 0 Failure error code lt 0 Sets the first record of the selection as the current r
20. he list opened by a user for a specific connection This command is accessible only if the user has administrator privileges TheList Call Object gCX GetDBOpenList 18 If Tistcount theList lt gt 0 then display the list in a message variable message thelist Else error End if GetUserList GetDBList GetDBList Get DBList rCXinstance rCXinstance is an instance of script GGConnection Success List of databases in the following format lt DBNamel1 gt lt DBName2 gt Failure error code lt 0 Get the list of all the available databases on the server This command is accessible only if the user has administrator privileges TheList Call Object gCX GetDBOpenList If Tistcount theList lt gt 0 then display the list in a message variable message thelist GoldenGate Client Xtra Reference Manual See also Syntax Parameters Description Example See also Syntax Parameters Return Description Examples Else error End if GetUserList GetDBOpenList GGDBE Methods In each of the methods below r DBi nst ance designates the GGBDE instance the method must act on New NewObj ect GGDBE rCXinstance dBName rCXinst ance GGConnection instance dbName name of the database to open Creates a GGDBE object New returns a reference to the object created You typically assign that reference to a global variable Always check that New succeeded by calling 0bj ec
21. lect Select rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success number of records in the selection Failure error code lt 0 Performs a selection on the remote table according to criteria set by Set Criteria and a sorting order set by Order By Select is typically preceded by Set Criteria and optionally by Order By After performing a Sel ect the set criteria remain valid for further Sel ects Call Object gRS SetCriteria country Zi mbabwe if GGStatus lt gt 0 then GoTo NotifyUser result Call Object gRS Select if GGStatus lt gt 0 then GoTo NotifyUser GoldenGate Client Xtra Reference Manual 16 See also Syntax Parameters Return Description Examples See also Syntax Parameters Return Description Example See also Syntax Parameters Return Description SetCriteria SelectAll SelectAll SelectAll rRSinstance rRSinstance is an instance of the Xtra GGRecordSet Success number of records in the selection Failure error code lt 0 Selects all the records of the remote table The order of the selection is the one defined by the last Order By see Or der By Call Object gRS OrderBy city city is indexed for higher performance if GGStatus lt gt 0 then GoTo NotifyUser result Call Object gRS SelectAll if GGStatus lt gt 0 then GoTo NotifyUser SetCriteria Select
22. pos is the number of the destination record in the selection Success 0 Failure error code lt 0 Sets the current record to record number pos Regardless of what the current record is at a given instant invoking Gol r RSi nstance pos sets the current record to the pos of the selection err Call Object gRS Go 25 GoFirst GoLast GoNext GoPrevious GetPosition GoFirst GoFirst rRSinstance rRSinstance is an instance of the Xtra GGSQLQueryRS Success 0 Failure error code lt 0 Sets the first record of the selection as the current record err Call Obj ect gRS GoFirst Go GoLast GoNext GoPrevious GetPosition GoLast GoLast rRSinstance rRSinstance is an instance of the Xtra GGSQLQueryRS Success 0 Failure error code lt 0 Sets the last record of the selection as the current record err Call Object gRS Golast Go GoFirst GoldenGate Client Xtra Reference Manual 22 Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example See also Syntax Parameters Return GoNext GoPrevious GetPosition GoNext GoNext rRSinstance rRSinstance is an instance of the Xtra GGSQLQueryRS Success 0 Failure error code lt 0 Sets the record next to the current record as the new current record If there is no next record the current record remains the same i e the last of the
23. rs connected to the GoldenGate server in the following format username lt the user name gt cID lt the connection ID gt Failure error code lt 0 Get the list of all the users connected to the GoldenGate server This command is accessible only if the user has administrator privileges TheList Call Obj ect gCX GetUserList If listcount thelList lt gt 0 Then Show the list in a message variable Message thelist Else error End if DisconnectUser GetDBOpenList GetDBList DisconnectUser DisconnectUser rCXinstance clD rCXinstance is an instance of script GGConnection cID is the connection ID to query this value is retrieved with GetUserList method Success 0 GoldenGate Client Xtra Reference Manual Description Example See also Syntax Parameters Return Description Example See also Syntax Parameters Return Description Example Failure error code lt 0 Disconnect a remote user identified by cID This command is accessible only if the user has administrator privileges Call Obj ect gCX diconnectUser 18 GetUserList GetDBOpenList Get DBOpenList rCXinstance clD rCXinstance is an instance of script GGConnection cID is the connection ID to query this value is retrieved with GetUserList method Success List of opened databases in the following format lt DBNamel1 gt lt DBName2 gt Failure error code lt 0 Get t
24. t P gDB NewObject GGBDE Pizza New GGRecordset New GGSQLQueryRS GetStruct Get Struct rDBinstance r DBi nstance is an instance of script GGDBE Success the structure of the opened database in the following format TableName lt name of the table gt Fields FieldName lt name of the field gt FieldType lt type of the field gt Precision lt data size in bytes gt Failure error code lt 0 Get the structure of the opened database Possible field types are CHAR VARCHAR WCHAR SMALLINT INTEGER FLOAT DOUBLE BYTE LONGINT BINARY VARBINARY DATE TIME TIMESTAMP TheList Call Object gDB GetStruct If Tistcount thelList lt gt 0 then display the list in a message variable message thelist Else error End if GoldenGate Client Xtra Reference Manual 9 See also GoldenGate Client Xtra Reference Manual 10 Syntax Parameters Description Example See also Syntax Parameters Return Description Examples See also Syntax Parameters return GGRecordSet Methods In each of the methods below r RSi nst ance designates the GGRecordSet instance the method must act on New NewObj ect GGRecordSet rDBinstance TableName r DBinstance is an instance of the Xtra GGDBE Tabl eName name of the table in remote GoldenGate database to open Creates a GGRecordSet Xtra instance This is typically done right
25. tatement DROP TABLE base table name insert statement INSERT INTO table name column identifier column identifier VALUES insert valuel insert value select statement SELECT ALL DISTINCT select list FROM table reference list WHERE search condition order by clause update statement searched UPDATE table name SET column identifier expression NULL column identifier expression NULL WHERE search condition Element base table identifier user defined name base table name base table identifier boolean factor NOT boolean primary boolean primary comparison predicate search condition boolean term boolean factor AND boolean term character string literal character character is any character in the character set of the driver data source To include a single literal quote character in a character string literal use two literal quote characters column identifier user defined name GoldenGate Client Xtra Reference Manual column name table name column identifier comparison operator lt gt lt gt lt gt LIKE comparison predicate expression comparison operator expression data type character string type character string type is any data type for which the DATA_TYPE column in the result set returned by SQLGetTypelnfo is either SQL CHAR or SQL_VARCHAR digit 0 11213141516171819
26. urned by the database manager on the server side To get a more descriptive error call GetError Example of error message returned by the ODBC database manager ODBC Error SQLState 42502 Native error 208 Diagnostic Msg Microsoft ODBC SQL Server Driver SQL Server Invalid object name n peoples Error code 2 A severe error returned by the GoldenGate server Do not rely on any GoldenGate object any more Delete your instances and create them anew Error codes 5000 through 4000 These errors are generated by the GoldenGate client Xtra see below for details Example Error 4200 No connection is opened Cannot proceed Other Error codes are generated by the low level communication module They must be treated as fatal errors abort and restart program Memory allocation error Missing parameters to this handler Too many parameters to this handler A Director internal error as occurred Cannot proceed An internal error as occurred Cannot proceed Expecting parameter of type integer in the Lingo call Expecting parameter of type string in the Lingo call Expecting parameter of type symbol in the Lingo call Wrong connection mode passed in the Lingo call Username should be longer than 3 characters Username should be shorter than xx characters Username contains illegal characters Unauthorized port number in Lingo call Password should be longer than 3 characters Password should not be longer than
27. xx characters Password contains illegal characters Illegal server address in Lingo call Connection is not opened Asynchronous connection requires a Lingo handler as parameter No callback handler expected in synchronous mode Error message is empty No connection is opened Cannot proceed Cannot use Unicode services An unexpected message was sent by the server Apple Text service for Unicode not installed An error occurred during text manipulation Either the data sent by GoldenGate Client Xtra Reference Manual 25 4245 4250 4255 4260 4265 4270 4275 4280 4285 4290 4300 4305 4305 4315 4320 4325 4330 4335 4345 4350 4355 4360 4365 4370 4375 4380 4385 4390 4395 the server were not formatted properly or a problem occurred with the Text Encoding Converter The parameter must be a valid GGConnection script object The parameter must be a valid GGDBE script object No such field in this table definition Field in the record definition has an unknown type Wrong output type symbol Must be one of Literal List or PropertyList Expecting linear list as parameter in Lingo call Expecting property list as parameter in Lingo call Expression inside the SetCriteria is not well formed Using an undefined operator in a SetCritera call Date value should be either a Lingo expression or a property list Error in the date property list Time value should be expressed as a prop
Download Pdf Manuals
Related Search