DataResult

A class representing the necessary operations to create the result of a query in the client database that emitted the query.

Index

Constructors

• constructor

Methods

• create
• createRelation
• fromQuery

Constructors

constructor

• new DataResult(): DataResult

• Returns DataResult

Methods

create

• create(tag: InstanceOrTag, model: InstanceOrTag, properties?: Map<InstanceOrTag, any>): DataResult

• Create a new Data Type instance with the specified InstanceOrTag, Data Type and properties.

  ---

  Parameters

  • tag: InstanceOrTag

    The unique identifier of the object instance to create.

  • model: InstanceOrTag

    The Data Type of the instance to create.

  • optionalproperties: Map<InstanceOrTag, any>

    The properties to set on the instance.

  Returns DataResult

  This DataResult instance.

createRelation

• createRelation(relation: InstanceOrTag, from: InstanceOrTag, to: InstanceOrTag): DataResult

• Create a relation between two instances with the specified Relation, from, and to instance tags.

  ---

  Parameters

  • relation: InstanceOrTag

    The type of relation to create.

  • from: InstanceOrTag

    The unique identifier of the source instance.

  • to: InstanceOrTag

    The unique identifier of the destination instance.

  Returns DataResult

  This DataResult instance.

staticfromQuery

• fromQuery(query: Query<CloudObject, any>): DataResult

• Create a new DataResult instance from the specified Query.

  ---

  Parameters

  • query: Query<CloudObject, any>

    The Query to create a DataResult from.

  Returns DataResult

  A new DataResult instance.