Skip to main content
Version: Next

SchemaLoader

age-schema-client v0.5.0


age-schema-client / SchemaLoader

Class: SchemaLoader<T>

Defined in: src/loader/schema-loader.ts:353

SchemaLoader class

Type Parameters

Type Parameter
T extends SchemaDefinition

Constructors

Constructor

new SchemaLoader<T>(
schema,
queryExecutor,
options): SchemaLoader<T>;

Defined in: src/loader/schema-loader.ts:366

Create a new SchemaLoader

Parameters

ParameterTypeDescription
schemaTSchema definition
queryExecutorQueryExecutorQuery executor
optionsSchemaLoaderOptionsSchemaLoader options

Returns

SchemaLoader<T>

Methods

loadGraphData()

loadGraphData(data, options): Promise<LoadResult>;

Defined in: src/loader/schema-loader.ts:413

Load graph data (vertices and edges)

Parameters

ParameterTypeDescription
dataGraphDataGraph data
optionsLoadOptionsLoad options

Returns

Promise<LoadResult>

Load result


loadVertices()

loadVertices(vertices, options): Promise<LoadResult>;

Defined in: src/loader/schema-loader.ts:670

Load vertices

Parameters

ParameterTypeDescription
verticesRecord<string, any[]>Vertex data
optionsLoadOptionsLoad options

Returns

Promise<LoadResult>

Load result


loadEdges()

loadEdges(edges, options): Promise<LoadResult>;

Defined in: src/loader/schema-loader.ts:951

Load edges

Parameters

ParameterTypeDescription
edgesRecord<string, any[]>Edge data
optionsLoadOptionsLoad options

Returns

Promise<LoadResult>

Load result


loadFromFile()

loadFromFile(filePath, options): Promise<LoadResult>;

Defined in: src/loader/schema-loader.ts:1292

Load data from a JSON file

Parameters

ParameterTypeDescription
filePathstringPath to the JSON file
optionsLoadOptionsLoad options

Returns

Promise<LoadResult>

Load result