# school_document_generate_log 表文档

## 表概述
**表名**: school_document_generate_log  
**功能**: 文档生成日志表，负责记录教务系统中文档生成的操作日志，包括生成记录、状态跟踪、错误信息等文档生成过程的完整记录和监控功能

## 字段说明

```
Field	Type	Collation	Null	Key	Default	Extra	Privileges	Comment
id	int	NULL	NO	PRI	NULL	auto_increment	select,insert,update,references	
user_type	int	NULL	NO		0		select,insert,update,references	人员类型1内部 2外部
template_id	int	NULL	NO	MUL	NULL		select,insert,update,references	模板ID
template_name	varchar(255)	utf8mb4_0900_ai_ci	YES				select,insert,update,references	模板名称
user_id	int	NULL	NO		NULL		select,insert,update,references	操作用户
user_name	varchar(100)	utf8mb4_0900_ai_ci	YES				select,insert,update,references	用户姓名
business_id	int	NULL	YES		NULL		select,insert,update,references	关联业务ID
business_type	varchar(50)	utf8mb4_0900_ai_ci	YES				select,insert,update,references	业务类型
fill_data	text	utf8mb4_0900_ai_ci	YES		NULL		select,insert,update,references	填充数据JSON
original_data	longtext	utf8mb4_0900_ai_ci	YES		NULL		select,insert,update,references	生成时使用的原始数据JSON
generated_file	varchar(500)	utf8mb4_0900_ai_ci	YES		NULL		select,insert,update,references	生成文件路径
file_size	bigint	NULL	YES		0		select,insert,update,references	生成文件大小
download_count	int	NULL	YES		0		select,insert,update,references	下载次数
status	enum('pending','processing','completed','failed')	utf8mb4_0900_ai_ci	YES	MUL	pending		select,insert,update,references	
error_msg	text	utf8mb4_0900_ai_ci	YES		NULL		select,insert,update,references	错误信息
created_at	timestamp	NULL	YES		CURRENT_TIMESTAMP	DEFAULT_GENERATED	select,insert,update,references	创建时间
completed_at	timestamp	NULL	YES		NULL		select,insert,update,references	完成时间
```

## 功能用途

### 主要功能
- **生成记录**: 记录文档生成的完整过程和结果
- **状态跟踪**: 跟踪文档生成的各个阶段状态
- **错误日志**: 记录生成过程中的错误和异常信息
- **性能监控**: 监控文档生成的耗时和性能指标
- **用户追踪**: 记录文档生成的操作用户信息
- **模板使用**: 记录使用的文档模板和数据源
- **文件管理**: 管理生成的文档文件路径和存储信息
- **批量处理**: 支持批量文档生成的日志记录
- **审计追踪**: 提供完整的文档生成审计轨迹
- **统计分析**: 支持文档生成的统计和分析功能

### 业务场景
- **成绩单生成**: 记录学生成绩单的生成过程和结果
- **证书制作**: 记录各类证书的制作日志和状态
- **报表生成**: 记录各种报表的生成历史和性能
- **通知书制作**: 记录入学通知书等文档的生成情况
- **批量导出**: 记录批量文档导出的处理过程
- **定时任务**: 记录定时生成文档任务的执行情况
- **错误排查**: 通过日志排查文档生成失败的原因
- **性能优化**: 分析生成耗时优化文档生成性能
- **合规审计**: 提供文档生成的合规性审计记录

## 关联关系

### 主要关联表
- `school_document_template`: 文档模板表 (使用的模板)
- `school_document_data_source_config`: 数据源配置表 (使用的数据源)
- `school_student`: 学员表 (文档相关学员)
- `school_course`: 课程表 (文档相关课程)
- `school_class`: 班级表 (文档相关班级)
- `school_teacher`: 教师表 (文档相关教师)
- `school_exam`: 考试表 (文档相关考试)
- `sys_user`: 系统用户表 (操作用户)
- `sys_file`: 系统文件表 (生成的文件)
- `sys_log`: 系统日志表 (系统操作日志)

### 关联说明
- **模板关联**: 记录使用的文档模板信息
- **数据源关联**: 记录使用的数据源配置
- **学员关联**: 记录文档涉及的学员信息
- **课程关联**: 记录文档涉及的课程信息
- **班级关联**: 记录文档涉及的班级信息
- **教师关联**: 记录文档涉及的教师信息
- **考试关联**: 记录文档涉及的考试信息
- **用户关联**: 记录执行文档生成的用户
- **文件关联**: 关联生成的文档文件
- **日志关联**: 与系统日志形成完整的操作记录

## 索引建议
- **主键索引**: id (已存在)
- **业务索引**: 
  - template_id (模板查询)
  - user_id (用户查询)
  - status (状态查询)
  - generate_time (生成时间查询)
  - create_time (创建时间查询)
- **复合索引**: 
  - (template_id, status) (模板状态查询)
  - (user_id, generate_time) (用户时间查询)
  - (status, generate_time) (状态时间查询)
- **时间索引**: 
  - generate_time (按生成时间排序)
  - create_time (按创建时间排序)

## 注意事项
- **日志保留**: 合理设置日志保留期限避免数据过度膨胀
- **性能影响**: 日志记录不应影响文档生成的性能
- **存储优化**: 大量日志数据需要考虑存储优化策略
- **隐私保护**: 日志中不应包含敏感的个人信息
- **错误处理**: 完善的错误信息记录便于问题排查
- **并发控制**: 高并发场景下的日志写入控制
- **数据完整性**: 确保日志记录的完整性和准确性
- **查询优化**: 优化日志查询性能避免影响系统
- **归档策略**: 制定合理的历史日志归档策略
- **监控告警**: 监控异常日志并及时告警
- **数据格式**: params和result字段存储JSON格式数据
- **文件清理**: 定期清理无效的生成文件
- **统计分析**: 利用日志数据进行业务分析和优化
- **备份恢复**: 重要日志数据需要定期备份
- **权限控制**: 控制日志数据的访问权限
- **实时性**: 确保日志记录的实时性和准确性