Database access layer (PDO based). More...

Inheritance diagram for Db:

Public Member Functions
	createPdo ($options=null, $attributes=null)
	Create a PDO instance. More...

	date ($time=null)
	Convert a Unix timestamp to database date format. More...

	dateTime ($time=null)
	Convert a Unix timestamp to database date+time format. More...

	escapeLike ($value, $escape='\\')
	Escape a value used for a "like" comparision. More...

	isSelection ($sql)
	Check if an SQL statement is a select statement. More...

	keyColumn ($table)
	Primary key column. More...

	begin ()
	Begin a transaction. More...

	rollBack ()
	Roll a transaction back. More...

	commit ()
	Commit a transaction. More...

	transaction ($callback, $throw=true)
	Wrap a callback function in a transaction. More...

	lastInsertId ()
	Get the last auto-incremented ID. More...

	statement ($sql, $args=null, $pdo=null)
	Create a PDO statement. More...

	execute ($sql, $args=null, $pdo=null)
	Execute an SQL statement. More...

	query ($sql, $args=null, $pdo=null)
	Execute an SQL statement. More...

	fetch ($statement)
	Fetch a row from an SQL statement. More...

	all ($sql, $args=null)
	Return al rows from an SQL statement. More...

	single ($sql, $args=null, $auto=true)
	Return a single row from an SQL statement. More...

	record ($sql, $args=null)
	Returns an array from an SQL statement. More...

	each ($callback, $sql, $args=null)
	Run a callback function for every row in an SQL resultset. More...

	batch ($callback, $sql, $args=null, $limit=1000)
	Run a callback function for every row in a batched SQL resultset. More...

	multiColumns ($columns)
	Expand an array with scalar values and arrays to multiple arrays. More...

	prepareWhere (&$where, &$args=null, $glue='and')
	Prepare a where statement. More...

	limit ($sql, $limit, $offset=null)
	Limit an SQL statement. More...

	scout ($table, $columns=null, $where=null, $args=null)
	Pre-select records (will be used by select()). More...

	insert ($table, $columns, $action=self::ACTION_INSERT, $update=null)
	Insert a record. More...

	create ($table, $columns)
	Create a record (if it does not exists). More...

	replace ($table, $columns)
	Replace a record (insert if not exists). More...

	upsert ($table, $columns, $update)
	Insert a record, or update it if it already exists. More...

	select ($table, $columns=' *', $where=null, $args=null, $limit=null, $offset=null)
	Select records. More...

	update ($table, $columns, $where, $args=null, $insert_if_not_exists=false)
	Update one or more record(s). More...

	inc ($table, $columns, $where)
	Increment one or more columns, or insert a new record if none exists. More...

	delete ($table, $where, $args=null)
	Delete one or more record(s). More...

	exists ($table, $where=null, $args=null)
	Check if a record exists that meets the requirement. More...

	count ($table, $where=null, $args=null)
	The number of records that meet the requirements. More...

	min ($table, $column, $where=null, $args=null)
	Smallest value from records that meet the requirements. More...

	max ($table, $column, $where=null, $args=null)
	Biggest value from records that meet the requirements. More...

	average ($table, $column, $where=null, $args=null)
	Average value from records that meet the requirements. More...

	sum ($table, $column, $where=null, $args=null)
	Total value from records that meet the requirements. More...

	database ()
	Name of the current database. More...

	tables ()
	All tables in current database. More...

	columns ($table, $database=null)
	Column properties for a table. More...

	optimize ($table=null)
	Optimize table(s). More...

	explain ($sql, $args=null)
	Explain plan. More...

	processes ()
	Running processes. More...

	kill ($id)
	Kill a process. More...

	__call ($func_name, $params)

	__invoke ($sql, $args=null)

	__sleep ()

Public Member Functions inherited from Component
	__construct ($fred, $config=null)

	__destruct ()

	clientConfig ()
	Public configuration. More...

	config ($key, $default=null)
	Retrieve a config value. More...

	ping ()
	Ping function. More...

	filemtime ($filename)
	Filemtime with session cache. More...

	component ($name)
	Get a component (local or default). More...

	components (... $names)
	Get multiple components in an array. More...

Public Member Functions inherited from Thing
	propertyExists ($property)
	Check if a property exists (public or published). More...

	constants ($prefix=null)
	Return all constants. More...

	get ($key)
	Get one or more properties. More...

	set ($key, $value=null)
	Set one or more properties. More...

	__get ($key)

	__set ($key, $value)

