Download the PHP package devtheorem/peachy-sql without Composer
On this page you can find all versions of the php package devtheorem/peachy-sql. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download devtheorem/peachy-sql
More information about devtheorem/peachy-sql
Files in devtheorem/peachy-sql
Package peachy-sql
Short Description A high-performance query builder and runner for PHP
License MIT
Informations about the package peachy-sql
PeachySQL
PeachySQL is a high-performance query builder and runner which streamlines prepared statements and working with large datasets. It is officially tested with MySQL, PostgreSQL, and SQL Server, but it should also work with any standards-compliant database which has a driver for PDO.
Install via Composer
composer require devtheorem/peachy-sql
Usage
Start by instantiating the PeachySql
class with a database connection,
which should be an existing PDO object:
After instantiation, arbitrary statements can be prepared by passing a
SQL string and array of bound parameters to the prepare()
method:
Most of the time prepared statements only need to be executed a single time.
To make this easier, PeachySQL provides a query()
method which automatically
prepares, executes, and closes a statement after results are retrieved:
Both prepare()
and query()
return a Statement
object with the following methods:
Method | Behavior |
---|---|
execute() |
Executes the prepared statement (automatically called when using query() ). |
getIterator() |
Returns a Generator object which can be used to iterate over large result sets without caching them in memory. |
getAll() |
Returns all selected rows as an array of associative arrays. |
getFirst() |
Returns the first selected row as an associative array (or null if no rows were selected). |
getAffected() |
Returns the number of rows affected by the query. |
close() |
Closes the prepared statement and frees its resources (automatically called when using query() ). |
Internally, getAll()
and getFirst()
are implemented using getIterator()
.
As such they can only be called once for a given statement.
Shorthand methods
PeachySQL comes with five shorthand methods for selecting, inserting, updating, and deleting records.
[!NOTE] To prevent SQL injection, the queries PeachySQL generates for these methods always use bound parameters for values, and column names are automatically escaped.
select / selectFrom
The selectFrom()
method takes a single string argument containing a SQL SELECT query.
It returns an object with three chainable methods:
where()
orderBy()
offset()
Additionally, the object has a getSqlParams()
method which builds the select query,
and a query()
method which executes the query and returns a Statement
object.
The select()
method works the same as selectFrom()
, but takes a SqlParams
object rather than a string and supports bound params in the select query:
Where clause generation
In addition to passing basic column => value arrays to the where()
method, you can
specify more complex conditions by using arrays as values. For example, passing
['col' => ['lt' => 15, 'gt' => 5]]
would generate the condition WHERE col < 15 AND col > 5
.
Full list of recognized operators:
Operator | SQL condition |
---|---|
eq | = |
ne | <> |
lt | < |
le | <= |
gt | > |
ge | >= |
lk | LIKE |
nl | NOT LIKE |
nu | IS NULL |
nn | IS NOT NULL |
If a list of values is passed with the eq
or ne
operator, it will generate an
IN(...) or NOT IN(...) condition, respectively. Passing a list with the lk
, nl
,
nu
, or nn
operator will generate an AND condition for each value. The lt
, le
,
gt
, and ge
operators cannot be used with a list of values.
insertRow
The insertRow()
method allows a single row to be inserted from an associative array.
It returns an InsertResult
object with readonly id
and affected
properties.
insertRows
The insertRows()
method makes it possible to bulk-insert multiple rows from an array.
It returns a BulkInsertResult
object with readonly ids
, affected
, and queryCount
properties.
An optional third parameter can be passed to insertRows()
to override the default
identity increment value:
[!NOTE] SQL Server allows a maximum of 1,000 rows to be inserted at a time, and limits individual queries to 2,099 or fewer bound parameters. MySQL and PostgreSQL support a maximum of 65,535 bound parameters per query. These limits can be easily reached when attempting to bulk-insert hundreds or thousands of rows at a time. To avoid these limits, the
insertRows()
method automatically splits row sets that exceed the limits into chunks to efficiently insert any number of rows (queryCount
contains the number of required queries).
updateRows and deleteFrom
The updateRows()
method takes three arguments: a table name, an associative array of
columns/values to update, and a WHERE array to filter which rows are updated.
The deleteFrom()
method takes a table name and a WHERE array to filter the rows to delete.
Both methods return the number of affected rows.
Transactions
Call the begin()
method to start a transaction. prepare()
, execute()
, query()
and any of the shorthand methods can then be called as needed, before committing
or rolling back the transaction with commit()
or rollback()
.
Binary columns
In order to insert/update raw binary data (e.g. to a binary, blob, or bytea column),
the bound parameter must have its encoding type set to binary. PeachySQL provides a
makeBinaryParam()
method to simplify this:
Author
Theodore Brown
https://theodorejb.me
License
MIT
All versions of peachy-sql with dependencies
ext-pdo Version *