Folio
const abstract class Folio : Obj
Folio database
Sub-class constructor
Configuration used to init database
Home directory for this database
Logging for this database
Name of this database
Backup APIs
Close the database synchronously (block until closed)
Close the database asynchronously and return future
Convenience for commitAll with a single diff
Apply a list of diffs to the database in batch
Commit a list of diffs to the database asynchronously
Convenience for commitAllAsync with a single diff
Get storage for passwords and other secrets
Find the first record which matches the given filter
Match all the records against a filter and return as grid
Match all the records against a filter and return as list
Read record by id
Read a list of records by ids into a grid
Read a list of records by id
Return the number of records which match given filter
abstract FolioBackup backup()
Backup APIs
Void close(Duration? timeout := null)
Close the database synchronously (block until closed)
FolioFuture closeAsync()
Close the database asynchronously and return future
Diff commit(Diff diff)
Convenience for commitAll with a single diff.
Diff[] commitAll(Diff[] diffs)
Apply a list of diffs to the database in batch. Either all the changes are successfully applied, or else none of them are applied and an exception is raised. Return updated Diffs which encapsulate both the old and new version of each record.
If any of the records have been modified since they were read
for the given change set then ConcurrentChangeErr is thrown
unless Diff.force configured.
FolioFuture commitAllAsync(Diff[] diffs)
Commit a list of diffs to the database asynchronously.
FolioFuture commitAsync(Diff diff)
Convenience for commitAllAsync with a single diff.
const FolioConfig : config
Configuration used to init database
const File : dir
Home directory for this database
const Log : log
Logging for this database
new make(FolioConfig config)
Sub-class constructor
const Str : name
Name of this database
abstract PasswordStore passwords()
Get storage for passwords and other secrets
Dict? read(Filter filter, Bool checked := true)
Find the first record which matches the given filter. If checked is true, throw UnknownRecErr if none found. Or if checked is false return null. Recs missing read permission in current context are silently excluded from the match; a PermissionErr is never thrown.
Grid readAll(Filter filter, Dict? opts := null)
Match all the records against a filter and return as grid. Recs missing read permission in current context are silently excluded; a PermissionErr is never thrown.
Options:
- limit: max number of recs to read
- search: search string to apply in addition to filter
- sort: marker tag to sort recs by dis string
- gridMeta: Dict to use for grid meta
Dict[] readAllList(Filter filter, Dict? opts := null)
Match all the records against a filter and return as list. This method uses same options and security semantics as readAll.
Dict? readById(Ref id, Bool checked := true)
Read record by id. If checked is true, throw UnknownRecErr if not found, or throw PermissionErr if missing read permission in current context. Or if checked is false return null in those cases.
Grid readByIds(Ref[] ids, Bool checked := true)
Read a list of records by ids into a grid. The rows in the result
correspond by index to the ids list. If checked is true, throw
UnknownRecErr if any id is not found, or throw PermissionErr
if missing read permission in current context. Or if checked is false
return a row with every column set to null (including the id tag)
in those cases.
Dict?[] readByIdsList(Ref[] ids, Bool checked := true)
Read a list of records by id. The resulting list matches the list of ids by index. If checked is true, throw UnknownRecErr if any id is not found, or throw PermissionErr if missing read permission in current context. Or if checked is false return null for those items.
Int readCount(Filter filter, Dict? opts := null)
Return the number of records which match given filter. This method supports the same options and security semantics as readAll.