Data Fields
const	ACTION_INSERT = 'insert'
	Insert a new record. More...

const	ACTION_CREATE = 'create'
	Create a new record (if none exists, otherwise ignore). More...

const	ACTION_REPLACE = 'replace'
	Replace an existing record (overwrite). More...

const	ACTION_UPDATE = 'update'
	Update an existing record. More...

const	ACTION_UPSERT = 'upsert'
	Insert a new record, or update the existing record if it already exists. More...

const	ACTION_DELETE = 'delete'
	Delete an existing record. More...

const	EVENT_OPEN = 'db:open'

const	EVENT_LOG_CHANGE = 'db:logChange'

const	EVENT_LOG_ADD_ID = 'db:logAddId'

	$multiOperators = ['\|' => 'or','&' => 'and']
	Operators (key) and glue (value) for multi column where conditions. More...

	$statTime = 3600
	Query time above which to increment a stat counter for the specific query (id = SQL). More...

	$statPrefix = 'db'

	$logTimes

	$logTimeSignificant = 3
	Number of significant figures (rounding). More...

	$logTables = []
	Tables (key) and key columns (value) to log changes for. More...

	$defTables = null
	Table definition to use (table name). More...

	$migrateClassName = __CLASS__ . '\\Migrate'
	Class name for the migration tool. More...

	$queryCount = 0
	Number of queries executed. More...

	$queryTime = 0
	Total time spent on queries (seconds). More...

	$allowInsert = true
	Allow inserts (for secondary processes like logs). More...

Data Fields inherited from Component
	$filemtimeTtl = 0

Data Fields inherited from Thing
const	HIDDEN = 0
	Property is hidden. More...

const	READABLE = 1
	Property is readable. More...

const	WRITEABLE = 2
	Property is writeable. More...

const	READWRITE = 3
	Property is readable and writeable. More...

Protected Member Functions
	startTimer ()

	checkTimer ($sql, $args)

	prepareArgs (&$sql, &$args)

	logChange ($table, $action, $key, $old, $new)
	Log a change. More...

	logAddId ($id)
	Add an auto-increment ID to the latest change log. More...

	logChanges ($table, $action, $columns, $where, $args=null)
	Log the changes for an action. More...

	updateSql ($columns, &$args)

	aggregate ($table, $function, $where=null, $args=null)
	Run an aggregation query. More...

	getMigrate ()

	getPdo ()

	getVersion ()

Protected Member Functions inherited from Component
	init ()

	done ()

	getSession ()

Protected Member Functions inherited from Thing
	publish ($property, $visibility=self::READABLE)
	Publish a property (or hide it again). More...

	alias ($alias, $property, $object=null)
	Define an alias for a property (of another object). More...

	configure ($config)
	Configure the object. More...

	_get ($key)
	Default getter if no specific setter is defined, and the property is also not published (readable). More...

	_set ($key, $value)
	Default setter if no specific setter is defined, and the property is also not published (writeable). More...

Protected Attributes
	$_defaultOptions = [\PDO::MYSQL_ATTR_FOUND_ROWS => true]

	$_defaultAttributes = [\PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true]

	$_eachOptions = [\PDO::ATTR_PERSISTENT => false]
	Do not (re-) use an existing connection (might be busy). More...

	$_eachAttributes = [\PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => false]
	Do not buffer; retrieve one by one. More...

	$_connection = []
	Connection parameters (keys 'dsn', 'username', 'password', 'options'). More...

	$_attributes = []
	Connection specific attributes (key = attribute, value = value). More...

	$_version = null

	$_pdo = null

	$_migrate = null

	$_startTime = null

	$_duploCount = []

	$_logAddId = false

	$_scout = []

Protected Attributes inherited from Component
	$_fred = null

	$_config = null

	$_name = null

	$_components = []
	Local components (key = component name, value = component). More...

	$_session = null

Protected Attributes inherited from Thing
	$_published = []
	Published properties (key = name of property, value = visibility). More...

	$_aliases = []
	Alias properties (key = alias, value = [object,property]). More...

Detailed Description

Database access layer (PDO based).

Definition at line 8 of file Db.php.

Member Function Documentation

◆ __call()

__call	(	$func_name,
		$params
	)

Definition at line 916 of file Db.php.

◆ __invoke()

__invoke	(	$sql,
		$args = `null`
	)

