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 mechanism 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 calls to DBIx::Recordset objects. When the database is not kept open, you must specify the !Password parameter each time the recordset has to be reopend.

same as setup parameter !TableFilter

same as setup parameter !DoOnConnect

If set, forces DBIx::Database to undef any preexisting database handle and call connect in any case. This is usefull in together with Apache::DBI. While the database connection are still kept open by Apache::DBI, Apache::DBI preforms a test if the handle is still vaild (which DBIx::Database itself wouldn't).

Name of table(s). You may use '*' instead of the table name to specify a default value which applies to all tables for which no other value is specified.

key to set/get

if present, set key to this value

Name of table(s)

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.

Name of table(s)

If present, this must be a reference to a hash with the new metadata. You should only use this if you really know what you are doing.

Clears the metadata for the given table, The next call to DBIx::Database -> new will recreate the metadata. Useful if your table has changed (e.g. by ALTER TABLE).

Either the name of a file which contains the schema or a array ref. See below how this schema must look like.

schemaname (only used for Oracle)

User that should be granted access. See !Grant parameter.

If set to true, access privilegs are revoked and granted again for already existing tables. That is necessary when $user changes.

If set to true contrains are cleared/set for already existing fields. DBI doesn't provide a database independ way to check which contrains already exists.

Gives the table name

Array with field names and types. There a some types which a translated database specifc. You can define more database specific translation in Compat.pm.

	bit
	boolean
	counter
	If an autoincrementing integer. For databases (like Oracle) that doesn't have such a datatype a sequence is generated to provide the autoincrement value and the fields will be of type integer.
	tinytext
	variables length text with up to 255 characters
	text
	variables length text

Name of the primary key

Can contain the same key as the table definintion, but is only executed for a specifc database.

Example:

    '!For' => { 
        'Oracle' => {
            '!Constraints' =>
                {
                'web_id'           => ['foreign key' => 'REFERENCES web (id)'],

                'prim__menu_id'    => ['!Name'       => 'web_prim_menu_id',
                                       'foreign key' => 'REFERENCES menu (id)',
                                       'not null'    => ''],
                }
            },
        },

Used to define contraints. See example under !For.

	!Name => <name>
	<constraint> => <second part>

Used to initialy populate the table.

Used to set a default value for a field, when the table is created. This doesn't have any affect for further INSERTs/UPDATEs.

Give the rights that should be grant to $user

Gives the names for the fields for which indices should be created. If the second parameter for an index is not empty, it gives the index name, otherwise a default name is used.

schemaname (only used for Oracle)

User that should be revoked access. See !Grant parameter.