Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/belgattitude/soluble-dbwrapper
Extra minimalist but universal database wrapper
https://github.com/belgattitude/soluble-dbwrapper
database database-adapter doctrine interop minimalist mssql mysql oracle php postgresql sqlite3
Last synced: 25 days ago
JSON representation
Extra minimalist but universal database wrapper
- Host: GitHub
- URL: https://github.com/belgattitude/soluble-dbwrapper
- Owner: belgattitude
- License: mit
- Created: 2016-01-01T11:48:33.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-11-28T17:45:21.000Z (almost 4 years ago)
- Last Synced: 2024-10-04T18:36:48.120Z (about 1 month ago)
- Topics: database, database-adapter, doctrine, interop, minimalist, mssql, mysql, oracle, php, postgresql, sqlite3
- Language: PHP
- Homepage:
- Size: 453 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# soluble/dbwrapper
[](https://packagist.org/packages/soluble/dbwrapper)
[](https://travis-ci.org/belgattitude/soluble-dbwrapper)
[](https://codecov.io/gh/belgattitude/soluble-dbwrapper)
[](https://scrutinizer-ci.com/g/belgattitude/soluble-dbwrapper)
[](https://packagist.org/packages/soluble/dbwrapper)
[](https://packagist.org/packages/soluble/dbwrapper)
[](https://packagist.org/packages/soluble/dbwrapper)
## Introduction
Minimalist *(but universal)* database wrapper to rule them all *(and to not choose)*.
## Features
- Provide a generic API for handling database access across various implementations.
- Lightweight, framework adaptive and agnostic.
- Natively supports `mysqli`, `pdo_mysql`, `pdo_sqlite` drivers.
- Bridged implementations of `zend-db`, `laravel` and `doctrine`.
- Access to Oracle, SQL-Server, PostgreSql,...
- Allow to develop database portable libraries.
- Adhere to soluble programming standards.
## Requirements
- PHP 7.1 optional ext-mysqli/PDO
> For PHP 5.6+, 7.0+ or HHVM >= 3.9 look at version 1.3.
> For PHP < 5.6 take the 1.2 version
## Documentation
- [Manual](http://docs.soluble.io/soluble-dbwrapper/manual/) in progress and [API documentation](http://docs.soluble.io/soluble-dbwrapper/api/) available.
## Installation
Instant installation via [composer](http://getcomposer.org/).
```console
$ composer require soluble/dbwrapper
```
## Quick start
### Connection
Create an adapter from an existing Mysqli connection
```php
set_charset($charset);
$adapter = DbWrapper\AdapterFactory::createAdapterFromResource($conn);
```
### Querying database
Execute SQL
```php
query("select * from my_table");
foreach($results as $result) {
echo $result['my_column'];
}
```
### Get connection infos
Execute SQL
```php
getConnection();
echo $connection->getCurrentSchema();
echo $connection->getHost();
$resource = $connection->getResource();
```
## API methods
### AdapterFactory
The `DbWrapper\AdapterFactory` allows to instanciate an Adapter from en existing connection link or resource.
| Methods | Return | Comment |
|-----------------------------------------------|--------------------|-------------------------------------|
| static `createAdapterFromResource($resource)` | `AdapterInterface` | From existing resource (mysqli, pdo) |
| static `createAdapterFromDbal2($dbal)` | `AdapterInterface` | From doctrine/dbal connection |
| static `createAdapterFromCapsule5($capsule)` | `AdapterInterface` | From Laravel connection |
| static `createAdapterFromZendDb2($zend)` | `AdapterInterface` | From zend-db connection |
### AdapterInterface
The `DbWrapper\Adapter\AdapterInterface` provides common operation on your database.
| Methods | Return | Description |
|--------------------------|---------------|-----------------------------------------------|
| `query($query)` | `Resultset` | Iterable results `DbWrapper\Result\Resultset` |
| `execute($query)` | `void` | Execute command (set, ...) |
| `quoteValue($value)` | `string` | Quote value |
| `getConnection()` | `ConnectionInterface` | ConnectionInterface |
### Resultset
The `DbWrapper\Result\Resultset` is can be easily iterated through a simple foreach loop.
Additionnaly you can call the following methods :
| Methods | Return | Description |
|---------------------------------|---------------|-----------------------------------------------|
| `count()` | `int` | Count the number of results |
### ConnectionInterface
The `DbWrapper\Connection\ConnectionInterface` provides information about your connection
| Methods | Return | Description |
|--------------------------|---------------|-----------------------------------------------|
| `getCurrentSchema()` | `string|false`| Return current schema |
| `getResource()` | `mixed` | Return internal connection (pdo, mysqli...) |
| `getHost()` | `string` | Return server hostname or IP |
## Supported databases
### Native
`soluble/dbwrapper` supports natively :
| Database | PHP ext |
|------------|------------------------------------------------------|
| Mysql | mysqli, pdo_mysql |
| MariaDb | mysqli, pdo_mysql |
| Sqlite | pdo_sqlite |
For examples, see the [native drivers doc](./docs/drivers/native-drivers.md)
### *Userland* implementations
Some of the supported databases can be (incomplete list) :
| Database | Doctrine | Laravel | Zend |
|------------|------------|---------|-----------|
| Mysql | Yes | Yes | Yes |
| MariaDb | Yes | Yes | Yes |
| Sqlite | Yes | Yes | Yes |
| Oracle | Yes | No | Yes |
| Sqlserver | Yes | Yes | Yes |
| Postgres | Yes | Yes | Yes |
(...)
For examples, see the [userland drivers doc](./docs/drivers/userland-drivers.md)
## Motivations
Initially the reason behind the development of `soluble/dbwrapper` was to get
a reliable and lightweight library to abstract the `PDO_mysql` and `mysqli` driver interfaces.
Later on, while developing some libraries, I feel the need for something more framework agnostic that could still
be integrated easily into any modern framework. The *userland* drivers idea was born.
## Contributing
Contribution and pull request are more than welcome, see the [contribution guide](./CONTRIBUTING.md)
## Coding standards
* [PSR 4 Autoloader](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)
* [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)