Definition at line 939 of file Db.php.

◆ __sleep()

__sleep ( )

Definition at line 943 of file Db.php.

◆ aggregate()

aggregate	(	$table,
		$function,
		$where = `null`,
		$args = `null`
	)

protected

Run an aggregation query.

Parameters

string	$table	Table name.
string	$function	Aggregation function (e.g. "sum").
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: mixed

Definition at line 737 of file Db.php.

◆ all()

all	(	$sql,
		$args = `null`
	)

Return al rows from an SQL statement.

Parameters

string	$sql	SQL statement to execute.
array	$args	Variables to bind to the statement.

Returns: array All rows (false on failure).

Definition at line 271 of file Db.php.

◆ average()

average	(	$table,
		$column,
		$where = `null`,
		$args = `null`
	)

Average value from records that meet the requirements.

Parameters

string	$table	Table name.
string	$column	Column to get value from.
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: mixed Average value.

Definition at line 783 of file Db.php.

◆ batch()

batch	(	$callback,
		$sql,
		$args = `null`,
		$limit = `1000`
	)

Run a callback function for every row in a batched SQL resultset.

The rows are fetched in batches. This makes it possible to process huge datasets one record at a time, without using a separate connection, and without running out of memory. Note that this may not work perfectly when the dataset changes frequently (items added or deleted in the beginning shift the contents of later batches).

Parameters

callable	$callback	Callback function (parameters row and index). If the function returns explicitly false the execution of further rows is halted.
string	$sql	SQL statement to execute.
array	$args	Variables to bind to the statement.
int	$limit	Batch size.

Returns: int Number of records processed.

Definition at line 357 of file Db.php.

◆ begin()

begin ( )

Begin a transaction.

Definition at line 120 of file Db.php.

◆ checkTimer()

checkTimer	(	$sql,
		$args
	)

protected

Definition at line 166 of file Db.php.

◆ columns()

columns	(	$table,
		$database = `null`
	)

Column properties for a table.

Parameters

string	$table	Name of the table.
string	$database	Name of the database (current database when empty).

Returns: array Key = column name, value = assoc.array with properties.

Definition at line 817 of file Db.php.

◆ commit()

commit ( )

Commit a transaction.

Definition at line 132 of file Db.php.

◆ count()

count	(	$table,
		$where = `null`,
		$args = `null`
	)

The number of records that meet the requirements.

Parameters

string	$table	Table name.
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: int Number of rows.

Definition at line 750 of file Db.php.

◆ create()

create	(	$table,
		$columns
	)

Create a record (if it does not exists).

Parameters

string	$table	Table name.
array	$columns	Columns (key = column name, value = value or values - for multiple records).

Returns: int The number of affected rows (0 = failure, 1 = success).

Definition at line 618 of file Db.php.

◆ createPdo()

createPdo	(	$options = `null`,
		$attributes = `null`
	)

Create a PDO instance.

Parameters

$options	array Connection options.
$attributes	Attributes (applied after connection).

Returns: PDO

Definition at line 59 of file Db.php.

◆ database()

database ( )

Name of the current database.

Returns: string

Definition at line 801 of file Db.php.

◆ date()

date ( $time = null )

Convert a Unix timestamp to database date format.

Parameters

int $time Timestamp (empty = now).

Returns: string Date as a string.

Definition at line 80 of file Db.php.

◆ dateTime()

dateTime ( $time = null )

Convert a Unix timestamp to database date+time format.

Parameters

int $time Timestamp (empty = now).

Returns: string Date+time as a string.

Definition at line 88 of file Db.php.

◆ delete()

delete	(	$table,
		$where,
		$args = `null`
	)

Delete one or more record(s).

Parameters

string	$table	Table name.
string \| array	$where	Where (empty = all).
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: int The number of affected rows (0 = failure, 1 or more = success).

Definition at line 710 of file Db.php.

◆ each()

each	(	$callback,
		$sql,
		$args = `null`
	)

Run a callback function for every row in an SQL resultset.

A separate conection is used without buffering. This makes it possible to process huge datasets one record at a time, without running out of memory.

Parameters

callable	$callback	Callback function (parameters row and index). If the function returns explicitly false the execution of further rows is halted.
string	$sql	SQL statement to execute.
array	$args	Variables to bind to the statement.

Returns: int Number of records processed (false on error).

Definition at line 334 of file Db.php.

◆ escapeLike()

