DBIx::Recordset - Perl extension for DBI recordsets
use DBIx::Recordset;
DBIx::Recordset is a Perl module, which should make it easier to access a set of records in a database. It should make standard database access (select/insert/update/delete) easier to handle (e.g. web applications or scripts to enter/retrieve data to/from a database). Special attention is made for web applications to make it possible to handle state-less access and to process the posted data of formfields. The programmer only has to supply the absolutely necessary information, the rest is done by DBIx::Recordset.
DBIx::Recordset uses the DBI API to access the database, so it should work with every database for which a DBD driver is available (see also DBIx::Compat)
Most public functions take a hash reference as parameter, which makes it simple to supply various different arguments to the same function. The parameter hash can also be taken from a hash containing posted formfields like those available with CGI.pm, mod_perl, HTML::Embperl and others.
Before using a recordset it is necessary to setup an object. Of course the setup step can be made with the same function call as the first database access, but it can also be handled separately.
Most functions which set up an object return a typglob. A typglob in Perl is an object which holds pointers to all datatypes with the same name. Therefore a typglob must always have a name and can't be declared with my. You can only use it as global variable or declare it with local. The trick for using a typglob is that setup functions can return a reference to an object, an array and a hash at the same time.
The object is used to access the object's methods, the array is used to access the records currently selected in the recordset and the hash is used to access the current record.
If you don't like the idea of using typglobs you can also set up the object, array and hash separately, or just set the ones you need.
Since most methods take a hash reference as argument, here is a description of the valid arguments first.
All parameters starting with an '!' are only recognized at setup time. If you specify them in later function calls they will be ignored.
Specifies the database to which to connect. This information can be given in the following ways:
Same as the first parameter to the DBI connect function.
Takes the same database handle as the given DBIx::Recordset object.
Takes Driver/DB/Host from the given database object.
Takes Driver/DB/Host from the database object which is saved under the given name ($saveas parameter to DBIx::Database -> new)
Tablename, multiple tables are comma-separated.
Username. Same as the second parameter to the DBI connect function.
Password. Same as the third parameter to the DBI connect function.
Reference to a hash which holds the attributes for the DBI connect function. See perldoc DBI for a detailed description.
Fields which should be returned by a query. If you have specified multiple tables the fieldnames should be unique. If the names are not unique you must specify them among with the tablename (e.g. tab1.field).
NOTE 1: Fieldnames specified with !Fields can't be overridden. If you plan to use other fields with this object later, use $Fields instead.
NOTE 2: The keys for the returned hash normaly doesn't have a table part, only the fieldname part forms the key. (see !LongNames for an execption)
NOTE 3: Because the query result is returned in a hash, there can only be one out of multiple fields with the same name fetched at once. If you specify multiple fields with the same name, only one is returned from a query. Which one this actually is depends on the DBD driver. (see !LongNames for an execption)
NOTE 4: Some databases (e.g. mSQL) require you to always qualify a fieldname with a tablename if more than one table is accessed in one query.
When set to 1 the keys of the hash which is returned for each record not only consits of the fieldname, but are build in the form table.field. In the current version this only works if you retrieve all fields (i.e. !Field is missing or contains '*')
Fields which should be used for ordering any query. If you have specified multiple tables the fieldnames should be unique. If the names are not unique you must specify them among with the tablename (e.g. tab1.field).
NOTE 1: Fieldnames specified with !Order can't be overridden. If you plan to use other fields with this object later, use $order instead.
Condition which describes the relation between the given tables. (e.g. tab1.id = tab2.id) (See also !TabJoin)
Example '!Table' => 'tab1, tab2', '!TabRelation' => 'tab1.id=tab2.id', 'name' => 'foo' This will generate the following SQL statement: SELECT * FROM tab1, tab2 WHERE name = 'foo' and tab1.id=tab2.id ;
!TabJoin gives you the possibilty to specify an INNER/RIGHT/LEFT JOIN which is used in a SELECT statement. (See also !TabRelation)
Example '!Table' => 'tab1, tab2', '!TabJoin' => 'tab1 LEFT JOIN tab2 ON (tab1.id=tab2.id)', 'name' => 'foo' This will generate the following SQL statement: SELECT * FROM tab1 LEFT JOIN tab2 ON (tab1.id=tab2.id) WHERE name = 'foo' ;
Name of primary key. If specified, DBIx::Recordset assumes that this is a unique key to the given table(s). DBIx::Recordset can not verify this; you are responsible for specifying the right key. If such a primary key exists in your table, you should specify it here, because it helps DBIx::Recordset to optimize the building of WHERE expressions.
!WriteMode specifies which write operations to the database are allowed and which are disabled. You may want to set !WriteMode to zero if you only need to query data, to avoid accidently changeing the content of the database.
NOTE: The !WriteMode only works for the DBIx::Recordset methods. If you disable !WriteMode, it is still possible to use do to send normal SQL statements to the database engine to write/delete any data.
!WriteMode consists of some flags, which may be added together:
Allow no write access to the table(s)
Allow INSERT
Allow UPDATE
Allow DELETE
To allow DELETE for the whole table, wmDELETE must be also specified. This is necessary for assigning a hash to a hash which is tied to a table. (Perl will first erase the whole table, then insert the new data)
Allow every access to the table(s)
Default is wmINSERT + wmUPDATE + wmDELETE
If present, this will cause DBIx::Recordset to store all rows which will be fetched between consecutive accesses, so it's possible to access data in a random order. (e.g. row 5, 2, 7, 1 etc.) If not specified, rows will only be fetched into memory if requested, which means that you will have to access rows in ascending order. (e.g. 1,2,3 if you try 3,2,4 you will get an undef for row 2 while 3 and 4 is ok) see also DATA ACCESS below.
By default, the hash which is returned by the setup function is tied to the current record. You can use it to access the fields of the current record. If you set this parameter to true, the hash will by tied to the whole database. This means that the key of the hash will be used as the primary key in the table to select one row. (This parameter only has an effect on functions which return a typglob).
This parameter defines how empty and undefined values are handled. The values 1 and 2 may be helpful when using DBIx::Recordset inside a CGI script, because browsers send empty formfields as empty strings.
An undefined value is treated as SQL NULL: an empty strings remains an empty string.
All fields with an undefined value are ignored when building the WHERE expression.
All fields with an undefined value or an empty string are ignored when building the WHERE expression.
NOTE: The default for versions before 0.18 was 2.
Filters can be used to pre/post-process the data which is read from/written to the database. The !Filter parameter takes an hash reference which contains the filter fucntions. If the key is numeric, it is treaded as a type value and the filter is applied to all fields of that type. If the key if alphanumeric, the filter applies to the named field. Every filter description consistst of an array which two element, the first element must contain the input function and the second element must contain the output function. Either may be undef, if only one of them are neccessary. The data is passed to the input function before it is written to the database. The input function must return the value in the correct format for the database. The output function get the data passed which is read from the database before it is return to the user.
Example: '!Filter' => { DBI::SQL_DATE => [ sub { shift =~ /(\d\d)\.(\d\d)\.(\d\d)/ ; "19$3$2$1"}, sub { shift =~ /\d\d(\d\d)(\d\d)(\d\d)/ ; "$3.$2.$1"} ], 'datefield' => [ sub { shift =~ /(\d\d)\.(\d\d)\.(\d\d)/ ; "19$3$2$1"}, sub { shift =~ /\d\d(\d\d)(\d\d)(\d\d)/ ; "$3.$2.$1"} ], }
Both filters converts a date in the format dd.mm.yy to the database format 19yymmdd and vice versa. The first one does this for all fields of the type SQL_DATE, the second one does this for the fields with the name datefield.
The !Filter parameter can also be passed to the function TableAttr of the DBIx::Database object. In this case it applies to all DBIx::Recordset objects, which use this tables.
This allows you to get a clear text description of a linked table, instead of (or in addition to) the !LinkField. For example, if you have a record with all your bills, and each record contains a customer number, setting !LinkName DBIx::Recordset can automatically retrieve the name of the customer instead of (or in addition to) the bill record itself.
This will additionally select all fields given in !NameField of the Link or the table attributes (see TableAttr).
This takes the values of !NameField of the Link or the table attributes (see TableAttr) and joins the content of these fields together into a new field, which has the same name as the !MainField, but in uppercase.
Same as 2, but the !MainField is replaced with "name" of the linked record.
See also !Links and WORKING WITH MULTIPLE TABLES below
This parameter can be used to link multiple tables together. It takes a reference to a hash, which has - as keys, names for a special "linkfield" and - as value, a parameter hash. The parameter hash can contain all the Setup parameters. The setup parameters are taken to construct a new recordset object to access the linked table. If !DataSource is omitted (as it normally should be), the same DataSource (and database handle), as the main object is taken. There are special parameters which can only occur in a link definition (see next paragraph). For a detailed description of how links are handled, see WORKING WITH MULTIPLE TABLES below.
The !MailField parameter holds a fieldname which is used to retrieve a key value for the search in the linked table from the main table. If omitted, it is set to the same value as !LinkedField.
The fieldname which holds the key value in the linked table. If omitted, it is set to the same value as !MainField.
This specifies the field or fields which will be used as a "name" for the destination table. It may be a string or a reference to an array of strings. For example, if you link to an address table, you may specfiy the field "nickname" as the name field for that table, or you may use ['name', 'street', 'city'].
Look at !LinkName for more information.
The following parameters are used to build an SQL WHERE expression
Value for field. The value will be quoted automatically, if necessary.
Value for field. The value will always be quoted. This is only necessary if DBIx::Recordset cannot determine the correct type for a field.
Value for field. The value will never be quoted, but will converted a to number. This is only necessary if DBIx::Recordset cannot determine the correct type for a field.
Value for field. The value will not be converted in any way i.e. you have to quote it before supplying it to DBIx::Recordset if necessary.
Values for multiple fields. The value must be in one/all fields depending on $compconj Example: '+name|text' => 'abc' will expand to name='abc' or text='abc'
'or' or 'and' (default is 'or'). Specifies the conjunction between multiple fields. (see above)
Regular expression for splitting a field value in multiple values (default is '\t') The conjunction for multiple values could be specified with $valueconj. By default, only one of the values must match the field.
Example: 'name' => "mouse\tcat" will expand to name='mouse' or name='cat'
'or' or 'and' (default is 'or'). Specifies the conjunction for multiple values.
'or' or 'and' (default is 'and') conjunction between fields
Default operator if not otherwise specified for a field. (default is '=')
Operator for the named field
Example: 'value' => 9, '*value' => '>' expand to value > 9
First row to fetch. The row specified here will appear as index 0 in the data array
Maximum number of rows to fetch. Every attempt to fetch more rows than specified here will return undef, even if the select returns more rows.
Add the number supplied with $max to $start. This is intended to implement a next button.
Subtract the number supplied with $max from $start. This is intended to implement a previous button.
Fieldname(s) for ordering (ORDER BY) (must be comma-separated, could also contain USING)
Fieldname(s) for grouping (GROUP BY) (must be comma-separated, could also contain HAVING)
String which is appended to the end of a SELECT statement, can contain any data.
Fields which should be returned by a query. If you have specified multiple tables the fieldnames should be unique. If the names are not unique you must specify them along with the tablename (e.g. tab1.field).
NOTE 1: If !fields is supplied at setup time, this can not be overridden by $fields.
NOTE 3: Because the query result is returned in a hash, there can only be one out of multiple fields with the same name fetched at once. If you specify multiple fields with same name, only one is returned from a query. Which one this actually is, depends on the DBD driver. (see !LongNames for an execption)
Name of primary key. DBIx::Recordset assumes that if specified, this is a unique key to the given table(s). DBIx::Recordset can not verify this. You are responsible for specifying the right key. If such a primary exists in your table, you should specify it here, because it helps DBIx::Recordset optimize the building of WHERE expressions.
See also !primkey
The following parameters specify which action is to be executed
search data
update record(s)
insert record
delete record(s)
setup empty object
Setup a new object and connect it to a database and table(s). Collects information about the tables which are needed later. Returns a typglob which can be used to access the object ($set), an array (@set) and a hash (%set).
params: setup
Same as above, but setup only the object, do not tie anything (no array, no hash)
Ties an array to a recordset object. The result of a query which is executed by the returned object can be accessed via the tied array. If the array contents are modified, the database is updated accordingly (see Data access below for more details). The first form ties the array to an already existing object, the second one setup a new object.
Ties a hash to a recordset object. The hash can be used to access/update/insert single rows of a table: the hash key is identical to the primary key value of the table. (see Data access below for more details)
The first form ties the hash to an already existing object, the second one sets up a new object.
Ties a hash to a recordset object. The hash can be used to access the fields of the current record of the recordset object. (see Data access below for more details)
Selects records from the recordsets table(s)
The first syntax setups a new DBIx::Recordset object and does the select.
The second and third syntax selects from an existing DBIx::Recordset object.
params: setup (only syntax 1), where (without $order and $fields)
where: (only syntax 3) string for SQL WHERE expression
fields: comma separated list of fieldnames to select
order: comma separated list of fieldnames to sort on
Does a search on the given tables and prepares data to access them via @set or %set. The first syntax also sets up a new object.
params: setup (only syntax 1), where, search
Inserts a new record in the recordset table(s). Params should contain one entry for every field for which you want to insert a value.
Fieldnames may be prefixed with a '\' in which case they are not processed (quoted) in any way.
params: setup (only syntax 1), fields
Updates one or more records in the recordset table(s). Parameters should contain one entry for every field you want to update. The $where contains the SQL WHERE condition as a string or as a reference to a hash. If $where is omitted, the where conditions are buily from the parameters.
Fieldnames maybe prefixed with a '\' in which case they are not processed (quoted) in any way.
params: setup (only syntax 1+2), where (only if $where is omitted), fields
Deletes one or more records form the recordsets table(s)
params: setup (only syntax 1), where
Executes one of the above methods, depending on the given arguments. If multiple execute parameters are specified, the priority is =search =update =insert =delete =empty
If none of the above parameters are specified, a search is performed.
params: setup (only syntax 1), execute, where, search, fields
Same as DBI. Executes a single SQL statement on the open database.
Position the record pointer to the first row.
Position the record pointer to the next row.
Position the record pointer to the previous row.
Returns a reference to an array of all fieldnames of all tables used by the object.
Returns a reference to an array of the fieldnames from the last query.
Returns a reference to an array of all fieldtypes of all tables used by the object.
Returns a reference to an array of the fieldtypes from the last query.
Adds a new row to a recordset. The first one adds an empty row, the second one will assign initial data to it. The Add method returns an index into the array where the new record is located.
Example: # Add an empty record $i = $set -> Add () ; # Now assign some data $set[$i]{id} = 5 ; $set[$i]{name} = 'test' ; # and here it is written to the database # (without Flush it is written, when the record goes out of scope) $set -> Flush () ;
Add will also set the current record to the newly created empty record. So you can assign the data by simply using the current record.
# Add an empty record $set -> Add () ; # Now assign some data to the new record $set{id} = 5 ; $set{name} = 'test' ;
Returns true if there are more records to fetch from the current recordset. If the $ignoremax parameter is specified and is true, MoreRecords ignores the $max parameter of the last Search.
To tell you if there are more records, More actually fetches the next record from the database and stores it in memory. It does not, however, change the current record.
Returns a HTML form which contains a previous and a next button and all data from %fdat, as hidden fields. When calling the Search method, You must set the $max parameter to the number of rows you want to see at once. After the search and the retrieval of the rows, you can call PrevNextForm to generate the needed buttons for scrolling through the recordset.
The Flush method flushes all data to the database and therefore makes sure that the db is up-to-date. Normally, DBIx::Recordset holds the update in memory until the row is destroyed, by either a new Select/Search or by the Recordsetobject itself is destroyed. With this method you can make sure that every update is really written to the db.
Undef takes the name of a typglob and will destroy the array, the hash and the object. All unwritten data is written to the db, all db connections are closed and all memory is freed.
Example: # this destroys $set, @set and %set DBIx::Recordset::Undef ('set') ;
Starts an transaction. Calls the DBI method begin.
Rolls back an transaction. Calls the DBI method rollback and makes sure that all internal buffers of DBIx::Recordset are flushed.
Commits an transaction. Calls the DBI method commit and makes sure that all internal buffers of DBIx::Recordset are flushed.
Returns the DBI database handle.
Returns the DBI statement handle of the last select.
Returns the record number of the record which will be returned for index 0.
$set -> LastSQLStatement ()
Returns the last executed SQL Statement.
$set -> Disconnect ()
Closes the connection to the database.
$set -> Link($linkname)
If $linkname is undef, returns reference to a hash of all links of the object. Otherwise, it returns a reference to the link with the given name.
$set -> Link4Field($fieldname)
Returns the name of the link for that field, or <undef> if there is no link for that field.
The data which is returned by a Select or a Search can be accessed in two ways:
1.) Through an array. Each item of the array corresponds to one of the selected records. Each array-item is a reference to a hash containing an entry for every field.
Example: $set[1]{id} access the field 'id' of the second record found $set[3]{name} access the field 'name' of the third record found
The record is fetched from the DBD driver when you access it the first time and is stored by DBIx::Recordset for later access. If you don't access the records one after each other, the skipped records are not stored and therefore can't be accessed anymore, unless you specify the !StoreAll parameter.
2.) DBIx::Recordset holds a current record which can be accessed directly via a hash. The current record is the one you last accessed via the array. After a Select or Search, it is reset to the first record. You can change the current record via the methods Next, Prev, First, Add.
Example: $set{id} access the field 'id' of the current record $set{name} access the field 'name' of the current record
Instead of doing a Select or Search you can directly access one row of a table when you have tied a hash to DBIx::Recordset::Hash or have specified the !HashAsRowKey Parameter. The hashkey will work as primary key to the table. You must specify the !PrimKey as setup parameter.
Example: $set{4}{name} access the field 'name' of the row with primary key = 4
One way to update/insert data into the database is by using the Update, Insert or Execute method of the DBIx::Recordset object. A second way is to directly assign new values to the result of a previous Select/Search.
Example: # setup a new object and search all records with name xyz *set = DBIx::Recordset -> Search ({'!DataSource' => 'dbi:db:tab', '!PrimKey => 'id', '!Table' => 'tabname', 'name' => 'xyz'}) ;
#now you can update an existing record by assigning new values #Note: if possible, specify a PrimKey for update to work faster $set[0]{'name'} = 'zyx' ; # or insert a new record by setting up an new array row $set[9]{'name'} = 'foo' ; $set[9]{'id'} = 10 ; # if you don't know the index of a new row you can obtain # one by using Add my $i = $set -> Add () ; $set[$i]{'name'} = 'more foo' ; $set[$i]{'id'} = 11 ; # or add an empty record via Add and assign the values to the current # record $set -> Add () ; $set{'name'} = 'more foo' ; $set{'id'} = 11 ; # or insert the data directly via Add $set -> Add ({'name' => 'even more foo', 'id' => 12}) ; # NOTE: up to this point, NO data is actually written to the db! # we are done with that object, Undef will flush all data to the db DBIx::Recordset::Undef ('set') ;
IMPORTANT: The data is not written to the database until you explicitly call flush, or a new query is started, or the object is destroyed. This is to keep the actual writes to the database to a minimum.
DBIx::Recordset has some nice features to make working with multiple tables and their relations easier.
First, you can specify more than one table to the !Table parameter. If you do so, you need to specifiy how both tables are related. You do this with !TabRelation parameter. This method will access all the specified tables simultanously.
If you have the following two tables, where the field street_id is a pointer to the table street:
table name name char (30), street_id integer table street id integer, street char (30), city char (30)
You can perform the following search:
*set = DBIx::Recordset -> Search ({'!DataSource' => 'dbi:drv:db', '!Table' => 'name, street', '!TabRelation'=> 'name.street_id = street.id'}) ;
The result is that you get a set which contains the fields name, street_id, street, city and id, where id is always equal to street_id. If there are multiple streets for one name, you will get as many records for that name as there are streets present for it. For this reason, this approach works best when you have a 1:1 relation.
It is also possible to specify JOINs. Here's how:
*set = DBIx::Recordset -> Search ({ '!DataSource' => 'dbi:drv:db', '!Table' => 'name, street', '!TabJoin' => 'name LEFT JOIN street ON (name.street_id=street.id)'}) ;
The difference between this and the first example is that this version also returns a record even if neither table contains a record for the given id. The way it's done depends on the JOIN you are given (LEFT/RIGHT/INNER) (see your SQL documentation for details about JOINs).
If you have 1:n relations between two tables, the following may be a better way to handle it:
*set = DBIx::Recordset -> Search ({'!DataSource' => 'dbi:drv:db', '!Table' => 'name', '!Links' => { '-street' => { '!Table' => 'street', '!LinkedField' => 'id', '!MainField' => 'street_id' } } }) ;
After that query, every record will contain the fields name and street_id. Additionally, there is a pseudofield named -street, which could be used to access another recordset object, which is the result of a query where street_id = id. Use
$set{name} to access the name field $set{-street}{street} to access the first street (as long as the current record of the subobject isn't modified) $set{-street}[0]{street} first street $set{-street}[1]{street} second street $set{-street}[2]{street} third street $set[2]{-street}[1]{street} to access the second street of the third name
You can have multiple linked tables in one recordset; you can also nest linked tables or link a table to itself.
NOTE: If you select only some fields and not all, the field which is specified by '!MainField' must be also given in the '!Fields' or '$fields' parameter.
NOTE: See also Automatic detection of links below
In the LinkName feature you may specify a "name" for every table. A name is one or more fields which gives a human readable "key" of that record. For example in the above example id is the key of the record, but the human readable form is street.
*set = DBIx::Recordset -> Search ({'!DataSource' => 'dbi:drv:db', '!Table' => 'name', '!LinkName' => 1, '!Links' => { '-street' => { '!Table' => 'street', '!LinkedField' => 'id', '!MainField' => 'street_id', '!NameField' => 'street' } } }) ;
For every record in the table, this example will return the fields
name street_id street
If you have more complex records, you may also specify more than one field in !NameField and pass it as an reference to an array e.g. ['street', 'city']. In this case, the result will contain
name street_id street city
If you set !LinkName to 2, the result will contain the fields
name street_id STREET_ID
where STREET_ID contains the values of the street and city fields joined together. If you set !LinkName to 3, you will get only
name street_id
where street_id contains the values of the street and city fields joined together.
NOTE: The !NameField can also be specified as a table attribute with the function TableAttr. In this case you don't need to specify it in every link. When a !NameField is given in a link description, it overrides the table attribute.
DBIx::Recordset and DBIx::Database will try to automatically detect links between tables based on the field and table names. For this feature to work, the field which points to another table must consist of the table name and the field name of the destination joined together with an underscore (as in the above example name.street_id). Then it will automatically recognized as a pointer to street.id.
*set = DBIx::Recordset -> Search ({'!DataSource' => 'dbi:drv:db', '!Table' => 'name') ;
is enough. DBIx::Recordset will automatically add the !Links attribute. You may use the !Links attribute to specify links which can not be automatically detected.
The DBIx::Database object gathers information about a datasource. Its main purpose is to create, at startup, an object which retrieves all necessary information from the database; tries to detect links between tables; and stores this information for use by the DBIx::Recordset objects. There are additional methods which allow you to add kinds of information which cannot be retreived automatically.
Specifies the database to which to connect. Driver/DB/Host. Same as the first parameter to the DBI connect function.
Username (optional)
Password (optional)
Attributes (optional) Same as the attribute parameter to the DBI connect function.
Name for this DBIx::Database object to save as. The name can be used in DBIx::Database::Get, or as !DataSource parameter in call to the DBIx::Recordset object.
This is intended as mechanisem to retrieve the necessary metadata; for example, when your web server starts (e.g. in the startup.pl file of mod_perl). Here you can give the database object a name. Later in your mod_perl or Embperl scripts, you can use this metadata by specifying this name. This will speed up the setup of DBIx::Recordset object without the need to pass a reference to the DBIx::Database object.
Normaly the database connection will be closed after the metadata has been retrieved from the database. This makes sure you don't get trouble when using the new method in a mod_perl startup file. You can keep the connection open to use them in further setup call to DBIx::Recordset objects.
$name = The name of the DBIx::Database object you wish to retrieve
Get a DBIx::Database object which has already been set up based on the name
get and/or set an attribute for an specfic table
Name of table(s)
key to set/get
if present, set key to this value
Get and/or set a link description for an table
Name of link to set/get
if present, this must be a reference to a hash with the link decription. See !Links for more information.
This returns a reference to a hash of the keys to all the tables of the datasource.
DBIx::Recordset is able to write a logfile, so you can see what's happening inside. There are two public variables used for this purpose:
Debuglevel 0 = off 1 = log only errors 2 = show connect, disconnect and SQL Statements 3 = some more infos 4 = much infos
The filehandle used for logging. The default is STDERR, unless you are running under HTML::Embperl, in which case the default is the Embperl logfile.
Example: # open the log file open LOG, ">test.log" or die "Cannot open test.log" ; # assign filehandle *DBIx::Recordset::LOG = \*LOG ; # set debugging level $DBIx::Recordset::Debug = 2 ; # now you can create a new DBIx::Recordset object
Since one possible application of DBIx::Recordset is its use in a web-server environment, some attention should paid to security issues.
The current version of DBIx::Recordset does not include extended security management, but some features can be used to make your database access safer. (more security features will come in further releases).
First of all, use the security feature of your database. Assign the web server process as few rights as possible.
The greatest security risk is when you feed DBIx::Recordset a hash which contains the formfield data posted to the web server. Somebody who knows DBIx::Recordset can post other parameters than those you would expect a normal user to post. For this reason, a primary issue is to override all parameters which should never be posted by your script.
Example: *set = DBIx::Recordset -> Search ({%fdat, ('!DataSource' => "dbi:$Driver:$DB", '!Table' => "$Table")}) ;
(assuming your posted form data is in %fdat). The above call will make sure that nobody from outside can override the values supplied by $Driver, $DB and $Table.
It is also wise to pre-setup your objects by supplying parameters which can not be changed.
Somewhere in your script startup (or at server startup time) add a setup call:
*set = DBIx::Recordset-> setup ({'!DataSource' => "dbi:$Driver:$DB", '!Table' => "$Table", '!Fields' => "a, b, c"}) ;
Later, when you process a request you can write:
$set -> Search (\%fdat) ;
This will make sure that only the database specified by $Driver, $DB, the table specified by $Table and the Fields a, b, and c can be accessed.
I have put a great deal of effort into making DBIx::Recordset run with various DBD drivers. The problem is that not all necessary information is specified via the DBI interface (yet). So I have made the module DBIx::Compat which gives information about the difference between various DBD drivers and their underlying database systems. Currently, there are definitions for:
DBIx::Recordset has been tested with all those DBD drivers (on Linux 2.0.32, except DBD::ODBC, which has been tested on Windows '95 using Access 7).
If you want to use another DBD driver with DBIx::Recordset, it may be necessary to create an entry for that driver. See perldoc DBIx::Compat for more information.
The following are some examples of how to use DBIx::Recordset. The Examples are from the test.pl. The examples show the DBIx::Recordset call first, followed by the generated SQL command.
*set = DBIx::Recordset-> setup ({'!DataSource' => "dbi:$Driver:$DB", '!Table' => "$Table"}) ;
Setup a DBIx::Recordset for driver $Driver, database $DB to access table $Table.
$set -> Select () ; SELECT * form <table> ; $set -> Select ({'id'=>2}) ; is the same as $set1 -> Select ('id=2') ; SELECT * form <table> WHERE id = 2 ; $set -> Select ({name => "Second Name\tFirst Name"}) ; SELECT * from <table> WHERE name = 'Second Name' or name = 'First Name' ; $set1 -> Select ({value => "9991 9992\t9993", '$valuesplit' => ' |\t'}) ; SELECT * from <table> WHERE value = 9991 or value = 9992 or value = 9993 ; $set -> Select ({'+name&value' => "9992"}) ; SELECT * from <table> WHERE name = '9992' or value = 9992 ; $set -> Select ({'+name&value' => "Second Name\t9991"}) ; SELECT * from <table> WHERE (name = 'Second Name' or name = '9991) or (value = 0 or value = 9991) ; $set -> Search ({id => 1,name => 'First Name',addon => 'Is'}) ; SELECT * from <table> WHERE id = 1 and name = 'First Name' and addon = 'Is' ; $set1 -> Search ({'$start'=>0,'$max'=>2, '$order'=>'id'}) or die "not ok ($DBI::errstr)" ; SELECT * form <table> ORDER BY id ; B<Note:> Because of the B<start> and B<max> only records 0,1 will be returned $set1 -> Search ({'$start'=>0,'$max'=>2, '$next'=>1, '$order'=>'id'}) or die "not ok ($DBI::errstr)" ; SELECT * form <table> ORDER BY id ; B<Note:> Because of the B<start>, B<max> and B<next> only records 2,3 will be returned $set1 -> Search ({'$start'=>2,'$max'=>1, '$prev'=>1, '$order'=>'id'}) or die "not ok ($DBI::errstr)" ; SELECT * form <table> ORDER BY id ; B<Note:> Because of the B<start>, B<max> and B<prev> only records 0,1,2 will be returned $set1 -> Search ({'$start'=>5,'$max'=>5, '$next'=>1, '$order'=>'id'}) or die "not ok ($DBI::errstr)" ; SELECT * form <table> ORDER BY id ; B<Note:> Because of the B<start>, B<max> and B<next> only records 5-9 will be returned *set6 = DBIx::Recordset -> Search ({ '!DataSource' => "dbi:$Driver:$DB", '!Table' => "t1, t2", '!TabRelation' => "t1.value=t2.value", '!Fields' => 'id, name, text', 'id' => "2\t4" }) or die "not ok ($DBI::errstr)" ; SELECT id, name, text FROM t1, t2 WHERE (id=2 or id=4) and t1.value=t2.value ; $set6 -> Search ({'name' => "Fourth Name" }) or die "not ok ($DBI::errstr)" ; SELECT id, name, text FROM t1, t2 WHERE (name = 'Fourth Name') and t1.value=t2.value ; $set6 -> Search ({'id' => 3, '$operator' => '<' }) or die "not ok ($DBI::errstr)" ; SELECT id, name, text FROM t1, t2 WHERE (id < 3) and t1.value=t2.value ; $set6 -> Search ({'id' => 4, 'name' => 'Second Name', '*id' => '<', '*name' => '<>' }) or die "not ok ($DBI::errstr)" ; SELECT id, name, text FROM t1, t2 WHERE (id<4 and name <> 'Second Name') and t1.value=t2.value ; $set6 -> Search ({'id' => 2, 'name' => 'Fourth Name', '*id' => '<', '*name' => '=', '$conj' => 'or' }) or die "not ok ($DBI::errstr)" ; SELECT id, name, text FROM t1, t2 WHERE (id<2 or name='Fourth Name') and t1.value=t2.value ; $set6 -> Search ({'+id|addon' => "7\tit", 'name' => 'Fourth Name', '*id' => '<', '*addon' => '=', '*name' => '<>', '$conj' => 'and' }) or die "not ok ($DBI::errstr)" ; SELECT id, name, text FROM t1, t2 WHERE (t1.value=t2.value) and ( ((name <> Fourth Name)) and ( ( id < 7 or addon = 7) or ( id < 0 or addon = 0))) $set6 -> Search ({'+id|addon' => "6\tit", 'name' => 'Fourth Name', '*id' => '>', '*addon' => '<>', '*name' => '=', '$compconj' => 'and', '$conj' => 'or' }) or die "not ok ($DBI::errstr)" ; SELECT id, name, text FROM t1, t2 WHERE (t1.value=t2.value) and ( ((name = Fourth Name)) or ( ( id > 6 and addon <> 6) or ( id > 0 and addon <> 0))) ; *set7 = DBIx::Recordset -> Search ({ '!DataSource' => "dbi:$Driver:$DB", '!Table' => "t1, t2", '!TabRelation' => "t1.id=t2.id", '!Fields' => 'name, typ'}) or die "not ok ($DBI::errstr)" ; SELECT name, typ FROM t1, t2 WHERE t1.id=t2.id ; %h = ('id' => 22, 'name2' => 'sqlinsert id 22', 'value2'=> 1022) ; *set9 = DBIx::Recordset -> Insert ({%h, ('!DataSource' => "dbi:$Driver:$DB", '!Table' => "$Table[1]")}) or die "not ok ($DBI::errstr)" ; INSERT INTO <table> (id, name2, value2) VALUES (22, 'sqlinsert id 22', 1022) ; %h = ('id' => 22, 'name2' => 'sqlinsert id 22u', 'value2'=> 2022) ; $set9 -> Update (\%h, 'id=22') or die "not ok ($DBI::errstr)" ; UPDATE <table> WHERE id=22 SET id=22, name2='sqlinsert id 22u', value2=2022 ; %h = ('id' => 21, 'name2' => 'sqlinsert id 21u', 'value2'=> 2021) ; *set10 = DBIx::Recordset -> Update ({%h, ('!DataSource' => "dbi:$Driver:$DB", '!Table' => "$Table[1]", '!PrimKey' => 'id')}) or die "not ok ($DBI::errstr)" ; UPDATE <table> WHERE id=21 SET name2='sqlinsert id 21u', value2=2021 ; %h = ('id' => 21, 'name2' => 'Ready for delete 21u', 'value2'=> 202331) ; *set11 = DBIx::Recordset -> Delete ({%h, ('!DataSource' => "dbi:$Driver:$DB", '!Table' => "$Table[1]", '!PrimKey' => 'id')}) or die "not ok ($DBI::errstr)" ; DELETE FROM <table> WHERE id = 21 ; *set12 = DBIx::Recordset -> Execute ({'id' => 20, '*id' => '<', '!DataSource' => "dbi:$Driver:$DB", '!Table' => "$Table[1]", '!PrimKey' => 'id'}) or die "not ok ($DBI::errstr)" ; SELECT * FROM <table> WHERE id<20 ; *set13 = DBIx::Recordset -> Execute ({'=search' => 'ok', 'name' => 'Fourth Name', '!DataSource' => "dbi:$Driver:$DB", '!Table' => "$Table[0]", '!PrimKey' => 'id'}) or die "not ok ($DBI::errstr)" ; SELECT * FROM <table> WHERE ((name = Fourth Name)) $set12 -> Execute ({'=insert' => 'ok', 'id' => 31, 'name2' => 'insert by exec', 'value2' => 3031, # Execute should ignore the following params, since it is already setup '!DataSource' => "dbi:$Driver:$DB", '!Table' => "quztr", '!PrimKey' => 'id99'}) or die "not ok ($DBI::errstr)" ; SELECT * FROM <table> ; $set12 -> Execute ({'=update' => 'ok', 'id' => 31, 'name2' => 'update by exec'}) or die "not ok ($DBI::errstr)" ; UPDATE <table> SET name2=update by exec,id=31 WHERE id=31 ; $set12 -> Execute ({'=insert' => 'ok', 'id' => 32, 'name2' => 'insert/upd by exec', 'value2' => 3032}) or die "not ok ($DBI::errstr)" ; INSERT INTO <table> (name2,id,value2) VALUES (insert/upd by exec,32,3032) ; $set12 -> Execute ({'=delete' => 'ok', 'id' => 32, 'name2' => 'ins/update by exec', 'value2' => 3032}) or die "not ok ($DBI::errstr)" ; DELETE FROM <table> WHERE id=32 ;
As far as possible for me, support will be available via the DBI Users' mailing list. (dbi-user@fugue.com)
G.Richter (richter@dev.ecos.de)
15 POD Errors
The following errors were encountered while parsing the POD:
'=item' outside of any '=over'
You forgot a '=back' before '=head2'
You forgot a '=back' before '=head1'
=over without closing =back
To install DBIx::Compat, copy and paste the appropriate command in to your terminal.
cpanm
cpanm DBIx::Compat
CPAN shell
perl -MCPAN -e shell install DBIx::Compat
For more information on module installation, please visit the detailed CPAN module installation guide.