Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

Conditions

复合条件类型

Functions

bo

  • bo(name: string): Bo
  • 创建一个聚合对象

    Parameters

    • name: string

      聚合对象名称

    Returns Bo

commit

  • commit(): void
  • 提交当前的数据库操作

    example
    
    import { commit } from 'db';
    
    // ...一些数据库操作
    
    // 如果希望提前提交流程前面的数据库操作,调用commit
    commit();
    

    Returns void

dynamicObject

  • dynamicObject(name: string): Orm
  • 创建一个动态对象封装器,该接口适合操作编译时不确定对象名称,需要运行时指定的场景。

    注意:不需要useObject装饰,在App打包时,不会打包对象的元数据定义。

    example
    
    import * as db from 'db';
    
    class Demo {
        run(): void {
            let s = db.dynamicObject('Student__CST');
        }
    }
    

    Parameters

    • name: string

      对象名,可以指定自定义对象,标准对象。

    Returns Orm

    对象封装器

object

  • object(name: string, dynamic?: boolean): Orm
  • 创建一个对象封装器

    注意:需要使用useObject装饰,在App打包时,会打包对象的元数据定义。

    example
    
    import * as db from 'db';
    
    @useObject(['Student__CST'])
    class Demo {
        run(): void {
            let s = db.object('Student__CST');
        }
    }
    

    Parameters

    • name: string

      对象名,可以指定自定义对象,标准对象。

    • Optional dynamic: boolean

      被标识已经废弃使用,请使用db.dynamicObject接口。

    Returns Orm

    对象封装器

rollback

  • rollback(): void
  • 回滚当前的数据库事务。

    example
    
    import { rollback } from 'db';
    
    // ...一些数据库操作
    
    // 如果希望回滚流程前面的数据库操作,调用rollback
    rollback();
    

    Returns void

setup

  • setup(objectName: string): Setup
  • deprecated

    创建一个系统对象封装器。

    不建议使用该接口来直接操作系统对象,建议使用平台封装的系统SDK来操作。 如查询系统参数时, 使用 getParameter

    注意:不需要useObject装饰,在App打包时,不会打包对象的元数据定义。

    setup针对系统对象,object针对标准对象,定制对象。 两者的核心区别:系统对象为了性能,大部分都会缓存在进程私有缓存中,而标准对象,定制对象不会缓存。 如果是依据id的单独查询一条记录,setup直接从缓存查询结果,object需要从数据库查询结果,setup会快很多。 批量删除,更新时,setup反而性能很差, setup对象删除,更新记录时,需要作很多特殊处理,所以不能直接从数据库层面批量删除。 setup.updateByConditionsetup.deleteByCondition的实现方式是: 先调用object.queryByCondition从数据库查询出所有的满足条件的id, 然后依据id一个一个的去delete, update。

    example
    
    import * as db from 'db';
    
    class Demo {
        run(): void {
            let s = db.setup('CustomResource');
        }
    }
    

    Parameters

    • objectName: string

      对象名,可以指定系统对象。

    Returns Setup

    对象封装器

sql

  • 创建一个sql封装器

    Returns Sql

transaction

  • 把一系列数据操作封装成一个独立的事务。这些操作要么全成功,要么全失败。

    且成功与失败不影响外部的操作,外部的操作的成功失败也不影响transaction的结果。

    example
    
    import { transaction } from 'db';
    
    let op = function(): void {
         // 进行一些数据库操作
    }
    
    transaction(op);
    
    

    Parameters

    Returns void