API:EPrints/Database

From EPrints Documentation
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Database - a connection to the SQL database for an eprints session


SYNOPSIS

$db = $repo->database
$sth = $db->prepare("SELECT 'hello, world!'");
$sth->execute;
print $sth->fetchrow_arrayref->[0], "\n";


DESCRIPTION

EPrints Database Access Module

Provides access to the backend database. All database access is performed via this module to 1) provide cross-database support and 2) improve security through enforcing proper quoting of SQL values.

In most use-cases it should not be necessary to use the database module directly. Instead you should use EPrints::DataSet or EPrints::MetaField accessor methods to access objects and field values respectively.


Cross-database Support

Any use of SQL statements must use quote_identifier to quote database tables and columns and quote_value to quote values. The only exception to this are the EPrints::Database::* modules which provide database-driver specific extensions.


Quoting SQL Values

By convention variables that contain already quoted values are prefixed with 'Q_' so they can be easily recognised when used in string interpolation:

  my $Q_value = $db->quote_value( "Hello, World!" );
  $db->do("SELECT $Q_value");

Where possible you should avoid quoting values yourself, instead use a method that accepts unquoted values which will (safely) do the work for you.


METHODS

Database

$db = EPrints::Database->new( $repo )

Create a connection to the database.

$db = $db->create( $username, $password )

Create and connect to a new database using super user account $username and $password.

$ok = $db->connect

Connects to the database.

$db->disconnect

Disconnects from the EPrints database.

$db->set_debug( $boolean )

Set the SQL debug mode to true or false.

$db->set_version( $versionid );

Set the version id table in the SQL database to the given value (used by the upgrade script).

$version = $db->get_version

Returns the current database schema version.

$boolean = $db->is_latest_version

Return true if the database schema is in the correct configuration for this version of eprints. Otherwise false.

$version = $db->get_server_version

Return the database server version.

$charset = $db->get_default_charset( LANGUAGE )

Return the character set to use for LANGUAGE.

Returns undef if character sets are unsupported.

$collation = $db->get_default_collation( LANGUAGE )

Return the collation to use for LANGUAGE.

Returns undef if collation is unsupported.

$driver = $db->get_driver_name

Return the database driver name.

$errstr = $db->error

Return a string describing the last SQL error.

$bool = $db->retry_error

Returns true if the current error is a retry error.

$bool = $db->duplicate_error

Returns true if the current error is a PRIMARY KEY or UNIQUE error.

$db->begin

Begin a transaction.

$db->commit

Commit the previously begun transaction.

$db->rollback

Roll-back the current transaction.

$type_info = $db->type_info( DATA_TYPE )

See DBI/type_info.

$real_type = $db->get_column_type( NAME, TYPE, NOT_NULL, [ LENGTH/PRECISION ], [ SCALE ], %opts )

Returns a SQL column definition for NAME of type TYPE, usually something like:

  $name $type($length,$scale) [ NOT NULL ]

If NOT_NULL is true column will be set "not null".

LENGTH/PRECISION and SCALE control the maximum lengths of character or decimal types (see below).

Other options available to refine the column definition:

  langid - character set/collation to use
  sorted - whether this column will be used to order by

langid is mapped to real database values by the "dblanguages" configuration option. The database may not be able to order the request column type in which case, if sorted is true, the database may use a substitute column type.

TYPE is the SQL type. The types are constants defined by this module, to import them use:

  use EPrints::Database qw( :sql_types );

Supported types (n = requires LENGTH argument):

Character data: SQL_VARCHAR(n), SQL_LONGVARCHAR, SQL_CLOB.

Binary data: SQL_VARBINARY(n), SQL_LONGVARBINARY.

Integer data: SQL_TINYINT, SQL_SMALLINT, SQL_INTEGER, SQL_BIGINT.

Floating-point data: SQL_REAL, SQL_DOUBLE.

Time data: SQL_DATE, SQL_TIME.

The actual column types used will be database-specific.


Basic SQL operations

