Skip to content

Commit 5830b1e

Browse files
author
Composite PHP
committed
Remove ORM mentions from the README
1 parent 7efbe27 commit 5830b1e

File tree

2 files changed

+9
-22
lines changed

2 files changed

+9
-22
lines changed

README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,49 +3,36 @@
33
[![Build Status](https://github.com/compositephp/db/actions/workflows/main.yml/badge.svg)](https://github.com/compositephp/db/actions)
44
[![Codecov](https://codecov.io/gh/compositephp/db/branch/master/graph/badge.svg)](https://codecov.io/gh/compositephp/db/)
55

6-
Composite DB is lightweight and fast PHP ORM, DataMapper and Table Gateway which allows you to represent your SQL tables
6+
Composite DB is lightweight and fast PHP DataMapper and Table Gateway which allows you to represent your SQL tables
77
scheme in OOP style using full power of PHP 8.1+ class syntax.
88

99
It also gives you CRUD, query builder and automatic caching out of the box, so you can start
1010
to work with your database from php code in a minutes!
1111

1212
Overview:
13-
* [Mission](#mission)
13+
* [Features](#features)
1414
* [Requirements](#requirements)
1515
* [Installation](#installation)
1616
* [Quick example](#quick-example)
1717
* [Documentation](doc/README.md)
1818

19-
## Mission
20-
You probably may ask, why do you need another ORM if there are already popular Doctrine, CycleORM, etc.?
21-
22-
Composite DB solves multiple problems:
19+
## Features
2320

2421
* **Lightweight** - easier entity schema, no getters and setters, you don't need attributes for each column definition,
2522
just use native php class syntax.
26-
* **Speed** - it's 1.5x faster in pure SQL queries mode and many times faster in automatic caching mode.
27-
* **Easy caching** - gives you CRUD operations caching out of the box and in general its much easier to work with cached "selects".
23+
* **Speed** - it's 1.5x faster in pure SQL queries mode and many times faster in automatic caching mode (see [benchmark](https://github.com/compositephp/php-orm-benchmark)).
24+
* **Easy caching** - gives you CRUD operations caching out of the box and in general it's much easier to work with cached "selects".
2825
* **Strict types** - Composite DB forces you to be more strict typed and makes your IDE happy.
2926
* **Hydration** - you can serialize your Entities to plain array or json and deserialize them back.
30-
* **Flexibility** - gives you more freedom to extend Repositories, for example its easier to build sharding tables.
27+
* **Flexibility** - gives you more freedom to extend Repositories, for example it's easier to build sharding tables.
3128
* **Code generation** - you can generate Entity and Repository classes from your SQL tables.
32-
* **Division of responsibility** - there is no "god" entity manager, every Entity has its own Repository class and its the only entry point to make queries to your table.
29+
* **Division of responsibility** - every Entity has its own Repository class, and it's the only entry point to make queries to your table.
3330

3431
It also has many popular features such as:
3532

3633
* **Query Builder** - build your queries with constructor, based on [doctrine/dbal](https://github.com/doctrine/dbal)
3734
* **Migrations** - synchronise your php entities with database tables
3835

39-
But there is 1 sacrifice for all these features - there is no support for relations in Composite DB. Its too much
40-
uncontrollable magic and hidden bottlenecks with "JOINs" and its not possible to implement automatic caching with
41-
relations. We recommend to have full control and make several cached select queries instead of "JOINs".
42-
43-
### When you shouldn't use Composite DB
44-
45-
1. If you have intricate structure with many foreign keys in your database
46-
2. You 100% sure in your indexes and fully trust "JOINs" performance
47-
3. You dont want to do extra cached select queries and want some magic
48-
4936
## Requirements
5037

5138
* PHP 8.1+
@@ -180,7 +167,7 @@ $user = User::fromArray([
180167
]);
181168
```
182169
183-
And thats it, no special getters or setters, no "behaviours" or extra code, smart entity casts everything automatically.
170+
And that's it, no special getters or setters, no "behaviours" or extra code, smart entity casts everything automatically.
184171
More about Entity and supported auto casting types you can find [here](doc/entity.md).
185172
186173
## License:

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "compositephp/db",
3-
"description": "PHP 8.1+ ORM and Table Gateway",
3+
"description": "PHP 8.1+ DataMapper and Table Gateway",
44
"type": "library",
55
"license": "MIT",
66
"minimum-stability": "dev",

0 commit comments

Comments
 (0)