Neo4jRepository

Defined in: neo4j-repository.ts:16

A Mantle GraphRepository<T> implementation backed by Neo4j.

Subclasses must declare readonly label: string — the Neo4j node label. Each node stores a UUID id property plus all entity fields as node properties.

Type Parameters

T

T extends Record<string, unknown>

The entity shape. Must extend Record<string, unknown>.

Implements

• GraphRepository<T>

Constructors

Constructor

new Neo4jRepository<T>(app): Neo4jRepository<T>

Defined in: neo4j-repository.ts:39

Parameters

app

MantleApplication

Returns

Neo4jRepository<T>

Properties

createdAtField

readonly createdAtField: string = "createdAt"

Defined in: neo4j-repository.ts:30

Property written for auto-managed creation timestamps.

Default

"createdAt"

---

database

protected readonly database: string

Defined in: neo4j-repository.ts:18

---

driver

protected readonly driver: Driver

Defined in: neo4j-repository.ts:17

---

fieldMap

readonly fieldMap: Record<string, string> = {}

Defined in: neo4j-repository.ts:37

Entity-field-to-node-property overrides, for a label whose property names don’t match the entity (e.g. a brownfield graph using snake_case).

Default

{}

---

idField

readonly idField: string = "id"

Defined in: neo4j-repository.ts:24

The property used as the node identifier.

Default

"id"

---

label

abstract readonly label: string

Defined in: neo4j-repository.ts:21

The Neo4j node label. Override in subclass.

---

timestamps

readonly timestamps: boolean = true

Defined in: neo4j-repository.ts:27

When true, auto-write createdAt / updatedAt ISO-8601 timestamps.

Default

true

---

updatedAtField

readonly updatedAtField: string = "updatedAt"

Defined in: neo4j-repository.ts:32

Property written for auto-managed update timestamps.

Default

"updatedAt"

Methods

buildProps()

protected buildProps(data): Record<string, unknown>

Defined in: neo4j-repository.ts:94

Parameters

data

Partial<T>

Returns

Record<string, unknown>

---

createNode()

createNode(data): Promise<T>

Defined in: neo4j-repository.ts:102

Create a node

Parameters

data

Partial<T>

Returns

Promise<T>

Implementation of

GraphRepository.createNode

---

createRelationship()

createRelationship(fromId, toId, type, properties?): Promise<void>

Defined in: neo4j-repository.ts:182

Create a directed relationship between two nodes

Parameters

fromId

Id

toId

Id

type

string

properties?

Record<string, unknown>

Returns

Promise<void>

Implementation of

GraphRepository.createRelationship

---

deleteNode()

deleteNode(id): Promise<T>

Defined in: neo4j-repository.ts:212

Delete a node and all its relationships

Parameters

id

Id

Returns

Promise<T>

Implementation of

GraphRepository.deleteNode

---

describe()

describe(): RepositoryCapabilities

Defined in: neo4j-repository.ts:44

Optional capability introspection. All

Returns

RepositoryCapabilities

Mantlejs

adapters implement it; user repositories may omit it.

Implementation of

GraphRepository.describe

---

findNodeById()

findNodeById(id): Promise<T | null>

Defined in: neo4j-repository.ts:124

Find a node by ID

Parameters

id

Id

Returns

Promise<T | null>

Implementation of

GraphRepository.findNodeById

---

findNodes()

findNodes(params?): Promise<T[]>

Defined in: neo4j-repository.ts:139

Find nodes matching properties

Parameters

params?

QueryParams

Returns

Promise<T[]>

Implementation of

GraphRepository.findNodes

---

openSession()

protected openSession(): Session

Defined in: neo4j-repository.ts:59

Returns

Session

---

raw()

raw<R>(query, params?): Promise<R[]>

Defined in: neo4j-repository.ts:228

Execute a raw query in the adapter’s native graph language (Cypher for Neo4j, AQL for ArangoDB, …).

Type Parameters

R

R = T

Parameters

query

string

params?

Record<string, unknown>

Returns

Promise<R[]>

Implementation of

GraphRepository.raw

---

recordToNode()

protected recordToNode(record): T

Defined in: neo4j-repository.ts:74

Parameters

record

Record<RecordShape<PropertyKey, any>, PropertyKey, RecordShape<PropertyKey, number>>

Returns

T

---

run()

protected run<R>(fn): Promise<R>

Defined in: neo4j-repository.ts:63

Type Parameters

R

R

Parameters

fn

(session) => Promise<R>

Returns

Promise<R>

---

toEntity()

protected toEntity(props): T

Defined in: neo4j-repository.ts:90

Parameters

props

Record<string, unknown>

Returns

T

---

toEntityField()

protected toEntityField(field): string

Defined in: neo4j-repository.ts:85

Translates a node property name back to its entity field name — the inverse of toField.

Parameters

field

string

Returns

string

---

toField()

protected toField(field): string

Defined in: neo4j-repository.ts:80

Translates an entity field name to its node property name (fieldMap override, else identity).

Parameters

field

string

Returns

string

---

traverse()

traverse(startId, relation, depth?): Promise<T[]>

Defined in: neo4j-repository.ts:198

Traverse relationships from a starting node

Parameters

startId

Id

relation

string

depth?

number = 1

Returns

Promise<T[]>

Implementation of

GraphRepository.traverse

---

withTransaction()

withTransaction<R>(fn): Promise<R>

Defined in: neo4j-repository.ts:252

Type Parameters

R

R

Parameters

fn

(repo) => Promise<R>

Returns

Promise<R>

---

wrapError()

protected wrapError(err): Error

Defined in: neo4j-repository.ts:273

Parameters

err

unknown

Returns

Error