Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Orm

对象封装器

Hierarchy

  • Orm

Index

Methods

batchInsert

  • batchInsert(records: Record[], flag?: Flag): string[]
  • 批量插入数据

    example
    
    import * as db from 'db';
    
    let s = db.object('Student__CST');
    let records = [
        {"name": "Tom","age__CST": "13"},
        {"name": "Jerry","age__CST": "12"},
    ];
    
    let ids = s.batchInsert(record);
    

    Parameters

    • records: Record[]

      记录集

    • Optional flag: Flag

      事务flag等

    Returns string[]

    成功插入记录的id列表

batchUpdate

  • batchUpdate(records: Record[], flag?: Flag): string[]
  • 批量更新记录

    example
    
    import * as db from 'db';
    
    let s = db.object('Student__CST');
    
    let records = [
        {"id":"00da000000f2scP5Bw36", "name": "Tom_t"},
        {"id":"00da000000f2scP5Bw37", "name": "Jerry_j"},
    ];
    
    let ids = s.batchUpdate(record);
    

    Parameters

    • records: Record[]

      记录集

    • Optional flag: Flag

      事务flag等

    Returns string[]

    string[] ids of the inserted records

compositeInsert

  • 批量创建父子对象组合记录

    example
    
    import * as db from 'db';
    
    let s = db.object('Customer__CST');
    
    // 父子记录需要通过关联字段关联起来,如下面的记录通过`Contacts`关联在一起,形成一条组合记录。
    let records = [ {
        "name": "hello",
        "count__CST": 123,
        "Contacts": {
            "records": [
            {
                "name": "hello_contact1"
            },
            {
                "name": "hello_contact2"
            }]
        }
    }];
    
    let ids = s.compositeInsert(records);
    console.log("id list = ", ids);
    

    Parameters

    • records: Record[]

      父子对象组合记录数组

    • Optional flag: Flag

      事务flag

    Returns Record[]

    插入记录集id列表

count

  • 计数满足条件记录数

    example
    
    import * as db from 'db';
    
    let s = db.object('Student__CST');
    let cond = {
        conjunction: db.Conjunction.AND,
        conditions: [
            {
                field: "age__CST",
                "operator": db.Operator.lt,
                "value": 10
            }
        ]
    }
    let num = s.count(cond);
    

    Parameters

    Returns number

    满足条件的记录数

delete

  • delete(id: string, flag?: Flag): number
  • 按照id删除记录

    Parameters

    • id: string

      记录id

    • Optional flag: Flag

      操作flag

    Returns number

    影响的记录数

deleteByCondition

  • 按照条件删除记录

    example
    
    import * as db from 'db';
    
    let s = db.object('Student__CST');
    let cond = {
        conjunction: db.Conjunction.AND,
        conditions: [
            {
                field: "name",
                operator: db.Operator.eq,
                value: "Tom"
            }
        ]
    }
    let num = s.deleteByCondition(cond);
    

    Parameters

    • condition: Condition

      匹配条件

    • Optional flag: Flag

      操作flag

    Returns number

    影响的记录数

insert

  • 新增加记录

    Parameters

    • record: Record

      记录

    • Optional flag: Flag

      操作flag

    Returns string

    新增记录id

query

  • 依据id查询记录

    example
    
    import * as db from 'db';
    
    let s = db.object('Student__CST');
    let id = '00da000000f2scP5Bw36';
    
    let option = {
        options: {
            fields: ["name", "age", "grade"],
        }
    };
    
    let record = s.query(id, option);
    

    Parameters

    • id: string

      记录id

    • Optional option: Option

      查询选项,在按照id查询的情况,主要可以指定查询字段集,其他选项没有效果。

    • Optional relation: Relation

      父子关系,如果需要级联查询出父子关系,则需要指定

    Returns Record

queryByCondition

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

    example
    
    import * as db from 'db';
    
    let s = db.object('Student__CST');
    
    let cond = {
        conjunction: db.Conjunction.AND,
        conditions:[
            {
                field: "age__CST",
                operator: db.Operator.lt,
                "value": 10
            }
        ]
    }
    
    let records = s.queryByCondition(cond);
    

    Parameters

    • condition: Condition

      匹配条件

    • Optional option: Option

      查询选项

    • Optional relation: Relation

      父子对象关系

    Returns Record[]

    满足条件的记录集

update

  • update(id: string, record: Record, flag?: Flag): number
  • 按照id更新记录

    Parameters

    • id: string

      记录id

    • record: Record

      需要更新的内容

    • Optional flag: Flag

      操作flag

    Returns number

    影响的记录数

updateByCondition

  • 按照条件更新记录

    example
    
    import * as db from 'db';
    
    let s = db.object('Student__CST');
    let cond = {
        conjunction: db.Conjunction.AND,
        conditions: [
            {
                field: "name",
                operator: db.Operator.eq,
                value: "Tom"
            }
        ]
    }
    let record = {
        "name": "NewTom",
        "age__CST": "14"
    };
    let num = s.updateByCondition(cond, record);
    
    

    Parameters

    • condition: Condition

      匹配条件

    • record: Record

      需要更新的内容

    • Optional flag: Flag

      操作flag

    Returns number

    影响的记录数