HelixDB/file_structure.txt at main · developer51709/HelixDB · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
HelixDB/
│
├── README.md
├── LICENSE
├── file_structure.txt
├── helixdb.config.json.example
│
├── cmd/
│   └── helixdb/
│       ├── main.go
│       └── commands.go
│       # Entry point for the HelixDB server binary.
│       # Contains CLI parsing, startup logic, and config loading.
│
├── internal/
│   ├── server/
│   │   ├── http.go
│   │   ├── routes.go
│   │   └── middleware.go
│   │   # HTTP server, routing, and request handling.
│   │
│   ├── storage/
│   │   ├── engine.go
│   │   ├── wal.go
│   │   ├── segments.go
│   │   ├── compaction.go
│   │   ├── recovery.go
│   │   └── checksums.go
│   │   # Core database engine:
│   │   # - Write-ahead log
│   │   # - Segment files
│   │   # - Compaction
│   │   # - Crash recovery
│   │   # - Corruption detection
│   │
│   ├── indexing/
│   │   ├── index.go
│   │   ├── btree.go
│   │   └── query.go
│   │   # Secondary indexes and query execution.
│   │
│   ├── backup/
│   │   ├── snapshot.go
│   │   ├── incremental.go
│   │   └── scheduler.go
│   │   # Backup and restore logic.
│   │
│   ├── config/
│   │   ├── loader.go
│   │   └── schema.go
│   │   # Loads and validates helixdb.config.json.
│   │
│   └── logging/
│       ├── logger.go
│       └── rotate.go
│       # Logging utilities and file rotation.
│
├── api/
│   ├── openapi.yaml
│   └── examples/
│       ├── create_document.json
│       ├── delete_document.json
│       ├── error_response.json
│       └── query.json
│   # API documentation and example payloads.
│
├── clients/
│   ├── node/
│   │   ├── package.json
│   │   ├── index.js
│   │   └── README.md
│   │   # Official Node.js client library.
│   │
│   └── python/
│       ├── helixdb/
│       │   ├── __init__.py
│       │   ├── client.py
│       │   └── collection.py
│       ├── pyproject.toml
│       └── README.md
│       # Official Python client library.
│
├── scripts/
│   ├── build.sh
│   ├── test.sh
│   └── release.sh
│   # Utility scripts for building, testing, and releasing HelixDB.
│
├── tests/
│   ├── integration/
│   │   ├── http_tests.go
│   │   └── recovery_tests.go
│   │
│   └── unit/
│       ├── wal_test.go
│       ├── index_test.go
│       └── storage_test.go
│   # Unit and integration tests.
│
└── examples/
    ├── node/
    │   └── basic_usage.js
    └── python/
        └── basic_usage.py
    # Example applications demonstrating how to use HelixDB.