Interface Orm

Inserting Data in Batches

Returns

ID list of records that are successfully inserted.

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);
Copy

Batch Update Records

Returns

string[] ids of the inserted records

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);
Copy

Creating Parent-Child Object Combination Records in Batches

Returns

Insert the record set ID list.

Example

import * as db from 'db';

let s = db.object('Customer__CST');

// Parent and child records need to be associated with each other through associated fields.
// For example, the following records are associated with each other through `Contacts` to
// form a combined record.
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);
Copy

Count the number of records that meet the condition.

Returns

Number of records that meet the conditions

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);
Copy

Deletes records by ID.

Returns

Number of records affected

Delete records based on conditions.

Returns

Number of records affected

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);
Copy

Newly added records

Returns

Specifies the ID of a new record.

Query records by 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);
Copy

Query records by condition. The number of returned records can be limited. The skip value specifies the number of records from which the query starts, and the limit value specifies the number of returned records.

If skip and limit are not specified, the default values are skip=0 and limit=5000, indicating that the first 5000 records in the result set are returned. The maximum limit can be set to 10000, indicating that the query interface can return only the first 10000 records in the query result set.

Returns

Recordsets that meet the conditions

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);
Copy

Updates records by ID.

Returns

Number of records affected

Update records based on conditions

Returns

Number of records affected

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);

Copy