ai-cfia / ai-cfia/ailab-datastore

As a Dev, I'd like the query modules to utilize an ORM plugin

未關閉
#264 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
dependencies documentation enhancement
主要語言
Python
星號
3
分支
0
PR 合併指標
30 天內沒有已合併 PR

描述

## Context

The query modules for all project served as a interface to execute Database queries. It was built as an ORM. However, based on a dev request, we would like to seperate ourselves from writing manual SQL queries and implement a prebuilt ORM toolkit to simplify database interactions and improve maintainability. This will help in reducing the complexity of manually written queries and ensure easier handling of database relationships across different objects.

## Proposed technology
- [SQL Alchemy](https://www.sqlalchemy.org/)
- [PostgREST](https://docs.postgrest.org/en/v12/)

## Acceptance Criteria:
- An ORM plugin audit has been performed with a relevant ADR
- Integrate a suitable ORM plugin within the ``db/queries/`` directories.
- Ensure that all existing query modules are refactored to use the ORM methods.
- ORM should handle relationships (if applicable) between different objects and provide built in models of entities
- Ensure proper documentation and examples are provided for developers using the query modules with the ORM

貢獻指南

這個儲存庫沒有索引到貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。