/** * PushPGUserMigrations 的单条 migration 输入 */ export interface IPGUserMigrationInput { /** migration 版本,14 位数字时间串,如 20260526000000 */ Version: string; /** migration 名称,仅允许小写字母和下划线 */ Name: string; /** 要执行的 SQL */ Query: string; /** 回滚 SQL(可选) */ Rollback?: string; } /** * 批量应用 PG 用户 migrations 请求参数 */ export interface IPushPGUserMigrationsOptions { /** 云开发环境 ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** migration 列表(至少 1 条) */ Migrations: IPGUserMigrationInput[]; /** 获取数据库锁最长等待时间(毫秒) */ LockTimeoutMs?: number; /** 单条 SQL 最长执行时间(毫秒) */ StatementTimeoutMs?: number; /** 是否允许 out-of-order local migrations */ IncludeAll?: boolean; } /** * 批量应用 PG 用户 migrations 返回参数 */ export interface IPushPGUserMigrationsResult { /** 请求唯一 ID */ RequestId: string; /** 异步任务 ID,可用于查询任务进度 */ TaskId: string; } /** * 预览 PG 用户 migrations 请求参数 */ export interface IPreviewPGUserMigrationsOptions { /** 云开发环境 ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** migration 列表(至少 1 条) */ Migrations: IPGUserMigrationInput[]; /** 是否允许 out-of-order local migrations */ IncludeAll?: boolean; } /** * migration 计划项 */ export interface IPGUserMigrationPlanItem { /** migration 版本 */ Version: string; /** migration 名称 */ Name: string; /** 当前状态(例如 applied / pending) */ Status?: string; /** 状态原因(例如 checksum_matched) */ Reason?: string; /** migration 内容校验和 */ Checksum?: string; /** 来源标记(响应字段,服务端可能返回) */ Source?: string; } /** * migration 冲突项 */ export interface IPGUserMigrationConflict { /** 发生冲突的 migration 版本 */ Version: string; /** 本地 migration 名称 */ Name?: string; /** 远端(数据库已应用)migration 名称 */ RemoteName?: string; /** 本次 SQL 计算出来的 checksum */ LocalChecksum?: string; /** 数据库中已应用 migration 的 checksum */ RemoteChecksum?: string; /** 冲突原因(如 checksum_mismatch) */ Reason?: string; /** 冲突详情信息 */ Message?: string; /** 兼容服务端未来扩展字段 */ [key: string]: any; } /** * 预览 PG 用户 migrations 返回参数 */ export interface IPreviewPGUserMigrationsResult { /** 将要执行的 migration 列表 */ Pending: IPGUserMigrationPlanItem[] | null; /** 已经应用过的 migration 列表 */ Applied: IPGUserMigrationPlanItem[] | null; /** checksum 冲突列表 */ Conflicts: IPGUserMigrationConflict[] | null; /** 是否可直接执行(当前主要表示无 checksum 冲突) */ Executable: boolean; /** 请求唯一 ID */ RequestId: string; } /** * 已应用的 PG 用户 migration 摘要项 */ export interface IPGUserMigrationSummary { /** migration 版本号,14 位数字时间串(如 20260526000000) */ Version: string; /** migration 名称 */ Name: string; } /** * 查询已应用 PG 用户 migrations 请求参数 */ export interface IListPGUserMigrationsOptions { /** 云开发环境 ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** 查询条数,取值范围 [1, 500],默认 100 */ Limit?: number; /** 分页偏移,默认 0 */ Offset?: number; } /** * 查询全部已应用 PG 用户 migrations 请求参数 */ export interface IListAllPGUserMigrationsOptions { /** 云开发环境 ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** 内部翻页每页大小,取值范围 [1, 500],默认 500 */ PageSize?: number; } /** * 查询已应用 PG 用户 migrations 返回参数 */ export interface IListPGUserMigrationsResult { /** 总数量 */ Total: number; /** 已应用的最新版本号,14 位数字时间串 */ LatestVersion: string; /** 已应用 migration 列表 */ Migrations: IPGUserMigrationSummary[]; /** 请求唯一 ID */ RequestId: string; } /** * 查询单条 PG 用户 migration 详情请求参数 */ export interface IDescribePGUserMigrationOptions { /** 云开发环境 ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** migration 版本号,14 位数字时间串(如 20260526000000) */ MigrationVersion: string; } /** * 查询单条 PG 用户 migration 详情返回参数 */ export interface IDescribePGUserMigrationResult { /** migration 版本号,14 位数字时间串 */ Version: string; /** migration 名称(仅小写字母和下划线) */ Name: string; /** migration SQL */ Query: string; /** 请求唯一 ID */ RequestId: string; } /** * 查询任务结果请求参数 */ export interface IDescribeTaskResultOptions { /** 云开发环境 ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** 任务 ID */ TaskId: string; } /** * 查询任务结果返回参数 */ export interface IDescribeTaskResultResult { /** 任务 ID */ TaskId: string; /** 任务类型(如 PGUserMigration) */ TaskType: string; /** 任务状态:Failed / Succeed / Accepted / Running */ Status: 'Failed' | 'Succeed' | 'Accepted' | 'Running' | string; /** 当前步骤 */ Phase: string; /** 失败原因(成功时可能为空) */ Reason: string; /** 创建时间(ISO 8601) */ CreatedAt: string; /** 最后更新时间(ISO 8601) */ UpdatedAt: string; /** 请求唯一 ID */ RequestId: string; } /** * 修复 PG 用户 migration history 请求参数 */ export interface IRepairPGUserMigrationHistoryOptions { /** 云开发环境 ID(可选,不传则自动使用当前环境 ID) */ EnvId?: string; /** migration 版本,14 位数字时间串,如 20260526000000 */ MigrationVersion: string; /** migration 版本名,仅允许小写字母和下划线 */ Name: string; /** 修复状态:applied(写入 history)或 reverted(删除 history) */ Status: 'applied' | 'reverted'; /** 修复原因 */ Reason: string; /** applied 时建议传入对应 SQL,reverted 时可不传 */ Query?: string; }