For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/reference/sdk/sapi/db/interfaces/TxContext.md.
  • English
  • Interface: TxContext

    Defined in: sapi/db/client.ts:38

    交互式事务上下文(db.tx / DbClient.tx 回调参数)。

    Methods

    query()

    query<T>(table: string, opts?: QueryOptions): Promise<T[]>;

    Defined in: sapi/db/client.ts:40

    事务内条件查询。

    Type Parameters

    Type ParameterDefault type
    T extends Record<string, unknown>Record<string, unknown>

    Parameters

    ParameterType
    tablestring
    opts?QueryOptions

    Returns

    Promise<T[]>


    get()

    get<T>(table: string, id: string | number): Promise<T | null>;

    Defined in: sapi/db/client.ts:45

    事务内按主键读取。

    Type Parameters

    Type ParameterDefault type
    T extends Record<string, unknown>Record<string, unknown>

    Parameters

    ParameterType
    tablestring
    idstring | number

    Returns

    Promise<T | null>


    insert()

    insert<T>(table: string, row: T): Promise<T>;

    Defined in: sapi/db/client.ts:50

    事务内插入。

    Type Parameters

    Type Parameter
    T extends Record<string, unknown>

    Parameters

    ParameterType
    tablestring
    rowT

    Returns

    Promise<T>


    update()

    update<T>(
       table: string, 
       id: string | number, 
       patch: Partial<T>): Promise<T>;

    Defined in: sapi/db/client.ts:52

    事务内更新。

    Type Parameters

    Type Parameter
    T extends Record<string, unknown>

    Parameters

    ParameterType
    tablestring
    idstring | number
    patchPartial<T>

    Returns

    Promise<T>


    delete()

    delete(
       table: string, 
       id: string | number, 
       opts?: {
      hard?: boolean;
    }): Promise<void>;

    Defined in: sapi/db/client.ts:58

    事务内删除。

    Parameters

    ParameterType
    tablestring
    idstring | number
    opts?{ hard?: boolean; }
    opts.hard?boolean

    Returns

    Promise<void>


    audit()

    audit(
       table: string, 
       rowId: string | number, 
       action: string, 
       data?: Record<string, unknown>): Promise<void>;

    Defined in: sapi/db/client.ts:60

    事务内写审计日志。

    Parameters

    ParameterType
    tablestring
    rowIdstring | number
    actionstring
    data?Record<string, unknown>

    Returns

    Promise<void>


    call()

    call<T>(name: string, input: Record<string, unknown>): Promise<T>;

    Defined in: sapi/db/client.ts:62

    交互会话内返回服务端真实 result

    Type Parameters

    Type ParameterDefault type
    Tunknown

    Parameters

    ParameterType
    namestring
    inputRecord<string, unknown>

    Returns

    Promise<T>