Do you wish to register an account?
A Query Builder and Database abstraction layer
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
Timothy Warren 60a75ebbbf Merge branch 'develop' of aviat/Query into master 1 månad sedan
apiDocumentation Update API docs 1 månad sedan
build Require 7.4, add typed properties to classes 1 månad sedan
src Minor code cleanup 1 månad sedan
tests Make sqlite-specific test more robust 1 månad sedan
.editorconfig Flatten source structure a bit 2 år sedan
.gitignore Cleanup/update build scripts/dependencies 5 månader sedan
.scrutinizer.yml Moved protected query builder methods to abstract class 6 år sedan
.travis.yml Require 7.4, add typed properties to classes 1 månad sedan
CONTRIBUTING.md Move development from fork to main repo on develop branch, test more PHP versions 3 år sedan
LICENSE.md Code Style fixes 3 år sedan
README.md Require 7.4, add typed properties to classes 1 månad sedan
RoboFile.php Implement basic 'returning' method for Postgres 2 månader sedan
composer.json Update types for limit clauses, misc improvements 1 månad sedan
phpdox.xml Implement basic 'returning' method for Postgres 2 månader sedan
phpstan.neon Remove PDOInterface to prevent conflicts in method parameters with native PDO object 2 år sedan

README.md

Query

A query builder/database abstraction layer, using prepared statements for security.

Code Coverage Scrutinizer Code Quality Latest Stable Version Total Downloads Latest Unstable Version

Requirements

  • PDO extensions for the databases you wish to use
  • PHP 7.4 or later

Databases Supported

  • MySQL 5+ / MariaDB
  • PostgreSQL 8.4+
  • SQLite

Including Query in your application

  • Install via composer and include vendor/autoload.php

Connecting

Create a connection array or object similar to this:

<?php

$params = array(
	'type' => 'mysql', // mysql, pgsql, sqlite
	'host' => 'localhost', // address or socket
	'user' => 'root',
	'pass' => '',
	'port' => '3306',
	'database' => 'test_db',

	// Only required for
	// SQLite
	'file' => '/path/to/db/file',

	// Optional parameters
	'prefix' => 'tbl_', 	// Database table prefix
	'alias' => 'old' 		// Connection name for the Query function
);

$db = Query($params);

The parameters required depend on the database.

Query function

You can use the Query() function as a reference to the last connected database. E.g.

<?php
Query()->get('table_name');

// or
$result = Query()->query($sql);

If the alias key is set in the parameters, you can refer to a specific database connection

<?php

// Set the alias in the connection parameters
$params['alias'] = 'old';

// Connect to the legacy database
Query('old')->query($sql);

Running Queries

Query is based on CodeIgniter's Query Builder class. However, it has camelCased method names, and does not implement the caching methods. For specific query builder methods, see the class documentation.

Other database methods not directly involved in building queries, are also available from the query builder object. The methods available depend on the database, but common methods are documented here.

You can also run queries manually.

To run a prepared statement, call $db->prepareExecute($sql, $params).

To run a plain query, $db->query($sql)

Retrieving Results:

An example of a moderately complex query:

<?php
$query = $db->select('id, key as k, val')
	->from('table t')
	->where('k >', 3)
	->orWhere('id !=', 5)
	->orderBy('val', 'DESC')
	->limit(3, 1)
	->get();

This will generate a query similar to (with this being the output for a PostgreSQL database):

SELECT "id", "key" AS "k", "val"
FROM "table" "t"
WHERE "k" > ?
OR "id" != ?
ORDER BY "val" DESC
LIMIT 3 OFFSET 1

The query execution methods get, getWhere, insert, insertBatch,update, and delete return a native PDOStatement object. To retrieve the results of a query, use the PDOStatement method fetch and/or fetchAll.

<?php
$query = $db->get('table_name');

$results = $query->fetchAll(PDO::FETCH_ASSOC);

Inserting / Updating

An example of an insert query:

<?php
$query = $db->set('foo', 'bar')
	->set('foobar', 'baz')
	->where('foo !=', 'bar')
	->insert('table');

An example of an update query:

<?php
$query = $db->set('foo', 'bar')
	->set('foobar', 'baz')
	->where('foo !=', 'bar')
	->update('table');

The set method can also take an array as a parameter, instead of setting individual values.