Skip to content

Commit ac85431

Browse files
committed
fixing readme
1 parent 73d109b commit ac85431

File tree

2 files changed

+24
-24
lines changed

2 files changed

+24
-24
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
/.idea
22
target/
33
todo
4+
todo.png
45
Cargo.lock

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,34 @@ through auto-generated REST API. It maximizes R/W speed while minimizing data si
1010

1111
### Major Out-of-the-Box Features
1212

13-
- ✅ Querying and ranging by secondary index
14-
- ✅ Optional dictionaries for low cardinality fields
15-
- ✅ One-to-One / One-to-Option / One-to-Many entities with cascade read/write/delete
16-
- ✅ All goodies including intuitive data ordering without writing custom codecs
17-
- ✅ SSE streaming api with efficient querying (ie. get txs or utxos for really HOT address)
18-
- supported filters : `eq`, `ne`, `lt`, `le`, `gt`, `ge`, `in`
19-
- queries are deeply nested with logical `AND` :
20-
```json
21-
{
22-
"header": {
23-
"height": { "$eq": 1 }
24-
},
25-
"transactions": {
26-
"hash": { "$in": ["bar", "baz"] },
27-
"utxo": {
28-
"address": { "$eq": "foo" }
29-
}
13+
✅ Querying and ranging by secondary index \
14+
✅ Optional dictionaries for low cardinality fields \
15+
✅ One-to-One / One-to-Option / One-to-Many entities with cascade read/write/delete \
16+
✅ All goodies including intuitive data ordering without writing custom codecs \
17+
✅ SSE streaming api with efficient querying (ie. get txs or utxos for really HOT address) \
18+
✅ query contraints : `eq`, `ne`, `lt`, `le`, `gt`, `ge`, `in` with logical `AND`
19+
```json
20+
{
21+
"header": {
22+
"height": { "$eq": 1 }
23+
},
24+
"transactions": {
25+
"hash": { "$in": ["bar", "baz"] },
26+
"utxo": {
27+
"address": { "$eq": "foo" }
3028
}
3129
}
32-
```
33-
- ✅ supported column types : `String`, `Integers`, `Vec<u8>`, `[u8; N]`, `bool`, `uuid::Uuid`, `chrono::DateTime`, `std::time::Duration`
34-
- supported encodings of binary columns : `hex`, `base64`
35-
- ✅ all types have binary (db) and human-readable (http) serde support
36-
- ✅ Macro derived http rest API at http://127.0.0.1:8000/swagger-ui/ with examples
37-
- ✅ Macro derived unit tests and integration tests on axum test server
30+
}
31+
```
32+
✅ column types : `String`, `Int`, `Vec<u8>`, `[u8; N]`, `bool`, `uuid::Uuid`, `chrono::DateTime`, `std::time::Duration` \
33+
✅ column encodings of binary columns : `hex`, `base64` \
34+
✅ all types have binary (db) and human-readable (http) serde support \
35+
✅ Macro derived http rest API at http://127.0.0.1:8000/swagger-ui/ with examples \
36+
✅ Macro derived unit tests and integration tests on axum test server
3837

3938
### Limitations
4039

41-
- ❌ root key must be newtype struct with numeric inner type (that's part of the design decision to achieve fast indexing of even whole bitcoin)
40+
❌ root key must be newtype struct with numeric inner type (that's part of the design decision to achieve fast indexing of even whole bitcoin) \
4241

4342
```
4443
cargo run --package utxo # to run the demo example

0 commit comments

Comments
 (0)