Class DB<Schema>

Type Parameters

Schema extends FullGraph = Empty

Hierarchy

Index

Constructors

constructor

new DB<Schema>(driver: Driver, options?: {
database: undefined | string;
}): DB<Schema>
Type Parameters
- Schema extends FullGraph = Empty
Parameters
- driver: Driver
  
  The neo4j driver
- options: {
  database: undefined | string;
  } = {}
  
  The database to use and the number of sessions to use
  - database: undefined | string
Returns DB<Schema>
- Defined in neo4j-ogm/src/db.ts:26

Properties

`Readonly` database

database: string

defs

defs: Record<keyof Schema, NodeShape<string, readonly string[], Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>, {}, {}>> = ...

`Readonly` driver

driver: Driver

idgen

idgen: (() => string) = cuid

Type declaration

- (): string
- This id ($id) generator function, defaults to cuid
  
  Returns string

`Protected` log

log: {
query: Debugger;
}

Type declaration

query: Debugger

`Readonly` sessions

sessions: Set<Session> = ...

The underlying sessions

Methods

_create

_create(label: string, data: OneOrMany<Record<string, unknown>>): Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>
n is returned as a node
Parameters
- label: string
- data: OneOrMany<Record<string, unknown>>
Returns Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>
- Defined in neo4j-ogm/src/db.ts:124

_fetch

_fetch($id: string): Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>
n is returned as a node
Parameters
- $id: string
Returns Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>
- Defined in neo4j-ogm/src/db.ts:117

_link

_link(from: string, to: string, rel: string, data: Record<string, unknown>): Promise<QueryResult<{
    from: unknown;
    r: Relationship<Integer, Properties, string>;
    to: unknown;
}>>
r is returned as a relation
Parameters
- from: string
- to: string
- rel: string
- data: Record<string, unknown>
Returns Promise<QueryResult<{
    from: unknown;
    r: Relationship<Integer, Properties, string>;
    to: unknown;
}>>
- Defined in neo4j-ogm/src/db.ts:152

_update

_update($id: string, data: Record<string, unknown>, old?: Record<string, unknown>): Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>
n is returned as a node
Parameters
- $id: string
- data: Record<string, unknown>
- Optional old: Record<string, unknown>
Returns Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>
- Defined in neo4j-ogm/src/db.ts:136

_update_link

_update_link($id: string, data: Record<string, unknown>, old?: Record<string, unknown>): Promise<QueryResult<{
r: Relationship<Integer, Properties, string>;
}>>
r is returned as a relation
Parameters
- $id: string
- data: Record<string, unknown>
- Optional old: Record<string, unknown>
Returns Promise<QueryResult<{
r: Relationship<Integer, Properties, string>;
}>>
- Defined in neo4j-ogm/src/db.ts:172

close

close(): Promise<void>
Close all underlying sessions

Returns Promise<void>
- Defined in neo4j-ogm/src/db.ts:65

create

