@h-ai/reldb 1.0.0-beta.18 → 1.0.0-beta.19

package/dist/index.d.ts

@@ -192,6 +192,38 @@ declare function parseJsonPath(path: string): string[];
  */
 declare function createJsonOps(dbType: 'sqlite' | 'postgresql' | 'mysql'): ReldbJsonOps;
 
+/** 模块维护自己的迁移；这里只提供跨数据库列检查、版本账本和执行边界。 */
+
+/**
+ * 一个可重入的模块升级步骤；只接收代码中固定的 SQL 与表名。
+ * @example
+ * ```ts
+ * import type { SchemaMigration } from '@h-ai/reldb'
+ * const steps: SchemaMigration[] = []
+ * ```
+ */
+interface SchemaMigration {
+    version: number;
+    name: string;
+    needed: (sql: DmlOperations) => Promise<HaiResult<boolean>>;
+    apply: (sql: DmlOperations) => Promise<HaiResult<unknown>>;
+}
+/**
+ * 只读预检结果；生产升级需先停旧写入并备份数据库与共享缓存。
+ * @example
+ * ```ts
+ * import type { SchemaMigrationPlan } from '@h-ai/reldb'
+ * function changes(plan: SchemaMigrationPlan) { return plan.changes }
+ * ```
+ */
+interface SchemaMigrationPlan {
+    module: string;
+    currentVersion: number;
+    targetVersion: number;
+    changes: string[];
+    requiresExclusiveAccess: boolean;
+}
+
 /**
  * HaiReldbError 的数据约束与操作契约。
  * @example
@@ -957,6 +989,28 @@ interface ReldbFunctions {
     readonly crud: CrudManager;
     /** 事务管理器 */
     readonly tx: TxManager;
+    /**
+     * 预检或执行模块维护的版本迁移；绑定当前数据库，不接受其它模块实例。
+     * @example
+     * ```ts
+     * import { reldb } from '@h-ai/reldb'
+     * const plan = await reldb.migrateSchema('example', [], { dryRun: true })
+     * if (!plan.success) throw new Error(plan.error.message)
+     * ```
+     */
+    migrateSchema: (module: string, steps: readonly SchemaMigration[], options?: {
+        dryRun?: boolean;
+    }) => Promise<HaiResult<SchemaMigrationPlan>>;
+    /**
+     * 只读查询当前数据库真实列名；sql 可指定当前事务，不创建表。
+     * @example
+     * ```ts
+     * import { reldb } from '@h-ai/reldb'
+     * const columns = await reldb.schemaColumns('hai_iam_users')
+     * if (!columns.success) throw new Error(columns.error.message)
+     * ```
+     */
+    schemaColumns: (table: string, sql?: DmlOperations) => Promise<HaiResult<string[]>>;
     /** 当前数据库脱敏配置快照（未初始化时为 null） */
     readonly config: ReldbConfig | null;
     /** 是否已初始化 */
@@ -1458,59 +1512,6 @@ declare abstract class BaseReldbCrudRepository<TItem> implements ReldbCrudReposi
  */
 declare const reldb: ReldbFunctions;
 
-/** 模块维护自己的迁移；这里只提供跨数据库列检查、版本账本和执行边界。 */
-
-/**
- * 一个可重入的模块升级步骤；只接收代码中固定的 SQL 与表名。
- * @example
- * ```ts
- * import type { SchemaMigration } from '@h-ai/reldb'
- * const steps: SchemaMigration[] = []
- * ```
- */
-interface SchemaMigration {
-    version: number;
-    name: string;
-    needed: (sql: DmlOperations) => Promise<HaiResult<boolean>>;
-    apply: (sql: DmlOperations) => Promise<HaiResult<unknown>>;
-}
-/**
- * 只读预检结果；生产升级需先停旧写入并备份数据库与共享缓存。
- * @example
- * ```ts
- * import type { SchemaMigrationPlan } from '@h-ai/reldb'
- * function changes(plan: SchemaMigrationPlan) { return plan.changes }
- * ```
- */
-interface SchemaMigrationPlan {
-    module: string;
-    currentVersion: number;
-    targetVersion: number;
-    changes: string[];
-    requiresExclusiveAccess: boolean;
-}
-/**
- * 查询真实列名；不创建表，不把查询错误当成新安装。
- * @example
- * ```ts
- * import { reldb, schemaColumns } from '@h-ai/reldb'
- * const columns = await schemaColumns(reldb, 'hai_iam_users')
- * ```
- */
-declare function schemaColumns(db: ReldbFunctions, table: string, sql?: DmlOperations): Promise<HaiResult<string[]>>;
-/**
- * 预检或执行模块维护的版本迁移。SQLite/PostgreSQL 原子提交；MySQL DDL 隐式提交，步骤须可重入。
- * 失败不记录目标版本；重启重新检查真实结构。新版本账本拒绝旧代码向下迁移。
- * @example
- * ```ts
- * import { reldb, migrateSchema } from '@h-ai/reldb'
- * const plan = await migrateSchema(reldb, 'example', [], { dryRun: true })
- * ```
- */
-declare function migrateSchema(db: ReldbFunctions, module: string, steps: readonly SchemaMigration[], options?: {
-    dryRun?: boolean;
-}): Promise<HaiResult<SchemaMigrationPlan>>;
-
 /**
  * @h-ai/reldb — 安全工具
  *
@@ -1588,4 +1589,5 @@ declare function quoteIdentifier(name: string): string;
  */
 declare function escapeSqlString(value: string): string;
 
-export { BaseReldbCrudRepository, type BaseReldbCrudRepositoryConfig, type ColumnType, type CrudConfig, type CrudManager, type CrudPageOptions, type CrudQueryOptions, DbType, type DdlOperations, type DmlOperations, type DmlWithTxOperations, type ExecuteResult, HaiReldbError, type JsonSqlExpr, type NormalizedPagination, type PaginationOverrides, type PaginationQueryOptions, type QueryRow, type ReldbColumnDef, ReldbConfig, ReldbConfigInput, type ReldbCrudCountOptions, type ReldbCrudFieldDefinition, type ReldbCrudRepository, type ReldbFunctions, type ReldbIndexDef, type ReldbJsonOps, type ReldbTableDef, type SchemaMigration, type SchemaMigrationPlan, type TxManager, type TxWrapCallback, createJsonOps, escapeSqlString, migrateSchema, parseJsonPath, quoteIdentifier, reldb, schemaColumns, validateIdentifier, validateIdentifiers };
+export { BaseReldbCrudRepository, DbType, HaiReldbError, ReldbConfig, ReldbConfigInput, createJsonOps, escapeSqlString, parseJsonPath, quoteIdentifier, reldb, validateIdentifier, validateIdentifiers };
+export type { BaseReldbCrudRepositoryConfig, ColumnType, CrudConfig, CrudManager, CrudPageOptions, CrudQueryOptions, DdlOperations, DmlOperations, DmlWithTxOperations, ExecuteResult, JsonSqlExpr, NormalizedPagination, PaginationOverrides, PaginationQueryOptions, QueryRow, ReldbColumnDef, ReldbCrudCountOptions, ReldbCrudFieldDefinition, ReldbCrudRepository, ReldbFunctions, ReldbIndexDef, ReldbJsonOps, ReldbTableDef, SchemaMigration, SchemaMigrationPlan, TxManager, TxWrapCallback };