API:EPrints/Database/mysql
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
NAME[edit]
EPrints::Database::mysql - custom database methods for MySQL DB
DESCRIPTION[edit]
MySQL database wrapper.
Foreign keys will be defined if you use a DB engine that supports them (e.g. InnoDB).
Synopsis[edit]
$c->{dbdriver} = 'mysql';
# $c->{dbhost} = 'localhost';
# $c->{dbport} = '3316';
$c->{dbname} = 'myrepo';
$c->{dbuser} = 'bob';
$c->{dbpass} = 'asecret';
# $c->{dbengine} = 'InnoDB';
MySQL-specific Annoyances[edit]
MySQL does not support sequences.
MySQL is (by default) lax about truncation.
CONSTANTS[edit]
See EPrints::Database.
INSTANCE VARIABLES[edit]
See EPrints::Database.
METHODS[edit]
get_server_version[edit]
$version = $db->get_server_version
Returns the database server version.
mysql_version_from_dbh[edit]
$version = $db->mysql_version_from_dbh
Returns the MySQL database server version from handle $dbh.
create[edit]
$version = $db->create( $username, $password )
Creates EPrints database as user with $username and $password.
create_counters[edit]
$n = $db->create_counters()
Creates and initialises the counters.
has_table[edit]
$boolean = $db->has_table( $tablename )
Returns true if the table with $tablename exists in the database.
has_column[edit]
$boolean = $db->has_column( $table, $column )
Returns true if named $table has named $column in the database.
connect[edit]
$db->connect()
Connects to the database.
has_counter[edit]
$success = $db->has_counter( $counter )
Returns true if $counter exists.
create_counter[edit]
$success = $db->create_counter( $name )
Create and initialise to zero a new counter with $name.
drop_counter[edit]
$success = $db->drop_counter( $name )
Destroy the counter named $name.
remove_counters[edit]
$success = $db->remove_counters
Destroy all counters.
counter_next[edit]
$n = $db->counter_next( $counter )
Return the next unused value for the named counter. Returns undef if the counter doesn't exist.
counter_minimum[edit]
$db->counter_minimum( $counter, $value )
Ensure that the counter is set no lower that $value. This is used when importing eprints which may not be in scrict sequence.
counter_reset[edit]
$db->counter_reset( $counter )
Return the counter. Use with cautiuon.
get_default_charset[edit]
$charset = $db->get_default_charset
Return the character set to use. Always utf8.
get_default_collation[edit]
$collation = $db->get_default_collation( $lang )
Return the collation to use for language $lang. Always utf8_bin.
get_primary_key[edit]
@columns = $db->get_primary_key( $table )
Returns a list of column names that comprise the primary key for named named $table.
Returns an empty list if no primary key exists.
get_number_of_keys[edit]
$num_keys = $db->get_number_of_keys( $table )
Returns the number of columns which are keys (PRI, MUL or UNI) for named $table.
get_column_colation[edit]
$collation = $db->get_column_colation( $table, $column )
Returns the collation for the named $column in the named $table.
quote_identifier[edit]
$str = $db->quote_identifier( @parts )
Quote a database identifier (e.g. table names). Multiple @parts will be joined by dots (.).
We'll do quote here, because DBD::mysql#quote_identifier is really slow.
prepare_regexp[edit]
$sql = $db->prepare_regexp( $col, $value )
Oracle use the syntax:
$col REGEXP $value
For the quoted regexp $value and the quoted column $col.
sql_like[edit]
$sql = $db->sql_LIKE()
Returns the syntactic glue to use when making a case-insensitive LIKE using utf8_general_ci collation.
ci_lookup[edit]
$value = $db->ci_lookup( $field, $value )
This is a hacky method to support case-insensitive lookup for usernames, emails, etc. It returns the actual case-sensitive version of $value if there is a case-insensitive match for the $field.
duplicate_error[edit]
$boolean = $db->duplicate_error()
Returns a boolean for whether the database error is a duplicate error. Based on whether the DBI#err code is 1062.
duplicate_error[edit]
$boolean = $db->duplicate_error()
Returns a boolean for whether the database error is a retry error. Based on whether the DBI#err code is 2006.
type_info[edit]
$type_info = $db->type_info( $data_type )
See DBI/type_info.
Uses LONGTEXT with column size 2^31 for SQL_CLOB.
index_name[edit]
$name = $db->index_name( $table, @cols )
Returns the name of the first index that starts with named columns @cols in the named $table.
Returns undef if no index exists.
Uses MySQL 4.0+ compatible SHOW INDEX.
This method gets the entire SHOW INDEX response and builds a look-up table of keys with their ordered columns. This ensures even if MySQL is weird and returns out of order results we won't break.
SEE ALSO[edit]
COPYRIGHT[edit]
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE[edit]
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 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 3.4. If not, see http://www.gnu.org/licenses/.