escapeLike	(	$value,
		$escape = `'\\'`
	)

Escape a value used for a "like" comparision.

Parameters

string	$value	String to escape.
string	$escape	Escape character.

Returns: Escaped string.

Definition at line 97 of file Db.php.

◆ execute()

execute	(	$sql,
		$args = `null`,
		$pdo = `null`
	)

Execute an SQL statement.

Parameters

string	$sql	SQL statement to execute.
array	$args	Variables to bind to the statement.
PDO	$pdo	Specific PDO connection to use.

Returns: int The number of affected rows.

Definition at line 225 of file Db.php.

◆ exists()

exists	(	$table,
		$where = `null`,
		$args = `null`
	)

Check if a record exists that meets the requirement.

Parameters

string	$table	Table name.
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: bool True if a record exists.

Definition at line 724 of file Db.php.

◆ explain()

explain	(	$sql,
		$args = `null`
	)

Explain plan.

Parameters

string	$sql	SQL statement to explain.
array	$args	Variables to bind to the statement.

Returns: array Steps in the plan.

Definition at line 865 of file Db.php.

◆ fetch()

fetch ( $statement )

Fetch a row from an SQL statement.

Parameters

PDOStatement $statement

Returns: array

Definition at line 261 of file Db.php.

◆ getMigrate()

getMigrate ( )

protected

Definition at line 897 of file Db.php.

◆ getPdo()

getPdo ( )

protected

Definition at line 905 of file Db.php.

◆ getVersion()

getVersion ( )

protected

Definition at line 910 of file Db.php.

◆ inc()

inc	(	$table,
		$columns,
		$where
	)

Increment one or more columns, or insert a new record if none exists.

Parameters

string	$table	Table name.
string \| array	$columns	Column to increment (string), or columns to update (array; key = column name, value = increment).
array	$where	Key to increment.

Returns: int The number of affected rows (0 = failure, 1 or more = success).

Definition at line 697 of file Db.php.

◆ insert()

insert	(	$table,
		$columns,
		$action = `self::ACTION_INSERT`,
		$update = `null`
	)

Insert a record.

Parameters

string	$table	Table name.
array	$columns	Columns (key = column name, value = value or values - for multiple records).
string	$action	Insert type to perform (see ACTION_* constants).
string \| array	$update	Update for an upsert action.

Returns: int The number of affected rows (0 = failure, 1 = success).

Definition at line 578 of file Db.php.

◆ isSelection()

isSelection ( $sql )

Check if an SQL statement is a select statement.

Parameters

string $sql SQL statement.

Returns: bool True if it is a select statement.

Definition at line 106 of file Db.php.

◆ keyColumn()

keyColumn ( $table )

Primary key column.

Parameters

string $table For this table.

Returns: string Column name.

Definition at line 114 of file Db.php.

◆ kill()

kill ( $id )

Kill a process.

Parameters

int $id Process ID.

Returns: bool True on success.

Definition at line 886 of file Db.php.

◆ lastInsertId()

lastInsertId ( )

Get the last auto-incremented ID.

Returns: string

Definition at line 158 of file Db.php.

◆ limit()

limit	(	$sql,
		$limit,
		$offset = `null`
	)

Limit an SQL statement.

Parameters

string	$sql	Original SQL statement.
int	$limit	Limit (number of rows).
int	$offset	Offset.

Returns: string SQL statement with limit.

Definition at line 490 of file Db.php.

◆ logAddId()

logAddId ( $id )

protected

Add an auto-increment ID to the latest change log.

Parameters

string $id The last auto-incremented ID (the key is stored in $this->_logAddId).

Definition at line 508 of file Db.php.

◆ logChange()

logChange	(	$table,
		$action,
		$key,
		$old,
		$new
	)

protected

Log a change.

Parameters

string	$table	Table name.
string	$action	Change type (see ACTION_* constants).
array	$key	Key of the changed record (key = column name, value = value).
array	$old	Original values for changed columns (key = column name, value = value).
array	$new	New values for changed columns (key = column name, value = value).

Definition at line 501 of file Db.php.

◆ logChanges()

logChanges	(	$table,
		$action,
		$columns,
		$where,
		$args = `null`
	)

protected

Log the changes for an action.

Parameters

string	$table	Table name.
string	$action	Change type (see ACTION_* constants).
array	$columns	New values (key = column name, value = value).
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Definition at line 519 of file Db.php.

