oktopost/squid

MySQL library build on top of PDO

v2.0.1 2023-06-19 13:36 UTC

Requires

• php: >=8.1-stable
• oktopost/jsonencode: ^1.0
• oktopost/objection: ^2.0.0
• oktopost/skeleton: ^2.0.0
• unstable-cacao/structura: ^3.0
• unstable-cacao/traitor: ^2.0

Requires (Dev)

• phpunit/phpunit: ^8.1
• satooshi/php-coveralls: ^1.0

MIT

• Alexey Puchkov
• Daniel Podrabinek
• Ivan Demchenkov

README

Squid is a MySQL library

Example code:

$select = $connector->select();
$select
	->column('a.*', 'b.Modified')
	->from('TableName', 'a')
	->leftJoin('AnotherTable', 'b', 'a.ID = b.TableNameID AND b.Status = ?', 'valid')
	->byField('b.Name', 'Jhon')
	->where('DATE(a.Created) > ?', new \DateTime());
	
$result = $select->query();

$modifiedAt = $result[0]['Modified'];

Basic Configuration

use Squid\MySql;

$mysql = new MySql();
$mysql->config()
	->addConfig(
	'connection_name',
	[
		'db'	=> 'db_name',
		'host'	=> 'localhost',
		'pass'	=> 'password',
		'user'	=> 'user_name'
	]);

// Aquire new connector object
$connector = $mysql->getConnector('connection_name');

// Aquiring commands
$select = $connector->select();
$insert = $connector->insert();
$delete = $connector->delete();

Select

Columns

column method

public function column(...$columns)

Set the columns to select.

Example:

$select1->column('a', 'NOW()');
$select2->column('a.a', 'a.b');

Will result respectively in:

SELECT a, NOW()
SELECT a.a, a.b

columns method

public function columns($columns, $table = false)

Set the columns to select using an array variable.

Example:

$select1->columns(['a', 'NOW()']);
$select2->columns(['a', 'b'], 'a');

Will result respectively in:

SELECT a, NOW()
SELECT a.a, a.b

From

from method

NOTE: A select can have only one main table. Calling this method a second time on the same select object will replace previous table selection.

public function from($table, $alias = false)

Describe the main table you want to select from. This method can't be used for selecting from multiplay tables. To do so, use the join method.

Example:

$select1->from('Table');
$select2->from('Table', 'a');

Will result respectively in:

SELECT * FROM Table
SELECT * FROM Table a

Where Clause

The where clause commands are available in select, insert, update, upsert and delete commands.

where method

public function where($exp, $bind = false)

Provide any costume where expression with optional bind parameters.

Example:

$select1->where('1 + 1 = ?', 2);
$select2->where('Table.SomeFieldName = ? - ?', [3, 1]);
$delete->where('NOW() > DATE(NOW())');

Will result respectively in:

SELECT * WHERE 1 + 1 = 2
SELECT * WHERE Table.SomeFieldName = 3 - 1
DELETE * WHERE NOW() > DATE(NOW())

byField method

public function byField($field, $value) 

Search for field = value or, if value is an array, where field IN (values)

Example:

$select1->byField('Name', ['Jhon']);
$select1->byField('ROUND(Price)', [23]);
$select1->byField('ID', [2, 3]);

Will result respectively in:

SELECT * WHERE Name = 'Jhon'
SELECT * WHERE ROUND(Price) = 23
SELECT * WHERE ID IN (2, 3)