diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-04-19 15:47:54 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-04-21 15:58:41 +0200 |
commit | 041b70cd1cd7883a12a71612784d937361aa5efd (patch) | |
tree | 098cc98f73c5f1e71fe6b6bacc6d08cc4b921f9a /doc/ref/guile/data-stores.texi | |
parent | Remove old unit-test style seraliazation tests. (diff) | |
download | calp-041b70cd1cd7883a12a71612784d937361aa5efd.tar.gz calp-041b70cd1cd7883a12a71612784d937361aa5efd.tar.xz |
Split data-store and data-format indo separate doc pages.
Diffstat (limited to 'doc/ref/guile/data-stores.texi')
-rw-r--r-- | doc/ref/guile/data-stores.texi | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/ref/guile/data-stores.texi b/doc/ref/guile/data-stores.texi new file mode 100644 index 00000000..ec3962da --- /dev/null +++ b/doc/ref/guile/data-stores.texi @@ -0,0 +1,36 @@ +@node Data Stores +@section Data Stores +Data stores are persistant stores for events, such as databases or the +file system. Each data store can support any number of data formats, +but which is an implementation detail of that format and shouldn't be +needed information from the high level view. +@footnote{It is however important for interoperability with other programs}. + +@c (make <calendar-store> #:path ``hello'') + +@defun path store +@end defun + +@deftp {GOOPS method} get-calendar this +Returns a vcomponent object of type @code{VCALENDAR}. Should contain +all @code{VEVENT} components of this calendar. +@end deftp + +@deftp {GOOPS method} get-by-uid this uid +Return the event object with UID equal to the string @var{uid}. +@end deftp + +@deftp {GOOPS method} queue-save this event +Queue a save event of @var{event} to the store. +@end deftp + +@deftp {GOOPS method} flush this +Force write of all queued actions. +@end deftp + +@subsection VDir +[VDIR]: http://vdirsyncer.pimutils.org/en/latest/vdir.html + +@subsection File + +@subsection SQLite |