1
1
# chillerlan/database
2
2
3
+ A PHP7 SQL client and querybuilder for the most common databases.
4
+
3
5
[ ![ version] [ packagist-badge ]] [ packagist ]
4
6
[ ![ license] [ license-badge ]] [ license ]
5
7
[ ![ Travis] [ travis-badge ]] [ travis ]
20
22
[ codeclimate-badge ] : https://img.shields.io/codeclimate/github/codemasher/php-database.svg
21
23
[ codeclimate ] : https://codeclimate.com/github/codemasher/php-database
22
24
23
- # Requirements
25
+ # Documentation
26
+
27
+ ## Requirements
24
28
- PHP 7+
29
+ - one of the supported databases, set up to work with PHP
25
30
26
- # Supported databases
31
+ ## Supported databases
27
32
- MySQL/MariaDB (native, PDO, ODBC)
28
33
- PostgreSQL (native, PDO, ODBC)
29
34
- Microsoft SQL Server (native, PDO, ODBC)
30
35
- SQLite3 (PDO)
31
36
- Firebird (PDO)
32
37
- any other database supported via PDO, ODBC or native PHP extension
33
38
34
- # Documentation
35
39
## Installation
36
- ### Using [ composer] ( https://getcomposer.org )
37
-
38
- * Terminal*
39
- ``` sh
40
- composer require chillerlan/database:dev-master
41
- ```
40
+ ** requires [ composer] ( https://getcomposer.org ) **
42
41
43
- * composer.json*
42
+ ### * composer.json*
43
+ (note: replace ` dev-master ` with a [ version boundary] ( https://getcomposer.org/doc/articles/versions.md#summary ) )
44
44
``` json
45
45
{
46
46
"require" : {
@@ -52,8 +52,9 @@ composer require chillerlan/database:dev-master
52
52
53
53
### Manual installation
54
54
Download the desired version of the package from [ master] ( https://github.com/codemasher/php-database/archive/master.zip ) or
55
- [ release] ( https://github.com/codemasher/php-database/releases ) and extract the contents to your project folder.
56
- Point the namespace ` chillerlan/Database ` to the folder ` src ` of the package.
55
+ [ release] ( https://github.com/codemasher/php-database/releases ) and extract the contents to your project folder. After that:
56
+ - run ` composer install ` to install the required dependencies and generate ` /vendor/autoload.php ` .
57
+ - if you use a custom autoloader, point the namespace ` chillerlan\Database ` to the folder ` src ` of the package
57
58
58
59
Profit!
59
60
0 commit comments