Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
MHHukiewitz committed Mar 6, 2023
2 parents 20200bb + 33e9ea1 commit 060bb50
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ AARS(channel="MyLibrary")
Index(Book, 'title')

# create & upload a book
new_book = await Book.create(title='Atlas Shrugged', author='Ayn Rand')
new_book = await Book(title='Atlas Shrugged', author='Ayn Rand').save()

# retrieve a book by its ID
book = await Book.get(new_book.id_hash)[0]
book = await Book.fetch(new_book.id_hash)[0]

# retrieve a book by its title
book = await Book.query(title='Atlas Shrugged')[0]
book = await Book.where_eq(title='Atlas Shrugged')[0]
```


Expand All @@ -37,21 +37,26 @@ book = await Book.query(title='Atlas Shrugged')[0]
- [x] Versioning
- [x] Use "amend" post_type for updates
- [x] Fetch revisions with messages endpoint
- [x] Basic indexing/querying operations
- [ ] Basic indexing/querying operations
- [x] Single-key indexing
- [x] Multi-key indexing
- [x] Query with list of keys
- [x] Update indices function
- [x] Allow multiple items to share one index key
- [ ] Add more comparators for where_() queries
- [ ] where_gte()
- [ ] where_lte()query
- [ ] where_lte()
- [ ] where_contains()
- [ ] Persist indices to lower startup time
- [x] Automatic multi-page fetching
- [x] Encapsulate Aleph SDK as class
- [x] Local VM caching
- [x] Add tests
- [x] Add documentation
- [x] Add to indices when fetching records
- [x] Test where_eq() for fetching multiple records
- [x] Add reindexing function on AARS
- [x] Add reindexing function on AARS
- [ ] Add caching of records
- [x] Cache records retrieved by item_hash
- [ ] Cache records retrieved by fetch_all/timeline
- [ ] Add item_hashes endpoint to pyaleph for quick cross-checking of cache hashes

0 comments on commit 060bb50

Please sign in to comment.