BaseDriver

Properties

dsnElements

public array $dsnElements

lastQueryString

public string $lastQueryString

selectGroups

public array $selectGroups

allowConstraints

protected bool $allowConstraints

reservedWords

protected array $reservedWords

quoteSpecial

protected string $quoteSpecial

adapter

protected Adapter $adapter

schemaName

protected string $schemaName

execs

protected int $execs

public  $

public  $

Methods

__construct

public  __construct({Array})

Parameters

Parameter	Type	Description
$adapter	Adapter
$config	Map

__toString

public  __toString({Array})

setTimezone

public  setTimezone({Array})

Parameters

Parameter	Type	Description
$tz	string

execCount

public  execCount({Array})

mkdsn

public  mkdsn({Array})

Parameters

Parameter	Type	Description
$config	Map

getSchemaName

public  getSchemaName({Array})

setSchemaName

public  setSchemaName({Array})

Parameters

Parameter	Type	Description
$schemaName	string

schemaExists

public  schemaExists({Array})

Parameters

Parameter	Type	Description
$schemaName	string

createSchema

public  createSchema({Array})

Parameters

Parameter	Type	Description
$schemaName	string

connect

public  connect({Array})

Parameters

Parameter	Type	Description
$dsn	string
$username	string
$password	string
$driverOptions	array

repair

public  repair({Array})

Parameters

Parameter	Type	Description
$tableName	string

beginTransaction

public  beginTransaction({Array})

commit

public  commit({Array})

getAttribute

public  getAttribute({Array})

Parameters

Parameter	Type	Description
$attribute	int

setAttribute

public  setAttribute({Array})

Parameters

Parameter	Type	Description
$attribute	int
$value	mixed

inTransaction

public  inTransaction({Array})

lastInsertId

public  lastInsertId({Array})

quote

public  quote({Array})

Parameters

Parameter	Type	Description
$string	mixed
$type	int

quoteSpecial

public  quoteSpecial({Array})

Parameters

Parameter	Type	Description
$value	mixed

rollBack

public  rollBack({Array})

errorCode

public  errorCode({Array})

errorInfo

public  errorInfo({Array})

exec

public  exec({Array})

Parameters

Parameter	Type	Description
$sql	string

query

public  query({Array})

Parameters

Parameter	Type	Description
$sql	string

prepare

public  prepare({Array})

Parameters

Parameter	Type	Description
$sql	string

schemaName

public  schemaName({Array})

Parameters

Parameter	Type	Description
$tableName	string

parseSchemaName

public  parseSchemaName({Array})

Parameters

Parameter	Type	Description
$tableName	string

field

public  field({Array})

Parameters

Parameter	Type	Description
$string	string

type

public  type({Array})

Parameters

Parameter	Type	Description
$info	array

prepareCriteria

public  prepareCriteria({Array})

Parameters

Parameter	Type	Description
$criteria	string
$bindType	string
$tissue	string
$parentRef	string
$optionalKey	string
$setKey	bool

prepareCriteriaAction

public  prepareCriteriaAction({Array})

Parameters

Parameter	Type	Description
$action	string
$value	mixed
$tissue	string
$key	string
$setKey	bool

prepareFields

public  prepareFields({Array})

Parameters

Parameter	Type	Description
$fields	mixed
$exclude	array
$tables	array

prepareValues

public  prepareValues({Array})

Parameters

Parameter	Type	Description
$values	mixed

prepareValue

public  prepareValue({Array})

Parameters

Parameter	Type	Description
$value	mixed
$key	string

insert

public  insert({Array})

Parameters

Parameter	Type	Description
$tableName	string
$fields	mixed
$returning	string
$conflictTarget	string
$conflictUpdate	mixed
$table	Table

update

public  update({Array})

Parameters

Parameter	Type	Description
$tableName	string
$fields	mixed
$criteria	array
$from	array
$returning	string
$tables	array

delete

public  delete({Array})

Parameters

Parameter	Type	Description
$tableName	string
$criteria	mixed
$from	array

deleteAll

public  deleteAll({Array})

Parameters

Parameter	Type	Description
$tableName	string

listTables

public  listTables({Array})

Parameters

Parameter	Type	Description
$	false

tableExists

public  tableExists({Array})

Parameters

Parameter	Type	Description
$tableName	string

createTable

public  createTable({Array})

Parameters

Parameter	Type	Description
$tableName	string
$columns	mixed

describeTable

public  describeTable({Array})

Parameters

Parameter	Type	Description
$tableName	string
$sort	string

renameTable

public  renameTable({Array})

Parameters

Parameter	Type	Description
$fromName	string
$toName	string

dropTable

public  dropTable({Array})

Parameters

Parameter	Type	Description
$name	string
$cascade	bool
$ifExists	bool

addColumn

public  addColumn({Array})

Parameters

Parameter	Type	Description
$tableName	string
$columnSpec	mixed

alterColumn

public  alterColumn({Array})

Parameters

Parameter	Type	Description
$tableName	string
$column	string
$columnSpec	mixed

dropColumn

public  dropColumn({Array})

Parameters

Parameter	Type	Description
$tableName	string
$column	string
$ifExists	bool

listSequences

public  listSequences({Array})

Parameters

Parameter	Type	Description
$	false

describeSequence

public  describeSequence({Array})

Parameters

