Skip to content

Commit b4d8829

Browse files
Added more documentation for the file format
1 parent 54d5ef1 commit b4d8829

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

Sources/CodableDatastore/CodableDatastore.docc/On Disk Representation.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,66 @@ long enough for it to operate successfully.
9494
- 📦 C-%%%%%%%%%%%%%%%%.datastore
9595
- ...
9696
```
97+
98+
### Data Store
99+
100+
```
101+
- 📦 A-0011223344556677.datastore
102+
- 📂 History/
103+
- 📃 yyyy-MM-dd HH-mm-ss %%%%%%%%%%%%%%%%.json
104+
- ...
105+
- 📂 Pages/
106+
- 📦 A-%%%%%%%%%%%%%%%%.datastoreindex
107+
- 📦 B-%%%%%%%%%%%%%%%%.datastoreindex
108+
- 📦 C-%%%%%%%%%%%%%%%%.datastoreindex
109+
- ...
110+
- 📂 Indexes/
111+
- 📦 A-%%%%%%%%%%%%%%%%.datastoreindex
112+
- 📦 B-%%%%%%%%%%%%%%%%.datastoreindex
113+
- 📦 C-%%%%%%%%%%%%%%%%.datastoreindex
114+
- ...
115+
```
116+
117+
### Data Store Index
118+
119+
```
120+
- 📦 A-0011223344556677.datastoreindex
121+
- 📂 yyyy/
122+
- 📂 MM-dd/
123+
- 📂 HH-mm/
124+
- 📃 yyyy-MM-dd HH-mm-ss %%%%%%%%%%%%%%%%.datastorepage
125+
```
126+
127+
### Direct Index Page Format
128+
129+
```
130+
PAGE
131+
<15
132+
ata": "data"
133+
}
134+
=42 version1
135+
7 object3
136+
{
137+
"data": "data"
138+
}
139+
>28 version1
140+
7 object4
141+
{
142+
"d
143+
```
144+
145+
### Secondary Index Page Format
146+
147+
TODO: Just the index values here, linking to the page with the actual data, and the index of the object within that page.
148+
149+
```
150+
PAGE
151+
<20
152+
6677.datastorepage@2
153+
=62
154+
7 object3
155+
2023-06-04 17-06-40 0011223344556677.datastorepage@5
156+
>25
157+
7 object4
158+
2023-06-04 17-0
159+
```

0 commit comments

Comments
 (0)