Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maghead/magsql
high performance cross platform sql generator
https://github.com/maghead/magsql
sql universal
Last synced: 2 months ago
JSON representation
high performance cross platform sql generator
- Host: GitHub
- URL: https://github.com/maghead/magsql
- Owner: maghead
- License: other
- Created: 2017-05-18T16:49:48.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-11T14:15:40.000Z (about 7 years ago)
- Last Synced: 2024-10-06T10:37:37.695Z (3 months ago)
- Topics: sql, universal
- Language: PHP
- Homepage:
- Size: 1.5 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Magsql - the powerful sql builder designed for PHP7
[](http://travis-ci.org/maghead/magsql)
[](https://coveralls.io/r/maghead/magsql)
[](https://packagist.org/packages/corneltek/sqlbuilder)
[](https://packagist.org/packages/corneltek/sqlbuilder)
[](https://packagist.org/packages/corneltek/sqlbuilder)
[](https://packagist.org/packages/corneltek/sqlbuilder)
[](https://packagist.org/packages/corneltek/sqlbuilder)
If you're looking for something that is not an ORM but can generate SQL for
you, you just found the right one.
Magsql is not an ORM (Object relational mapping) system, but a toolset that helps you generate
cross-platform SQL queries in PHP.
Magsql is a stand-alone library, you can simply install it through composer
or just require them (the class files) with your autoloader, and it has no
dependencies.
## Features
* Simple API, easy to remember.
* Fast & Powerful.
* Custom parameter marker support:
* Question-mark parameter marker.
* Named parameter marker.
* Configurable quote handler.
* Zero dependency.
## Synopsis
Here is a short example of using Universal SelectQuery
```php
use Magsql\Universal\Query\SelectQuery;
use Magsql\Driver\MySQLDriver;
use Magsql\Driver\PgSQLDriver;
use Magsql\Driver\SQLiteDriver;
$mysql = new MySQLDriver;
$args = new ArgumentArray;
$query = new SelectQuery;
$query->select(array('id', 'name', 'phone', 'address','confirmed'))
->from('users', 'u')
->partitions('u1', 'u2', 'u3')
->where()
->is('confirmed', true)
->in('id', [1,2,3])
;
$query
->join('posts')
->as('p')
->on('p.user_id = u.id')
;
$query
->orderBy('rand()')
->orderBy('id', 'DESC')
;
$sql = $query->toSql($mysql, $args);
var_dump($sql);
var_dump($args);
```
## A More Detailed Description
Unlike other SQL utilities, Magsql let you define the quote style and the
parameter marker type. there are 2 parameter marker type you can choose:
1. Question mark parameter marker (`?`)
2. Named parameter. (`:id`, `:name`, `:address`, `:p1`)
The above two are supported by PDO directly, and the first one is also
supported by `mysqli`, `pgsql` extension.
The API is *dead simple, easy to remember*, you can just define one query, then pass
different query driver to the query object to get a different SQL string for
your targettting platform.
It also supports cross-platform query generation, there are three types of
query (currently): **Universal**, **MySQL**, **PgSQL**. The **Universal** queries are
cross-platform, you can use them to create a cross-platform PHP API of
your database system, and the supported platforms are: **MySQL**, **PgSQL** and **SQLite**.
Universql Queries:
- CreateDatabaseQuery
- DropDatabaseQuery
- SelectQuery
- InsertQuery
- UpdateQuery
- DeleteQuery
- UnionQuery
- CreateIndexQuery
- DropIndexQuery
To see the implementation details, you can check the source code inside **Universal** namespace:
MySQL Queries:
- CreateUserQuery
- DropUserQuery
- GrantQuery
- SetPasswordQuery
For MySQL platform, the implementation is according to the specification of MySQL 5.6.
For PostgreSQL platform, the implementation is according to the specification of PostgreSQL 9.2.
## Installation
### Install through Composer
composer require corneltek/sqlbuilder
## Getting Started
[Documentation](https://github.com/maghead/magsql/wiki)
## Development
```
composer install
```
Copy the `phpunit.xml` file for your local configuration:
```sh
phpunit -c your-phpunit.xml tests
```
## Contribution
To test with mysql database:
mysql -uroot -p
CREATE DATABASE sqlbuilder CHARSET utf8;
GRANT ALL PRIVILEGES ON sqlbuilder.* TO 'testing'@'localhost' identified by '';
--- or use this to remove password for testing account
SET PASSWORD FOR testing@localhost=PASSWORD('');
To test with pgsql database:
sudo -u postgres createdb sqlbuilder
## Reference
- http://dev.mysql.com/doc/refman/5.0/en/sql-syntax.html
- http://www.postgresql.org/docs/8.2/static/sql-syntax.html
- http://www.sqlite.org/optoverview.html
## Author
Yo-An Lin (c9s)