Class OrientDbStore

constructor

• new OrientDbStore(options?: OrientDbStoreOptions): OrientDbStore

  Parameters

  • options: OrientDbStoreOptions = {}

  Returns OrientDbStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): any

  Access the underlying native client for operations not wrapped here

  Returns any

insert

• insert(collection: string, doc: Record<string, unknown>): Promise<unknown>

  Insert a document into collection (class); returns its @rid/id.

  Parameters

  • collection: string
  • doc: Record<string, unknown>

  Returns Promise<unknown>

get

• get(collection: string, id: string): Promise<unknown>

  Fetch a document by @rid.

  Parameters

  • collection: string
  • id: string

  Returns Promise<unknown>

update

• update(
      collection: string,
      id: string,
      patch: Record<string, unknown>,
  ): Promise<unknown>

  Merge patch into an existing document identified by @rid.

  Parameters

  • collection: string
  • id: string
  • patch: Record<string, unknown>

  Returns Promise<unknown>

delete

• delete(collection: string, id: string): Promise<unknown>

  Delete a document identified by @rid.

  Parameters

  • collection: string
  • id: string

  Returns Promise<unknown>

query

• query(
      collection: string,
      statement: string,
      options?: OrientDbQueryOptions,
  ): Promise<unknown[]>

  Run an OrientDB SQL statement and return the resulting rows. options.params binds parameters into the statement.

  Parameters

  • collection: string
  • statement: string
  • options: OrientDbQueryOptions = {}

  Returns Promise<unknown[]>