Schema
age-schema-client / Schema
Interface: Schema
Defined in: src/schema/schema.ts:20
Schema interface for accessing schema information
Methods
getVertexSchema()
getVertexSchema(vertexType): VertexLabel;
Defined in: src/schema/schema.ts:27
Get the vertex schema for a specific vertex type
Parameters
| Parameter | Type | Description |
|---|---|---|
vertexType | string | The vertex type to get the schema for |
Returns
The vertex schema or undefined if not found
getEdgeSchema()
getEdgeSchema(edgeType): EdgeLabel;
Defined in: src/schema/schema.ts:35
Get the edge schema for a specific edge type
Parameters
| Parameter | Type | Description |
|---|---|---|
edgeType | string | The edge type to get the schema for |
Returns
The edge schema or undefined if not found
getVertexTypes()
getVertexTypes(): string[];
Defined in: src/schema/schema.ts:42
Get all vertex types defined in the schema
Returns
string[]
Array of vertex type names
getEdgeTypes()
getEdgeTypes(): string[];
Defined in: src/schema/schema.ts:49
Get all edge types defined in the schema
Returns
string[]
Array of edge type names
getSchemaDefinition()
getSchemaDefinition(): SchemaDefinition;
Defined in: src/schema/schema.ts:56
Get the schema definition
Returns
The schema definition