企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
# mysql 插件 `ESD` 已默认启用本插件。 ## 插件使用 有两种方法在对象中使用。 ### 方法1 使用 use trait,然后通过 $this->mysql() 获取数据库连接。 ~~~ use GetMysql; ~~~ ~~~ protected function cacheTest($id){ $this->mysql()->query("SHOW GLOBAL STATUS LIKE '%connections%'"); return $res; } ~~~ 如果需要切换 mysql 配置为test,可按照如下方法修改。 ~~~ protected function cacheTest($id){ $this->mysql('test')->query("SHOW GLOBAL STATUS LIKE '%connections%'"); return $res; } ~~~ ### 方法2 在对象中进行注入mysql 对象 ~~~ use DI\Annotation\Inject; /** * @Inject() * @var \MysqliDb */ protected $mysql; ~~~ ~~~ protected function cacheTest($id){ $res = $this->mysql->query("SHOW GLOBAL STATUS LIKE '%connections%'"); return $res; } ~~~ >[danger] **通过注入的方法,目前还不支持切换 mysql 连接配置。** ## mysql 对象的使用方法 mysql 对象使用了[PHP-MySQLi-Database-Class](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class)库,可点击查看。 ### Insert Query Simple example ~~~html $data = Array ("login" => "admin", "firstName" => "John", "lastName" => 'Doe' ); $id = $db->insert ('users', $data); if($id) echo 'user was created. Id=' . $id; ~~~ Insert with functions use ~~~html $data = Array ( 'login' => 'admin', 'active' => true, 'firstName' => 'John', 'lastName' => 'Doe', 'password' => $db->func('SHA1(?)',Array ("secretpassword+salt")), // password = SHA1('secretpassword+salt') 'createdAt' => $db->now(), // createdAt = NOW() 'expires' => $db->now('+1Y') // expires = NOW() + interval 1 year // Supported intervals [s]econd, [m]inute, [h]hour, [d]day, [M]onth, [Y]ear ); $id = $db->insert ('users', $data); if ($id) echo 'user was created. Id=' . $id; else echo 'insert failed: ' . $db->getLastError(); ~~~ Insert with on duplicate key update ~~~html $data = Array ("login" => "admin", "firstName" => "John", "lastName" => 'Doe', "createdAt" => $db->now(), "updatedAt" => $db->now(), ); $updateColumns = Array ("updatedAt"); $lastInsertId = "id"; $db->onDuplicate($updateColumns, $lastInsertId); $id = $db->insert ('users', $data); ~~~ Insert multiple datasets at once ~~~html $data = Array( Array ("login" => "admin", "firstName" => "John", "lastName" => 'Doe' ), Array ("login" => "other", "firstName" => "Another", "lastName" => 'User', "password" => "very_cool_hash" ) ); $ids = $db->insertMulti('users', $data); if(!$ids) { echo 'insert failed: ' . $db->getLastError(); } else { echo 'new users inserted with following id\'s: ' . implode(', ', $ids); } ~~~ If all datasets only have the same keys, it can be simplified ~~~html $data = Array( Array ("admin", "John", "Doe"), Array ("other", "Another", "User") ); $keys = Array("login", "firstName", "lastName"); $ids = $db->insertMulti('users', $data, $keys); if(!$ids) { echo 'insert failed: ' . $db->getLastError(); } else { echo 'new users inserted with following id\'s: ' . implode(', ', $ids); } ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#replace-query)Replace Query [Replace()](https://dev.mysql.com/doc/refman/5.0/en/replace.html)method implements same API as insert(); ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#update-query)Update Query ~~~html $data = Array ( 'firstName' => 'Bobby', 'lastName' => 'Tables', 'editCount' => $db->inc(2), // editCount = editCount + 2; 'active' => $db->not() // active = !active; ); $db->where ('id', 1); if ($db->update ('users', $data)) echo $db->count . ' records were updated'; else echo 'update failed: ' . $db->getLastError(); ~~~ `update()`also support limit parameter: ~~~html $db->update ('users', $data, 10); // Gives: UPDATE users SET ... LIMIT 10 ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#select-query)Select Query After any select/get function calls amount or returned rows is stored in $count variable ~~~html $users = $db->get('users'); //contains an Array of all users $users = $db->get('users', 10); //contains an Array 10 users ~~~ or select with custom columns set. Functions also could be used ~~~html $cols = Array ("id", "name", "email"); $users = $db->get ("users", null, $cols); if ($db->count > 0) foreach ($users as $user) { print_r ($user); } ~~~ or select just one row ~~~html $db->where ("id", 1); $user = $db->getOne ("users"); echo $user['id']; $stats = $db->getOne ("users", "sum(id), count(*) as cnt"); echo "total ".$stats['cnt']. "users found"; ~~~ or select one column value or function result ~~~html $count = $db->getValue ("users", "count(*)"); echo "{$count} users found"; ~~~ select one column value or function result from multiple rows: ~~~html $logins = $db->getValue ("users", "login", null); // select login from users $logins = $db->getValue ("users", "login", 5); // select login from users limit 5 foreach ($logins as $login) echo $login; ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#insert-data)Insert Data You can also load .CSV or .XML data into a specific table. To insert .csv data, use the following syntax: ~~~html $path_to_file = "/home/john/file.csv"; $db->loadData("users", $path_to_file); ~~~ This will load a .csv file called**file.csv**in the folder**/home/john/**(john's home directory.) You can also attach an optional array of options. Valid options are: ~~~html Array( "fieldChar" => ';', // Char which separates the data "lineChar" => '\r\n', // Char which separates the lines "linesToIgnore" => 1 // Amount of lines to ignore at the beginning of the import ); ~~~ Attach them using ~~~html $options = Array("fieldChar" => ';', "lineChar" => '\r\n', "linesToIgnore" => 1); $db->loadData("users", "/home/john/file.csv", $options); // LOAD DATA ... ~~~ You can specify to**use LOCAL DATA**instead of**DATA**: ~~~html $options = Array("fieldChar" => ';', "lineChar" => '\r\n', "linesToIgnore" => 1, "loadDataLocal" => true); $db->loadData("users", "/home/john/file.csv", $options); // LOAD DATA LOCAL ... ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#insert-xml)Insert XML To load XML data into a table, you can use the method**loadXML**. The syntax is smillar to the loadData syntax. ~~~html $path_to_file = "/home/john/file.xml"; $db->loadXML("users", $path_to_file); ~~~ You can also add optional parameters. Valid parameters: ~~~html Array( "linesToIgnore" => 0, // Amount of lines / rows to ignore at the beginning of the import "rowTag" => "<user>" // The tag which marks the beginning of an entry ) ~~~ Usage: ~~~html $options = Array("linesToIgnore" => 0, "rowTag" => "<user>"): $path_to_file = "/home/john/file.xml"; $db->loadXML("users", $path_to_file, $options); ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#pagination)Pagination Use paginate() instead of get() to fetch paginated result ~~~html $page = 1; // set page limit to 2 results per page. 20 by default $db->pageLimit = 2; $products = $db->arraybuilder()->paginate("products", $page); echo "showing $page out of " . $db->totalPages; ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#result-transformation--map)Result transformation / map Instead of getting an pure array of results its possible to get result in an associative array with a needed key. If only 2 fields to fetch will be set in get(), method will return result in array($k => $v) and array ($k => array ($v, $v)) in rest of the cases. ~~~html $user = $db->map ('login')->ObjectBuilder()->getOne ('users', 'login, id'); Array ( [user1] => 1 ) $user = $db->map ('login')->ObjectBuilder()->getOne ('users', 'id,login,createdAt'); Array ( [user1] => stdClass Object ( [id] => 1 [login] => user1 [createdAt] => 2015-10-22 22:27:53 ) ) ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#defining-a-return-type)Defining a return type MysqliDb can return result in 3 different formats: Array of Array, Array of Objects and a Json string. To select a return type use ArrayBuilder(), ObjectBuilder() and JsonBuilder() methods. Note that ArrayBuilder() is a default return type ~~~html // Array return type $= $db->getOne("users"); echo $u['login']; // Object return type $u = $db->ObjectBuilder()->getOne("users"); echo $u->login; // Json return type $json = $db->JsonBuilder()->getOne("users"); ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#running-raw-sql-queries)Running raw SQL queries ~~~html $users = $db->rawQuery('SELECT * from users where id >= ?', Array (10)); foreach ($users as $user) { print_r ($user); } ~~~ To avoid long if checks there are couple helper functions to work with raw query select results: Get 1 row of results: ~~~html $user = $db->rawQueryOne ('select * from users where id=?', Array(10)); echo $user['login']; // Object return type $user = $db->ObjectBuilder()->rawQueryOne ('select * from users where id=?', Array(10)); echo $user->login; ~~~ Get 1 column value as a string: ~~~html $password = $db->rawQueryValue ('select password from users where id=? limit 1', Array(10)); echo "Password is {$password}"; NOTE: for a rawQueryValue() to return string instead of an array 'limit 1' should be added to the end of the query. ~~~ Get 1 column value from multiple rows: ~~~html $logins = $db->rawQueryValue ('select login from users limit 10'); foreach ($logins as $login) echo $login; ~~~ More advanced examples: ~~~html $params = Array(1, 'admin'); $users = $db->rawQuery("SELECT id, firstName, lastName FROM users WHERE id = ? AND login = ?", $params); print_r($users); // contains Array of returned rows // will handle any SQL query $params = Array(10, 1, 10, 11, 2, 10); $q = "( SELECT a FROM t1 WHERE a = ? AND B = ? ORDER BY a LIMIT ? ) UNION ( SELECT a FROM t2 WHERE a = ? AND B = ? ORDER BY a LIMIT ? )"; $resutls = $db->rawQuery ($q, $params); print_r ($results); // contains Array of returned rows ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#where--having-methods)Where / Having Methods `where()`,`orWhere()`,`having()`and`orHaving()`methods allows you to specify where and having conditions of the query. All conditions supported by where() are supported by having() as well. WARNING: In order to use column to column comparisons only raw where conditions should be used as column name or functions cant be passed as a bind variable. Regular == operator with variables: ~~~html $db->where ('id', 1); $db->where ('login', 'admin'); $results = $db->get ('users'); // Gives: SELECT * FROM users WHERE id=1 AND login='admin'; ~~~ ~~~html $db->where ('id', 1); $db->having ('login', 'admin'); $results = $db->get ('users'); // Gives: SELECT * FROM users WHERE id=1 HAVING login='admin'; ~~~ Regular == operator with column to column comparison: ~~~html // WRONG $db->where ('lastLogin', 'createdAt'); // CORRECT $db->where ('lastLogin = createdAt'); $results = $db->get ('users'); // Gives: SELECT * FROM users WHERE lastLogin = createdAt; ~~~ ~~~html $db->where ('id', 50, ">="); // or $db->where ('id', Array ('>=' => 50)); $results = $db->get ('users'); // Gives: SELECT * FROM users WHERE id >= 50; ~~~ BETWEEN / NOT BETWEEN: ~~~html $db->where('id', Array (4, 20), 'BETWEEN'); // or $db->where ('id', Array ('BETWEEN' => Array(4, 20))); $results = $db->get('users'); // Gives: SELECT * FROM users WHERE id BETWEEN 4 AND 20 ~~~ IN / NOT IN: ~~~html $db->where('id', Array(1, 5, 27, -1, 'd'), 'IN'); // or $db->where('id', Array( 'IN' => Array(1, 5, 27, -1, 'd') ) ); $results = $db->get('users'); // Gives: SELECT * FROM users WHERE id IN (1, 5, 27, -1, 'd'); ~~~ OR CASE: ~~~html $db->where ('firstName', 'John'); $db->orWhere ('firstName', 'Peter'); $results = $db->get ('users'); // Gives: SELECT * FROM users WHERE firstName='John' OR firstName='peter' ~~~ NULL comparison: ~~~html $db->where ("lastName", NULL, 'IS NOT'); $results = $db->get("users"); // Gives: SELECT * FROM users where lastName IS NOT NULL ~~~ LIKE comparison: ~~~html $db->where ("fullName", 'John%', 'like'); $results = $db->get("users"); // Gives: SELECT * FROM users where fullName like 'John%' ~~~ Also you can use raw where conditions: ~~~html $db->where ("id != companyId"); $db->where ("DATE(createdAt) = DATE(lastLogin)"); $results = $db->get("users"); ~~~ Or raw condition with variables: ~~~html $db->where ("(id = ? or id = ?)", Array(6,2)); $db->where ("login","mike") $res = $db->get ("users"); // Gives: SELECT * FROM users WHERE (id = 6 or id = 2) and login='mike'; ~~~ Find the total number of rows matched. Simple pagination example: ~~~html $offset = 10; $count = 15; $users = $db->withTotalCount()->get('users', Array ($offset, $count)); echo "Showing {$count} from {$db->totalCount}"; ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#query-keywords)Query Keywords To add LOW PRIORITY | DELAYED | HIGH PRIORITY | IGNORE and the rest of the mysql keywords to INSERT (), REPLACE (), GET (), UPDATE (), DELETE() method or FOR UPDATE | LOCK IN SHARE MODE into SELECT (): ~~~html $db->setQueryOption ('LOW_PRIORITY')->insert ($table, $param); // GIVES: INSERT LOW_PRIORITY INTO table ... ~~~ ~~~html $db->setQueryOption ('FOR UPDATE')->get ('users'); // GIVES: SELECT * FROM USERS FOR UPDATE; ~~~ Also you can use an array of keywords: ~~~html $db->setQueryOption (Array('LOW_PRIORITY', 'IGNORE'))->insert ($table,$param); // GIVES: INSERT LOW_PRIORITY IGNORE INTO table ... ~~~ Same way keywords could be used in SELECT queries as well: ~~~html $db->setQueryOption ('SQL_NO_CACHE'); $db->get("users"); // GIVES: SELECT SQL_NO_CACHE * FROM USERS; ~~~ Optionally you can use method chaining to call where multiple times without referencing your object over and over: ~~~html $results = $db ->where('id', 1) ->where('login', 'admin') ->get('users'); ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#delete-query)Delete Query ~~~html $db->where('id', 1); if($db->delete('users')) echo 'successfully deleted'; ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#ordering-method)Ordering method ~~~html $db->orderBy("id","asc"); $db->orderBy("login","Desc"); $db->orderBy("RAND ()"); $results = $db->get('users'); // Gives: SELECT * FROM users ORDER BY id ASC,login DESC, RAND (); ~~~ Order by values example: ~~~html $db->orderBy('userGroup', 'ASC', array('superuser', 'admin', 'users')); $db->get('users'); // Gives: SELECT * FROM users ORDER BY FIELD (userGroup, 'superuser', 'admin', 'users') ASC; ~~~ If you are using setPrefix () functionality and need to use table names in orderBy() method make sure that table names are escaped with ``. ~~~html $db->setPrefix ("t_"); $db->orderBy ("users.id","asc"); $results = $db->get ('users'); // WRONG: That will give: SELECT * FROM t_users ORDER BY users.id ASC; $db->setPrefix ("t_"); $db->orderBy ("`users`.id", "asc"); $results = $db->get ('users'); // CORRECT: That will give: SELECT * FROM t_users ORDER BY t_users.id ASC; ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#grouping-method)Grouping method ~~~html $db->groupBy ("name"); $results = $db->get ('users'); // Gives: SELECT * FROM users GROUP BY name; ~~~ Join table products with table users with LEFT JOIN by tenantID ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#join-method)JOIN method ~~~html $db->join("users u", "p.tenantID=u.tenantID", "LEFT"); $db->where("u.id", 6); $products = $db->get ("products p", null, "u.name, p.productName"); print_r ($products); ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#join-conditions)Join Conditions Add AND condition to join statement ~~~html $db->join("users u", "p.tenantID=u.tenantID", "LEFT"); $db->joinWhere("users u", "u.tenantID", 5); $products = $db->get ("products p", null, "u.name, p.productName"); print_r ($products); // Gives: SELECT u.login, p.productName FROM products p LEFT JOIN users u ON (p.tenantID=u.tenantID AND u.tenantID = 5) ~~~ Add OR condition to join statement ~~~html $db->join("users u", "p.tenantID=u.tenantID", "LEFT"); $db->joinOrWhere("users u", "u.tenantID", 5); $products = $db->get ("products p", null, "u.name, p.productName"); print_r ($products); // Gives: SELECT u.login, p.productName FROM products p LEFT JOIN users u ON (p.tenantID=u.tenantID OR u.tenantID = 5) ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#properties-sharing)Properties sharing It is also possible to copy properties ~~~html $db->where ("agentId", 10); $db->where ("active", true); $customers = $db->copy (); $res = $customers->get ("customers", Array (10, 10)); // SELECT * FROM customers where agentId = 10 and active = 1 limit 10, 10 $cnt = $db->getValue ("customers", "count(id)"); echo "total records found: " . $cnt; // SELECT count(id) FROM users where agentId = 10 and active = 1 ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#subqueries)Subqueries Subquery init Subquery init without an alias to use in inserts/updates/where Eg. (select \* from users) ~~~html $sq = $db->subQuery(); $sq->get ("users"); ~~~ A subquery with an alias specified to use in JOINs . Eg. (select \* from users) sq ~~~html $sq = $db->subQuery("sq"); $sq->get ("users"); ~~~ Subquery in selects: ~~~html $ids = $db->subQuery (); $ids->where ("qty", 2, ">"); $ids->get ("products", null, "userId"); $db->where ("id", $ids, 'in'); $res = $db->get ("users"); // Gives SELECT * FROM users WHERE id IN (SELECT userId FROM products WHERE qty > 2) ~~~ Subquery in inserts: ~~~html $userIdQ = $db->subQuery (); $userIdQ->where ("id", 6); $userIdQ->getOne ("users", "name"), $data = Array ( "productName" => "test product", "userId" => $userIdQ, "lastUpdated" => $db->now() ); $id = $db->insert ("products", $data); // Gives INSERT INTO PRODUCTS (productName, userId, lastUpdated) values ("test product", (SELECT name FROM users WHERE id = 6), NOW()); ~~~ Subquery in joins: ~~~html $usersQ = $db->subQuery ("u"); $usersQ->where ("active", 1); $usersQ->get ("users"); $db->join($usersQ, "p.userId=u.id", "LEFT"); $products = $db->get ("products p", null, "u.login, p.productName"); print_r ($products); // SELECT u.login, p.productName FROM products p LEFT JOIN (SELECT * FROM t_users WHERE active = 1) u on p.userId=u.id; ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#exists--not-exists-condition)EXISTS / NOT EXISTS condition ~~~html $sub = $db->subQuery(); $sub->where("company", 'testCompany'); $sub->get ("users", null, 'userId'); $db->where (null, $sub, 'exists'); $products = $db->get ("products"); // Gives SELECT * FROM products WHERE EXISTS (select userId from users where company='testCompany') ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#has-method)Has method A convenient function that returns TRUE if exists at least an element that satisfy the where condition specified calling the "where" method before this one. ~~~html $db->where("user", $user); $db->where("password", md5($password)); if($db->has("users")) { return "You are logged"; } else { return "Wrong user/password"; } ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#helper-methods)Helper methods Disconnect from the database: ~~~html $db->disconnect(); ~~~ Reconnect in case mysql connection died: ~~~html if (!$db->ping()) $db->connect() ~~~ Get last executed SQL query: Please note that function returns SQL query only for debugging purposes as its execution most likely will fail due missing quotes around char variables. ~~~html $db->get('users'); echo "Last executed query was ". $db->getLastQuery(); ~~~ Check if table exists: ~~~html if ($db->tableExists ('users')) echo "hooray"; ~~~ mysqli\_real\_escape\_string() wrapper: ~~~html $escaped = $db->escape ("' and 1=1"); ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#transaction-helpers)Transaction helpers Please keep in mind that transactions are working on innoDB tables. Rollback transaction if insert fails: ~~~html $db->startTransaction(); ... if (!$db->insert ('myTable', $insertData)) { //Error while saving, cancel new record $db->rollback(); } else { //OK $db->commit(); } ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#error-helpers)Error helpers After you executed a query you have options to check if there was an error. You can get the MySQL error string or the error code for the last executed query. ~~~html $db->where('login', 'admin')->update('users', ['firstName' => 'Jack']); if ($db->getLastErrno() === 0) echo 'Update succesfull'; else echo 'Update failed. Error: '. $db->getLastError(); ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#query-execution-time-benchmarking)Query execution time benchmarking To track query execution time setTrace() function should be called. ~~~html $db->setTrace (true); // As a second parameter it is possible to define prefix of the path which should be striped from filename // $db->setTrace (true, $_SERVER['SERVER_ROOT']); $db->get("users"); $db->get("test"); print_r ($db->trace); ~~~ ~~~ [0] => Array ( [0] => SELECT * FROM t_users ORDER BY `id` ASC [1] => 0.0010669231414795 [2] => MysqliDb->get() >> file "/avb/work/PHP-MySQLi-Database-Class/tests.php" line #151 ) [1] => Array ( [0] => SELECT * FROM t_test [1] => 0.00069189071655273 [2] => MysqliDb->get() >> file "/avb/work/PHP-MySQLi-Database-Class/tests.php" line #152 ) ~~~ ### [](https://github.com/ThingEngineer/PHP-MySQLi-Database-Class#table-locking)Table Locking To lock tables, you can use the**lock**method together with**setLockMethod**. The following example will lock the table**users**for**write**access. ~~~html $db->setLockMethod("WRITE")->lock("users"); ~~~ Calling another**\->lock()**will remove the first lock. You can also use ~~~html $db->unlock(); ~~~ to unlock the previous locked tables. To lock multiple tables, you can use an array. Example: ~~~html $db->setLockMethod("READ")->lock(array("users", "log")); ~~~ This will lock the tables**users**and**log**for**READ**access only. Make sure you use \**unlock()*afterwards or your tables will remain locked!