hakuryo/database-client

A simple database client with a lot a helper function

2.1.5 2025-02-24 16:14 UTC

Requires

• php: >=8.1
• ext-fileinfo: *
• ext-json: *
• ext-pdo: *
• hakuryo/config-parser: ^1.0

Requires (Dev)

• phpunit/phpunit: ^11.5

MIT

• Hakuryo

README

2.1.0

feature

• Add trackBy param to search function. This param will replace the auto index key of the array by the value of the key for the corresponding line.

exemple:

$db = ConnectionDB::fromFile("my_file",'mydb');
$res = $db->search(request:"SELECT id,name,mail from user",trackBy:"mail");
print_r($res);
// Will ouptut something like this with id = 1 name=toto and mail=[e-mail]
Array
(
  ["[e-mail]"] => stdClass Object
  (
      [id] => 1
      [name] => toto
      [mail] => [e-mail]
  ) 
)

2.0.0 (Breaking changes)

feature

• Add callback param to "get" and "search" to act on lines when they are read.
• Add property lastRowCount to store last UPDATE/INSERT/DELETE rowCount
• Function bindValues now affect SQL type on "boolean","string","int","null" param where preparing a query.

change

• Now require php8.1 or above
• Now require hakuryo/config-parser
• Changing naming convention from snake_case to camelCase
• Removing internal class ConfigParser to use hakuryo/config-parser instead
• Removing query type checks for "get","modify","search" function

fix

• Some optimization when reading database results

1.5.0

• Add CHARSET param to config parser.
• removing default utf8 charset for mysql. you must now use CHARSET config param.

1.4.3

• Fix Forcing utf8 queries for dblib driver

1.4.2

• Update composer.json for php8+ compatibility

1.4.1

• Fix space in oci / dblib dsn build

1.4.0

• Add call function to preform SQL procedure calls

1.3.0

• Refactoring ConfigParser
  • Add support for pgsl and dblib drivers
  • Now checking if provided driver is installed with PDO::getAvailableDrivers function

1.2.1

• Allowed "Truncate" keyword in modify request.

1.2.0

• Add $classname param to search and get function. If set, these function will return database line as $classname object. (POD::FETCH_CLASS)

1.1.0 (Breaking changes)

• Remove $assoc variable from fucntion search,get,modify. Theses function now detect automatically if provided array is associative or not.

Install

composer require hakuryo/database-client

Dependencies

Mandatory

• PHP >= 7.x

Optionnal

Only If you want to use ConnectionDB to connect to an ORACLE database

• Oracle Instantclient
• PHP PDO_OCI
• php-sybase
• php-pgsql

Features

• Parsing client config from INI and JSON file

Usage & exemples

Exemple INI file

[mysql]
HOST = "localhost"
DB = mydb
USER = "root"
PWD = "mypass"
PORT = 1234
DRIVER = "mysql" ;Accepted Values are oci,mysql,dblib,pgsl

[oracle]
HOST = "localhost"
DB = mydb
USER = "root"
PWD = "mypass"
PORT = 1234
DRIVER = "oci" ;Accepted Values are oci,mysql,dblib,pgsl
CHARSET = UTF8

Exemple JSON file

{
  "db": {
    "DB": "mydb",
    "HOST": "localhost",
    "USER": "root",
    "PWD": "mypass",
    "PORT": 3306,
    "DRIVER": "mysql"
  },
  "db2": {
    "DB": "mydb",
    "HOST": "localhost",
    "USER": "root",
    "PWD": "mypass",
    "PORT": 3306,
    "DRIVER": "mysql",
    "CHARSET": "UTF-8"
  }
}

ConnectionDB usage

require "./vendor/autoload.php";

use hakuryo\db\ConnectionDB;
//Connection to mysql
$db = ConnectionDB::fromFile('config.ini', 'mysql');
//Usage of anonnymous params
$rq = "SELECT * FROM users";
// search function is for multiple result
print_r($db->search($rq, [1234]));
$db =null;

//Connection to oracle
$db = ConnectionDB::fromFile('config.ini', 'oracle');
$rq = "SELECT firstname FROM users WHERE id = :id";
//Usage of named params
// get function return the first line of the result
$result = $db->get($rq, ["id"=>1234]);

// Check if result is relevant
if($result !== null){
var_dump($result);
}
$db =null;

//Connection with a config.ini without section
$db = ConnectionDB::fromFile('config_without_section.ini');
$rq = "INSERT INTO users (firstname,lastname) VALUES (:fname,:lname)";
//Modify is use to perform update, insert or delete operation
print_r($db->modify($rq, ["fname"=>"Bob","lname"=>"Moran"]));
$db =null;