PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of tools

Interface for a Database Tools for handling cross-db actions such as altering columns, etc.

perform_schema_changes($schema_changes) X-Ref

Handle passed database update array.
Expected structure...
Key being one of the following
drop_tables: Drop tables
add_tables: Add tables
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}),
)

param: array $schema_changes
return: null

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|true    Statements to run, or true if the statements have been executed

sql_table_drop($table_name) X-Ref

Drop Table

param: string $table_name The table name to drop
return: array|true Statements to run, or true if the statements have been executed

sql_list_columns($table_name) X-Ref

Gets a list of columns of a table.

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

sql_column_exists($table_name, $column_name) X-Ref

Check whether a specified column exist in a table

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

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

Add new column

param: string    $table_name        Table to modify
param: string    $column_name    Name of the column to add
param: array        $column_data    Column data
param: bool        $inline            Whether the query should actually be run,
return: array|true    Statements to run, or true if the statements have been executed

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

Change column type (not name!)

param: string    $table_name        Table to modify
param: string    $column_name    Name of the column to modify
param: array        $column_data    Column data
param: bool        $inline            Whether the query should actually be run,
return: array|true    Statements to run, or true if the statements have been executed

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

Drop column

param: string    $table_name        Table to modify
param: string    $column_name    Name of the column to drop
param: bool        $inline            Whether the query should actually be run,
return: array|true    Statements to run, or true if the statements have been executed

sql_list_index($table_name) X-Ref

List all of the indices that belong to a table

NOTE: does not list
- UNIQUE indices
- PRIMARY keys

param: string $table_name Table to check
return: array Array with index names

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_create_index($table_name, $index_name, $column) X-Ref

Add index

param: string    $table_name        Table to modify
param: string    $index_name        Name of the index to create
param: string|array    $column        Either a string with a column name, or an array with columns
return: array|true    Statements to run, or true if the statements have been executed

sql_index_drop($table_name, $index_name) X-Ref

Drop Index

param: string    $table_name        Table to modify
param: string    $index_name        Name of the index to delete
return: array|true    Statements to run, or true if the statements have been executed

sql_unique_index_exists($table_name, $index_name) X-Ref

Check if a specified index exists in table.

NOTE: Does not return normal and PRIMARY KEY 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_create_unique_index($table_name, $index_name, $column) X-Ref

Add unique index

param: string    $table_name        Table to modify
param: string    $index_name        Name of the unique index to create
param: string|array    $column        Either a string with a column name, or an array with columns
return: array|true    Statements to run, or true if the statements have been executed

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

Add primary key

param: string    $table_name        Table to modify
param: string|array    $column        Either a string with a column name, or an array with columns
param: bool        $inline            Whether the query should actually be run,
return: array|true    Statements to run, or true if the statements have been executed

Copyright:	(c) phpBB Limited
License:	GNU General Public License, version 2 (GPL-2.0)
File Size:	202 lines (7 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of phpBB-3.3.14-deutsch

/phpbb/db/tools/ -> tools_interface.php (summary)

Defines 1 class