Change the primary key of a table.

• ID_TEXT $table_name: The name of the table to create the index on
• array $new_key: A list of fields to put in the new key
• array $db: The DB connection to make on

Create a table index.

• ID_TEXT $table_name: The name of the table to create the index on
• ID_TEXT $index_name: The index name (not really important at all)
• string $_fields: Part of the SQL query: a comma-separated list of fields to use on the index
• array $db: The DB connection to make on

Get the default password for making db connections (used by the installer as a default).

• return: The default password for db connections

Delete a table.

• ID_TEXT $table_name: The table name
• array $db: The DB connection to delete on

Encode a LIKE string comparision fragement for the database system. The pattern is a mixture of characters and ? and % wilcard symbols.

• return: The encoded pattern

• string $pattern: The pattern

Assemble part of a WHERE clause for doing full-text search

• return: Part of a WHERE clause for doing full-text search

• string $content: Our match string
• boolean $boolean: Whether to do a boolean full text search

Get the ID of the first row in an auto-increment table (used whenever we need to reference the first).

• return: First ID used

Find whether full-text-search is present

• return: Whether it is

• array $db: A DB connection

Find whether subquery support is present

• return: Whether it is

• array $db: A DB connection

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

• return: The results (NULL: no results), or the insert ID

• string $query: The complete SQL query
• array $db: A DB connection
• ?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 not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)
• boolean $get_insert_id: Whether to get the autoincrement ID created for an insert query
• boolean $no_syndicate: Whether to force the query to execute on the XML database driver (won't optimise by using MySQL). Useful for calls happening for multi-part queries from within this DB driver
• boolean $save_as_volatile: Whether we are saving as a 'volatile' file extension

Encode an SQL statement fragment for a conditional to see if two strings are not equal.

• return: The SQL

• ID_TEXT $attribute: The attribute
• string $compare: The comparison

Give out an error message and die, when a query fails.

• return: Always returns null (NULL: error)

• string $query: The query that failed
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)
• ?string $error: Error message (NULL: none)

Execute an ALTER query.

• return: The results (NULL: no results)

• array $tokens: Tokens
• string $query: Query that was executed
• array $db: Database connection
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)

Execute a DELETE query.

• return: The results (NULL: no results)

• array $tokens: Tokens
• string $query: Query that was executed
• array $db: Database connection
• ?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 not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)

Wrapper to execute an INSERT query.

• return: The insert ID (NULL: not requested / error)

• array $tokens: Tokens
• string $query: Query that was executed
• array $db: Database connection
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)
• boolean $get_insert_id: Whether to get the autoincrement ID created for an insert query
• ?integer &$random_key: The random key that we would use (NULL: not generated yet)
• boolean $save_as_volatile: Whether we are saving as a 'volatile' file extension

Parse an INSERT query.

• return: A pair: the table, and the rows to insert (NULL: error)

• array $tokens: Tokens
• string $query: Query that was executed
• array $db: Database connection
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)

Execute an UPDATE query.

• return: The results (NULL: no results)

• array $tokens: Tokens
• string $query: Query that was executed
• array $db: Database connection
• ?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 not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)

Execute an expression.

• return: The result (NULL: error/NULL)

• array $expr: The expression
• array $bindings: Bindings available in the execution scope
• string $query: Query that was executed

Run SQL data filter functions over a result set.

• return: The result row based on the set

• array $set: The set of results we are operating on
• array $select: Parse tree of what we are selecting
• array $rep: Record we are copying the function results into
• string $query: Query that was executed

Check to see if there is a key conflict problem.

• return: Whether there was a conflict

• array $db: Database connection
• string $table_name: The table name
• array $schema: The schema
• array $record: The record
• string $query: Query that was executed
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)
• ?string $existing_identity: The GUID representing what we have now (so we don't think we're conflicting with ourself) (NULL: not yet added)

Expect a certain token next.

• return: Success status

• integer &$at: Our offset counter
• array $tokens: Tokens
• string $token: Token expected
• string $query: Query that was executed
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)

Parse an SQL expression.

• return: The expression (NULL: error)

• integer &$at: Our offset counter
• array $tokens: Tokens
• string $query: Query that was executed
• array $db: Database connection
• boolean $look_for_connectives: Whether to work as a connection point to seek out logic connection expression parts
• boolean $look_for_any_connectives: Whether to work as a connection point to seek out arithmetic connection expression parts
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)

Read in a table specifier clause for a WHERE query.

• return: Join condition (NULL: no join here)

• integer &$at: Our offset counter
• array $tokens: Tokens
• string $query: Query that was executed
• array $db: Database connection
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)
• integer &$closing_brackets_needed: How many closing brackets we expect

Find the schema for a table.

• return: The schema map (NULL: not found)

• array $db: The database
• string $table_name: The table name
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)

Take an expression and do our best to collapse it into a fixed mapping of stuff we know we are going to AND.

• return: AND map

• array $where_expr: The expression parse tree
• string $table_as: What the table will be renamed to (blank: N/A)
• ?array $schema: Schema to type-set against (NULL: do not do type-setting)
• boolean $not_full_accuracy: Whether to do a not-full-accurate search

Unescape a value from a filesystem path back to the original.

• return: Original value

• string $in: Escaped value

Write in all the records to a table.

• array $db: Database connection
• string $table_name: The table name
• array $records: The list of record maps
• boolean $fail_ok: Whether to not output an error on some kind of run-time failure (parse errors and clear programming errors are always fatal)