$success = $db->do( $sql )

Execute the given SQL.

$sth = $db->prepare( $sql )

Prepare the SQL statement $sql for execution.

Use the execute method on the returned DBI handle to execute the SQL:

  my $sth = $db->prepare_select( "SELECT 'Hello, World'" );
  $sth->execute;
$sth = $db->prepare_select( $sql [, %options ] )

Prepare a SELECT statement $sql for execution. This method provides cross-database support for getting a part of the result list based on an offset/limit.

Returns a DBI statement handle.

Options:

  limit - limit the number of rows returned
  offset - return limit number of rows after offset
$rows = $db->update( $tablename, $keycols, $keyvals, $columns, $values )

UPDATEs $columns with the equivalent slot from $values where the rows in $tablename match the $keycols/$keyvals.

Returns the number of rows affected or false on error, see DBI's execute() method.

  $db->update(
    'eprint',
    ['eprintid'],
    [23],
    ['title','description'],
    ['Hello, World!', undef]
  );
$success = $db->update_quoted( $tablename, $keycols, $keyvals, $columns, $Q_values )

UPDATEs $tablename where $keycols equals $keyvals.

Returns the number of rows affected or false on error, see DBI's execute() method.

$success = $db->insert( $table, $columns, @values )

Inserts values into the table $table. If $columns is defined it will be used as a list of columns to insert into. @values is a list of arrays containing values to insert.

Values will be quoted before insertion.

$success = $db->insert_quoted( $table, $columns, @Q_values )

Inserts values into the table $table. If $columns is defined it will be used as a list of columns to insert into. @qvalues is a list of arrays containing values to insert.

Values will NOT be quoted before insertion - care must be exercised!

$success = $db->delete_from( $table, $columns, @values )

Perform a SQL DELETE FROM $table using $columns to build a where clause. @values is a list of array references of values in the same order as $columns.

If you want to clear a table completely use clear_table().

$n = $db->count_table( $tablename )

Return the number of rows in the specified SQL table.

$db->clear_table( $tablename )

Clears all records from the given table, use with caution!


Quoting

$mungedvalue = EPrints::Database::prep_int( $value )

Escape a numerical value for SQL. undef becomes NULL. Anything else becomes a number (zero if needed).

$mungedvalue = EPrints::Database::prep_value( $value )

Escape a value for SQL. Modify value such that " becomes \" and \ becomes \\ and ' becomes \'

$mungedvalue = EPrints::Database::prep_like_value( $value )

Escape an value for an SQL like field. In addition to ' " and \ also escapes % and _

$str = $db->quote_value( $value )

Return a quoted value. To quote a 'like' value you should do:

 my $str = $database->quote_value( EPrints::Database::prep_like_value( $foo ) . '%' );
$str = $db->quote_int( $value )

Return a quoted integer value

$str = $db->quote_binary( $bytes )

Some databases (Oracle/PostgreSQL) require transforms of binary data to work correctly.

This method should be called on data containing nul bytes or back-slashes before being passed on quote_value.

$str = $db->quote_ordervalue( $field, $value )

Some databases (Oracle) can't order by CLOBS so need special treatment when creating the ordervalues tables. This method allows any fixing-up required for string data before it's inserted.

$str = $db->quote_identifier( @parts )

Quote a database identifier (e.g. table names). Multiple @parts will be joined by dot.

$sql = $db->prepare_regexp( $quoted_column, $quoted_value )

The syntax used for regular expressions varies across databases. This method takes two quoted values and returns a SQL expression that will apply the regexp ($quoted_value) to the column ($quoted_column).

$sql = $db->sql_AS()

Returns the syntactic glue to use when aliasing. SQL 92 DBs will happilly use " AS " but some DBs (Oracle!) won't accept it.

$sql = $db->sql_LIKE()

Returns the syntactic glue to use when making a case-insensitive LIKE. PostgreSQL requires "ILIKE" while everything else uses "LIKE" and the column collation.

