Construct a database driver from connection parameters.

• string $db_name: The database name
• string $db_host: The database server
• string $db_user: The connection username
• string $db_password: The connection password
• string $table_prefix: The table prefix
• boolean $fail_ok: Whether to on error echo an error and return with a NULL, rather than giving a critical error
• ?object $static: Static call object (NULL: use global static call object)

Change the type of a DB field in a table. Note: this function does not support ascession/decession of translatability

• ID_TEXT $table_name: The table name
• ID_TEXT $name: The field name
• ID_TEXT $_type: The new field type
• ?ID_TEXT $new_name: The new field name (NULL: leave name)

Add an index to a table without disturbing the contents, after the table has been created.

• ID_TEXT $table_name: The table name
• ID_TEXT $index_name: The index name
• array $fields: The fields
• ID_TEXT $unique_key_field: The name of the unique key field for the table

Delete an index from a table.

• ID_TEXT $table_name: The table name
• ID_TEXT $index_name: The index name

Drop the given table, or if it doesn't exist, silently return.

• ID_TEXT $table: The table name

Initialise a filesystem DB that we can use for caching.

This function is a very basic query executor. It shouldn't usually be used by you, as there are abstracted versions available (see below).

• return: The results (NULL: no results)

• string $query: The complete SQL query
• ?integer $max: The maximum number of rows to affect (NULL: no limit)
• ?integer $start: The start row to affect (NULL: no specification)
• boolean $fail_ok: Whether to output an error on failure
• boolean $skip_safety_check: Whether to skip the query safety check
• ?array $lang_fields: Extra language fields to join in for cache-prefilling. You only need to send this if you are doing a JOIN and carefully craft your query so table field names won't conflict (NULL: none)
• string $field_prefix: All the core fields have a prefix of this on them, so when we fiddle with language lookup we need to use this (only consider this if you're setting $lang_fields)

Insert a row.

• return: The id of the new row

• string $table: The table name
• array $map: The insertion map
• boolean $ret: Whether to return the auto-insert-id
• boolean $fail_ok: Whether to allow failure (outputting a message instead of exiting completely)
• boolean $save_as_volatile: Whether we are saving as a 'volatile' file extension (used in the XML DB driver, to mark things as being non-syndicated to subversion)

Update (edit) a row in the database.

• return: The number of touched records (NULL: hasn't been asked / error)

• string $table: The table name
• array $update_map: The UPDATE map
• ?array $where_map: The WHERE map [will all be AND'd together] (NULL: no conditions)
• string $end: Something to tack onto the end of the statement
• ?integer $max: The maximum number of rows to update (NULL: no limit)
• ?integer $start: The starting row to update (NULL: no specific start)
• boolean $num_touched: Whether to get the number of touched rows. WARNING: Do not use in core ocPortal code as it does not work on all database drivers
• boolean $fail_ok: Whether to allow failure (outputting a message instead of exiting completely)

Get the specified value from the database, or NULL if it is not there (or if the value itself is NULL). This is good for detection existence of records, or for use if they might may or may not be present.

• return: The first value of the first row returned (NULL: nothing found, or null value found)

• string $table: The table name
• string $select: The field to select
• ?array $where_map: The WHERE map [will all be AND'd together] (NULL: no where conditions)
• string $end: Something to tack onto the end
• boolean $fail_ok: Whether to allow failure (outputting a message instead of exiting completely)

If we've changed what $type is stored as, this function will need to be called to change the typing in the DB.

• ID_TEXT $type: The field type

Check if a table exists.

• return: Whether it exists

• ID_TEXT $tablename: The table name

This function is a very basic query executor. It shouldn't usually be used by you, as there are specialised abstracted versions available.

• return: The results (NULL: no results)

• string $query: The complete SQL query
• ?integer $max: The maximum number of rows to affect (NULL: no limit)
• ?integer $start: The start row to affect (NULL: no specification)
• boolean $fail_ok: Whether to output an error on failure
• boolean $get_insert_id: Whether to get an insert ID
• ?array $lang_fields: Extra language fields to join in for cache-prefilling. You only need to send this if you are doing a JOIN and carefully craft your query so table field names won't conflict (NULL: none)
• string $field_prefix: All the core fields have a prefix of this on them, so when we fiddle with language lookup we need to use this (only consider this if you're setting $lang_fields)
• boolean $save_as_volatile: Whether we are saving as a 'volatile' file extension (used in the XML DB driver, to mark things as being non-syndicated to subversion)