@haxall/haxall
    Preparing search index...

    Class Client

    Client manages a network connection to a haystack server.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Call "about" operation to query server summary info. Also see HTTP API.

      Returns Dict

    • Call the given REST operation with its request grid and return the response grid. If req is null, then an empty grid used for request. If the checked flag is true and server returns an error grid, then raise haystack::CallErr, otherwise return the grid itself.

      Parameters

      • op: string
      • Optionalreq: Grid
      • Optionalchecked: boolean

      Returns Grid

    • Close the session by sending the close op.

      Returns void

    • Commit a set of diffs. The req parameter must be a grid with a "commit" tag in the grid.meta. The rows are the items to commit. Return result as Grid or or raise haystack::CallErr if server returns error grid.

      Also see HTTP API.

      Examples:

      // add new record
      tags := ["site":Marker.val, "dis":"Example Site"])
      toCommit := Etc.makeDictGrid(["commit":"add"], tags)
      client.commit(toCommit)

      // update dis tag
      changes := ["id": orig->id, "mod":orig->mod, "dis": "New dis"]
      toCommit := Etc.makeDictGrid(["commit":"update"], changes)
      client.commit(toCommit)

      Parameters

      Returns Grid

    • 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

    • 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

    • Evaluate an Axon expression and return results as Grid. Raise haystack::CallErr if server returns error grid. Also see HTTP API.

      Parameters

      • expr: string

      Returns Grid

    • 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

    • Call "read" operation to read a record that matches the given filter. If there is more than one record, then it is undefined which one is returned. If there are no matches then return null or raise UnknownRecException based on checked flag. Raise haystack::CallErr if server returns error grid. Also see HTTP API.

      Parameters

      • filter: string
      • Optionalchecked: boolean

      Returns Dict

    • Call "read" operation to read a record all recs which match the given filter. Raise haystack::CallErr if server returns error grid. Also see HTTP API.

      Parameters

      • filter: string

      Returns Grid

    • Call "read" operation to read a record by its identifier. If the record is not found then return null or raise UnknownRecException based on checked flag. Raise haystack::CallErr if server returns error grid. Also see HTTP API.

      Parameters

      • id: JsObj
      • Optionalchecked: boolean

      Returns Dict

    • Call "read" operation to read a list of records by their identifiers. Return a grid where each row of the grid maps to the respective id list (indexes line up). If checked is true and any one of the ids cannot be resolved then raise UnknownRecErr for first id not resolved. If checked is false, then each id not found has a row where every cell is null. Raise haystack::CallErr if server returns error grid. Also see HTTP API.

      Parameters

      Returns Grid

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

      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

    • URI of endpoint such as "http://host/api/myProj/". This URI always ends in a trailing slash.

      Returns Uri

    • 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

    • Open with URI of project such as "http://host/api/myProj/". Throw IOErr for network/connection error or AuthErr if credentials are not authenticated.

      Parameters

      • uri: Uri
      • username: string
      • password: string
      • Optionalopts: Map<string, JsObj>

      Returns Client