"""数据库表管理模块 对应前端源码: api/systemData/dataModel.ts 提供数据库表和字段的 CRUD 操作,支持通过 DataSource 管理数据库连接。 用于创建/查询/修改/删除数据库表、获取表字段列表等。 优先使用此模块(配合 DataSource)来操作数据库,而非直接执行 SQL。 """ from typing import Any, Dict, Optional from aibridge.client import JNPFClient from aibridge.models import APIResponse class DataModelAPI: """数据库表管理 API 用法:: # 查询表列表 resp = client.data_model.get_table_list("0") # 主数据库 link_id="0" for t in resp.data.get("list", []): print(t["table"], t["comment"]) # 查询表详情 resp = client.data_model.get_table_info("0", "base_my_table") fields = resp.data.get("tableFieldList", []) # 查询表字段列表 resp = client.data_model.get_field_list("0", "base_my_table") """ def __init__(self, client: JNPFClient): self._client = client self._prefix = "/api/system/DataModel" def get_table_list(self, link_id: str, data: dict = None) -> APIResponse: """获取数据库表列表 Args: link_id: 数据连接 ID,"0" 表示主数据库 data: 查询参数,支持 keyword/currentPage/pageSize """ return self._client.request("GET", f"{self._prefix}/{link_id}/Tables", params=data) def get_table_list_all(self, link_id: str, data: dict = None) -> APIResponse: """获取数据库表列表(含视图) Args: link_id: 数据连接 ID data: 查询参数 """ return self._client.request("GET", f"{self._prefix}/{link_id}/TableAll", params=data) def preview_table(self, link_id: str, table: str, data: dict = None) -> APIResponse: """预览数据库表数据 Args: link_id: 数据连接 ID table: 表名 data: 查询参数 """ return self._client.request("GET", f"{self._prefix}/{link_id}/Table/{table}/Preview", params=data) def create_table(self, link_id: str, data: dict) -> APIResponse: """新建数据库表 Args: link_id: 数据连接 ID data: 表定义数据 """ return self._client.request("POST", f"{self._prefix}/{link_id}/Table", data=data) def update_table(self, link_id: str, data: dict) -> APIResponse: """修改数据库表 Args: link_id: 数据连接 ID data: 表定义数据(含表名标识) """ return self._client.request("PUT", f"{self._prefix}/{link_id}/Table", data=data) def get_table_info(self, link_id: str, table: str) -> APIResponse: """获取数据库表详情(含字段列表) Args: link_id: 数据连接 ID table: 表名 Returns: data.tableInfo: 表基本信息 {table, tableName} data.tableFieldList: 字段列表 [{field, fieldName, dataType, dataLength, primaryKey, ...}] """ return self._client.request("GET", f"{self._prefix}/{link_id}/Table/{table}") def delete_table(self, link_id: str, table: str) -> APIResponse: """删除数据库表 Args: link_id: 数据连接 ID table: 表名 注意:如果表被功能表单引用,删除会失败。 """ return self._client.request("DELETE", f"{self._prefix}/{link_id}/Table/{table}") def get_field_list(self, link_id: str, table: str, field_type: str = "0") -> APIResponse: """获取数据库表字段列表 Args: link_id: 数据连接 ID table: 表名 field_type: 字段类型 (0=全部, 1=仅主表字段, 2=仅关联字段) """ return self._client.request("GET", f"{self._prefix}/{link_id}/Tables/{table}/Fields", params={"type": field_type}) def add_fields(self, link_id: str, data: dict) -> APIResponse: """新增字段到数据库表 Args: link_id: 数据连接 ID data: 字段定义数据 """ return self._client.request("PUT", f"{self._prefix}/{link_id}/addFields", data=data) def export_table(self, link_id: str, table: str) -> APIResponse: """导出数据库表结构 Args: link_id: 数据连接 ID table: 表名 """ return self._client.request("GET", f"{self._prefix}/{link_id}/Table/{table}/Actions/Export") # ==================== 便捷查询方法 ==================== def query(self, link_id: str, table: str, keyword: str = "", field: str = "", current_page: int = 1, page_size: int = 20) -> APIResponse: """简单查询表数据(封装 Preview 接口) Args: link_id: 数据连接 ID,"0"=主数据库 table: 表名 keyword: 关键字搜索(可选) field: 搜索字段名(可选,如 "f_en_code") current_page: 当前页(默认 1) page_size: 每页条数(默认 20) Returns: APIResponse,resp.data 包含: - list: 数据列表 - pagination: {currentPage, pageSize, total} 示例:: resp = client.data_model.query("0", "base_module", keyword="admin", field="f_en_code") for row in resp.data.get("list", []): print(row["f_en_code"], row.get("f_full_name")) """ params = { "currentPage": current_page, "pageSize": page_size, } # 默认用 f_id 排序(主键雪花ID,所有表都有这个字段) params["field"] = field if field else "f_id" if keyword: params["keyword"] = keyword return self._client.request("GET", f"{self._prefix}/{link_id}/Table/{table}/Preview", params=params) def query_one(self, link_id: str, table: str, field: str, value: str) -> Optional[Dict]: """查询单条记录 Args: link_id: 数据连接 ID table: 表名 field: 字段名(如 "f_en_code") value: 字段值 Returns: 匹配的记录 dict,未找到返回 None 示例:: record = client.data_model.query_one("0", "base_module", "f_en_code", "admin") if record: print(record["f_full_name"]) """ resp = self.query(link_id, table, keyword=value, field=field, page_size=1) if resp.success and resp.data: records = resp.data.get("list", []) return records[0] if records else None return None