backend-devel:open-ils_cstore_api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
backend-devel:open-ils_cstore_api [2008/12/01 22:14] – Cleaning up example syntax; Using OpenSRF 1.0+ classing syntax miker | backend-devel:open-ils_cstore_api [2022/02/10 13:34] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ===== open-ils.cstore interface ==== | ||
+ | |||
+ | All methods are prefixed with // | ||
+ | |||
+ | === transaction.begin === | ||
+ | * returns new transaction ID on success, execption on failure | ||
+ | |||
+ | < | ||
+ | |||
+ | === transaction.{commit|rollback} === | ||
+ | * completes a transaction block | ||
+ | * returns transaction ID on success, execption on failure | ||
+ | |||
+ | < | ||
+ | |||
+ | < | ||
+ | |||
+ | === savepoint.set === | ||
+ | * **new savepoint name** -- existing savepoints are moved forward | ||
+ | * returns new savepoint name on success, exception on failure | ||
+ | |||
+ | < | ||
+ | |||
+ | === savepoint.{release|rollback} === | ||
+ | * **savepoint name** | ||
+ | * returns savepoint name on success, exception on failure | ||
+ | |||
+ | < | ||
+ | |||
+ | < | ||
+ | |||
+ | === direct.{object}.retrieve === | ||
+ | * **pkey value** | ||
+ | * **select/ | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | |||
+ | < | ||
+ | |||
+ | === direct.{object}.search[.atomic] === | ||
+ | * **abstract search style blob** -- { " | ||
+ | * **select/ | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | |||
+ | < | ||
+ | |||
+ | //Stream all values in the table, sorted by description field// | ||
+ | |||
+ | < | ||
+ | |||
+ | === direct.{object}.id_list[.atomic] === | ||
+ | * same as .search, but returns a stream (or an array, for **.atomic**) of object pkey values | ||
+ | |||
+ | === direct.{object}.create === | ||
+ | * **new object** | ||
+ | * returns new object as represented in DB | ||
+ | |||
+ | < | ||
+ | |||
+ | === direct.{object}.update === | ||
+ | * **modified object** | ||
+ | * returns object ID on success, NULL on failure | ||
+ | |||
+ | < | ||
+ | |||
+ | === direct.{object}.delete === | ||
+ | * **object or pkey value for deletion** | ||
+ | * returns old object ID on success, NULL on failure | ||
+ | |||
+ | < | ||