Determines if an error throws an exception

• var: Set to true to throw error exceptions (RuntimeException)
• access: protected

Instance flag for auto-escaping values in BuildSQL* helpers

• var: Controlled via SetAutoEscapeValues() / SetGlobalAutoEscapeValues()
• access: private

Forces buffered results for SELECT queries (true = Buffered, false = Unbuffered)

• var: Controlled via SetUnbufferedMode()
• access: private

Enables automatic reconnection on connection loss

• var: Controlled via SetAutoReconnect()
• access: private

Constructor: Opens the connection to the database

• access: public

• boolean $connect: Auto-connect when object is created
• string $database: Database name
• string $server: Host address
• string $username: User name
• string $password: Password
• string $charset: Character set (default utf8mb4)
• boolean $persistent: Use persistent connection

Destructor: Closes the connection to the database

• access: public

Sets auto-escape mode for this instance (used by BuildSQL* helpers)

• access: public

• boolean $flag: True to enable auto-escaping

Sets global auto-escape mode for all new instances

• access: public
• static

• boolean $flag: True to enable auto-escaping globally

Sets unbuffered (streaming) mode for SELECT queries. Default is TRUE (Unbuffered).

• access: public

• boolean $flag: True for UNBUFFERED (streaming), False for BUFFERED

Enables or disables automatic reconnection on connection loss

• access: public

• boolean $flag: True to enable auto-reconnect

Enables or disables throwing exceptions on database errors

• access: public

• boolean $flag: True to throw RuntimeException on errors

Sets the debug log file path (must be absolute and outside webroot recommended)

• access: public

• string $path: Absolute path to the debug log file

Automatically performs an INSERT or UPDATE based on record existence (uses Transaction + SELECT FOR UPDATE)

• return: Returns INSERT ID on new record, TRUE on update, FALSE on error
• access: public

• string $tableName: The table name
• array $valuesArray: Associative array of column=>value data to insert/update
• array $whereArray: Associative array for WHERE clause (required)

Checks if the internal result pointer is at the first row (index 0)

• return: True if at beginning, false otherwise
• access: public

[STATIC] Builds a SQL DELETE statement with optional WHERE clause and auto-escape support

• return: The DELETE SQL statement
• access: public
• static

• string $tableName: Table name
• array $whereArray: WHERE conditions (optional)
• boolean $autoEscape: Auto-escape values via SQLValue()

[STATIC] Builds a SQL INSERT statement with auto-escape support

• return: The INSERT SQL statement
• access: public
• static

• string $tableName: Table name
• array $valuesArray: Associative array of column=>value
• boolean $autoEscape: Auto-escape values via SQLValue()

[STATIC] Builds a SELECT SQL statement with full clause support (WHERE, COLUMNS, ORDER BY, LIMIT, OFFSET)

• return: The SELECT SQL statement
• access: public
• static

• string $tableName: Table name
• array $whereArray: WHERE conditions (supports operators, IN, NULL, _raw)
• array|string $columns: Columns to select (null = *)
• array|string $sortColumns: ORDER BY columns
• boolean $sortAscending: Sort direction (true=ASC)
• int $limit: LIMIT count
• int $offset: OFFSET count
• boolean $autoEscape: Auto-escape values in WHERE

[STATIC] Builds a SQL UPDATE statement with auto-escape support

• return: The UPDATE SQL statement
• access: public
• static

• string $tableName: Table name
• array $valuesArray: Column=>value pairs to set
• array $whereArray: WHERE conditions (optional)
• boolean $autoEscape: Auto-escape values

[STATIC] Builds a WHERE clause from an array. Supports operators in keys (e.g. "age >"), IN/NOT IN arrays, NULL checks, and '_raw' key for raw SQL fragments.

• return: The WHERE clause (prefixed with " WHERE " or " AND ")
• access: public
• static

• array $whereArray: Conditions array
• boolean $autoEscape: Auto-escape values

[STATIC] Escapes a database identifier (table/column name) with backticks. Validates against forbidden chars.

• return: Escaped identifier (e.g., `table`)
• access: public
• static

• string $identifier: The identifier to escape

