rlkollman/meekrodb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cleanup README, add note about $logfile

Browse Source
This commit is contained in:
Sergey Tsalkov
2021-06-29 04:31:23 +00:00
parent 13f249f200
commit e30c240d54
1 changed files with 83 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
README.md
View File

@@ -15,61 +15,85 @@ When you're ready to get started, see the [Quick Start Guide](http://www.meekro.
### Manual Setup ### Manual Setup
Include the `db.class.php` file into your project and set it up like this: Include the `db.class.php` file into your project and set it up like this:
require_once 'db.class.php'; ```php
DB::$user = 'my_database_user'; require_once 'db.class.php';
DB::$password = 'my_database_password'; DB::$user = 'my_database_user';
DB::$dbName = 'my_database_name'; DB::$password = 'my_database_password';
DB::$dbName = 'my_database_name';
```
### Composer ### Composer
Add this to your `composer.json` Add this to your `composer.json`
{ ```json
"require": { {
"sergeytsalkov/meekrodb": "*" "require": {
} "sergeytsalkov/meekrodb": "*"
} }
}
```
Code Examples Code Examples
======== ========
### Grab some rows from the database and print out a field from each row. ### Grab some rows from the database and print out a field from each row.
$accounts = DB::query("SELECT * FROM accounts WHERE type = %s AND age > %i", $type, 15); ```php
foreach ($accounts as $account) { $accounts = DB::query("SELECT * FROM accounts WHERE type = %s AND age > %i", $type, 15);
echo $account['username'] . "\n"; foreach ($accounts as $account) {
} echo $account['username'] . "\n";
}
```
### Insert a new row. ### Insert a new row.
DB::insert('mytable', array( ```php
'name' => $name, DB::insert('mytable', array(
'rank' => $rank, 'name' => $name,
'location' => $location, 'rank' => $rank,
'age' => $age, 'location' => $location,
'intelligence' => $intelligence 'age' => $age,
)); 'intelligence' => $intelligence
));
```
### Grab one row or field ### Grab one row or field
$account = DB::queryFirstRow("SELECT * FROM accounts WHERE username=%s", 'Joe'); ```php
$number_accounts = DB::queryFirstField("SELECT COUNT(*) FROM accounts"); $account = DB::queryFirstRow("SELECT * FROM accounts WHERE username=%s", 'Joe');
$number_accounts = DB::queryFirstField("SELECT COUNT(*) FROM accounts");
```
### Use a list in a query ### Use a list in a query
DB::query("SELECT * FROM tbl WHERE name IN %ls AND age NOT IN %li", array('John', 'Bob'), array(12, 15)); ```php
DB::query("SELECT * FROM tbl WHERE name IN %ls AND age NOT IN %li", array('John', 'Bob'), array(12, 15));
```
### Log all queries and errors
```php
// log all queries and errors to file, or ..
DB::$logfile = '/home/username/logfile.txt';
// log all queries and errors to screen
DB::$logfile = fopen('php://output', 'w');
```
### Nested Transactions ### Nested Transactions
```php
DB::$nested_transactions = true; DB::$nested_transactions = true;
DB::startTransaction(); // outer transaction DB::startTransaction(); // outer transaction
// .. some queries.. // .. some queries..
$depth = DB::startTransaction(); // inner transaction $depth = DB::startTransaction(); // inner transaction
echo $depth . 'transactions are currently active'; // 2 echo $depth . 'transactions are currently active'; // 2
// .. some queries.. // .. some queries..
DB::commit(); // commit inner transaction DB::commit(); // commit inner transaction
// .. some queries.. // .. some queries..
DB::commit(); // commit outer transaction DB::commit(); // commit outer transaction
```
### Lots More - See: http://www.meekro.com/docs.php ### Lots More - See: http://meekro.com/docs
How is MeekroDB better than PDO? How is MeekroDB better than PDO?
@@ -84,17 +108,23 @@ MeekroDB works. Still, if you need database objects, MeekroDB can do that too.
The code below escapes your parameters for safety, runs the query, and grabs The code below escapes your parameters for safety, runs the query, and grabs
the first row of results. Try doing that in one line with PDO. the first row of results. Try doing that in one line with PDO.
$account = DB::queryFirstRow("SELECT * FROM accounts WHERE username=%s", 'Joe'); ```php
$account = DB::queryFirstRow("SELECT * FROM accounts WHERE username=%s", 'Joe');
```
Or how about just one field? Or how about just one field?
$created_at = DB::queryFirstField("SELECT created_at FROM accounts WHERE username=%s", 'Joe'); ```php
$created_at = DB::queryFirstField("SELECT created_at FROM accounts WHERE username=%s", 'Joe');
```
### Work with list parameters easily ### Work with list parameters easily
Using MySQL's IN keyword should not be hard. MeekroDB smooths out the syntax for you, Using MySQL's IN keyword should not be hard. MeekroDB smooths out the syntax for you,
PDO does not. PDO does not.
$accounts = DB::query("SELECT * FROM accounts WHERE username IN %ls", array('Joe', 'Frank')); ```php
$accounts = DB::query("SELECT * FROM accounts WHERE username IN %ls", array('Joe', 'Frank'));
```
### Simple inserts ### Simple inserts
@@ -102,23 +132,27 @@ Using MySQL's INSERT should not be more complicated than passing in an
associative array. MeekroDB also simplifies many related commands, including associative array. MeekroDB also simplifies many related commands, including
the useful and bizarre INSERT .. ON DUPLICATE UPDATE command. PDO does none of this. the useful and bizarre INSERT .. ON DUPLICATE UPDATE command. PDO does none of this.
DB::insert('accounts', array('username' => 'John', 'password' => 'whatever')); ```php
DB::insert('accounts', array('username' => 'John', 'password' => 'whatever'));
```
### Nested transactions ### Nested transactions
MySQL's SAVEPOINT commands lets you create nested transactions, but only MySQL's SAVEPOINT commands lets you create nested transactions, but only
if you keep track of SAVEPOINT ids yourself. MeekroDB does this for you, if you keep track of SAVEPOINT ids yourself. MeekroDB does this for you,
so you can have nested transactions with no complexity or learning curve. so you can have nested transactions with no complexity or learning curve.
DB::$nested_transactions = true; ```php
DB::startTransaction(); // outer transaction DB::$nested_transactions = true;
// .. some queries.. DB::startTransaction(); // outer transaction
$depth = DB::startTransaction(); // inner transaction // .. some queries..
echo $depth . 'transactions are currently active'; // 2 $depth = DB::startTransaction(); // inner transaction
echo $depth . 'transactions are currently active'; // 2
// .. some queries..
DB::commit(); // commit inner transaction // .. some queries..
// .. some queries.. DB::commit(); // commit inner transaction
DB::commit(); // commit outer transaction // .. some queries..
DB::commit(); // commit outer transaction
```
### Flexible debug logging and error handling ### Flexible debug logging and error handling
You can log all queries (and any errors they produce) to a file for debugging purposes. You can also add hooks that let you run your own functions at any point in the query handling process. You can log all queries (and any errors they produce) to a file for debugging purposes. You can also add hooks that let you run your own functions at any point in the query handling process.