◆ max()

max	(	$table,
		$column,
		$where = `null`,
		$args = `null`
	)

Biggest value from records that meet the requirements.

Parameters

string	$table	Table name.
string	$column	Column to get value from.
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: mixed Biggest value.

Definition at line 772 of file Db.php.

◆ min()

min	(	$table,
		$column,
		$where = `null`,
		$args = `null`
	)

Smallest value from records that meet the requirements.

Parameters

string	$table	Table name.
string	$column	Column to get value from.
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: mixed Smallest value.

Definition at line 761 of file Db.php.

◆ multiColumns()

multiColumns ( $columns )

Expand an array with scalar values and arrays to multiple arrays.

Parameters

array $columns Columns (key = column name, value = array with values or single scalar value).

Returns: array Array of column arrays (key = column name, value = value).

Definition at line 371 of file Db.php.

◆ optimize()

optimize ( $table = null )

Optimize table(s).

Parameters

string $table Table to optimize (empty for all tables).

Definition at line 852 of file Db.php.

◆ prepareArgs()

prepareArgs	(	&	$sql,
		&	$args
	)

protected

Definition at line 188 of file Db.php.

◆ prepareWhere()

prepareWhere	(	&	$where,
		&	$args = `null`,
			$glue = `'and'`
	)

Prepare a where statement.

Parameters

string \| array	$where	If this a string, it is used directly as the where clause. If it is an assoc.array, it is translated to a where statement. Key => value pairs are translated as follow: 'key' => 'value' : "key = 'value'" (or "key is null" when the value is null, or "key in (...)" when the value is an array). 'key<>' => 'value' : "key <> 'value'" (or "key is not null" when the value is null, or "key not in (...)" when the value is an array). 'key~' => 'value' : "key like 'value'" 'key^' => [key1 => value1,key2 => value2] : "(key1 = value1 or key2 = value2)" (same rules as above apply for the 'or' part).
string \| array	$args	If the $where is a string, and this is also, this value is added to the where. Otherwise the arguments resulting from the translation will be added to this array.
string	$glue	Glue to combine seperate arguments.

Definition at line 400 of file Db.php.

◆ processes()

processes ( )

Running processes.

Returns: array Key = process ID, value = array with info.

Definition at line 872 of file Db.php.

◆ query()

query	(	$sql,
		$args = `null`,
		$pdo = `null`
	)

Execute an SQL statement.

Parameters

string	$sql	SQL statement to execute.
array	$args	Variables to bind to the statement.
PDO	$pdo	Specific PDO connection to use.

Returns: PDOStatement (false on failure).

Definition at line 247 of file Db.php.

◆ record()

record	(	$sql,
		$args = `null`
	)

Returns an array from an SQL statement.

If the query returns only one column, the result is an array of those values. With two columns, the first one becomes the key, and the second one the value of an assoc.array. With three or more columns the first column will be the key, and the others the value.

Parameters

string	$sql	SQL statement to execute.
array	$args	Variables to bind to the statement.

Returns: array

Definition at line 308 of file Db.php.

◆ replace()

replace	(	$table,
		$columns
	)

Replace a record (insert if not exists).

Parameters

string	$table	Table name.
array	$columns	Columns (key = column name, value = value or values - for multiple records).

Returns: int The number of affected rows (0 = failure, 1 = success).

Definition at line 627 of file Db.php.

◆ rollBack()

rollBack ( )

Roll a transaction back.

Definition at line 126 of file Db.php.

◆ scout()

scout	(	$table,
		$columns = `null`,
		$where = `null`,
		$args = `null`
	)

Pre-select records (will be used by select()).

Parameters

string	$table	Table name.
array	$columns	Columns to select from the table. Leaving this empty will clear the cache for this table.
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: array Selected rows (null on clear).

Definition at line 547 of file Db.php.

◆ select()

select	(	$table,
		$columns = `'*'`,
		$where = `null`,
		$args = `null`,
		$limit = `null`,
		$offset = `null`
	)

Select records.

Parameters

string	$table	Table name.
array	$columns	Columns to select from the table. Prefix the first columns with a '+' to make this the key.
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.
int \| bool	$limit	Limit the number of rows (0 = no limit).
int	$offset	Offset.

Returns: array Single value when limit is true, single row when limit is 1, otherwise an array of records.

See also: prepareWhere()

Definition at line 650 of file Db.php.

◆ single()

