@haxall/haxall
    Preparing search index...

    Class Folio

    Folio database

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    type$

    Methods

    backup close closeAsync commit commitAll commitAllAsync commitAsync compare config dir equals hash isImmutable log name passwords read readAll readAllList readById readByIds readByIdsList readCount toImmutable toStr trap typeof with echo make

    Constructors

    Properties

    type$: Type

    Methods

    • Backup APIs

      Returns FolioBackup

    • Close the database synchronously (block until closed)

      Parameters

      Returns void

    • Close the database asynchronously and return future

      Returns FolioFuture

    • Convenience for commitAll with a single diff.

      Parameters

      Returns Diff

    • 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.

      Parameters

      Returns List<Diff>

    • Commit a list of diffs to the database asynchronously.

      Parameters

      Returns FolioFuture

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that  =>  0
      this > that   =>  >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3)  =>  1
      8.compare(8)  =>  0
      3 <=> 8       =>  -1  // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Configuration used to init database

      Returns FolioConfig

    • Home directory for this database

      Returns File

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Logging for this database

      Returns Log

    • Name of this database

      Returns string

    • Get storage for passwords and other secrets

      Returns PasswordStore

    • Find the first record which matches the given filter. Throw UnknownRecErr or return null based on checked flag.

      Parameters

      • filter: Filter
      • Optionalchecked: boolean

      Returns Dict

    • Match all the records against a filter and return as grid.

      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
      • trash: marker tag to include recs with trash tag
      • gridMeta: Dict to use for grid meta

      Parameters

      Returns Grid

    • Match all the records against a filter and return as list. This method uses same semantics and options as readAll.

      Parameters

      Returns List<Dict>

    • Convenience for readByIds with single id.

      Parameters

      • id: Ref
      • Optionalchecked: boolean

      Returns Dict

    • 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, then every id must be found in the project or UnknownRecErr is thrown. If checked is false, then an unknown record is returned as a row with every column set to null (including the id tag).

      Parameters

      • ids: List<Ref>
      • Optionalchecked: boolean

      Returns Grid

    • Read a list of records by id. The resulting list matches the list of ids by index (null if record not found).

      Parameters

      • ids: List<Ref>
      • Optionalchecked: boolean

      Returns List<Dict>

    • Return the number of records which match given filter. This method supports the same options as readAll.

      Parameters

      Returns number

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x()      a.trap("x", null)
      a->x = b    a.trap("x", [b])
      a->x(b)     a.trap("x", [b])
      a->x(b, c)  a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Sub-class constructor

      Parameters

      Returns Folio

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods