API Reference¶

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

Architecture¶

Core architectural components that define the graflo framework:

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
FalkorDB:
Connection: FalkorDB-specific connection implementation
TigerGraph:
Connection: TigerGraph-specific connection implementation with REST++ API and GSQL support
NebulaGraph:
Connection: NebulaGraph connection implementation with dual v3.x/v5.x support
Adapter: Version-agnostic client adapter layer (v3 Thrift, v5 gRPC)
Query: nGQL and GQL query builders
Utilities: Type mapping, value serialization, VID generation, filter rendering
PostgreSQL:
Connection: PostgreSQL connection and schema introspection
Schema Inference: Automatic schema generation from PostgreSQL 3NF databases
Resource Mapping: Mapping PostgreSQL tables to graflo Resources
Type Mapping: PostgreSQL to graflo type conversion

Main graflo functionality:

Helper modules and utilities:

Data filtering and query capabilities:

Graph visualization and plotting:

CLI tools for graflo operations:

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