documentation:developer:zzz_archive:backend-devel:open-ils_storage_api
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
documentation:developer:zzz_archive:backend-devel:open-ils_storage_api [2018/04/24 10:26] – ↷ Page moved from backend-devel:open-ils_storage_api to documentation:developer:zzz_archive:backend-devel:open-ils_storage_api dbwells | documentation:developer:zzz_archive:backend-devel:open-ils_storage_api [2022/02/10 13:34] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 10: | Line 10: | ||
* // | * // | ||
* // | * // | ||
- | * //.direct// -- **Access Type**\\ This method acts directly on the underlying storage mechanism, and deals only with [[fieldmapper|Fieldmapper]] objects of the **Fieldmapper:: | + | * //.direct// -- **Access Type**\\ This method acts directly on the underlying storage mechanism, and deals only with [[backend-devel: |
* // | * // | ||
* //.batch// -- **Action Modifier**\\ In this case, specifying that the method accepts multiple IDs and will return multiple **Fieldmapper:: | * //.batch// -- **Action Modifier**\\ In this case, specifying that the method accepts multiple IDs and will return multiple **Fieldmapper:: | ||
Line 47: | Line 47: | ||
* **.batch.create** -- Returns the number of objects created | * **.batch.create** -- Returns the number of objects created | ||
- | * **.retrieve** -- Returns the [[Fieldmapper]] object identified by the **id** passed in | + | * **.retrieve** -- Returns the [[backend-devel: |
- | * **.batch.retrieve** -- Returns a stream of [[Fieldmapper]] objects identified by the list of **id**s passed in | + | * **.batch.retrieve** -- Returns a stream of [[backend-devel: |
- | * **.retrieve.all** -- Returns a stream of **ALL** [[Fieldmapper]] objects of that type | + | * **.retrieve.all** -- Returns a stream of **ALL** [[backend-devel: |
* **.update** -- Returns **1** on success, **0** on failure | * **.update** -- Returns **1** on success, **0** on failure | ||
Line 80: | Line 80: | ||
=== Return types === | === Return types === | ||
- | All **search**-type methods return a stream of [[Fieldmapper]] objects that match the requested criteria. | + | All **search**-type methods return a stream of [[backend-devel: |
| |
documentation/developer/zzz_archive/backend-devel/open-ils_storage_api.1524580008.txt.gz · Last modified: 2022/02/10 13:33 (external edit)