Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Setup

系统对象操作接口

Hierarchy

  • Setup

Index

Methods

Methods

batchInsert

  • batchInsert(records: Record[]): string[]

  • 批量插入记录

    Parameters

    Returns string[]

    插入成功的记录id集

batchUpdate

  • batchUpdate(records: Record[]): string[]

  • 批量更新记录

    Parameters

    Returns string[]

    更新的记录id集

count

  • 计数满足条件记录数

    example
    
import * as db from 'db';

let s = db.setup('setup_object');
let cond = {
    conjunction: db.Conjunction.AND,
    conditions: [
        {
            field: "name",
            "operator": db.Operator.eq,
            "value": 'setup_name'
        }
    ]
}
let num = s.count(cond);

    Parameters

    Returns number

    满足条件的记录数

delete

  • delete(id: string): number

  • 按照id删除记录

    Parameters

    • id: string

      记录id

    Returns number

    影响记录数

deleteByCondition

  • deleteByCondition(condition?: Condition): number

  • 按照条件删除记录, 最多只能删除5000条记录

    Parameters

    Returns number

insert

  • insert(record: Record): string

  • 创建记录

    Parameters

    Returns string

    新增记录id

query

  • 按照id查询记录

    Parameters

    • id: string

      记录id

    Returns Record

    记录

queryByCondition

  • 支持限制查询返回的记录条数，通过skip值指定从第多少条开始，limit指定总共返回多少条记录。 在不指定skip, limit情况，默认值为skip=0, limit=5000，意味着查询返回结果集的前5000条。 limit最大值可设置为10000条，意味着该查询接口最多只能返回查询结果集的前10000条。

    Parameters

    • Optional condition: Condition

      匹配条件

    • Optional option: Option

      查询选项

    • Optional relation: Relation

      父子关系

    Returns Record[]

    记录集

update

  • update(id: string, record: Record): number

  • 按照id更新记录

    Parameters

    • id: string

      记录id

    • record: Record

      更新内容

    Returns number

    影响记录数

updateByCondition

  • 按照条件更新记录，最多只能更新5000条记录

    Parameters

    • record: Record

      需要更新的内容

    • Optional condition: Condition

      匹配条件

    Returns number