Interface Database

Readonly[TypeId]

query

graph

• get graph(): Hypergraph

  Returns Hypergraph

schemaRegistry

• get schemaRegistry(): SchemaRegistry

  Returns SchemaRegistry

spaceId

• get spaceId(): SpaceId

  Returns SpaceId

add

• add<T extends Entity.Unknown = Entity.Unknown>(obj: T, opts?: AddOptions): T

  Adds object to the database.

  Type Parameters

  • T extends Entity.Unknown = Entity.Unknown

  Parameters

  • obj: T
  • Optionalopts: AddOptions

  Returns T

flush

• flush(opts?: FlushOptions): Promise<void>

  Wait for all pending changes to be saved to disk. Optionaly waits for changes to be propagated to indexes and event handlers.

  Parameters

  • Optionalopts: FlushOptions

  Returns Promise<void>

getObjectById

• getObjectById<T extends Unknown = Obj<AnyProperties>>(
      id: string,
      opts?: GetObjectByIdOptions,
  ): undefined | T

  Return object by local ID.

  Type Parameters

  • T extends Unknown = Obj<AnyProperties>

  Parameters

  • id: string
  • Optionalopts: GetObjectByIdOptions

  Returns undefined | T

makeRef

• makeRef<T extends Entity.Unknown = Entity.Unknown>(dxn: DXN): Ref<T>

  Creates a reference to an existing object in the database.

  NOTE: The reference may be dangling if the object is not present in the database. NOTE: Difference from Ref.fromDXN Ref.fromDXN(dxn) returns an unhydrated reference. The .load and .target APIs will not work. db.makeRef(dxn) is preferable in cases with access to the database.

  Type Parameters

  • T extends Entity.Unknown = Entity.Unknown

  Parameters

  • dxn: DXN

  Returns Ref<T>

remove

• remove(obj: Entity.Unknown): void

  Removes object from the database.

  Parameters

  • obj: Entity.Unknown

  Returns void

toJSON

• toJSON(): object

  Returns object