User Tools

Site Tools


documentation:developer:zzz_archive:backend-devel:open-ils_storage_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

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 dbwellsdocumentation: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:
   * //open-ils.storage// -- **[[osrf-devel:terms#opensrf_api-namespace|API Namespace]]**\\ The [[osrf-devel:terms#opensrf_api-namespace|API Namespace]] in which the method lives.   * //open-ils.storage// -- **[[osrf-devel:terms#opensrf_api-namespace|API Namespace]]**\\ The [[osrf-devel:terms#opensrf_api-namespace|API Namespace]] in which the method lives.
     * //.cachable// -- **Access Type**\\ Denotes this method as a cadidate for server-side caching, and informs the user that the method accepts optional [[open-ils_storage_api#optional_result_caching|cache-oriented parameters]].     * //.cachable// -- **Access Type**\\ Denotes this method as a cadidate for server-side caching, and informs the user that the method accepts optional [[open-ils_storage_api#optional_result_caching|cache-oriented parameters]].
-    * //.direct// -- **Access Type**\\ This method acts directly on the underlying storage mechanism, and deals only with [[fieldmapper|Fieldmapper]] objects of the **Fieldmapper::config::copy_status type**.+    * //.direct// -- **Access Type**\\ This method acts directly on the underlying storage mechanism, and deals only with [[backend-devel:fieldmapper|Fieldmapper]] objects of the **Fieldmapper::config::copy_status type**.
       * //.config.copy_status// -- **Object Type**\\ This tells the user what object type this method deals with, in this case **Fieldmapper::config::copy_status**.       * //.config.copy_status// -- **Object Type**\\ This tells the user what object type this method deals with, in this case **Fieldmapper::config::copy_status**.
         * //.batch// -- **Action Modifier**\\ In this case, specifying that the method accepts multiple IDs and will return multiple **Fieldmapper::config::copy_status** objects.         * //.batch// -- **Action Modifier**\\ In this case, specifying that the method accepts multiple IDs and will return multiple **Fieldmapper::config::copy_status** objects.
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:fieldmapper]] object identified by the **id** passed in 
-  * **.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:fieldmapper]] objects identified by the list of **id**s passed in 
-  * **.retrieve.all** -- Returns a stream of **ALL** [[Fieldmapper]] objects of that type+  * **.retrieve.all** -- Returns a stream of **ALL** [[backend-devel:fieldmapper]] objects of that type
  
   * **.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.  If you would perfer a single return value of an array containing the objects then simply use the **.atomic** version of the method, as in:+All **search**-type methods return a stream of [[backend-devel:fieldmapper]] objects that match the requested criteria.  If you would perfer a single return value of an array containing the objects then simply use the **.atomic** version of the method, as in:
  
  open-ils.storage.cachable.direct.actor.user.search_regex.family_name.**atomic**  open-ils.storage.cachable.direct.actor.user.search_regex.family_name.**atomic**
documentation/developer/zzz_archive/backend-devel/open-ils_storage_api.1524580008.txt.gz · Last modified: 2022/02/10 13:33 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.