Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fiedsch/sqlite-manager
Helper classes for working with SQLite Databases
https://github.com/fiedsch/sqlite-manager
Last synced: about 7 hours ago
JSON representation
Helper classes for working with SQLite Databases
- Host: GitHub
- URL: https://github.com/fiedsch/sqlite-manager
- Owner: fiedsch
- License: mit
- Created: 2018-01-27T12:49:15.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-31T05:47:50.000Z (almost 7 years ago)
- Last Synced: 2024-12-20T09:29:30.370Z (3 days ago)
- Language: PHP
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQLite Manager (Helper Library)
## Purpose
Helper classes for working with SQLite Databases.
## Examples
### Connect to a database
```php
$dbpath = '/path/to/your/sqlite-database.db';
$manager = new \Fiedsch\SqliteManager\Manager();
// @var Doctrine\DBAL\Connection
$connection = $manager->connectTo($dbpath);
```
which is mostly syntactic sugar that wraps `\Doctrine\DBAL\DriverManager::getConnection()`.
### Create a table in a database
```php
$manager = new \Fiedsch\SqliteManager\Manager();
// columns configuration
// keys are the column names,
// values are the respective column's configuration settings
$columns = [
'foo' => [
'type' => 'TEXT',
],
'bar' => [
'type' => 'REAL',
'mandatory' => true,
'unique' => true,
]
];
$sql = $manager->getCreateTableSql('mytable', $columns);
// "CREATE TABLE mytable (id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT, foo TEXT, bar REAL NOT NULL,)"
// Note the id column that will always be created!
```
Note: what is stored in `$columns[]['type']` is SQLite's "affinity"
(see. "Type Affinity" in https://www.sqlite.org/datatype3.html).
### Add a column to an existing table
```php
$manager = new \Fiedsch\SqliteManager\Manager();
// column configuration
$colconfig = [
'type' => 'REAL',
'mandatory' => true,
'default' => 1.5,
];
$sql = $manager->getAddColumnSql('foo', 'bar', $colconfig);
// "ALTER TABLE foo ADD COLUMN bar REAL NOT NULL DEFAULT '1.5'"
```
```php
$manager = new \Fiedsch\SqliteManager\Manager();
// column configuration
$colconfig = [
'type' => 'REAL',
'unique' => true,
];
$sql = $manager->getAddColumnSql('foo', 'bar', $colconfig);
// will throw a \RuntimeException as you can not add a unique column
// (if the table already contains data, which we assume)
```
### Augment and check configuration
```php
$configuration = [
'type' => 'TEXT'
];
$checker = new ColumnConfiguration($configuration);
$checker->hasErrors(); // false
$checker->getErrors(); // []
$checker->getConfiguration();
// [
// 'type' => 'TEXT',
// 'mandatory' => false,
// 'unique' => false,
// 'default' => null
// ]
```
For column types see https://www.sqlite.org/datatype3.html
For more Examples see the unit tests located in `tests`.
## TODO (Roadmap)
* Test existing table matches a column configuration
* Add columns if above test fails
* Add new features if required. Feel free to open an issue or create a pull request.