Skip to content

Commit 865a75a

Browse files
committed
Refactor, rename 'include' to 'join'
1 parent a55d275 commit 865a75a

14 files changed

+208
-90
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ These features match features in v1 (see branch "v1"):
109109
- [ ] Permission system for databases, tables, columns and records
110110
- [ ] Multi-tenant database layouts are supported
111111
- [x] Multi-domain CORS support for cross-domain requests
112-
- [x] Combined requests with support for multiple table names
112+
- [x] Support for reading joined results from multiple tables
113113
- [x] Search support on multiple criteria
114114
- [x] Pagination, seeking, sorting and column selection
115-
- [x] Relation detection nested results (belongsTo, hasMany and HABTM)
115+
- [x] Relation detection with nested results (belongsTo, hasMany and HABTM)
116116
- [ ] ~~Relation "transforms" (of condensed JSON) for PHP and JavaScript~~
117117
- [x] Atomic increment support via PATCH (for counters)
118118
- [x] Binary fields supported with base64 encoding
@@ -215,7 +215,7 @@ Where "1" is the value of the primary key of the record that you want to read. I
215215
"created": "2018-03-05T20:12:56Z"
216216
}
217217

218-
On read operations you may apply includes.
218+
On read operations you may apply joins.
219219

220220
#### Update
221221

@@ -262,7 +262,7 @@ It will return:
262262
]
263263
}
264264

265-
On list operations you may apply filters and includes.
265+
On list operations you may apply filters and joins.
266266

267267
### Filters
268268

@@ -319,7 +319,7 @@ by adding a letter (a-f) you can create almost any reasonably complex condition
319319

320320
NB: You can only filter on the requested table (not on it's included) and filters are only applied on list calls.
321321

322-
### Includes
322+
### Joins
323323

324324
Let's say that you have a posts table that has comments (made by users) and the posts can have tags.
325325

@@ -337,7 +337,7 @@ When you want to list posts with their comments users and tags you can ask for t
337337

338338
These paths have the same root and this request can be written in URL format as:
339339

340-
GET /records/posts?include=comments,users&include=tags
340+
GET /records/posts?join=comments,users&join=tags
341341

342342
Here you are allowed to leave out the intermediate table that binds posts to tags. In this example
343343
you see all three table relation types (hasMany, belongsTo and hasAndBelongsToMany) in effect:

0 commit comments

Comments
 (0)