An associative array with parameters to create the handler object. The array indexes are the names of the parameters and the array values are the respective parameter values. Some parameters are specific of the class of each type of handler object that is created. The following parameters are common to all handler object classes: type Name of the type of the built-in supported class that will be used to create the handler object. There are currently four built-in types of handler object classes: data, resultlob, inputfile and outputfile. The data handler class is the default class. It simply reads data from a given data string. The resultlob handler class is meant to read data from a large object retrieved from a query result. This class is not used directly by applications. The inputfile handler class is meant to read data from a file to use in prepared queries with large object field parameters. The outputfile handler class is meant to write to a file data from result columns with large object fields. The functions to read from this type of large object do not return any data. Instead, the data is just written to the output file with the data retrieved from a specified large object handle. class Name of the class of the handler object that will be created if the Type argument is not specified. This argument should be used when you need to specify a custom handler class. database Database object as returned by MDB2::connect. This is an option argument needed by some handler classes like resultlob. The following arguments are specific of the inputfile handler class: file Integer handle value of a file already opened for writing. file_name Name of a file to be opened for writing if the File argument is not specified. The following arguments are specific of the outputfile handler class: file Integer handle value of a file already opened for writing. file_name Name of a file to be opened for writing if the File argument is not specified. buffer_length Integer value that specifies the length of a buffer that will be used to read from the specified large object. LOB Integer handle value that specifies a large object from which the data to be stored in the output file will be written. result Integer handle value as returned by the function MDB2::query() or MDB2::execute() that specifies the result set that contains the large object value to be retrieved. If the LOB argument is specified, this argument is ignored. row Integer value that specifies the number of the row of the result set that contains the large object value to be retrieved. If the LOB argument is specified, this argument is ignored. field Integer or string value that specifies the number or the name of the column of the result set that contains the large object value to be retrieved. If the LOB argument is specified, this argument is ignored. binary Boolean value that specifies whether the large object column to be retrieved is of binary type (blob) or otherwise is of character type (clob). If the LOB argument is specified, this argument is ignored. The following argument is specific of the data handler class: data String of data that will be returned by the class when it requested with the readLOB() method. The following argument is specific of the resultlob handler class: resultLOB Integer handle value of a large object result row field. |
