mirror of
https://github.com/immich-app/isar.git
synced 2026-09-30 21:27:50 +08:00
Update TODO.md
This commit is contained in:
@@ -3,38 +3,49 @@
|
|||||||
|
|
||||||
# Documentation
|
# Documentation
|
||||||
|
|
||||||
|
## API Docs
|
||||||
|
|
||||||
|
- [ ] Document all public APIs
|
||||||
|
|
||||||
## Schema
|
## Schema
|
||||||
|
|
||||||
- [ ] Update schema migration instructions
|
- [x] Update schema migration instructions
|
||||||
|
- [ ] Document all annotation options
|
||||||
|
|
||||||
## CRUD
|
## CRUD
|
||||||
|
|
||||||
- [ ] Document sync operations
|
- [ ] Document sync operations
|
||||||
- [ ] `getAll()`, `putAll`, `deleteAll()`
|
- [x] `getAll()`, `putAll`, `deleteAll()`
|
||||||
|
- [ ] `getBy...()`, `deleteBy...()`
|
||||||
|
|
||||||
## Queries
|
## Queries
|
||||||
|
|
||||||
- [ ] Filter groups
|
- [x] Filter groups
|
||||||
- [ ] Boolean operators `and()`, `or()`, `not()`
|
- [x] Boolean operators `and()`, `or()`, `not()`
|
||||||
- [ ] Offset, limit
|
- [x] Offset, limit
|
||||||
- [ ] Distinct where clauses
|
- [x] Distinct where clauses
|
||||||
- [ ] Different filter operations (`equalTo`, `beginsWith()` etc.)
|
- [x] Different filter operations (`equalTo`, `beginsWith()` etc.)
|
||||||
|
- [ ] Better explanation for distinct and sorted where clauses
|
||||||
|
- [ ] Watching queries
|
||||||
|
|
||||||
## Indexes
|
## Indexes
|
||||||
|
|
||||||
- [ ] Intro
|
- [ ] Intro
|
||||||
- [ ] What are they
|
- [x] What are they
|
||||||
- [ ] Why use them
|
- [ ] Why use them
|
||||||
- [ ] How to in isar?
|
- [x] How to in isar?
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
- [ ] Create minimal example
|
- [ ] Create minimal example
|
||||||
- [ ] Create complex example with indexes, filter groups etc.
|
- [ ] Create complex example with indexes, filter groups etc.
|
||||||
|
- [ ] More Sample Apps
|
||||||
|
|
||||||
## Tutorials
|
## Tutorials
|
||||||
|
|
||||||
- [ ] How to write fast queries
|
- [ ] How to write fast queries
|
||||||
|
- [ ] Build a simple offline first app
|
||||||
|
- [ ] Advanced queries
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
@@ -44,25 +55,25 @@
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- [ ] Distinct by
|
- [x] Distinct by
|
||||||
- [ ] Offset, Limit
|
- [x] Offset, Limit
|
||||||
- [ ] Sorted by
|
- [x] Sorted by
|
||||||
|
|
||||||
## Fixes
|
## Fixes
|
||||||
|
|
||||||
- [ ] Port [pluralize](https://github.com/plurals/pluralize) to Dart and use it to generate collection accessors
|
- [x] Provide an option to change collection accessor names
|
||||||
|
|
||||||
## Unit tests
|
## Unit tests
|
||||||
|
|
||||||
- [ ] Download binaries automatically for tests
|
- [x] Download binaries automatically for tests
|
||||||
|
|
||||||
### Queries
|
### Queries
|
||||||
|
|
||||||
- [ ] Restructure query tests to make them less verbose
|
- [x] Restructure query tests to make them less verbose
|
||||||
- [ ] Define models that can be reused across tests
|
- [x] Define models that can be reused across tests
|
||||||
- [ ] Where clauses with string indexes (value, hash, words, case-sensitive)
|
- [x] Where clauses with string indexes (value, hash, words, case-sensitive)
|
||||||
- [ ] Distinct where clauses
|
- [x] Distinct where clauses
|
||||||
- [ ] String filter operations
|
- [x] String filter operations
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
@@ -73,16 +84,27 @@
|
|||||||
## Features (low priority)
|
## Features (low priority)
|
||||||
|
|
||||||
- [ ] Draft Synchronization
|
- [ ] Draft Synchronization
|
||||||
- [ ] Relationships
|
- [x] Relationships
|
||||||
|
|
||||||
## Unit tests
|
## Unit tests
|
||||||
|
|
||||||
- [ ] Make lmdb unit tests bulletproof
|
- [ ] Make mdbx unit tests bulletproof
|
||||||
- [ ] Migration tests
|
- [x] Migration tests
|
||||||
|
- [x] Binary format
|
||||||
|
- [x] CRUD
|
||||||
|
- [x] Links
|
||||||
- [ ] QueryBuilder
|
- [ ] QueryBuilder
|
||||||
- [ ] WhereClause
|
- [ ] WhereClause
|
||||||
- [ ] WhereExecutor
|
- [ ] WhereExecutor
|
||||||
- [ ] CollectionMigrator
|
- [x] CollectionMigrator
|
||||||
- [ ] Watchers
|
- [ ] Watchers
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
# Isar Web
|
||||||
|
|
||||||
|
- [ ] MVP
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user