Skip to main content
Version: Next

API Reference

Complete API documentation for ageSchemaClient.

Auto-Generated API Documentation​

For the most comprehensive and up-to-date API documentation, see our Complete API Reference which is automatically generated from TypeScript source code.

Quick Navigation​

  • Classes - All available classes including AgeSchemaClient, QueryBuilder, BatchOperations, etc.
  • Interfaces - Type definitions and contracts
  • Functions - Utility functions and helpers
  • Type Aliases - Custom type definitions

Core Classes Overview​

AgeSchemaClient | Full API​

The main client class for interacting with Apache AGE graph databases.

QueryBuilder | Full API​

Fluent API for constructing type-safe Cypher queries.

BatchLoader | Full API​

Efficient batch loading for large datasets.

SchemaManager | Full API​

Schema validation and management for graph databases.

Transaction | Full API​

Transactional operations for data consistency.

Quick Reference​

Basic Usage​

import { AgeSchemaClient } from 'age-schema-client';

const client = new AgeSchemaClient({
  host: 'localhost',
  port: 5432,
  database: 'your_database',
  user: 'your_user',
  password: 'your_password',
  graph: 'your_graph'
});

// Query data
const result = await client.query()
  .match('(p:Person)')
  .where({ age: { $gte: 18 } })
  .return('p.name, p.age')
  .execute();

// Batch load data
const loader = client.batch();
await loader.loadVertices([
  { label: 'Person', properties: { name: 'Alice', age: 30 } }
]);

Type Definitions​

All TypeScript type definitions are included with the package and provide full IntelliSense support in your IDE.

Error Handling​

All methods can throw specific error types for different failure scenarios. See individual class documentation for details.

Next Steps​