PHPackages                             komeiji-satori/miner - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. komeiji-satori/miner

ActiveLibrary[Database & ORM](/categories/database)

komeiji-satori/miner
====================

A dead simple PHP class for building SQL statements. No manual string concatenation necessary.

v0.10.0(12y ago)114MITPHPPHP >=5.1.0

Since Sep 17Pushed 8y ago1 watchersCompare

[ Source](https://github.com/komeiji-satori/Miner)[ Packagist](https://packagist.org/packages/komeiji-satori/miner)[ Docs](https://github.com/jstayton/Miner)[ RSS](/packages/komeiji-satori-miner/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (1)Versions (7)Used By (0)

Miner
=====

[](#miner)

[![Latest Stable Version](https://camo.githubusercontent.com/9aadcfa36ad950de6bbbbee990d882e47c272b8c6bac6e7b6fb80cac453efda0/68747470733a2f2f706f7365722e707567782e6f72672f6a73746179746f6e2f6d696e65722f762f737461626c652e706e67)](https://packagist.org/packages/jstayton/miner)[![Total Downloads](https://camo.githubusercontent.com/a3d5b72f7a06fec4acd3c3b991a8513ae312b10b90bb6f7395e4648162380924/68747470733a2f2f706f7365722e707567782e6f72672f6a73746179746f6e2f6d696e65722f646f776e6c6f6164732e706e67)](https://packagist.org/packages/jstayton/miner)

A dead simple PHP class for building SQL statements. No manual string concatenation necessary.

Developed by [Justin Stayton](http://twitter.com/jstayton) while at [Monk Development](http://monkdev.com).

- [Documentation](http://jstayton.github.io/Miner/classes/Miner.html)
- [Release Notes](https://github.com/jstayton/Miner/wiki/Release-Notes)

Requirements
------------

[](#requirements)

- PHP >= 5.1.0

Installation
------------

[](#installation)

### Composer

[](#composer)

The recommended installation method is through [Composer](http://getcomposer.org/), a dependency manager for PHP. Just add `jstayton/miner` to your project's `composer.json` file:

```
{
    "require": {
        "jstayton/miner": "*"
    }
}
```

[More details](http://packagist.org/packages/jstayton/miner) can be found over at [Packagist](http://packagist.org).

### Manually

[](#manually)

1. Copy `src/Miner.php` to your codebase, perhaps to the `vendor` directory.
2. Add the `Miner` class to your autoloader or `require` the file directly.

Getting Started
---------------

[](#getting-started)

Composing SQL with Miner is very similar to writing it by hand, as much of the syntax maps directly to methods:

```
$Miner = new Miner();
$Miner->select('*')
      ->from('shows')
      ->innerJoin('episodes', 'show_id')
      ->where('shows.network_id', 12)
      ->orderBy('episodes.aired_on', Miner::ORDER_BY_DESC)
      ->limit(20);
```

Now that the statement is built,

```
$Miner->getStatement();
```

returns the full SQL string with placeholders (?), and

```
$Miner->getPlaceholderValues();
```

returns the array of placeholder values that can then be passed to your database connection or abstraction layer of choice. Or, if you'd prefer it all at once, you can get the SQL string with values already safely quoted:

```
$Miner->getStatement(false);
```

If you're using PDO, however, Miner makes executing the statement even easier:

```
$PDOStatement = $Miner->execute();
```

Miner works directly with your PDO connection, which can be passed during creation of the Miner object

```
$Miner = new Miner($PDO);
```

or after

```
$Miner->setPdoConnection($PDO);
```

Usage
-----

[](#usage)

### SELECT

[](#select)

```
SELECT *
FROM shows
INNER JOIN episodes
  ON shows.show_id = episodes.show_id
WHERE shows.network_id = 12
ORDER BY episodes.aired_on DESC
LIMIT 20
```

With Miner:

```
$Miner->select('*')
      ->from('shows')
      ->innerJoin('episodes', 'show_id')
      ->where('shows.network_id', 12)
      ->orderBy('episodes.aired_on', Miner::ORDER_BY_DESC)
      ->limit(20);
```

### INSERT

[](#insert)

```
INSERT HIGH_PRIORITY shows
SET network_id = 13,
    name = 'Freaks & Geeks',
    air_day = 'Tuesday'
```

With Miner:

```
$Miner->insert('shows')
      ->option('HIGH_PRIORITY')
      ->set('network_id', 13)
      ->set('name', 'Freaks & Geeks')
      ->set('air_day', 'Tuesday');
```

### REPLACE

[](#replace)

```
REPLACE shows
SET network_id = 13,
    name = 'Freaks & Geeks',
    air_day = 'Monday'
```

With Miner:

```
$Miner->replace('shows')
      ->set('network_id', 13)
      ->set('name', 'Freaks & Geeks')
      ->set('air_day', 'Monday');
```

### UPDATE

[](#update)

```
UPDATE episodes
SET aired_on = '2012-06-25'
WHERE show_id = 12
  OR (name = 'Girlfriends and Boyfriends'
        AND air_day != 'Monday')
```

With Miner:

```
$Miner->update('episodes')
      ->set('aired_on', '2012-06-25')
      ->where('show_id', 12)
      ->openWhere(Miner::LOGICAL_OR)
      ->where('name', 'Girlfriends and Boyfriends')
      ->where('air_day', 'Monday', Miner::NOT_EQUALS)
      ->closeWhere();
```

### DELETE

[](#delete)

```
DELETE
FROM shows
WHERE show_id IN (12, 15, 20)
LIMIT 3
```

With Miner:

```
$Miner->delete()
      ->from('shows')
      ->whereIn('show_id', array(12, 15, 20))
      ->limit(3);
```

Methods
-------

[](#methods)

- [\_\_construct](http://jstayton.github.io/Miner/classes/Miner.html#method___construct)

### SELECT

[](#select-1)

- [select](http://jstayton.github.io/Miner/classes/Miner.html#method_select)
- [getSelectString](http://jstayton.github.io/Miner/classes/Miner.html#method_getSelectString)
- [mergeSelectInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeSelectInto)

### INSERT

[](#insert-1)

- [insert](http://jstayton.github.io/Miner/classes/Miner.html#method_insert)
- [getInsert](http://jstayton.github.io/Miner/classes/Miner.html#method_getInsert)
- [getInsertString](http://jstayton.github.io/Miner/classes/Miner.html#method_getInsertString)
- [mergeInsertInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeInsertInto)

### REPLACE

[](#replace-1)

- [replace](http://jstayton.github.io/Miner/classes/Miner.html#method_replace)
- [getReplace](http://jstayton.github.io/Miner/classes/Miner.html#method_getReplace)
- [getReplaceString](http://jstayton.github.io/Miner/classes/Miner.html#method_getReplaceString)
- [mergeReplaceInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeReplaceInto)

### UPDATE

[](#update-1)

- [update](http://jstayton.github.io/Miner/classes/Miner.html#method_update)
- [getUpdate](http://jstayton.github.io/Miner/classes/Miner.html#method_getUpdate)
- [getUpdateString](http://jstayton.github.io/Miner/classes/Miner.html#method_getUpdateString)
- [mergeUpdateInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeUpdateInto)

### DELETE

[](#delete-1)

- [delete](http://jstayton.github.io/Miner/classes/Miner.html#method_delete)
- [getDeleteString](http://jstayton.github.io/Miner/classes/Miner.html#method_getDeleteString)
- [mergeDeleteInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeDeleteInto)

### OPTIONS

[](#options)

- [option](http://jstayton.github.io/Miner/classes/Miner.html#method_option)
- [calcFoundRows](http://jstayton.github.io/Miner/classes/Miner.html#method_calcFoundRows)
- [distinct](http://jstayton.github.io/Miner/classes/Miner.html#method_distinct)
- [getOptionsString](http://jstayton.github.io/Miner/classes/Miner.html#method_getOptionsString)
- [mergeOptionsInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeOptionsInto)

### SET / VALUES

[](#set--values)

- [set](http://jstayton.github.io/Miner/classes/Miner.html#method_set)
- [values](http://jstayton.github.io/Miner/classes/Miner.html#method_values)
- [getSetPlaceholderValues](http://jstayton.github.io/Miner/classes/Miner.html#method_getSetPlaceholderValues)
- [getSetString](http://jstayton.github.io/Miner/classes/Miner.html#method_getSetString)
- [mergeSetInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeSetInto)

### FROM

[](#from)

- [from](http://jstayton.github.io/Miner/classes/Miner.html#method_from)
- [innerJoin](http://jstayton.github.io/Miner/classes/Miner.html#method_innerJoin)
- [leftJoin](http://jstayton.github.io/Miner/classes/Miner.html#method_leftJoin)
- [rightJoin](http://jstayton.github.io/Miner/classes/Miner.html#method_rightJoin)
- [join](http://jstayton.github.io/Miner/classes/Miner.html#method_join)
- [getFrom](http://jstayton.github.io/Miner/classes/Miner.html#method_getFrom)
- [getFromAlias](http://jstayton.github.io/Miner/classes/Miner.html#method_getFromAlias)
- [getFromString](http://jstayton.github.io/Miner/classes/Miner.html#method_getFromString)
- [getJoinString](http://jstayton.github.io/Miner/classes/Miner.html#method_getJoinString)
- [mergeFromInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeFromInto)
- [mergeJoinInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeJoinInto)

### WHERE

[](#where)

- [where](http://jstayton.github.io/Miner/classes/Miner.html#method_where)
- [andWhere](http://jstayton.github.io/Miner/classes/Miner.html#method_andWhere)
- [orWhere](http://jstayton.github.io/Miner/classes/Miner.html#method_orWhere)
- [whereIn](http://jstayton.github.io/Miner/classes/Miner.html#method_whereIn)
- [whereNotIn](http://jstayton.github.io/Miner/classes/Miner.html#method_whereNotIn)
- [whereBetween](http://jstayton.github.io/Miner/classes/Miner.html#method_whereBetween)
- [whereNotBetween](http://jstayton.github.io/Miner/classes/Miner.html#method_whereNotBetween)
- [openWhere](http://jstayton.github.io/Miner/classes/Miner.html#method_openWhere)
- [closeWhere](http://jstayton.github.io/Miner/classes/Miner.html#method_closeWhere)
- [getWherePlaceholderValues](http://jstayton.github.io/Miner/classes/Miner.html#method_getWherePlaceholderValues)
- [getWhereString](http://jstayton.github.io/Miner/classes/Miner.html#method_getWhereString)
- [mergeWhereInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeWhereInto)

### GROUP BY

[](#group-by)

- [groupBy](http://jstayton.github.io/Miner/classes/Miner.html#method_groupBy)
- [getGroupByString](http://jstayton.github.io/Miner/classes/Miner.html#method_getGroupByString)
- [mergeGroupByInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeGroupByInto)

### HAVING

[](#having)

- [having](http://jstayton.github.io/Miner/classes/Miner.html#method_having)
- [andHaving](http://jstayton.github.io/Miner/classes/Miner.html#method_andHaving)
- [orHaving](http://jstayton.github.io/Miner/classes/Miner.html#method_orHaving)
- [havingIn](http://jstayton.github.io/Miner/classes/Miner.html#method_havingIn)
- [havingNotIn](http://jstayton.github.io/Miner/classes/Miner.html#method_havingNotIn)
- [havingBetween](http://jstayton.github.io/Miner/classes/Miner.html#method_havingBetween)
- [havingNotBetween](http://jstayton.github.io/Miner/classes/Miner.html#method_havingNotBetween)
- [openHaving](http://jstayton.github.io/Miner/classes/Miner.html#method_openHaving)
- [closeHaving](http://jstayton.github.io/Miner/classes/Miner.html#method_closeHaving)
- [getHavingPlaceholderValues](http://jstayton.github.io/Miner/classes/Miner.html#method_getHavingPlaceholderValues)
- [getHavingString](http://jstayton.github.io/Miner/classes/Miner.html#method_getHavingString)
- [mergeHavingInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeHavingInto)

### ORDER BY

[](#order-by)

- [orderBy](http://jstayton.github.io/Miner/classes/Miner.html#method_orderBy)
- [getOrderByString](http://jstayton.github.io/Miner/classes/Miner.html#method_getOrderByString)
- [mergeOrderByInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeOrderByInto)

### LIMIT

[](#limit)

- [limit](http://jstayton.github.io/Miner/classes/Miner.html#method_limit)
- [getLimit](http://jstayton.github.io/Miner/classes/Miner.html#method_getLimit)
- [getLimitOffset](http://jstayton.github.io/Miner/classes/Miner.html#method_getLimitOffset)
- [getLimitString](http://jstayton.github.io/Miner/classes/Miner.html#method_getLimitString)

### Statement

[](#statement)

- [execute](http://jstayton.github.io/Miner/classes/Miner.html#method_execute)
- [getStatement](http://jstayton.github.io/Miner/classes/Miner.html#method_getStatement)
- [getPlaceholderValues](http://jstayton.github.io/Miner/classes/Miner.html#method_getPlaceholderValues)
- [isSelect](http://jstayton.github.io/Miner/classes/Miner.html#method_isSelect)
- [isInsert](http://jstayton.github.io/Miner/classes/Miner.html#method_isInsert)
- [isReplace](http://jstayton.github.io/Miner/classes/Miner.html#method_isReplace)
- [isUpdate](http://jstayton.github.io/Miner/classes/Miner.html#method_isUpdate)
- [isDelete](http://jstayton.github.io/Miner/classes/Miner.html#method_isDelete)
- [\_\_toString](http://jstayton.github.io/Miner/classes/Miner.html#method___toString)
- [mergeInto](http://jstayton.github.io/Miner/classes/Miner.html#method_mergeInto)

### Connection

[](#connection)

- [setPdoConnection](http://jstayton.github.io/Miner/classes/Miner.html#method_setPdoConnection)
- [getPdoConnection](http://jstayton.github.io/Miner/classes/Miner.html#method_getPdoConnection)
- [setAutoQuote](http://jstayton.github.io/Miner/classes/Miner.html#method_setAutoQuote)
- [getAutoQuote](http://jstayton.github.io/Miner/classes/Miner.html#method_getAutoQuote)
- [autoQuote](http://jstayton.github.io/Miner/classes/Miner.html#method_autoQuote)
- [quote](http://jstayton.github.io/Miner/classes/Miner.html#method_quote)

Feedback
--------

[](#feedback)

Please open an issue to request a feature or submit a bug report. Or even if you just want to provide some feedback, I'd love to hear. I'm also available on Twitter as [@jstayton](http://twitter.com/jstayton).

Contributing
------------

[](#contributing)

1. Fork it.
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Commit your changes (`git commit -am 'Added some feature'`).
4. Push to the branch (`git push origin my-new-feature`).
5. Create a new Pull Request.

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 95.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~111 days

Recently: every ~135 days

Total

6

Last Release

4427d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d635b892fd367fbda5ec96ba77858cf14c620e9ddb8312e0f0297bc75aba5c47?d=identicon)[komeiji-satori](/maintainers/komeiji-satori)

---

Top Contributors

[![jstayton](https://avatars.githubusercontent.com/u/98357?v=4)](https://github.com/jstayton "jstayton (60 commits)")[![komeiji-satori](https://avatars.githubusercontent.com/u/18225919?v=4)](https://github.com/komeiji-satori "komeiji-satori (2 commits)")[![detook](https://avatars.githubusercontent.com/u/853431?v=4)](https://github.com/detook "detook (1 commits)")

---

Tags

mysqlsqlitepostgresqlsqlpdoqueryquerybuildercrudselectupdatedeletequeriesinsertstatementsequelstatements

### Embed Badge

![Health badge](/badges/komeiji-satori-miner/health.svg)

```
[![Health](https://phpackages.com/badges/komeiji-satori-miner/health.svg)](https://phpackages.com/packages/komeiji-satori-miner)
```

###  Alternatives

[aura/sqlquery

Object-oriented query builders for MySQL, Postgres, SQLite, and SQLServer; can be used with any database connection library.

4572.9M34](/packages/aura-sqlquery)[atlas/query

Object-oriented query builders and performers for MySQL, Postgres, SQLite, and SQLServer.

41249.0k7](/packages/atlas-query)[doctrine/dbal

Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management.

9.7k578.4M5.6k](/packages/doctrine-dbal)[nette/database

💾 Nette Database: layer with a familiar PDO-like API but much more powerful. Building queries, advanced joins, drivers for MySQL, PostgreSQL, SQLite, MS SQL Server and Oracle.

5656.7M234](/packages/nette-database)[ezsql/ezsql

Advance database access library. Make interacting with a database ridiculously easy. An universal interchangeable CRUD system.

86946.7k](/packages/ezsql-ezsql)[jv2222/ezsql

Advance database access library. Make interacting with a database ridiculously easy. An universal interchangeable CRUD system.

87311.3k2](/packages/jv2222-ezsql)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)