danog/AsyncOrm
1
0
Fork 0
mirror of https://github.com/danog/AsyncOrm.git synced 2024-11-26 12:24:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Daniil Gentili 2024-11-14 17:37:16 +00:00
parent 789d857b9b
commit a7594799c7
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -182,6 +182,8 @@ If non-zero, all array elements fetched from the database will be stored in an i
All elements written to the array by the application will also be stored in an in-memory *write cache*, and flushed to the database every `cacheTtl` seconds. All elements written to the array by the application will also be stored in an in-memory *write cache*, and flushed to the database every `cacheTtl` seconds.
The cache is also flushed on shutdown by deferring an event loop callback, so make sure `EventLoop::run();` is being used to run the application, to make sure all data is flushed correctly (alternatively, `saveDbProperties` can be used to manually flush the cache on shutdown when using automatic properties, and `flushCache` in manual mode).
If the array has an [object value type (ValueType::OBJECT)](#key-and-value-types), write caching is disabled. If the array has an [object value type (ValueType::OBJECT)](#key-and-value-types), write caching is disabled.
If `cacheTtl` is 0, read and write caching is disabled. If `cacheTtl` is 0, read and write caching is disabled.