|
1 | 1 | # phpdb-adapter-sqlite |
2 | 2 |
|
3 | | -This package provides SQLite support for php-db. |
| 3 | +<!-- markdownlint-disable MD013 --> |
| 4 | + |
| 5 | +This package provides [SQLite][sqlite] support for [php-db][php-db], which is a continuation of [laminas-db][laminas-db]. |
| 6 | + |
| 7 | +[](https://github.com/php-db/phpdb-sqlite/actions/workflows/continuous-integration.yml) |
| 8 | + |
| 9 | +## Prerequisites |
| 10 | + |
| 11 | +You'll need the following to use the package: |
| 12 | + |
| 13 | +- PHP 8.2 or above with the [PDO][php-pdo-extension] and [PDO SQLite][php-pdo-sqlite-extension] extensions |
| 14 | +- [Composer][composer] installed globally |
| 15 | + |
| 16 | +## Quick Start |
| 17 | + |
| 18 | +To get started with the project, add it to your project with the following command: |
| 19 | + |
| 20 | +```bash |
| 21 | +composer require php-db/phpdb-sqlite |
| 22 | +``` |
| 23 | + |
| 24 | +## Contributing |
| 25 | + |
| 26 | +Please be sure to read the [contributor's guide](https://github.com/php-db/.github/blob/main/CONTRIBUTING.md) for general information on contributing. |
| 27 | +This section outlines specifics for php-db. |
| 28 | + |
| 29 | +### Test suites |
| 30 | + |
| 31 | +The `phpunit.xml.dist` file defines two test suites, "unit test" and "integration test". |
| 32 | +You can run one or the other using the `--testsuite` option to `phpunit`: |
| 33 | + |
| 34 | +```bash |
| 35 | +./vendor/bin/phpunit --testsuite "unit test" # unit tests only |
| 36 | +./vendor/bin/phpunit --testsuite "integration test" # integration tests only |
| 37 | +``` |
| 38 | + |
| 39 | +Unit tests do not require additional functionality beyond having the appropriate database extensions present and loaded in your PHP binary. |
| 40 | + |
| 41 | +--- |
| 42 | + |
| 43 | +- File issues at <https://github.com/php-db/phpdb-sqlite/issues> |
| 44 | +- Documentation is at <https://docs.php-db.dev> |
| 45 | + |
| 46 | +[composer]: https://getcomposer.org |
| 47 | +[laminas-db]: https://docs.laminas.dev/laminas-db/ |
| 48 | +[php-db]: https://github.com/php-db/phpdb |
| 49 | +[php-pdo-extension]: https://www.php.net/manual/en/pdo.installation.php |
| 50 | +[php-pdo-sqlite-extension]: https://www.php.net/manual/en/ref.pdo-sqlite.php |
| 51 | +[sqlite]: https://sqlite.org/docs.html |
| 52 | + |
| 53 | +<!-- markdownlint-enable MD013 --> |
0 commit comments