Closes the database connection and frees resources (statements, results)

• return: True on success, false on failure
• access: public

Deletes rows matching the WHERE conditions (requires WHERE to prevent mass delete)

• return: True on success, false on error
• access: public

• string $tableName: Table name
• array $whereArray: WHERE conditions (required)

Checks if the internal result pointer is at or past the last row

• return: True if at end (or empty), false otherwise
• access: public

Gets the last error description

• return: Error string with code (e.g., "Error (#1064)"), or false if no error
• access: public

Gets the last error number

• return: MySQL error code, or false if no error
• access: public

[STATIC] Converts a value to boolean using loose semantics (Y, T, 1, ON, etc.)

• return: True if value represents truthy state
• access: public
• static

• mixed $value: Value to check

Retrieves column comments for a table or the current result set

• return: Array of comments, or false on error
• access: public

• string $table: Table name (empty = current result set)
• string $resultType: Return format: ASSOC, NUM, BOTH

Gets the number of columns in a table or the current result set

• return: Column count, or false on error
• access: public

• string $table: Table name (empty = current result set)

Gets the generic data type (e.g., 'int', 'varchar') for a column

• return: Type name string, or false on error
• access: public

• string|int $column: Column name or index
• string $table: Table name (empty = current result set)

Gets the full MySQL column type definition (e.g., 'varchar(255)', 'int(11)')

• return: Type definition string, or false on error
• access: public

• string|int $column: Column name or index
• string $table: Table name

Gets the zero-based index of a column by name

• return: Column index, or false if not found
• access: public

• string $column: Column name
• string $table: Table name (empty = current result set)

Gets the maximum length (display size) of a column

• return: Column length, or false on error
• access: public

• string|int $column: Column name or index
• string $table: Table name (empty = current result set)

Gets the name of a column by its zero-based index

• return: Column name, or false on error
• access: public

• int $columnID: Column index
• string $table: Table name (empty = current result set)

Gets an array of column names for a table or the current result set

• return: Array of column names, or false on error
• access: public

• string $table: Table name (empty = current result set)

Gets a list of all tables in the current database

• return: Array of table names, or false on error
• access: public

Generates an HTML table representation of the current result set. Respects MYSQL_MAX_BUFFERED_ROWS safety limit.

• return: HTML string, or false if no result set / error / safety limit exceeded
• access: public

• boolean $showCount: Prepend row count
• string $styleTable: Inline CSS for <table>
• string $styleHeader: Inline CSS for header <td>
• string $styleData: Inline CSS for data <td>

Returns the current result set as a JSON string. Respects MYSQL_MAX_BUFFERED_ROWS safety limit.

• return: JSON encoded string (pretty print), or 'null' if no result / error / safety limit exceeded
• access: public

Gets the last auto-generated INSERT ID

• return: The ID (int|string), or false if none
• access: public

Gets the last executed SQL query string

• return: The SQL query
• access: public

Returns the current result set as an XML string. Respects MYSQL_MAX_BUFFERED_ROWS safety limit.

• return: XML document string
• access: public

Checks if a query returns any rows (executes SQL if provided)

• return: True if rows exist, false otherwise
• access: public

• string $sql: Optional SQL to execute first

Inserts a single row into a table

• return: Insert ID on success, false on error
• access: public

• string $tableName: Table name
• array $valuesArray: Associative array of column=>value

Checks if the database connection is active

• return: True if connected
• access: public

[STATIC] Determines if a value is a date PHP can convert. Use DateTime objects or ISO 8601 strings with SQLValue() instead.

• return: True if value is date
• access: public
• static
• deprecated: Since v5.0

• mixed $value: Value to check

Terminates script execution with an error message

• return: Never returns
• access: public

• string $message: Optional custom message (defaults to last error)

Moves the internal result pointer to the first row (index 0). Not supported for unbuffered prepared statements without mysqlnd.

• return: True on success, false on failure or empty result
• access: public

Moves the internal result pointer to the last row. Not supported for unbuffered prepared statements without mysqlnd.

• return: True on success, false on failure or empty result
• access: public

Opens a database connection. Supports SSL options and connection timeout.

• return: True on success, false on failure
• access: public

• string $database: Database name (overrides constructor)
• string $server: Host (overrides constructor)
• string $username: User (overrides constructor)
• string $password: Pass (overrides constructor)
• string $charset: Charset (overrides constructor)
• boolean $persistent: Use persistent connection
• int $connectTimeout: Connection timeout in seconds
• array $sslOptions: SSL options array (keys: key, cert, ca, capath, cipher)

Prepares a SQL statement for execution with placeholders (?)

• return: True on success, false on failure
• access: public

• string $sql: The SQL query with placeholders (?)

Binds a single parameter to the prepared statement. Must be called before Execute().

• return: True on success, false on error
• access: public

• mixed $value: The value to bind (by reference)
• string $type: Type specifier: 'i' (int), 'd' (double), 's' (string), 'b' (blob)

Binds multiple parameters at once. Types auto-detected if omitted.

• return: True on success, false on error
• access: public

• array $params: Array of values
• string $types: String of type specifiers (e.g., 'issd')

Executes the prepared statement. Handles SELECT (buffered/unbuffered) and DML automatically.

• return: True on success, false on failure
• access: public

Fetches the next row from a prepared statement (buffered or unbuffered fallback). Memory efficient for streaming.

• return: Row array, or false if no more rows / error
• access: public

• int $resultType: Fetch mode (MYSQLI_ASSOC, MYSQLI_NUM, MYSQLI_BOTH)

Fetches all remaining rows from a prepared statement into an array. Respects MYSQL_MAX_BUFFERED_ROWS safety limit.

• return: Array of rows, or false if safety limit exceeded / error
• access: public

• int $resultType: Fetch mode

Closes the current prepared statement and resets state

• return: True if a statement was closed, false if none active
• access: public

Gets the row count for the last prepared SELECT statement. Requires mysqlnd (mysqli_stmt_get_result). Throws error if unavailable.

• return: Row count, or false if unsupported/error
• access: public

Executes a raw SQL query directly. Detects SELECT vs DML to handle buffering and insert IDs. Blocks multi-statement queries for security. Supports buffered override.

• return: mysqli_result on success (SELECT), true on success (DML), false on error
• access: public

• string $sql: The SQL query
• bool $buffered: Override default buffering (true=buffered, false=unbuffered, null=use class default)

Executes a query and returns all rows as an array. Shortcut for Query() + RecordsArray().

• return: Array of rows, or false on error
• access: public

• string $sql: The SQL query
• int $resultType: Fetch mode

Executes a query and returns the first row as an object

• return: Row object, or false if no rows / error
• access: public

• string $sql: The SQL query

Executes a query and returns the first row as an array

• return: Row array, or false if no rows / error
• access: public

• string $sql: The SQL query
• int $resultType: Fetch mode

Executes a query and returns the first column of the first row

• return: The value, or false if no rows / error
• access: public

• string $sql: The SQL query

Executes a query and times the execution duration

• return: mysqli_result or false
• access: public

• string $sql: The SQL query

Gets the internal mysqli_result or mysqli_stmt object

• return: The result resource
• access: public

Fetches all rows from the last query result into an array. Buffers entire result set in memory. Respects MYSQL_MAX_BUFFERED_ROWS. Not supported for unbuffered prepared statements.

• return: Array of rows, or false on error / safety limit
• access: public

• int $resultType: Fetch mode

Frees the memory associated with the last query result

• return: True on success
• access: public

Fetches the current/next row as an object (stdClass). Advances internal pointer. Seeks if row number provided.

• return: Row object, or false if no row / error
• access: public

• int $optional_row_number: Zero-based row index to seek to (optional)

Fetches the current/next row as an array. Advances internal pointer. Seeks if row number provided.

• return: Row array, or false if no row / error
• access: public

• int $optional_row_number: Zero-based row index to seek to (optional)
• int $resultType: Fetch mode (MYSQLI_ASSOC, MYSQLI_NUM, MYSQLI_BOTH)

Gets the number of rows in the last result set (SELECT) or affected rows (DML). For unbuffered prepared statements without mysqlnd, returns false with error.