$sql = $db->sql_IS_SET( $qname )

Return the SQL to test whether $qname is set. For most databases this will be:

  $qname is not null AND $qname != ''

$qname is a quoted identifier or value.


Counters

$n = $db->counter_current( $counter )

Return the value of the previous counter_next on $counter.

$n = $db->counter_next( $counter )

Return the next unused value for the named counter. Returns undef if the counter doesn't exist.

$db->counter_minimum( $counter, $value )

Ensure that the counter is set no lower than $value. This is used when importing eprints which may not be in scrict sequence.

$db->counter_reset( $counter )

Reset the counter. Use with caution.

$n = $db->next_doc_pos( $eprintid )

Return the next unused document pos for the given eprintid.


Dataset data

$boolean = $db->exists( $dataset, $id )

Return true if a record with the given primary key exists in the dataset, otherwise false.

$success = $db->insert_data( $dataset, $data )

Add the given data as a new record in the given dataset. $data is a reference to a hash containing values structured for a record in the that dataset.

Returns undef if a record already exists with the key field value in $data.

Inserts ordervalues if the dataset is ordered.

$success = $db->update_data( $dataset, $data, $changed )

Updates a record in the given $dataset. $data is a copy of the entire record's data and $changed the values that have changed.

If the record does not already exist or the key field is unset in $data no changes will be written.

Updates ordervalues if the dataset is ordered.

$success = $db->remove( $dataset, $id )

Remove the record, index terms and order value with the key field value $id from the specified dataset.

Returns true on success.


Searching, caching and object retrieval

$searchexp = $db->cache_exp( $cacheid )

Return the serialised Search of a the cached search with id $cacheid. Return undef if the id is invalid or expired.

$cacheid = $db->cache( $searchexp, $dataset, $srctable, [$order], [$list] )

Create a cache of the specified search expression from the SQL table $srctable.

If $order is set then the cache is ordered by the specified fields. For example "-year/title" orders by year (descending). Records with the same year are ordered by title.

If $srctable is set to "LIST" then order is ignored and the list of ids is taken from the array reference $list.

If $srctable is set to "ALL" every matching record from $dataset is added to the cache, optionally ordered by $order.

$tablename = $db->cache_table( $id )

Return the SQL table used to store the cache with id $id.

$ids = $db->search( $keyfield, $tables, $conditions, [$main_table_alias] )

Return a reference to an array of ids - the results of the search specified by $conditions accross the tables specified in the $tables hash where keys are tables aliases and values are table names.

If no table alias is passed then M is assumed.

$db->drop_cache( $id )

Remove the cached search with the given id.

$foo = $db->from_cache( $dataset, $cacheid, [$offset], [$count], [$justids] )

Return a reference to an array containing all the items from the given dataset that have id's in the specified cache. The cache may be specified either by id or serialised search expression.

$offset is an offset from the start of the cache and $count is the number of records to return.

If $justids is true then it returns just an ref to an array of the record ids, not the objects.

$c = $db->drop_orphan_cache_tables

Drop tables called "cacheXXX" where XXX is an integer. Returns the number of tables dropped.

$obj = $db->get_single( $dataset, $id )

Return a single item from the given dataset. The one with the specified id.

$items = $db->get_all( $dataset )

Returns a reference to an array with all the items from the given dataset.

@ids = $db->get_cache_ids( $dataset, $cachemap, $offset, $count )

Returns a list of $count ids from $cache_id starting at $offset and in the order in the cachemap.

@dataobjs = $db->get_dataobjs( $dataset [, $id [, $id ] ] )

Retrieves the records in $dataset with the given $id(s). If an $id doesn't exist in the database it will be ignored.

$foo = $db->get_values( $field, $dataset )

Return a reference to an array of all the distinct values of the EPrints::MetaField specified.

$ids = $db->get_ids_by_field_values( $field, $dataset [ %opts ] )

Return a reference to a hash table where the keys are field value ids and the value is a reference to an array of ids.

@events = $db->dequeue_events( $n )