single	(	$sql,
		$args = `null`,
		$auto = `true`
	)

Return a single row from an SQL statement.

Returns a single value if the resulting row has only one column.

Parameters

string	$sql	SQL statement to execute.
array	$args	Variables to bind to the statement.
bool	$auto	Set to false to always return a row.

Returns: mixed Row (multi column) or value (single column).

Definition at line 290 of file Db.php.

◆ startTimer()

startTimer ( )

protected

Definition at line 162 of file Db.php.

◆ statement()

statement	(	$sql,
		$args = `null`,
		$pdo = `null`
	)

Create a PDO statement.

Parameters

string	$sql	SQL statement to execute.
array	$args	Variables to bind to the statement.
PDO	$pdo	Specific PDO connection to use.

Returns: PDOStatement (false on failure).

Definition at line 207 of file Db.php.

◆ sum()

sum	(	$table,
		$column,
		$where = `null`,
		$args = `null`
	)

Total value from records that meet the requirements.

Parameters

string	$table	Table name.
string	$column	Column to get value from.
string \| array	$where	Where.
string \| array	$args	Arguments (assoc.array) or extra statement for the where.

Returns: mixed Total value.

Definition at line 794 of file Db.php.

◆ tables()

tables ( )

All tables in current database.

Returns: array

Definition at line 808 of file Db.php.

◆ transaction()

transaction	(	$callback,
		$throw = `true`
	)

Wrap a callback function in a transaction.

Parameters

callable	$callback	Callback function (first and only parameter is this instance).
bool	$throw	If true, an exception is re-thrown after the rollback.

Returns: bool True on success, false on error (and $throw set to false).

Definition at line 141 of file Db.php.

◆ update()

update	(	$table,
		$columns,
		$where,
		$args = `null`,
		$insert_if_not_exists = `false`
	)

Update one or more record(s).

Parameters

string	$table	Table name.
array	$columns	Columns to update (key = column name, value = new value).
string \| array	$where	Where (empty = all).
string \| array	$args	Arguments (assoc.array) or extra statement for the where.
bool	$insert_if_not_exists	If true, a new record will be inserted when there is not yet an existing record.

Returns: int The number of affected rows (0 = failure, 1 or more = success).

Definition at line 680 of file Db.php.

◆ updateSql()

updateSql	(		$columns,
		&	$args
	)

protected

Definition at line 558 of file Db.php.

◆ upsert()

upsert	(	$table,
		$columns,
		$update
	)

Insert a record, or update it if it already exists.

Parameters

string	$table	Table name.
array	$columns	Columns (key = column name, value = value or values - for multiple records).
array	$update	Columns to update if the record already exists (key = column name, value = new value).

Definition at line 636 of file Db.php.

Field Documentation

◆ $_attributes

$_attributes = []

protected

Connection specific attributes (key = attribute, value = value).

Definition at line 43 of file Db.php.

◆ $_connection

$_connection = []

protected

Connection parameters (keys 'dsn', 'username', 'password', 'options').

Definition at line 42 of file Db.php.

◆ $_defaultAttributes

$_defaultAttributes = [\PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true]

protected

Definition at line 39 of file Db.php.

◆ $_defaultOptions

$_defaultOptions = [\PDO::MYSQL_ATTR_FOUND_ROWS => true]

protected

Definition at line 38 of file Db.php.

◆ $_duploCount

$_duploCount = []

protected

Definition at line 50 of file Db.php.

◆ $_eachAttributes

$_eachAttributes = [\PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => false]

protected

Do not buffer; retrieve one by one.

Definition at line 41 of file Db.php.

◆ $_eachOptions

$_eachOptions = [\PDO::ATTR_PERSISTENT => false]

protected

Do not (re-) use an existing connection (might be busy).

Definition at line 40 of file Db.php.

◆ $_logAddId

$_logAddId = false

protected

Definition at line 51 of file Db.php.

◆ $_migrate

$_migrate = null

protected

Definition at line 47 of file Db.php.

◆ $_pdo

$_pdo = null

protected

Definition at line 46 of file Db.php.

◆ $_scout

$_scout = []

protected

Definition at line 52 of file Db.php.

◆ $_startTime

$_startTime = null

protected

Definition at line 49 of file Db.php.

◆ $_version

$_version = null

protected

Definition at line 45 of file Db.php.

◆ $allowInsert

$allowInsert = true

Allow inserts (for secondary processes like logs).

