Editing API:EPrints/Database (section)

===Database Schema Manipulation===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_has_sequence -->
====has_sequence====

 $boolean = $db-&gt;has_sequence( $name )
Returns <tt>true</tt> if a sequence of the given <tt>$name</tt> exists in the  database. Otherwise, returns <tt>false</tt>.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_create_sequence -->
====create_sequence====

 $success = $db-&gt;create_sequence( $name )
Creates a new sequence object with <tt>$name</tt> and initialises to zero.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_drop_sequence -->
====drop_sequence====

 $success = $db-&gt;drop_sequence( $name )
Deletes a sequence object with <tt>$name</tt>.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_has_column -->
====has_column====

 $boolean = $db-&gt;has_column( $table, $column )
Return <tt>true</tt> if the named <tt>$table</tt> has the named <tt>$column</tt> in the  database.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_drop_column -->
====drop_column====

 $success = $db-&gt;drop_column( $table, $column )
Drops the named <tt>$column</tt> from the named <tt>$table</tt>.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_get_primary_key -->
====get_primary_key====

 @columns = $db-&gt;get_primary_key( $tablename )
Returns a list of column names that comprise the primary key for  the <tt>$tablename</tt>.

Returns an empty list if no primary key exists.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_index_name -->
====index_name====

 $name = $db-&gt;index_name( $table, @cols )
Returns the name of the first index that starts with named columns  <tt>@cols</tt> in the named <tt>$table</tt>.

Returns <tt>undef</tt> if no index exists.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_get_index_ids -->
====get_index_ids====

 $ids = $db-&gt;get_index_ids( $table, $condition )
Return a reference to an array of the distinct primary keys from the named SQL <tt>$table</tt> which match the specified <tt>$condition</tt>.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_create_index -->
====create_index====

 $success = $db-&gt;create_index( $table, @columns )
Creates an index over <tt>@columns</tt> for named <tt>$table</tt>. Returns <tt>true</tt>  on success, <tt>false</tt> otherwise.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_create_unique_index -->
====create_unique_index====

 $success = $db-&gt;create_unique_index( $tablename, @columns )
Creates a unique index over <tt>@columns</tt> for named <tt>$table</tt>. Returns  <tt>true</tt> on success, <tt>false</tt> otherwise.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_create_foreign_key -->
====create_foreign_key====

 $ok = $db-&gt;create_foreign_key( $main_table, $table, $key_field )
Create a foreign key relationship between named <tt>$main_table</tt> and  named <tt>$table</tt> using <tt>$key_field</tt>.

This will cause records in <tt>$table</tt> to be deleted if the equivalent  record is deleted from <tt>$main_table</tt>.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_get_tables -->
====get_tables====

 @tables = $db-&gt;get_tables( [ $dbname ] )
Returns a list of all the tables in the database.  

<tt>$dbname</tt> specifies a particular database name of current connection has access to more than one database.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_has_table -->
====has_table====

 $boolean = $db-&gt;has_table( $tablename )
Returns boolean dependent on whether a table of the <tt>$tablename</tt>  exists in the database.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_create_table -->
====create_table====

 $success = $db-&gt;create_table( $tablename, $setkey, @fields );
Creates a new table with <tt>$tablename</tt> based on <tt>@fields</tt>.

The first <tt>$setkey</tt> number of fields are used for its primary key.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_drop_table -->
====drop_table====

 $db-&gt;drop_table( @tables )
Delete the named <tt>@tables</tt>. Use with caution!

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_rename_table -->
====rename_table====

 $db-&gt;rename_table( $table_from, $table_to )
Renames the table named <tt>$table_from</tt> to <tt>$table_to</tt>.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_swap_table -->
====swap_table====

 $db-&gt;swap_table( $table_a, $table_b )
Renames table named <tt>$table_a</tt> to <tt>$table_b</tt> and vice-versa. 

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_eprints_schema_manipulation -->