Unofficial SMF API Documentation

./Sources/DbPackages-postgresql.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

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'): void

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)

smf_db_drop_table

function smf_db_drop_table(string $table_name, array $parameters = array(), string $error = 'fatal'): bool

Drop a table and its associated sequences.

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.

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.

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.

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.

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.

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.

smf_db_table_structure

function smf_db_table_structure(string $table_name): array

Get table structure.

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.

smf_db_list_indexes

function smf_db_list_indexes(string $table_name, bool $detail = false, array $parameters = array()): array

Get index information.

Suggest an edit to this page on GitHub