Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thipages/quickdb
Quick SQLite/MySql database sql creation builder
https://github.com/thipages/quickdb
creation database foreign-keys index php quick sqlite
Last synced: 2 months ago
JSON representation
Quick SQLite/MySql database sql creation builder
- Host: GitHub
- URL: https://github.com/thipages/quickdb
- Owner: thipages
- License: mit
- Created: 2020-08-20T07:02:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-20T14:12:13.000Z (over 3 years ago)
- Last Synced: 2024-04-26T03:22:49.520Z (10 months ago)
- Topics: creation, database, foreign-keys, index, php, quick, sqlite
- Language: PHP
- Homepage:
- Size: 25.4 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# quickdb
Quick SQLite and MySql/MariaDB database sql creation builder
### Installation
**composer** require thipages\quickdb
### Dependency
[quicksql](https://github.com/thipages/quicksql)
### QDb class API
```php
// Creates sql database creation statements
create($definition, $options=[]):Array
// Creates insert/update/delete sql statements
insert($tableName, $keyValues):string
update($tableName, $keyValues, $where):string
delete($tableName, $keyValues, $where):string
```
**Primary keys** are automatically created as `id` field name
**Foreign keys** are automatically indexed
**`$defintion`** is an associative array
fieldDefinition follows SQLite definition rules but supports shortcuts for indexes and foreign keys
- `#INDEX` or `#UNIQUE` to add an index (unique) to the field,
- `#FK_parentTable` to associate the field to the primary key of its parent table (foreign key)
**`$options`** is an associated array for customization by merging with default
- `primarykey : string` defines the primary key common to all tables, default : `id INTEGER PRIMARY KEY AUTOINCREMENT`
- `prefield : boolean` (default:`false`). If true : all fields are prefixed by table name
- `omnifields : array` defines fields present in all tables, default:
```
// For SQLite
[
"created_at INTEGER not null default (strftime('%s','now'))",
"modified_at INTEGER not null default (strftime('%s','now'))"
]
// For MySql/MariaDB
[
"created_at TIMESTAMP not null default CURRENT_TIMESTAMP",
"modified_at TIMESTAMP not null default CURRENT_TIMESTAMP ON UPDATE current_timestamp"
]
```
Note 1 : if `modified_at` definition is present in omnifields options, it will be automatically updated on `update`
Note 2 : `strftime('%s','now')` stores UTC unixtime (sqlite)
#### Example
```php
$db=new QDb();
$db->create(
[
// MySql : VARCHAR(xx) is mandatory for MySql indexation
// MariaDB : TEXT would be ok
// SQLite : use TEXT instead - Equivalent to VARCHAR(X)
'user'=>'name VARCHAR(10) #INDEX',
'message'=>[
'content TEXT',
'userId INTEGER NOT NULL #FK_user',
'category TEXT #UNIQUE'
]
]
);
/*
For Sqlite
Array
(
[0] => PRAGMA foreign_keys=OFF;
[1] => DROP TABLE IF EXISTS user;
[2] => CREATE TABLE user (id INTEGER PRIMARY KEY AUTOINCREMENT,name VARCHAR(10),created_at INTEGER not null default (strftime('%s','now')),modified_at INTEGER not null default (str
ftime('%s','now')));
[3] => DROP INDEX IF EXISTS user_name_idx;
[4] => CREATE INDEX user_name_idx ON user (name);
[5] => DROP TABLE IF EXISTS message;
[6] => CREATE TABLE message (id INTEGER PRIMARY KEY AUTOINCREMENT,content TEXT,userId INTEGER NOT NULL ,category TEXT,created_at INTEGER not null default (strftime('%s','now')),mod
ified_at INTEGER not null default (strftime('%s','now')),FOREIGN KEY(userId) REFERENCES user(id));
[7] => DROP INDEX IF EXISTS message_category_idx;
[8] => CREATE UNIQUE INDEX message_category_idx ON message (category);
[9] => DROP INDEX IF EXISTS message_userId_idx;
[10] => CREATE INDEX message_userId_idx ON message (userId);
[11] => PRAGMA foreign_keys=ON;
)
For Mysql/MariaDB - varchar(10) for user name for compatibility
Array
(
[0] => SET FOREIGN_KEY_CHECKS=0;
[1] => DROP TABLE IF EXISTS user;
[2] => CREATE TABLE user (id INTEGER PRIMARY KEY AUTO_INCREMENT,name VARCHAR(10),created_at TIMESTAMP not null default CURRENT_TIMESTAMP,modified_at TIMESTAMP not null default CURRENT_TIMESTAMP ON UPDATE current_timestamp);
[3] => CREATE INDEX user_name_idx ON user (name);
[4] => DROP TABLE IF EXISTS message;
[5] => CREATE TABLE message (id INTEGER PRIMARY KEY AUTO_INCREMENT,content TEXT,userId INTEGER NOT NULL ,category TEXT,created_at TIMESTAMP not null default CURRENT_TIMESTAMP,modified_at TIMESTAMP not null default CURRENT_TIMESTAMP ON UPDATE current_timestamp,FOREIGN KEY(userId) REFERENCES user(id));
[6] => CREATE UNIQUE INDEX message_category_idx ON message (category);
[7] => CREATE INDEX message_userId_idx ON message (userId);
[8] => SET FOREIGN_KEY_CHECKS=1;
)
*/
```