create<T>(type: T, data: OneOrMany<{ [ K in string | number | symbol]: Schema[T]["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }>): Promise<Vertex<Schema, T, Schema[T]>[]>
Create a new node

Returns
This will always return an array, even if only one node was created
Type Parameters
- T extends string | number | symbol
Parameters
- type: T
- data: OneOrMany<{ [ K in string | number | symbol]: Schema[T]["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }>
Returns Promise<Vertex<Schema, T, Schema[T]>[]>
- Defined in neo4j-ogm/src/db.ts:191

define

define<N>(name: N): DB<Schema & { [ k in string]: NodeShape<N, readonly string[], Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>, {}, {}> }>
Define a new node (vertex, entity) type

Returns
Self, for chaining
Type Parameters
- N extends string
Parameters
- name: N
  
  The name of the node type
Returns DB<Schema & { [ k in string]: NodeShape<N, readonly string[], Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>, {}, {}> }>
- Defined in neo4j-ogm/src/db.ts:42
define<N, L>(name: N, labels: L): DB<Schema & { [ k in string]: NodeShape<N, L, Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>, {}, {}> }>
Type Parameters
- N extends string
- L extends readonly string[]
Parameters
- name: N
- labels: L
Returns DB<Schema & { [ k in string]: NodeShape<N, L, Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>, {}, {}> }>
- Defined in neo4j-ogm/src/db.ts:43
define<N, P>(name: N, props: P): DB<Schema & { [ k in string]: NodeShape<N, [], P, { [ K in string | number | symbol as P[K] extends PropValue ? K : never]: P[K] extends PropValue ? any[any] : never }, { [ K in string | number | symbol as P[K] extends RelationShape<boolean, string, readonly string[], Record<string, PropValue>> ? K : never]: P[K] extends RelationShape<boolean, string, readonly string[], Record<string, PropValue>> ? any[any] : never }> }>
Type Parameters
- N extends string
- P extends Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>
Parameters
- name: N
- props: P
Returns DB<Schema & { [ k in string]: NodeShape<N, [], P, { [ K in string | number | symbol as P[K] extends PropValue ? K : never]: P[K] extends PropValue ? any[any] : never }, { [ K in string | number | symbol as P[K] extends RelationShape<boolean, string, readonly string[], Record<string, PropValue>> ? K : never]: P[K] extends RelationShape<boolean, string, readonly string[], Record<string, PropValue>> ? any[any] : never }> }>
- Defined in neo4j-ogm/src/db.ts:47
define<N, L, P>(name: N, labels: L, props: P): DB<Schema & { [ k in string]: NodeShape<N, L, P, { [ K in string | number | symbol as P[K] extends PropValue ? K : never]: P[K] extends PropValue ? any[any] : never }, { [ K in string | number | symbol as P[K] extends RelationShape<boolean, string, readonly string[], Record<string, PropValue>> ? K : never]: P[K] extends RelationShape<boolean, string, readonly string[], Record<string, PropValue>> ? any[any] : never }> }>
Type Parameters
- N extends string
- L extends readonly string[]
- P extends Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>
Parameters
- name: N
- labels: L
- props: P
Returns DB<Schema & { [ k in string]: NodeShape<N, L, P, { [ K in string | number | symbol as P[K] extends PropValue ? K : never]: P[K] extends PropValue ? any[any] : never }, { [ K in string | number | symbol as P[K] extends RelationShape<boolean, string, readonly string[], Record<string, PropValue>> ? K : never]: P[K] extends RelationShape<boolean, string, readonly string[], Record<string, PropValue>> ? any[any] : never }> }>
- Defined in neo4j-ogm/src/db.ts:51

fetch

fetch<N>(node: {
$id: string;
}, label: N): Promise<Vertex<Schema, N, Schema[N]>>
Type Parameters
- N extends string | number | symbol
Parameters
- node: {
  $id: string;
  }
  - $id: string
- label: N
Returns Promise<Vertex<Schema, N, Schema[N]>>
- Defined in neo4j-ogm/src/db.ts:243

find

find<N>(label: N, query?: {
    limit?: number;
    order?: OneOrMany<[keyof Schema[N]["props"], "ASC" | "DESC"]>;
    where?: Partial<{ [ K in string | number | symbol]: Schema[N]["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }> & {
        $id?: string;
    };
}): Promise<Vertex<Schema, N, Schema[N]>[]>
Type Parameters
- N extends string | number | symbol
Parameters
- label: N
- Optional query: {
      limit?: number;
      order?: OneOrMany<[keyof Schema[N]["props"], "ASC" | "DESC"]>;
      where?: Partial<{ [ K in string | number | symbol]: Schema[N]["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }> & {
          $id?: string;
      };
  }
  - Optional limit?: number
  - Optional order?: OneOrMany<[keyof Schema[N]["props"], "ASC" | "DESC"]>
  - Optional where?: Partial<{ [ K in string | number | symbol]: Schema[N]["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }> & {
    $id?: string;
    }
Returns Promise<Vertex<Schema, N, Schema[N]>[]>
- Defined in neo4j-ogm/src/db.ts:203

reset

reset(check: "DELETE ALL DATA"): Promise<void>
Delete all data in the database
Parameters
- check: "DELETE ALL DATA"
  
  string to confirm you want to delete all data
Returns Promise<void>
- Defined in neo4j-ogm/src/db.ts:107

run

run<Q>(query: Q, ...params: ParamNames<Q>[number] extends never ? [Record<string, unknown>?] : [Params<Q>]): Promise<QueryResult<keyof Returns<Q> extends never ? {
[key: string]: unknown;
} : { [ key in string | number | symbol]: Returns<Q>[key] extends "Node" ? Node<Integer, Properties, string> : Returns<Q>[key] extends "Relationship" ? Relationship<Integer, Properties, string> : unknown }>>
Run a typed raw query
Type Parameters
- Q extends string
Parameters
- query: Q
  
  Query in Cypher
- Rest ...params: ParamNames<Q>[number] extends never ? [Record<string, unknown>?] : [Params<Q>]
  
  Parameters to pass to the query
Returns Promise<QueryResult<keyof Returns<Q> extends never ? {
[key: string]: unknown;
} : { [ key in string | number | symbol]: Returns<Q>[key] extends "Node" ? Node<Integer, Properties, string> : Returns<Q>[key] extends "Relationship" ? Relationship<Integer, Properties, string> : unknown }>>
- Defined in neo4j-ogm/src/db.ts:74

vertexify

vertexify<N>(node: Node<Integer, Properties, string>, name: N): Vertex<Schema, N, Schema[N]>
Type Parameters
- N extends string | number | symbol
Parameters
- node: Node<Integer, Properties, string>
- name: N
Returns Vertex<Schema, N, Schema[N]>
- Defined in neo4j-ogm/src/db.ts:251

Class DB<Schema>

Type Parameters

Schema extends FullGraph = Empty

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Schema extends FullGraph = Empty

Parameters

driver: Driver

options: { database: undefined | string; } = {}

database: undefined | string

Returns DB<Schema>

Properties

Readonly database

defs

Readonly driver

idgen

Type declaration

Returns string

Protected log

Type declaration

query: Debugger

Readonly sessions

Methods

_create

Parameters

label: string

data: OneOrMany<Record<string, unknown>>

Returns Promise<QueryResult<{ n: Node<Integer, Properties, string>; }>>

_fetch

Parameters

$id: string

Returns Promise<QueryResult<{ n: Node<Integer, Properties, string>; }>>

_link

Parameters

from: string

to: string

rel: string

data: Record<string, unknown>

Returns Promise<QueryResult<{ from: unknown; r: Relationship<Integer, Properties, string>; to: unknown; }>>

_update

Parameters

$id: string

data: Record<string, unknown>

Optional old: Record<string, unknown>

Returns Promise<QueryResult<{ n: Node<Integer, Properties, string>; }>>

_update_link

Parameters

$id: string

data: Record<string, unknown>

Optional old: Record<string, unknown>

Returns Promise<QueryResult<{ r: Relationship<Integer, Properties, string>; }>>

close

Returns Promise<void>

create

Returns

Type Parameters

T extends string | number | symbol

Parameters

type: T

data: OneOrMany<{ [ K in string | number | symbol]: Schema[T]["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }>

Returns Promise<Vertex<Schema, T, Schema[T]>[]>

define

Returns

Type Parameters

N extends string

Parameters

name: N

Returns DB<Schema & { [ k in string]: NodeShape<N, readonly string[], Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>, {}, {}> }>

Type Parameters

N extends string

L extends readonly string[]

Parameters

name: N

labels: L

options: {
database: undefined | string;
} = {}

`Readonly` database

`Readonly` driver

`Protected` log

`Readonly` sessions

Returns Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>

Returns Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>

Returns Promise<QueryResult<{
from: unknown;
r: Relationship<Integer, Properties, string>;
to: unknown;
}>>

`Optional` old: Record<string, unknown>

Returns Promise<QueryResult<{
n: Node<Integer, Properties, string>;
}>>

`Optional` old: Record<string, unknown>

Returns Promise<QueryResult<{
r: Relationship<Integer, Properties, string>;
}>>

node: {
$id: string;
}

`Optional` query: {
limit?: number;
order?: OneOrMany<[keyof Schema[N]["props"], "ASC" | "DESC"]>;
where?: Partial<{ [ K in string | number | symbol]: Schema[N]["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }> & {
$id?: string;
};
}

`Optional` limit?: number

`Optional` order?: OneOrMany<[keyof Schema[N]["props"], "ASC" | "DESC"]>

`Optional` where?: Partial<{ [ K in string | number | symbol]: Schema[N]["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }> & {
$id?: string;
}

`Rest` ...params: ParamNames<Q>[number] extends never ? [Record<string, unknown>?] : [Params<Q>]

Returns Promise<QueryResult<keyof Returns<Q> extends never ? {
[key: string]: unknown;
} : { [ key in string | number | symbol]: Returns<Q>[key] extends "Node" ? Node<Integer, Properties, string> : Returns<Q>[key] extends "Relationship" ? Relationship<Integer, Properties, string> : unknown }>>