Parameter	Type	Description
$name	string
$	false

listIndexes

public  listIndexes({Array})

Parameters

Parameter	Type	Description
$tableName	string
$	false

createIndex

public  createIndex({Array})

Parameters

Parameter	Type	Description
$indexName	string
$tableName	string
$idxInfo	mixed

dropIndex

public  dropIndex({Array})

Parameters

Parameter	Type	Description
$indexName	string
$ifExists	bool

listConstraints

public  listConstraints({Array})

Parameters

Parameter	Type	Description
$tableName	string
$type	string
$invertType	bool
$	false

addConstraint

public  addConstraint({Array})

Parameters

Parameter	Type	Description
$constraintName	string
$info	mixed

dropConstraint

public  dropConstraint({Array})

Parameters

Parameter	Type	Description
$constraintName	string
$tableName	string
$cascade	bool
$ifExists	bool

listViews

public  listViews({Array})

Parameters

Parameter	Type	Description
$	false

describeView

public  describeView({Array})

Parameters

Parameter	Type	Description
$name	string
$	false

createView

public  createView({Array})

Parameters

Parameter	Type	Description
$name	string
$content	mixed

viewExists

public  viewExists({Array})

Parameters

Parameter	Type	Description
$viewName	string

dropView

public  dropView({Array})

Parameters

Parameter	Type	Description
$name	string
$cascade	bool
$ifExists	bool

listFunctions

List defined functions.

public  listFunctions({Array})

Parameters

Parameter	Type	Description
$schemaName	string
$includeParameters	bool
$	false

describeFunction

public  describeFunction({Array})

Parameters

Parameter	Type	Description
$name	string
$schemaName	string
$	false

createFunction

Create a new database function.

public  createFunction({Array})

Parameters

Parameter	Type	Description
$name	mixed	The name of the function to create
$spec	mixed	A function specification. This is basically the array returned from describeFunction()

dropFunction

Remove a function from the database.

public  dropFunction({Array})

Parameters

Parameter	Type	Description
$name	string	The name of the function to remove
$argTypes	string	the argument list of the function to remove
$cascade	bool	Whether to perform a DROP CASCADE
$ifExists	bool

truncate

TRUNCATE empty a table or set of tables.

public  truncate({Array})

TRUNCATE quickly removes all rows from a set of tables. It has the same effect as an unqualified DELETE on each table, but since it does not actually scan the tables it is faster. Furthermore, it reclaims disk space immediately, rather than requiring a subsequent VACUUM operation. This is most useful on large tables.

Parameters

Parameter	Type	Description
$tableName	string	The name of the table(s) to truncate. Multiple tables are supported.
$only	bool	Only the named table is truncated. If FALSE, the table and all its descendant tables (if any) are truncated.
$restartIdentity	bool	Automatically restart sequences owned by columns of the truncated table(s). The default is to no restart.
$cascade	bool	If TRUE, automatically truncate all tables that have foreign-key references to any of the named tables, or

                           to any tables added to the group due to CASCADE.  If FALSE, Refuse to truncate if any of the tables have
                           foreign-key references from tables that are not listed in the command. FALSE is the default. |

listTriggers

List defined triggers.

public  listTriggers({Array})

Parameters

Parameter	Type	Description
$tableName	string
$schemaName	string	Optional: schema name. If not supplied the current schemaName is used.
$	false

describeTrigger

Describe a database trigger.

public  describeTrigger({Array})

This will return an array as there can be multiple triggers with the same name but with different attributes

Parameters

Parameter	Type	Description
$triggerName	string
$schemaName	string	Optional: schemaName name. If not supplied the current schemaName is used.
$	false

createTrigger

Summary of createTrigger.

public  createTrigger({Array})

Parameters

Parameter	Type	Description
$triggerName	string
$tableName	string	The table on which the trigger is being created
$spec	mixed	The spec of the trigger. Basically this is the array returned from describeTriggers()

dropTrigger

Drop a trigger from a table.

public  dropTrigger({Array})

Parameters

Parameter	Type	Description
$triggerName	string
$tableName	string	The name of the table to remove the trigger from
$cascade	bool	Whether to drop CASCADE
$ifExists	bool

listUsers

public  listUsers({Array})

Parameters

Parameter	Type	Description
$	false

listGroups

public  listGroups({Array})

Parameters

Parameter	Type	Description
$	false

createRole

public  createRole({Array})

Parameters

Parameter	Type	Description
$name	string
$password	string
$privileges	array

dropRole

public  dropRole({Array})

Parameters

Parameter	Type	Description
$name	string
$ifExists	bool

listExtensions

public  listExtensions({Array})

Parameters

Parameter	Type	Description
$	false

createExtension

public  createExtension({Array})

Parameters

Parameter	Type	Description
$name	string

dropExtension

public  dropExtension({Array})

Parameters

Parameter	Type	Description
$name	string
$ifExists	bool

createDatabase

public  createDatabase({Array})

Parameters

Parameter	Type	Description
$name	string

fixValue

Special internal function to fix the default column value.

protected  fixValue({Array})

This function is normally overridden by the DBD class being used so that values can be "fixed".

Parameters

Parameter	Type	Description
$value	mixed

prepareArrayAliases

private  prepareArrayAliases({Array})

Parameters

Parameter	Type	Description
$array	array

---

Generated by Hazaar API Doc Generator