SchemaImpl

age-schema-client v0.3.0

---

age-schema-client / SchemaImpl

Class: SchemaImpl

Defined in: src/schema/schema.ts:62

Schema implementation that wraps a SchemaDefinition

Implements

• Schema

Constructors

Constructor

new SchemaImpl(schemaDefinition): SchemaImpl;

Defined in: src/schema/schema.ts:70

Create a new SchemaImpl

Parameters

Parameter	Type	Description
schemaDefinition	SchemaDefinition	Schema definition

Returns

SchemaImpl

Methods

getVertexSchema()

getVertexSchema(vertexType): VertexLabel;

Defined in: src/schema/schema.ts:80

Get the vertex schema for a specific vertex type

Parameters

Parameter	Type	Description
vertexType	string	The vertex type to get the schema for

Returns

VertexLabel

The vertex schema or undefined if not found

Implementation of

Schema.getVertexSchema

---

getEdgeSchema()

getEdgeSchema(edgeType): EdgeLabel;

Defined in: src/schema/schema.ts:90

Get the edge schema for a specific edge type

Parameters

Parameter	Type	Description
edgeType	string	The edge type to get the schema for

Returns

EdgeLabel

The edge schema or undefined if not found

Implementation of

Schema.getEdgeSchema

---

getVertexTypes()

getVertexTypes(): string[];

Defined in: src/schema/schema.ts:99

Get all vertex types defined in the schema

Returns

string[]

Array of vertex type names

Implementation of

Schema.getVertexTypes

---

getEdgeTypes()

getEdgeTypes(): string[];

Defined in: src/schema/schema.ts:108

Get all edge types defined in the schema

Returns

string[]

Array of edge type names

Implementation of

Schema.getEdgeTypes

---

getSchemaDefinition()

getSchemaDefinition(): SchemaDefinition;

Defined in: src/schema/schema.ts:117

Get the schema definition

Returns

SchemaDefinition

The schema definition

Implementation of

Schema.getSchemaDefinition