PHPXRef 0.7.1 : Unnamed Project : Detail view of db

Class: phpbb_db_tools - X-Ref

Database Tools for handling cross-db actions such as altering columns, etc.
Currently not supported is returning SQL for creating tables.

phpbb_db_tools(&$db, $return_statements = false) X-Ref

Constructor. Set DB Object and set {@link $return_statements return_statements}.

param: phpbb_dbal $db DBAL object
param: bool $return_statements True if only statements should be returned and no SQL being executed

sql_list_tables() X-Ref

Gets a list of tables in the database.

return: array Array of table names (all lower case)

sql_table_exists($table_name) X-Ref

Check if table exists

param: string $table_name The table name to check for
return: bool true if table exists, else false

sql_create_table($table_name, $table_data) X-Ref

Create SQL Table

param: string    $table_name    The table name to create
param: array    $table_data    Array containing table data.
return: array    Statements if $return_statements is true.

perform_schema_changes($schema_changes) X-Ref

Handle passed database update array.
Expected structure...
Key being one of the following
change_columns: Column changes (only type, not name)
add_columns: Add columns to a table
drop_keys: Dropping keys
drop_columns: Removing/Dropping columns
add_primary_keys: adding primary keys
add_unique_index: adding an unique index
add_index: adding an index (can be column:index_size if you need to provide size)

The values are in this format:
{TABLE NAME}        => array(
{COLUMN NAME}        => array({COLUMN TYPE}, {DEFAULT VALUE}, {OPTIONAL VARIABLES}),
{KEY/INDEX NAME}    => array({COLUMN NAMES}),
)

For more information have a look at /develop/create_schema_files.php (only available through SVN)

sql_list_columns($table) X-Ref

Gets a list of columns of a table.

param: string $table Table name
return: array Array of column names (all lower case)

sql_column_exists($table, $column_name) X-Ref

Check whether a specified column exist in a table

param: string    $table            Table to check
param: string    $column_name    Column to check
return: bool        True if column exists, false otherwise

sql_index_exists($table_name, $index_name) X-Ref

Check if a specified index exists in table. Does not return PRIMARY KEY and UNIQUE indexes.

param: string $table_name Table to check the index at
param: string $index_name The index name to check
return: bool True if index exists, else false

sql_unique_index_exists($table_name, $index_name) X-Ref

_sql_run_sql($statements) X-Ref

Private method for performing sql statements (either execute them or return them)

sql_prepare_column_data($table_name, $column_name, $column_data) X-Ref

Function to prepare some column information for better usage

sql_column_add($table_name, $column_name, $column_data, $inline = false) X-Ref

Add new column

sql_column_remove($table_name, $column_name, $inline = false) X-Ref

Drop column

sql_index_drop($table_name, $index_name) X-Ref

Drop Index

sql_table_drop($table_name) X-Ref

Drop Table

sql_create_primary_key($table_name, $column, $inline = false) X-Ref

Add primary key

sql_create_unique_index($table_name, $index_name, $column) X-Ref

Add unique index

sql_create_index($table_name, $index_name, $column) X-Ref

Add index

sql_list_index($table_name) X-Ref

List all of the indices that belong to a table,
does not count:
* UNIQUE indices
* PRIMARY keys

sql_column_change($table_name, $column_name, $column_data, $inline = false) X-Ref

Change column type (not name!)

Copyright:	(c) 2007 phpBB Group
License:	http://opensource.org/licenses/gpl-license.php GNU Public License
Version:	$Id$
File Size:	2477 lines (68 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Unnamed Project

/includes/db/ -> db_tools.php (summary)

Defines 1 class