Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit d2d5614

Browse files
author
Dekel Barzilay
committed
Added the new schema service option & params operator to the docs
1 parent f1e8558 commit d2d5614

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,20 +92,27 @@ module.exports = function(app) {
9292
### Service Options
9393

9494
- `model` (**required**) - The Objection model definition
95+
9596
- `id` (_optional_, default: `model.idColumn` or `'id'`) - The name of the id field property. Use
9697
array of strings for composite primary keys
97-
- `events` (_optional_) - A list of
98+
99+
- `events` (_optional_) - List of
98100
[custom service events](https://docs.feathersjs.com/api/events.html#custom-events)
99101
sent by this service
100-
- `paginate` (_optional_) - A
101-
[pagination object](https://docs.feathersjs.com/api/databases/common.html#pagination)
102+
103+
- `paginate` (_optional_) - [Pagination object](https://docs.feathersjs.com/api/databases/common.html#pagination)
102104
containing a `default` and `max` page size
105+
103106
- `multi` (_optional_) - Allow `create` with arrays and `update` and `remove`
104107
with `id` `null` to change multiple items. Can be `true` for all methods or an
105108
array of allowed methods (e.g. `[ 'remove', 'create' ]`)
106-
- `whitelist` (_optional_) - A list of additional query operators to allow (e.g.
109+
110+
- `whitelist` (_optional_) - List of additional query operators to allow (e.g.
107111
`[ '$eager', '$joinRelation' ]`)
108112

113+
- `schema` (_optional_) - Database schema to use with all the service queries (e.g.
114+
`public`). See [`withSchema`](https://vincit.github.io/objection.js/api/query-builder/find-methods.html#withschema) documentation.
115+
109116
### Default Query Operators
110117

111118
Starting at version 2.0.0 `feathers-objection` converts queries securely. If you
@@ -238,6 +245,10 @@ Note that all this eager related options are optional.
238245
merges on top of the `eagerOptions` service option.
239246
See [`GraphOptions`](https://vincit.github.io/objection.js/api/types/#type-graphoptions)
240247
documentation.
248+
249+
- **`schema`** - Database schema to use with the query (e.g. `public`)
250+
See [`withSchema`](https://vincit.github.io/objection.js/api/query-builder/find-methods.html#withschema)
251+
documentation.
241252

242253
### Composite primary keys
243254

0 commit comments

Comments
 (0)