AgeSchemaClient

age-schema-client v0.3.0

---

age-schema-client / AgeSchemaClient

Class: AgeSchemaClient<T>

Defined in: src/core/client.ts:20

Main client class for interacting with Apache AGE graph databases

Type Parameters

Type Parameter	Default type
T extends SchemaDefinition	SchemaDefinition

Constructors

Constructor

new AgeSchemaClient<T>(config): AgeSchemaClient<T>;

Defined in: src/core/client.ts:34

Create a new AgeSchemaClient instance

Parameters

Parameter	Type	Description
config	ClientConfig	Client configuration

Returns

AgeSchemaClient<T>

Methods

getConfig()

getConfig(): ClientConfig;

Defined in: src/core/client.ts:46

Get the client configuration

Returns

ClientConfig

The client configuration

---

createQueryBuilder()

createQueryBuilder(graphName): QueryBuilder<T>;

Defined in: src/core/client.ts:56

Create a query builder for the specified graph

Parameters

Parameter	Type	Default value	Description
graphName	string	'default'	Name of the graph

Returns

QueryBuilder<T>

A query builder instance

---

createPathQueryBuilder()

createPathQueryBuilder(graphName): PathQueryBuilder<T>;

Defined in: src/core/client.ts:74

Create a path query builder for the specified graph

Parameters

Parameter	Type	Default value	Description
graphName	string	'default'	Name of the graph

Returns

PathQueryBuilder<T>

A path query builder instance

---

getVertexOperations()

getVertexOperations(): VertexOperations<T>;

Defined in: src/core/client.ts:91

Get vertex operations

Returns

VertexOperations<T>

Vertex operations

---

getEdgeOperations()

getEdgeOperations(): EdgeOperations<T>;

Defined in: src/core/client.ts:120

Get edge operations

Returns

EdgeOperations<T>

Edge operations