Attempt to dequeue upto $n events. May return between 0 and $n events depending on parallel processes and how many events are remaining on the queue.


Password Validation

$real_username = $db->valid_login( $username, $password )

Tests whether the clear-text $password matches the stored encrypted password for $username.

Returns the user's real (case-sensitive) username or undef if the passwords don't match.


Database schema manipulation

$boolean = $db->has_sequence( $name )

Return true if a sequence of the given name exists in the database.

$success = $db->create_sequence( $seq_name )

Creates a new sequence object initialised to zero.

$success = $db->drop_sequence( $seq_name )

Deletes a sequence object.

$boolean = $db->has_column( $tablename, $columnname )

Return true if the a table of the given name has a column named $columnname in the database.

$success = $db->drop_column( $table, $column )

Drops a column from a table.

@columns = $db->get_primary_key( $tablename )

Returns the list of column names that comprise the primary key for $tablename.

Returns empty list if no primary key exists.

$db->create_primary_key( $tablename, @cols )

Create a PRIMARY KEY on $tablename over @cols.

$name = $db->index_name( $table, @columns )

Returns the name of the first index that starts with @columns on the $table table.

Returns undef if no index exists.

$success = $db->create_index( $tablename, @columns )

Creates an index over @columns for $tablename. Returns true on success.

$success = $db->create_unique_index( $tablename, @columns )

Creates a unique index over @columns for $tablename. Returns true on success.

$ok = $db->create_foreign_key( $main_table, $aux_table, $key_field )

Create a foreign key relationship between $main_table and $aux_table using the $key_field.

This will cause records in $aux_table to be deleted if the equivalent record is deleted from $main_table.

@tables = $db->get_tables

Return a list of all the tables in the database.

$boolean = $db->has_table( $tablename )

Return true if a table of the given name exists in the database.

$success = $db->create_table( $tablename, $setkey, @fields );

Creates a new table $tablename based on @fields.

The first $setkey number of fields are used for a primary key.

$db->drop_table( $tablename [, $tablename2 ] )

Delete the named table(s). Use with caution!

$db->rename_table( $tablename, $newtablename )

Renames the table from the old name to the new one.

$db->swap_table( $table_a, $table_b )

Swap table a and table b.


EPrints schema manipulation

$success = $db->create_archive_tables

Create all the SQL tables for each dataset.

$db->drop_archive_tables()

Destroy all tables used by eprints in the database.

$db->create_version_table

Make the version table (and set the only value to be the current version of eprints).

$db->drop_version_table

Drop the version table.

$db->has_dataset( $dataset )

Returns true if $dataset exists in the database or has no database tables.

This does not check that all fields are configured - see has_field().

$success = $db->create_dataset_tables( $dataset )

Create all the SQL tables for a single dataset.

Index tables are created in the dataset is indexable.

Order values tables are created for each configured languaged if the dataset is ordered.

$db->drop_dataset_tables( $dataset )

Drop all the SQL tables for a single dataset.

$db->has_field( $dataset, $field )

Returns true if $field is in the database for $dataset.

$db->add_field( $dataset, $field [, $force ] )

Add $field to $dataset's tables.

If $force is true will modify/replace an existing column (use with care!).

$db->remove_field( $dataset, $field )

Remove $field from $dataset's tables.

$ok = $db->rename_field( $dataset, $field, $old_name )

Rename a $field in the database from it's old name $old_name.

Returns true if the field was successfully renamed.

$success = $db->create_counters

Create the counters used to store the highest current id of eprints, users etc.

$success = $db->has_counter( $counter )

Returns true if $counter exists.

$success = $db->create_counter( $name )

Create and initialise to zero a new counter called $name.

$success = $db->remove_counters

Destroy all counters.

$success = $db->drop_counter( $name )

Destroy the counter named $name.


SEE ALSO

To access database-stored objects use the methods provided by the following modules: EPrints::Repository, EPrints::DataSet.


COPYRIGHT

Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.