Definition at line 36 of file Db.php.

◆ $defTables

$defTables = null

Table definition to use (table name).

Definition at line 31 of file Db.php.

◆ $logTables

$logTables = []

Tables (key) and key columns (value) to log changes for.

Definition at line 30 of file Db.php.

◆ $logTimes

$logTimes

Initial value:

= [ 
    Log::CRITICAL => 10.0,
    Log::ERROR => 5.0,
    Log::WARNING => 2.5
  ]

Definition at line 24 of file Db.php.

◆ $logTimeSignificant

$logTimeSignificant = 3

Number of significant figures (rounding).

Definition at line 29 of file Db.php.

◆ $migrateClassName

$migrateClassName = __CLASS__ . '\\Migrate'

Class name for the migration tool.

Definition at line 32 of file Db.php.

◆ $multiOperators

$multiOperators = ['|' => 'or','&' => 'and']

Operators (key) and glue (value) for multi column where conditions.

Definition at line 21 of file Db.php.

◆ $queryCount

$queryCount = 0

Number of queries executed.

Definition at line 34 of file Db.php.

◆ $queryTime

$queryTime = 0

Total time spent on queries (seconds).

Definition at line 35 of file Db.php.

◆ $statPrefix

$statPrefix = 'db'

Definition at line 23 of file Db.php.

◆ $statTime

$statTime = 3600

Query time above which to increment a stat counter for the specific query (id = SQL).

Definition at line 22 of file Db.php.

◆ ACTION_CREATE

const ACTION_CREATE = 'create'

Create a new record (if none exists, otherwise ignore).

Definition at line 11 of file Db.php.

◆ ACTION_DELETE

const ACTION_DELETE = 'delete'

Delete an existing record.

Definition at line 15 of file Db.php.

◆ ACTION_INSERT

const ACTION_INSERT = 'insert'

Insert a new record.

Definition at line 10 of file Db.php.

◆ ACTION_REPLACE

const ACTION_REPLACE = 'replace'

Replace an existing record (overwrite).

Definition at line 12 of file Db.php.

◆ ACTION_UPDATE

const ACTION_UPDATE = 'update'

Update an existing record.

Definition at line 13 of file Db.php.

◆ ACTION_UPSERT

const ACTION_UPSERT = 'upsert'

Insert a new record, or update the existing record if it already exists.

Definition at line 14 of file Db.php.

◆ EVENT_LOG_ADD_ID

const EVENT_LOG_ADD_ID = 'db:logAddId'

Definition at line 19 of file Db.php.

◆ EVENT_LOG_CHANGE

const EVENT_LOG_CHANGE = 'db:logChange'

Definition at line 18 of file Db.php.

◆ EVENT_OPEN

const EVENT_OPEN = 'db:open'

Definition at line 17 of file Db.php.

The documentation for this class was generated from the following file:

/var/www/fred.local/vendor/rsi/fred/src/Rsi/Fred/Db.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ __invoke()

◆ __sleep()

◆ aggregate()

◆ all()

◆ average()

◆ batch()

◆ begin()

◆ checkTimer()

◆ columns()

◆ commit()

◆ count()

◆ create()

◆ createPdo()

◆ database()

◆ date()

◆ dateTime()

◆ delete()

◆ each()

◆ escapeLike()

◆ execute()

◆ exists()

◆ explain()

◆ fetch()

◆ getMigrate()

◆ getPdo()

◆ getVersion()

◆ inc()

◆ insert()

◆ isSelection()

◆ keyColumn()

◆ kill()

◆ lastInsertId()

◆ limit()

◆ logAddId()

◆ logChange()

◆ logChanges()

◆ max()

◆ min()

◆ multiColumns()

◆ optimize()

◆ prepareArgs()

◆ prepareWhere()

◆ processes()

◆ query()

◆ record()

◆ replace()

◆ rollBack()

◆ scout()

◆ select()

◆ single()

◆ startTimer()

◆ statement()

◆ sum()

◆ tables()

◆ transaction()

◆ update()

◆ updateSql()

◆ upsert()

Field Documentation

◆ $_attributes

◆ $_connection

◆ $_defaultAttributes

◆ $_defaultOptions

◆ $_duploCount

◆ $_eachAttributes

◆ $_eachOptions

◆ $_logAddId

◆ $_migrate

◆ $_pdo

◆ $_scout

◆ $_startTime

◆ $_version

◆ $allowInsert