Class Neo4jAdapter

constructor

• new Neo4jAdapter(
      registry: MetadataRegistry,
      connectionString: string,
      auth?: Neo4jAuthConfig,
  ): Neo4jAdapter

  Constructor for Neo4j adapter

  Parameters

  • registry: MetadataRegistry

    The metadata registry to use for schema information
  • connectionString: string

    The Neo4j connection string
  • auth: Neo4jAuthConfig = ...

    The Neo4j authentication (username/password)

  Returns Neo4jAdapter

Readonlytype

close

• close(): Promise<void>

  Close the Neo4j driver when done

  Returns Promise<void>

delete

• delete<T>(entityType: Type<T>, id: string | number): Promise<void>

  Delete an entity from Neo4j

  Type Parameters

  • T

  Parameters

  • entityType: Type<T>
  • id: string | number

  Returns Promise<void>

query

• query<T>(entityType: Type<T>, criteria: object): Promise<T>

  Query for a single entity by criteria

  Type Parameters

  • T

  Parameters

  • entityType: Type<T>
  • criteria: object

  Returns Promise<T>

queryMany

• queryMany<T>(entityType: Type<T>, criteria: object): Promise<T[]>

  Query for multiple entities by criteria

  Type Parameters

  • T

  Parameters

  • entityType: Type<T>
  • criteria: object

  Returns Promise<T[]>

runNativeQuery

• runNativeQuery<T = any>(query: string, params?: Record<string, any>): Promise<T>

  Execute a raw Cypher query

  Type Parameters

  • T = any

  Parameters

  • query: string
  • Optionalparams: Record<string, any>

  Returns Promise<T>

save

• save<T>(entity: T): Promise<void>

  Save an entity to Neo4j

  Type Parameters

  • T

  Parameters

  • entity: T

  Returns Promise<void>