Files
WorthPath/docs/database-comments.json
T

406 lines
11 KiB
JSON

{
"tableCount": 8,
"columnCount": 73,
"tables": [
{
"TABLE_NAME": "exchangerate",
"TABLE_COMMENT": "用户原币兑本位币的历史汇率"
},
{
"TABLE_NAME": "icon",
"TABLE_COMMENT": "可复用账户图标"
},
{
"TABLE_NAME": "position",
"TABLE_COMMENT": "持有项目:账户、独立资产和借入借出债务"
},
{
"TABLE_NAME": "positionlink",
"TABLE_COMMENT": "项目关联关系,不参与金额求和"
},
{
"TABLE_NAME": "revision",
"TABLE_COMMENT": "余额历史:金额为变更后的绝对余额"
},
{
"TABLE_NAME": "session",
"TABLE_COMMENT": "登录会话与隐藏项目查看授权"
},
{
"TABLE_NAME": "transfer",
"TABLE_COMMENT": "资金往来及账户与债务的双边配对记账"
},
{
"TABLE_NAME": "user",
"TABLE_COMMENT": "用户及个人设置"
}
],
"columns": [
{
"TABLE_NAME": "exchangerate",
"COLUMN_NAME": "id",
"COLUMN_COMMENT": "唯一标识"
},
{
"TABLE_NAME": "exchangerate",
"COLUMN_NAME": "userId",
"COLUMN_COMMENT": "所属用户标识,用于数据隔离"
},
{
"TABLE_NAME": "exchangerate",
"COLUMN_NAME": "currency",
"COLUMN_COMMENT": "原始币种代码"
},
{
"TABLE_NAME": "exchangerate",
"COLUMN_NAME": "baseCurrency",
"COLUMN_COMMENT": "本位币代码"
},
{
"TABLE_NAME": "exchangerate",
"COLUMN_NAME": "date",
"COLUMN_COMMENT": "汇率业务日期"
},
{
"TABLE_NAME": "exchangerate",
"COLUMN_NAME": "rate",
"COLUMN_COMMENT": "每单位原币对应的本位币金额"
},
{
"TABLE_NAME": "exchangerate",
"COLUMN_NAME": "source",
"COLUMN_COMMENT": "汇率来源标识,保留已有历史来源"
},
{
"TABLE_NAME": "icon",
"COLUMN_NAME": "id",
"COLUMN_COMMENT": "唯一标识"
},
{
"TABLE_NAME": "icon",
"COLUMN_NAME": "ownerId",
"COLUMN_COMMENT": "上传用户标识;空可表示系统图标或原用户已删除"
},
{
"TABLE_NAME": "icon",
"COLUMN_NAME": "name",
"COLUMN_COMMENT": "显示名称"
},
{
"TABLE_NAME": "icon",
"COLUMN_NAME": "shared",
"COLUMN_COMMENT": "是否公开共享给已登录用户"
},
{
"TABLE_NAME": "icon",
"COLUMN_NAME": "hash",
"COLUMN_COMMENT": "规范化图标内容的 SHA-256 摘要"
},
{
"TABLE_NAME": "icon",
"COLUMN_NAME": "data",
"COLUMN_COMMENT": "规范化静态 PNG 图片二进制"
},
{
"TABLE_NAME": "icon",
"COLUMN_NAME": "source",
"COLUMN_COMMENT": "可选公开来源网址"
},
{
"TABLE_NAME": "icon",
"COLUMN_NAME": "createdAt",
"COLUMN_COMMENT": "记录创建时间,UTC"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "id",
"COLUMN_COMMENT": "唯一标识"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "userId",
"COLUMN_COMMENT": "所属用户标识,用于数据隔离"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "kind",
"COLUMN_COMMENT": "项目类型:account 账户、asset 独立资产、debt 债务"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "side",
"COLUMN_COMMENT": "统计方向:asset 资产或借出应收、liability 负债或借入应付"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "name",
"COLUMN_COMMENT": "显示名称"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "category",
"COLUMN_COMMENT": "项目分类代码"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "currency",
"COLUMN_COMMENT": "原始币种代码"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "notes",
"COLUMN_COMMENT": "用户备注,原文保留"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "archived",
"COLUMN_COMMENT": "是否归档;归档项目仍计入总额"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "createdAt",
"COLUMN_COMMENT": "记录创建时间,UTC"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "updatedAt",
"COLUMN_COMMENT": "记录更新时间,UTC"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "importedFromId",
"COLUMN_COMMENT": "备份导入来源项目标识,用于重复导入识别"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "hidden",
"COLUMN_COMMENT": "是否隐藏;未解锁时不参与可见范围统计"
},
{
"TABLE_NAME": "position",
"COLUMN_NAME": "iconId",
"COLUMN_COMMENT": "关联账户图标标识"
},
{
"TABLE_NAME": "positionlink",
"COLUMN_NAME": "id",
"COLUMN_COMMENT": "唯一标识"
},
{
"TABLE_NAME": "positionlink",
"COLUMN_NAME": "sourceId",
"COLUMN_COMMENT": "关联来源项目标识,通常为债务"
},
{
"TABLE_NAME": "positionlink",
"COLUMN_NAME": "targetId",
"COLUMN_COMMENT": "关联目标项目标识,通常为账户或资产"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "id",
"COLUMN_COMMENT": "唯一标识"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "positionId",
"COLUMN_COMMENT": "所属持有项目标识"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "amount",
"COLUMN_COMMENT": "变更后的原币绝对余额,不是收支增量,禁止对全部历史求和"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "effectiveDate",
"COLUMN_COMMENT": "北京时间业务时间对应的 UTC,精确到分钟"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "notes",
"COLUMN_COMMENT": "用户备注,原文保留"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "reason",
"COLUMN_COMMENT": "变更原因:初始、余额、估值、转账或借贷配对操作"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "createdAt",
"COLUMN_COMMENT": "记录创建时间,UTC"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "updatedAt",
"COLUMN_COMMENT": "记录更新时间,UTC"
},
{
"TABLE_NAME": "revision",
"COLUMN_NAME": "sequence",
"COLUMN_COMMENT": "数据库自增唯一顺序,同业务时间按此排序"
},
{
"TABLE_NAME": "session",
"COLUMN_NAME": "id",
"COLUMN_COMMENT": "随机会话令牌的 SHA-256 摘要"
},
{
"TABLE_NAME": "session",
"COLUMN_NAME": "userId",
"COLUMN_COMMENT": "所属用户标识,用于数据隔离"
},
{
"TABLE_NAME": "session",
"COLUMN_NAME": "expiresAt",
"COLUMN_COMMENT": "会话过期时间,UTC"
},
{
"TABLE_NAME": "session",
"COLUMN_NAME": "lastActivity",
"COLUMN_COMMENT": "最后有效交互时间,UTC"
},
{
"TABLE_NAME": "session",
"COLUMN_NAME": "revealUntil",
"COLUMN_COMMENT": "隐藏项目授权截止时间,UTC;空表示未解锁"
},
{
"TABLE_NAME": "session",
"COLUMN_NAME": "backupDigest",
"COLUMN_COMMENT": "已下载备份内容的 SHA-256 摘要"
},
{
"TABLE_NAME": "session",
"COLUMN_NAME": "backupExpiresAt",
"COLUMN_COMMENT": "备份清空确认凭据截止时间,UTC"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "id",
"COLUMN_COMMENT": "唯一标识"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "importedFromId",
"COLUMN_COMMENT": "备份导入来源项目标识,用于重复导入识别"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "userId",
"COLUMN_COMMENT": "所属用户标识,用于数据隔离"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "sourceId",
"COLUMN_COMMENT": "来源资产账户标识"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "targetId",
"COLUMN_COMMENT": "目标账户或债务标识"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "sourceRevisionId",
"COLUMN_COMMENT": "来源账户配对余额历史标识"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "targetRevisionId",
"COLUMN_COMMENT": "目标项目配对余额历史标识"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "sourceCurrency",
"COLUMN_COMMENT": "来源账户币种"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "targetCurrency",
"COLUMN_COMMENT": "目标项目币种"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "amount",
"COLUMN_COMMENT": "本次来源账户本金金额,不是变更后余额"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "received",
"COLUMN_COMMENT": "本次目标到账金额或债务本金金额"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "fee",
"COLUMN_COMMENT": "来源币种手续费;负数表示优惠"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "effectiveDate",
"COLUMN_COMMENT": "北京时间业务时间对应的 UTC,精确到分钟"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "notes",
"COLUMN_COMMENT": "用户备注,原文保留"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "createdAt",
"COLUMN_COMMENT": "记录创建时间,UTC"
},
{
"TABLE_NAME": "transfer",
"COLUMN_NAME": "operation",
"COLUMN_COMMENT": "操作类型:transfer 转账、borrow 借入、lend 借出、collect 收款、repay 还款"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "id",
"COLUMN_COMMENT": "唯一标识"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "username",
"COLUMN_COMMENT": "登录用户名,唯一"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "passwordHash",
"COLUMN_COMMENT": "登录密码的 bcrypt 哈希,不存储明文"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "baseCurrency",
"COLUMN_COMMENT": "本位币代码"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "createdAt",
"COLUMN_COMMENT": "记录创建时间,UTC"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "updatedAt",
"COLUMN_COMMENT": "记录更新时间,UTC"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "idleMinutes",
"COLUMN_COMMENT": "无操作退出分钟数,0 表示关闭"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "hiddenMenus",
"COLUMN_COMMENT": "隐藏菜单标识列表"
},
{
"TABLE_NAME": "user",
"COLUMN_NAME": "showNotes",
"COLUMN_COMMENT": "是否显示备注"
}
]
}