|
1 | 1 | # js-db
|
2 | 2 |
|
3 |
| -DB is library managing key value state for MatrixAI's JavaScript/TypeScript applications. |
| 3 | +DB is library managing key value state for MatrixAI's JavaScript/TypeScript |
| 4 | +applications. |
4 | 5 |
|
5 |
| -This forks classic-level's C++ binding code around LevelDB 1.20. Differences from classic-level: |
| 6 | +This forks classic-level's C++ binding code around LevelDB 1.20. Differences |
| 7 | +from classic-level: |
6 | 8 |
|
7 | 9 | - Uses TypeScript from ground-up
|
8 | 10 | - Supports Snapshot-Isolation based transactions via `DBTransaction`
|
9 |
| -- API supports "key paths" which can be used to manipulate "levels" of nested keys |
10 |
| -- Value encryption (key-encryption is not supported yet) - requires additional work with block-encryption |
| 11 | +- API supports "key paths" which can be used to manipulate "levels" of nested |
| 12 | + keys |
| 13 | +- Value encryption (key-encryption is not supported yet) - requires additional |
| 14 | + work with block-encryption |
11 | 15 | - Uses RocksDB
|
12 | 16 |
|
13 | 17 | ## Installation
|
@@ -71,11 +75,13 @@ async function main() {
|
71 | 75 | main();
|
72 | 76 | ```
|
73 | 77 |
|
74 |
| -If you created the `DB` with a `crypto` object, then upon restarting the `DB`, you must pass in the same `crypto` object. |
| 78 | +If you created the `DB` with a `crypto` object, then upon restarting the `DB`, |
| 79 | +you must pass in the same `crypto` object. |
75 | 80 |
|
76 | 81 | ## Development
|
77 | 82 |
|
78 |
| -This project uses Git submodules to bring in rocksdb. **Make sure to clone recursively.** |
| 83 | +This project uses Git submodules to bring in rocksdb. **Make sure to clone |
| 84 | +recursively.** |
79 | 85 |
|
80 | 86 | If you already cloned, run this:
|
81 | 87 |
|
@@ -106,7 +112,9 @@ npm run lintfix
|
106 | 112 | npm run bench
|
107 | 113 | ```
|
108 | 114 |
|
109 |
| -View benchmarks here: https://github.com/MatrixAI/js-db/blob/master/benches/results with https://raw.githack.com/ |
| 115 | +View benchmarks here: |
| 116 | +https://github.com/MatrixAI/js-db/blob/master/benches/results with |
| 117 | +https://raw.githack.com/ |
110 | 118 |
|
111 | 119 | ### Docs Generation
|
112 | 120 |
|
|
0 commit comments