0.1.0 To Do Tasks

[billy1624]

1. Connection

   • Connection to Live Database
     • Database: abstract interface of a database
     • Connection: a live connection able to execute SQL statements
     • ExecutionResult: execution result of non select query
     • QueryResult: execution result of select query #83
   • Backend support
     • SQLx MySql
     • SQLx Postgres (Postgres support #19)
     • SQLx Sqlite (sea-query/51) #33
   • Mock Connection
     • Provide a mock database API for unit testing

2. ORM Core

   • Components
     • Entity: encapsulates all the necessary specification of the corresponding database table
       • Column: column name
       • PrimaryKey: primary key name
       • Relation: definition of relation between tables
     • Model: struct to store the data of a database row
   • Query Result
     • serialize to serde_json::Value (Serialize QueryResult into serde_json::Value #4)
   • Entity Generator
     • Given a table schema (from sea-schema), generate Entity file as Rust code (Entity Generator #11)

3. Select from Table

   • Execute the SelectStatment and return one or many models
   • Select into custom (ad hoc) models
   • where (filter and condition)
   • order_by
   • Paginate selection result
     • Stream sync item (Pagination API #5)
       i.e. into impl Stream<Item = Result<_, _>>
     • Test cases for Paginator implemented with mock connection
   • Relations: one to one and one to many
   • Relation: many to many via junction table

4. Insert into Table

   • Insert one model into database
   • Insert multiple models as a single query

5. Update from Table

   • Update a whole model to a row
   • ActiveModel: wrap Model and indicates which fields are modified, and only update respective columns
   • save semantics: insert if model is new, otherwise update
   • Update many using filters

6. Delete from Table

   • Delete one model
   • Delete many models using filters (similar to select)

7. Utility (sea-orm-cli #24)

   • Discovery: generate command to generate entities from existing database

8. Test suite

   • bakery: a database schema for demonstration (Bakery Schema Design #32)
   • end-to-end test suite (Test Suite #41)
   • runnable on CI (GitHub Action) for Sqlite (Setup GitHub Action with SQLite #25)