• return: Row count, affected rows, or false on error/unsupported
• access: public

Seeks the internal result pointer to a specific row number. Not supported for unbuffered prepared statements.

• return: True on success, false on failure / out of bounds
• access: public

• int $row_number: Zero-based row index

Gets the current zero-based row pointer position

• return: Current position (-1 if before first, count if after last)
• access: public

Selects the default database for the connection

• return: True on success, false on failure
• access: public

• string $database: Database name
• string $charset: Charset to set (optional)

Selects rows from a table with full query building capabilities (WHERE, COLUMNS, ORDER BY, LIMIT, OFFSET). Executes the query and stores result internally. Returns true on success, false on error. Use RowCount(), RecordsArray(), RowArray(), Fetch() etc. to access results.

• return: True on success, false on error
• access: public

• string $tableName: Table name
• array $whereArray: WHERE conditions (supports '_raw', operators in keys, etc.)
• array|string $columns: Columns to select (null = *)
• array|string $sortColumns: Column(s) to sort by
• boolean $sortAscending: Sort direction (true=ASC, false=DESC)
• int $limit: LIMIT count
• int $offset: OFFSET count
• int $resultType: Fetch mode (MYSQLI_ASSOC, MYSQLI_NUM, MYSQLI_BOTH)

Selects all rows from a table (SELECT * FROM table). Shortcut for SelectRows() with no filters.

• return: True on success, false on error
• access: public

• string $tableName: Table name

[STATIC] Converts a boolean into a formatted TRUE or FALSE value of choice

• return: SQL formatted value of the specified data type
• access: public
• static

• mixed $value: Value to analyze for TRUE or FALSE
• mixed $trueValue: Value to use if TRUE
• mixed $falseValue: Value to use if FALSE
• string $datatype: Use SQLVALUE constants

Escapes a string for safe use in SQL queries (mysqli_real_escape_string). Requires active connection.

• return: Escaped string, or false if no connection
• access: public

• string $value: The string to escape

[STATIC] Formats a PHP value into a SQL literal string based on datatype. Handles NULL, strings, numbers, booleans, dates (DateTime/ISO8601), blobs.

• return: SQL literal (e.g., 'hello', 123, NULL, '2023-01-01')
• access: public
• static

• mixed $value: The value to format
• string $datatype: One of SQLVALUE_* constants (text, number, date, datetime, time, boolean, y-n, t-f, bit)

Gets the duration of the last timed query

• return: Formatted duration in seconds
• access: public

• int $decimals: Decimal places for formatting

Starts the internal timer

• access: public

Stops the internal timer and calculates duration

• access: public

Begins a database transaction

• return: True on success, false on failure (e.g., already in transaction)
• access: public

Commits the current transaction

• return: True on success, false on failure
• access: public

Rolls back the current transaction

• return: True on success, false on failure
• access: public

Checks if currently inside a transaction

• return: True if in transaction
• access: public

Gets the transaction nesting depth (emulated, always 0 or 1)

• return: 1 if in transaction, 0 otherwise
• access: public

Truncates a table (removes all rows, resets auto_increment)

• return: True on success, false on error
• access: public

• string $tableName: Table name

Updates rows matching WHERE conditions (requires WHERE to prevent mass update)

• return: True on success, false on error
• access: public

• string $tableName: Table name
• array $valuesArray: Column=>value pairs to set
• array $whereArray: WHERE conditions (required)

Advances to the next result set in a multi-query execution

• return: True if next result exists, false otherwise
• access: public

SQL Value Type: Bit (1 or 0)

SQL Value Type: Boolean (1 or 0)

SQL Value Type: Date (YYYY-MM-DD)

SQL Value Type: Datetime (YYYY-MM-DD HH:MM:SS)

SQL Value Type: Integer, Int, BigInt, etc. (raw number)

SQL Value Type: Text, Varchar, Char, etc. (escaped string)

SQL Value Type: Time (HH:MM:SS)

SQL Value Type: Boolean ('T' or 'F')

SQL Value Type: Boolean ('Y' or 'N')