./Sources/DbPackages-mysql.php
- db_packages_init
- smf_db_create_table
- smf_db_drop_table
- smf_db_add_column
- smf_db_remove_column
- smf_db_change_column
- smf_db_add_index
- smf_db_remove_index
- smf_db_calculate_type
- smf_db_table_structure
- smf_db_list_columns
- smf_db_list_indexes
- smf_db_create_query_column
db_packages_init
function db_packages_init(): void
Add the file functions to the $smcFunc array.
smf_db_create_table
function smf_db_create_table(string $table_name, array $columns, array $indexes = array(), array $parameters = array(), string $if_exists = 'ignore', string $error = 'fatal'): bool
This function can be used to create a table without worrying about schema compatibilities across supported database systems.
- If the table exists will, by default, do nothing.
- Builds table with columns as passed to it - at least one column must be sent.
The columns array should have one sub-array for each column - these sub arrays contain:
‘name’ = Column name
‘type’ = Type of column - values from (smallint, mediumint, int, text, varchar, char, tinytext, mediumtext, largetext)
‘size’ => Size of column (If applicable) - for example 255 for a large varchar, 10 for an int etc.
If not set SMF will pick a size.
- ‘default’ = Default value - do not set if no default required.
- ‘not_null’ => Can it be null (true or false) - if not set default will be false.
- ‘auto’ => Set to true to make it an auto incrementing column. Set to a numerical value to set from what it should begin counting.
- Adds indexes as specified within indexes parameter. Each index should be a member of $indexes. Values are:
- ‘name’ => Index name (If left empty SMF will generate).
- ‘type’ => Type of index. Choose from ‘primary’, ‘unique’ or ‘index’. If not set will default to ‘index’.
- ‘columns’ => Array containing columns that form part of key - in the order the index is to be created.
- parameters: (None yet)
- if_exists values:
- ‘ignore’ will do nothing if the table exists. (And will return true)
- ‘overwrite’ will drop any existing table of the same name.
- ‘error’ will return false if the table already exists.
- ‘update’ will update the table if the table already exists (no change of ai field and only colums with the same name keep the data)
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table to create |
array |
$columns |
An array of column info in the specified format |
array |
$indexes |
An array of index info in the specified format |
array |
$parameters |
Extra parameters. Currently only ‘engine’, the desired MySQL storage engine, is used. |
string |
$if_exists |
What to do if the table exists. |
string |
$error |
smf_db_drop_table
function smf_db_drop_table(string $table_name, array $parameters = array(), string $error = 'fatal'): bool
Drop a table.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table to drop |
array |
$parameters |
Not used at the moment |
string |
$error |
smf_db_add_column
function smf_db_add_column(string $table_name, array $column_info, array $parameters = array(), string $if_exists = 'update', string $error = 'fatal'): bool
This function adds a column.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table to add the column to |
array |
$column_info |
An array of column info ({@see \smf_db_create_table}) |
array |
$parameters |
Not used? |
string |
$if_exists |
What to do if the column exists. If ‘update’, column is updated. |
string |
$error |
smf_db_remove_column
function smf_db_remove_column(string $table_name, string $column_name, array $parameters = array(), string $error = 'fatal'): bool
Removes a column.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table to drop the column from |
string |
$column_name |
The name of the column to drop |
array |
$parameters |
Not used? |
string |
$error |
smf_db_change_column
function smf_db_change_column(string $table_name, string $old_column, array $column_info): bool
Change a column. You only need to specify the column attributes that are changing.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table this column is in |
string |
$old_column |
The name of the column we want to change |
array |
$column_info |
An array of info about the “new” column definition (see {@link smf_db_create_table()}) |
| Note that $column_info also supports two additional parameters that only make sense when changing columns: | ||
| - drop_default - to drop a default that was previously specified |
smf_db_add_index
function smf_db_add_index(string $table_name, array $index_info, array $parameters = array(), string $if_exists = 'update', string $error = 'fatal'): bool
Add an index.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table to add the index to |
array |
$index_info |
An array of index info (see {@link smf_db_create_table()}) |
array |
$parameters |
Not used? |
string |
$if_exists |
What to do if the index exists. If ‘update’, the definition will be updated. |
string |
$error |
smf_db_remove_index
function smf_db_remove_index(string $table_name, string $index_name, array $parameters = array(), string $error = 'fatal'): bool
Remove an index.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table to remove the index from |
string |
$index_name |
The name of the index to remove |
array |
$parameters |
Not used? |
string |
$error |
smf_db_calculate_type
function smf_db_calculate_type(string $type_name, int $type_size = null, bool $reverse = false): array
Get the schema formatted name for a type.
| Type | Parameter | Description |
|---|---|---|
string |
$type_name |
The data type (int, varchar, smallint, etc.) |
int |
$type_size |
The size (8, 255, etc.) |
bool |
$reverse |
smf_db_table_structure
function smf_db_table_structure(string $table_name): array
Get table structure.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table |
smf_db_list_columns
function smf_db_list_columns(string $table_name, bool $detail = false, array $parameters = array()): array
Return column information for a table.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table to get column info for |
bool |
$detail |
Whether or not to return detailed info. If true, returns the column info. If false, just returns the column names. |
array |
$parameters |
Not used? |
smf_db_list_indexes
function smf_db_list_indexes(string $table_name, bool $detail = false, array $parameters = array()): array
Get index information.
| Type | Parameter | Description |
|---|---|---|
string |
$table_name |
The name of the table to get indexes for |
bool |
$detail |
Whether or not to return detailed info. |
array |
$parameters |
Not used? |
smf_db_create_query_column
function smf_db_create_query_column(array $column): string
Creates a query for a column
| Type | Parameter | Description |
|---|---|---|
array |
$column |
An array of column info |