API Reference

This section provides detailed API documentation for all GraphCast components and modules.

Architecture

Core architectural components that define the GraphCast framework:

• Schema: Graph schema definition and management
• Vertex: Vertex configuration and properties
• Edge: Edge configuration and relationship management
• Resource: Data source mapping and transformation
• Actor: Document processing pipeline components
• Transform: Data transformation utilities
• Ontology: Core data structures and types
• Utilities: Common utility functions

Database Operations

Database connection and management components:

• Connection Manager: Database connection lifecycle management
• ArangoDB:
• Connection: ArangoDB-specific connection implementation
• Query: AQL query execution and utilities
• Utilities: ArangoDB-specific utility functions
• Neo4j:
• Connection: Neo4j-specific connection implementation

Core Components

Main GraphCast functionality:

• Caster: Main data ingestion and transformation engine
• Ontology: Core data types and enums

Utilities

Helper modules and utilities:

• Chunker: Data chunking and batching utilities
• Merge: Data merging and deduplication
• Transform: Data transformation utilities
• Miscellaneous: Other utility functions

Filtering

Data filtering and query capabilities:

• Ontology: Filter expression system and operators

Visualization

Graph visualization and plotting:

• Plotter: Graph visualization and schema plotting utilities

Command Line Interface

CLI tools for GraphCast operations:

• Ingest: Data ingestion commands
• Database Management: Database administration commands
• Schema Visualization: Schema visualization commands
• XML to JSON: XML data conversion utilities

Getting Started

• Installation
• Quick Start Guide
• Concepts
• Examples

Contributing

For information on contributing to GraphCast, see the Contributing Guide.