Reference
Technical reference documentation for graph operations. Use these pages to look up specific details about commands, APIs, and configuration options.
Reference Sections
CLI Reference
Documentation for all graph operation CLI commands:
koza join- Combine KGX fileskoza split- Split by field valueskoza merge- Complete pipelinekoza normalize- Apply SSSOM mappingskoza deduplicate- Remove duplicateskoza prune- Clean graph integritykoza append- Add to existing databasekoza report- Generate reportskoza node-report/koza edge-report- Tabular reportskoza node-examples/koza edge-examples- Sample extraction
Each command includes:
- Synopsis and description
- All options with types and defaults
- Usage examples
- Output description
Python API
Auto-generated documentation from source code docstrings:
join_graphs()- Join operationsplit_graph()- Split operationmerge_graphs()- Pipeline orchestrationnormalize_graph()- SSSOM normalizationdeduplicate_graph()- Deduplicationprune_graph()- Graph cleaningappend_graphs()- Incremental updates- Report generation functions
Configuration
Detailed documentation for all configuration models:
FileSpec- File specification with format detectionJoinConfig- Join operation settingsSplitConfig- Split operation settingsMergeConfig- Pipeline configurationNormalizeConfig- Normalization settingsDeduplicateConfig- Deduplication settingsPruneConfig- Pruning settingsAppendConfig- Append settings- Report configuration models
Each model includes:
- All fields with types
- Default values
- Validation rules
- Usage examples
File Formats
Supported Input Formats
| Format | Extension | Description |
|---|---|---|
| TSV | .tsv |
Tab-separated values (KGX standard) |
| JSONL | .jsonl |
JSON Lines (one record per line) |
| Parquet | .parquet |
Columnar binary format |
Compression supported: .gz, .bz2, .xz
KGX File Types
| Type | Required Columns | Optional Columns |
|---|---|---|
| Nodes | id |
category, name, provided_by, ... |
| Edges | subject, predicate, object |
id, category, provided_by, ... |