https://github.com/phrenotype/qorm
The best
https://github.com/phrenotype/qorm
activerecord database mysql orm php php-orm postgresql sql sqlite
Last synced: 7 days ago
JSON representation
The best
- Host: GitHub
- URL: https://github.com/phrenotype/qorm
- Owner: phrenotype
- License: mit
- Created: 2021-11-01T17:45:00.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-12T16:58:02.000Z (12 days ago)
- Last Synced: 2026-01-12T22:24:26.857Z (12 days ago)
- Topics: activerecord, database, mysql, orm, php, php-orm, postgresql, sql, sqlite
- Language: PHP
- Homepage:
- Size: 288 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **Q Orm**
```php
filter(['id.in' => Comment::items()->project('user')])
->order_by('id desc')
->limit(10)
->all();
```
```sql
SELECT ... FROM user WHERE id IN ( SELECT user_id FROM comment ) ORDER BY id DESC LIMIT 10
```
This is a simple orm that makes quering and generating migrations extremely easy. It **auto detects** changes in models when the user decides to make migrations, hence **removing the need to manually write migrations**.
Your data can also be moved to any other system and be fully distributed without risk of primary key collisions.
It provides all the basic pieces need to craft almost any SQL query. You end up with one query all written in SQL without having to do in PHP tasks that would have otherwise been done by SQL.
You can **automatically generate and re-use migration files**. That is, you can copy and zip your migrations folder and send it to another developer, and all they have to do is run one command and an entire copy of your schema is made. As a bonus, the migrations are written in php, so, no sql will be seen in your code (unless you want it, of course).
So all you ever do is modify your models, ask the orm to detect the changes, and when you are ready, apply the changes. It's not your job to detect or keep track of changes you've made to your models.
This way, you can focus on modelling your data without ever having to convert it to a relational schema yourself.
Also, the models are **autoloaded**. You don't need to include the folders in your autoloader.
As long as you point to the correct file(s) or folders for models and migrations, you can leave the rest to the orm.
## Why Use Q Orm ?
If you've used the django framework, you'll notice that when you `makemigrations`, the django orm automatically detects any changes you've made to your models and creates a migration file based on that.
Unfortunately, no major php orm has anything of that sorts. One has to manually define migrations based on their changes. Well, we offer that as well, but for *most* of your migrations, we'll **correctly** detect the change and let you apply the migration at your own time.
With this, you can zip your migrations folder and send it to another developer and with a single command, they will have an exact replica of your database. So, migration files are **auto-generate once, run everywhere**.
1. You can move your data anywhere because of the globally unique integer ids.
1. You don't have to write migrations by hand.
1. Model definition and schema are all in one class.
1. A powerful and smooth query api.
1. Full support for nested queries, joins and **all** set operations, irrespective of sql dialect.
1. You can compose nested queries more easily.
1. Every operation is lazy. Except stated otherwise.
1. The n+1 problem does not exist.
1. Every update, insertion, or deletion is done via transactions.
1. All operations are done on the database to speed things up and avoid race conditions.
1. Migration files can be moved to another project and simply ran, irrespective of sql flavor.
1. You will end up with a well modelled data and properly designed database without feeling forced to do so.
1. All changes to model classes are automatically detected. With this, you will hardly ever need to write your own migrations. And if you do, you have the ability to do so, even in raw sql.
## Why 'qorm.config.php' For Setup ?
In earlier versions, this orm used **.env** file for configuration. For security reasons, and mistakes that can occur during deployment, this has been dropped in favor of using a php file for configuration. The risk of leaking credentials is gone, irrespective of who the developer is. This orm assumes whoever using it has no knowledge of security and takes proactive measures to ensure data is kept secure.
TLDR; Just create a file called **qorm.config.php** in the root of your project if you do not already have one.
## Install
`composer require qorm/qorm`
## Tutorials And Setup
For the complete **setup** and **tutorials** visit [this page](docs/setup.md).
## Database Support
For now, this project only supports `MYSQL` (`MariaDB`), and `SQLITE`. Work is in progress to add support for `POSTGRESQL`.
## Dependencies
APCU is required for perculiar Id's to work.
## Contribution
To contribute, contact the email below.
## Contact
**Twitter** : [@phrenotyper](https://twitter.com/phrenotyper)
**Email** : dev@paulrobert.xyz