Command line interface
The Raphtory CLI tool is included in the Python package and allows you to interact directly with the Raphtory server. This is useful for experimentation and scripting.
Server
The server subcommand starts the GraphQL server with the specified configuration.
| Command | Parameter(s) | Description |
|---|---|---|
| -h, --help | Show the help message and exit | |
| --work-dir | WORK_DIR | Working directory |
| --cache-capacity | CACHE_CAPACITY | Cache capacity |
| --cache-tti-seconds | CACHE_TTI_SECONDS | Cache time-to-idle in seconds |
| --log-level | LOG_LEVEL | Log level |
| --tracing | Enable tracing | |
| --tracing-level | TRACING_LEVEL | Set the tracing level. Available options are: COMPLETE, ESSENTIAL, MINIMAL. |
| --otlp-agent-host | OTLP_AGENT_HOST | OTLP agent host |
| --otlp-agent-port | OTLP_AGENT_PORT | OTLP agent port |
| --otlp-tracing-service-name | OTLP_TRACING_SERVICE_NAME | OTLP tracing service name |
| --auth-public-key | AUTH_PUBLIC_KEY | Public key for auth |
| --auth-enabled-for-reads | Enable auth for reads | |
| --config-path | CONFIG_PATH | Optional config path |
| --create-index | Enable index creation | |
| --port | PORT | Port for Raphtory to run on, defaults to 1736 |
| --timeout | TIMEOUT | Timeout for starting the server in milliseconds. Defaults: 180000ms |
Tracing
Tracing provides the following levels of verbosity:
- COMPLETE - Provides full traces for each query.
- ESSENTIAL - Tracks the following key functions: addEdge, addEdges, deleteEdge, graph, updateGraph, addNode, node, nodes, edge, edges.
- MINIMAL - Provides summary execution times.
For more details on tracing configuration and other server options, see Advanced Server Settings.
Helper functions
Schema
The Schema subcommand prints the current GraphQL schema.
Version
Access the version of raphtory