2018-01-24 15:31:27 -05:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en" >
< head >
< title > phpDox - Query\Drivers\Mysql\Driver< / title >
< link rel = "stylesheet" type = "text/css" href = "../css/style.css" media = "screen" / >
< meta http-equiv = "content-type" content = "text/html; charset=utf-8" / >
< / head >
< body >
< nav class = "topnav" >
< ul >
< li >
< div class = "logo" > < span > /**< / span > phpDox< / div >
< / li >
< li class = "separator" >
< a href = "../index.html" > Overview< / a >
< / li >
< li class = "separator" >
< a href = "../namespaces.html" > Namespaces< / a >
< / li >
< li >
< a href = "../interfaces.html" > Interfaces< / a >
< / li >
< li >
< a href = "../classes.html" > Classes< / a >
< / li >
< li class = "separator" >
< a href = "../source/index.html" > Source< / a >
< / li >
< / ul >
< / nav >
< div id = "mainstage" >
< div class = "box" >
< ul class = "breadcrumb" >
< li >
< a href = "../index.html" > Overview< / a >
< / li >
< li class = "separator" >
< a href = "../classes.html" > Classes< / a >
< / li >
< li class = "separator" >
< a href = "../classes.html#Query_Drivers_Mysql" > Query\Drivers\Mysql< / a >
< / li >
< li class = "separator" > Driver< / li >
< / ul >
< / div >
< nav class = "box" >
< ul >
< li >
< a href = "#introduction" > Introduction< / a >
< / li >
< li >
< a href = "#synopsis" > Synopsis< / a >
< / li >
< li >
< a href = "#hierarchy" > Hierarchy< / a >
< / li >
< li >
2020-04-17 15:05:37 -04:00
< a href = "#tasks" > Tasks< / a >
2018-01-24 15:31:27 -05:00
< / li >
< li >
2020-04-17 15:05:37 -04:00
< a href = "#methods" > Methods< / a >
2018-01-24 15:31:27 -05:00
< / li >
< li >
2020-04-17 15:05:37 -04:00
< a href = "../source/Drivers/Mysql/Driver.php.html#line25" > Source< / a >
2018-01-24 15:31:27 -05:00
< / li >
< / ul >
< / nav >
< section >
< h1 id = "introduction" > < small > Query\Drivers\Mysql\< / small > Driver< / h1 >
< h4 > MySQL specific class< / h4 >
< p / >
< ul / >
< h2 id = "synopsis" > Synopsis< / h2 >
< div class = "synopsis" > class
extends < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver.html" > AbstractDriver< / a >
{< br / > < ul class = "none" > < li > // methods< / li > < li > public < a title = "Query\Drivers\Mysql\Driver" href = "../classes/Query_Drivers_Mysql_Driver/__construct.html" > __construct< / a > ()
2020-04-17 15:05:37 -04:00
< / li > < li > public < a title = "Query\Drivers\Mysql\Driver" href = "../classes/Query_Drivers_Mysql_Driver/returning.html" > returning< / a > ()
2018-01-24 15:31:27 -05:00
< / li > < / ul > < ul class = "none" > < li > // Inherited methods from < span title = "Query\Drivers\AbstractDriver" > AbstractDriver< / span > < / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/__construct.html" > __construct< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/__call.html" > __call< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getLastQuery.html" > getLastQuery< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/setLastQuery.html" > setLastQuery< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getSql.html" > getSql< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getUtil.html" > getUtil< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/setTablePrefix.html" > setTablePrefix< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/prepareQuery.html" > prepareQuery< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/prepareExecute.html" > prepareExecute< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/affectedRows.html" > affectedRows< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/prefixTable.html" > prefixTable< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/quoteTable.html" > quoteTable< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/quoteIdent.html" > quoteIdent< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getSchemas.html" > getSchemas< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getTables.html" > getTables< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getDbs.html" > getDbs< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getViews.html" > getViews< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getSequences.html" > getSequences< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getFunctions.html" > getFunctions< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getProcedures.html" > getProcedures< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getTriggers.html" > getTriggers< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getSystemTables.html" > getSystemTables< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getColumns.html" > getColumns< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getFks.html" > getFks< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getIndexes.html" > getIndexes< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getTypes.html" > getTypes< / a > ()
2020-04-17 15:05:37 -04:00
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getVersion.html" > getVersion< / a > ()
2018-01-24 15:31:27 -05:00
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/driverQuery.html" > driverQuery< / a > ()
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/numRows.html" > numRows< / a > ()
2019-12-11 16:09:58 -05:00
< / li > < li > public < string|array|null> < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/insertBatch.html" > insertBatch< / a > ()
2018-01-26 09:16:13 -05:00
< / li > < li > public < string < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/updateBatch.html" > updateBatch< / a > ()
2018-01-24 15:31:27 -05:00
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/truncate.html" > truncate< / a > ()
2020-04-17 15:05:37 -04:00
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/returning.html" > returning< / a > ()
2018-01-24 15:31:27 -05:00
< / li > < li > public < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/_quote.html" > _quote< / a > ()
< / li > < / ul > < ul class = "none" > < li > // Inherited methods from < span title = "PDO" > PDO< / span > < / li > < li > public < a title = "PDO" href = "../classes/PDO/__construct.html" > __construct< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/beginTransaction.html" > beginTransaction< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/commit.html" > commit< / a > ()
2019-12-11 16:09:58 -05:00
< / li > < li > public < a title = "PDO" href = "../classes/PDO/errorCode.html" > errorCode< / a > ()
2018-01-24 15:31:27 -05:00
< / li > < li > public < a title = "PDO" href = "../classes/PDO/errorInfo.html" > errorInfo< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/exec.html" > exec< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/getAttribute.html" > getAttribute< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/getAvailableDrivers.html" > getAvailableDrivers< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/inTransaction.html" > inTransaction< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/lastInsertId.html" > lastInsertId< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/prepare.html" > prepare< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/query.html" > query< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/quote.html" > quote< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/rollBack.html" > rollBack< / a > ()
< / li > < li > public < a title = "PDO" href = "../classes/PDO/setAttribute.html" > setAttribute< / a > ()
< / li > < / ul >
}< br / > < / div >
< h2 id = "hierarchy" > Hierarchy< / h2 >
< div class = "styled" >
< h4 > Extends< / h4 >
< ul >
< li >
< a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver.html" > Query\Drivers\AbstractDriver< / a >
< / li >
< / ul >
< / div >
2020-04-17 15:05:37 -04:00
< h2 id = "tasks" > Tasks< / h2 >
< table class = "styled" >
< thead >
< tr >
< th style = "width:3em;" > Line< / th >
< th > Task< / th >
< / tr >
< / thead >
< tr >
< td class = "nummeric" > 77< / td >
< td > add checks for MariaDB for future-proofing< / td >
< / tr >
< / table >
2018-01-24 15:31:27 -05:00
< h2 id = "methods" > Methods< / h2 >
< div class = "styled" >
2020-04-17 15:05:37 -04:00
< h4 > public< / h4 >
< ul >
< li id = "__construct" > < a title = "Query\Drivers\Mysql\Driver" href = "../classes/Query_Drivers_Mysql_Driver/__construct.html" > __construct()< / a >
— Connect to MySQL Database< / li >
< li id = "returning" > < a title = "Query\Drivers\Mysql\Driver" href = "../classes/Query_Drivers_Mysql_Driver/returning.html" > returning()< / a >
— Generate the returning clause for the current database< / li >
< / ul >
2018-01-24 15:31:27 -05:00
< h3 > Inherited from < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver.html" > Query\Drivers\AbstractDriver< / a > < / h3 >
< h4 > public< / h4 >
< ul >
< li id = "__call" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/__call.html" > __call()< / a >
— Allow invoke to work on table object< / li >
< li id = "_quote" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/_quote.html" > _quote()< / a >
— Helper method for quote_ident< / li >
< li id = "affectedRows" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/affectedRows.html" > affectedRows()< / a >
— Returns number of rows affected by an INSERT, UPDATE, DELETE type query< / li >
< li id = "driverQuery" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/driverQuery.html" > driverQuery()< / a >
— Method to simplify retrieving db results for meta-data queries< / li >
< li id = "getColumns" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getColumns.html" > getColumns()< / a >
— Retrieve column information for the current database table< / li >
< li id = "getDbs" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getDbs.html" > getDbs()< / a >
— Return list of dbs for the current connection, if possible< / li >
< li id = "getFks" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getFks.html" > getFks()< / a >
— Retrieve foreign keys for the table< / li >
< li id = "getFunctions" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getFunctions.html" > getFunctions()< / a >
— Return list of functions for the current database< / li >
< li id = "getIndexes" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getIndexes.html" > getIndexes()< / a >
— Retrieve indexes for the table< / li >
< li id = "getLastQuery" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getLastQuery.html" > getLastQuery()< / a >
— Get the last sql query executed< / li >
< li id = "getProcedures" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getProcedures.html" > getProcedures()< / a >
— Return list of stored procedures for the current database< / li >
< li id = "getSchemas" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getSchemas.html" > getSchemas()< / a >
— Return schemas for databases that list them< / li >
< li id = "getSequences" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getSequences.html" > getSequences()< / a >
— Return list of sequences for the current database, if they exist< / li >
< li id = "getSql" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getSql.html" > getSql()< / a >
— Get the SQL class for the current driver< / li >
< li id = "getSystemTables" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getSystemTables.html" > getSystemTables()< / a >
— Retrieves an array of non-user-created tables for the connection/database< / li >
< li id = "getTables" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getTables.html" > getTables()< / a >
— Return list of tables for the current database< / li >
< li id = "getTriggers" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getTriggers.html" > getTriggers()< / a >
— Return list of triggers for the current database< / li >
< li id = "getTypes" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getTypes.html" > getTypes()< / a >
— Retrieve list of data types for the database< / li >
< li id = "getUtil" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getUtil.html" > getUtil()< / a >
— Get the Util class for the current driver< / li >
2020-04-17 15:05:37 -04:00
< li id = "getVersion" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getVersion.html" > getVersion()< / a >
— Get the version of the database engine< / li >
2018-01-24 15:31:27 -05:00
< li id = "getViews" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/getViews.html" > getViews()< / a >
— Return list of views for the current database< / li >
< li id = "insertBatch" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/insertBatch.html" > insertBatch()< / a >
— Create sql for batch insert< / li >
< li id = "numRows" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/numRows.html" > numRows()< / a >
— Return the number of rows returned for a SELECT query< / li >
< li id = "prefixTable" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/prefixTable.html" > prefixTable()< / a >
— Prefixes a table if it is not already prefixed< / li >
< li id = "prepareExecute" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/prepareExecute.html" > prepareExecute()< / a >
— Create and execute a prepared statement with the provided parameters< / li >
< li id = "prepareQuery" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/prepareQuery.html" > prepareQuery()< / a >
— Simplifies prepared statements for database queries< / li >
< li id = "quoteIdent" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/quoteIdent.html" > quoteIdent()< / a >
— Surrounds the string with the databases identifier escape characters< / li >
< li id = "quoteTable" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/quoteTable.html" > quoteTable()< / a >
— Quote database table name, and set prefix< / li >
2020-04-17 15:05:37 -04:00
< li id = "returning" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/returning.html" > returning()< / a >
— Generate the returning clause for the current database< / li >
2018-01-24 15:31:27 -05:00
< li id = "setLastQuery" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/setLastQuery.html" > setLastQuery()< / a >
— Set the last query sql< / li >
< li id = "setTablePrefix" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/setTablePrefix.html" > setTablePrefix()< / a >
— Set the common table name prefix< / li >
< li id = "truncate" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/truncate.html" > truncate()< / a >
— Empty the passed table< / li >
< li id = "updateBatch" > < a title = "Query\Drivers\AbstractDriver" href = "../classes/Query_Drivers_AbstractDriver/updateBatch.html" > updateBatch()< / a >
— Creates a batch update, and executes it.< / li >
< / ul >
< h3 > Inherited from < a title = "PDO" href = "../classes/PDO.html" > PDO< / a > < / h3 >
< h4 > public< / h4 >
< ul >
< li id = "beginTransaction" > < a title = "PDO" href = "../classes/PDO/beginTransaction.html" > beginTransaction()< / a >
—
Initiates a transaction
< / li >
< li id = "commit" > < a title = "PDO" href = "../classes/PDO/commit.html" > commit()< / a >
—
Commits a transaction
< / li >
< li id = "errorCode" > < a title = "PDO" href = "../classes/PDO/errorCode.html" > errorCode()< / a >
—
Fetch the SQLSTATE associated with the last operation on the database handle
< / li >
< li id = "errorInfo" > < a title = "PDO" href = "../classes/PDO/errorInfo.html" > errorInfo()< / a >
—
Fetch extended error information associated with the last operation on the database handle
< / li >
< li id = "exec" > < a title = "PDO" href = "../classes/PDO/exec.html" > exec()< / a >
—
Execute an SQL statement and return the number of affected rows
< / li >
< li id = "getAttribute" > < a title = "PDO" href = "../classes/PDO/getAttribute.html" > getAttribute()< / a >
—
Retrieve a database connection attribute
< / li >
< li id = "getAvailableDrivers" > < a title = "PDO" href = "../classes/PDO/getAvailableDrivers.html" > getAvailableDrivers()< / a >
—
Return an array of available PDO drivers
< / li >
< li id = "inTransaction" > < a title = "PDO" href = "../classes/PDO/inTransaction.html" > inTransaction()< / a >
—
Checks if inside a transaction
< / li >
< li id = "lastInsertId" > < a title = "PDO" href = "../classes/PDO/lastInsertId.html" > lastInsertId()< / a >
—
Returns the ID of the last inserted row or sequence value
< / li >
< li id = "prepare" > < a title = "PDO" href = "../classes/PDO/prepare.html" > prepare()< / a >
—
Prepares a statement for execution and returns a statement object
< / li >
< li id = "query" > < a title = "PDO" href = "../classes/PDO/query.html" > query()< / a >
—
Executes an SQL statement, returning a result set as a PDOStatement object
< / li >
< li id = "quote" > < a title = "PDO" href = "../classes/PDO/quote.html" > quote()< / a >
—
2019-12-11 16:09:58 -05:00
Quotes a string for use in a query
2018-01-24 15:31:27 -05:00
< / li >
< li id = "rollBack" > < a title = "PDO" href = "../classes/PDO/rollBack.html" > rollBack()< / a >
—
Rolls back a transaction
< / li >
< li id = "setAttribute" > < a title = "PDO" href = "../classes/PDO/setAttribute.html" > setAttribute()< / a >
—
Set an attribute
< / li >
< / ul >
< / div >
< / section >
< / div >
< footer >
2020-04-17 15:05:37 -04:00
< span > Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors< / span >
2018-01-24 15:31:27 -05:00
< / footer >
< / body >
< / html >
