https://github.com/phppkg/pdox
a lightweight database client by php PDO
https://github.com/phppkg/pdox
database database-connector pdo pdo-wrapper
Last synced: about 1 month ago
JSON representation
a lightweight database client by php PDO
- Host: GitHub
- URL: https://github.com/phppkg/pdox
- Owner: phppkg
- License: mit
- Created: 2017-12-14T03:47:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-05-11T13:45:26.000Z (almost 3 years ago)
- Last Synced: 2025-02-01T11:17:44.375Z (3 months ago)
- Topics: database, database-connector, pdo, pdo-wrapper
- Language: PHP
- Homepage: https://phppkg.github.io/pdox/
- Size: 234 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple db client
[](LICENSE)
[](https://packagist.org/packages/phppkg/pdox)
[](https://packagist.org/packages/phppkg/pdox)
Simple database client for mysql,sqlite by PDO
- **github** https://github.com/phppkg/pdox.git
## Install
- By composer require
```bash
composer require phppkg/pdox
```
- By composer.json
```json
{
"require": {
"phppkg/pdox": "~1.0.0"
}
}
```
- Pull directly
```bash
git clone https://github.com/phppkg/pdox.git
```
## Usage
### create connection
```php
use PhpComp\PdoX\PdoX;
$db = PdoX::create([
// open debug, will record query logs.
'debug' => 1,
'driver' => 'mysql', // 'sqlite' 'pgsql' 'mssql'
'host' => 'localhost',
'user' => 'root',
'password' => 'password',
'database' => 'test',
]);
// add event listeners.
$db->on(PdoX::CONNECT, function ($db) {
echo "connect database success\n";
});
$db->on(PdoX::BEFORE_EXECUTE, function ($sql) {
echo "Will run SQL: $sql\n";
});
$db->on(PdoX::DISCONNECT, function ($db) {
echo "disconnect database success\n";
});
```
### basic
```php
$db->exec('CREATE TABLE IF NOT EXISTS `user` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`username` VARCHAR(32) NOT NULL,
`nickname` VARCHAR(32),
primary key(id)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;');
// fetch all
$ret = $db->fetchAll('show tables');
var_dump($ret);
```
### insert
```php
// insert one
$ret = $db->insert('user', [
'username' => 'tom',
'nickname' => 'tom-nick',
], [
'returnSql' => 1,
]);
var_dump($ret);
// batch insert
$ret = $db->insertBatch('user',[
[
'username' => 'tom',
'nickname' => 'tom-nick',
],
[
'username' => 'tom1',
'nickname' => 'tom-nick2',
],
], [
'returnSql' => 1,
]);
var_dump($ret);
```
### query
```php
// find one
// SQL: SELECT * FROM `user` WHERE `id`= ? LIMIT 1
$ret = $db->queryOne('user', ['id' => 3], '*', [
'fetchType' => 'assoc',
'returnSql' => 1,
]);
var_dump($ret);
// find all
// SQL: SELECT * FROM `user` WHERE `username` like ? LIMIT 1000
$ret = $db->queryAll('user', [ ['username', 'like', '%tes%'] ], '*', [
'fetchType' => 'assoc',
'limit' => 10,
'returnSql' => 1,
]);
var_dump($ret);
// more conditions
$ret = $db->queryAll('user', [
'userId' => 23, // 'AND `userId` = 23'
'title' => 'test', // value will auto add quote, equal to "AND title = 'test'"
'status' => [1, 2], // status IN (1,2)
['publishAt', '>', '0'], // ==> 'AND `publishAt` > 0'
['createdAt', '<=', 1345665427, 'OR'], // ==> 'OR `createdAt` <= 1345665427'
['id', 'IN' ,[4,5,56]], // ==> '`id` IN ('4','5','56')'
['id', 'NOT IN', [4,5,56]], // ==> '`id` NOT IN ('4','5','56')'
// a closure
function () {
return 'a < 5 OR b > 6';
}
]);
// SQL: SELECT * FROM `user` WHERE "name"= ? OR ( "type"= ? AND "createAt" <= ? ) AND "status" IN ('1','2')
$ret = $db->queryAll('user', [
'name' => 'tom',
'or' => '(',
'type' => 'admin',
['createAt', '<=', \date('Y-m-d H:i:s')],
')',
'status' => [1,2]
]);
```
### update
```php
$ret = $db->update('user', ['id' => 2], [
'username' => 'tom',
'nickname' => 'tom-nick',
], [
'returnSql' => 1,
]);
var_dump($ret);
```
### delete
```php
$ret = $db->delete('user', ['id' => 2], [
'returnSql' => 1,
'limit' => 1,
]);
var_dump($ret);
```
### get query logs
```php
var_dump($db->getQueryLogs());
```
## Methods docs
> https://phppkg.github.io/pdox/classes/master/Inhere/PdoX/PdoX.html
## License
MIT