Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This class is used to operate a database by providing ways to use some of the functional capabilities of this class in client-side scripts, for for example, UI policy scripts.
In SimpleRecord API, records and fields are included.
In this class, client-side queries execute on the server. That is, to get the record data, perform the request from the client browser., to get the record data,
Scoped applications do not provide the client-side SimpleRecord. Create Create an include script instead, or use API REST.
addQuery()
Using Use this method , you can to filter the records by specifying certain conditions (field, operator, value). AlsoAlso, this method can return returns records having a field equal to the value (or is in the list of the values).
Within this method, you can it is possible to use any preferred operator from the Condition Operators list. Please notice that you need Notice that it is necessary to use the system name of the operator in your the scripts.
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('task'); record.addQuery('number', 'like', 'TSK'); record.addQuery('subject', 'startswith', 'Email'); record.query(() => { while (record.next()) { console.log(record.number); // TSK0000128 } }); |
deleteRecord(responseFunction)
Using Use this method , to delete the current record.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
responseFunction | Function | N | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const taskRecord = new SimpleRecord('task'); taskRecord.get('123456789012345678', () => { taskRecord.deleteRecord(callback); }); function callback(response) { const answer = response.responseXML.documentElement.getAttribute('answer'); if (answer == '1') { console.log('Запись удалена'); } else { console.log(answer); } } |
get(recordId, callback)
This method loads an object from a database, based on the field value.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
recordId | String (thesys_id value) | Y | N |
callback | Function | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('user'); record.get(s_user.userID, () => { console.log(record.email); // admin@admin.ru }); |
getTableName()
This method getsreturns the current table name.
Return:
Type | Description |
---|---|
String | The table name value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('user'); record.get(s_user.userID, () => { console.log(record.getTableName()); // user }); |
hasNext()
Using Use this method , you can to define whether the selection contains any more records.
Return:
Type | Description |
---|---|
Boolean | This method returns TRUE 'true' if there are any more records; otherwise, it returns FALSE 'false'. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('user'); record.get(s_user.userID, () => { console.log(record.hasNext()); // true }); |
insert(responseFunction)
This method allows inserting a new record.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
responseFunction | Function | Y | N |
Return:
Type | Description |
---|---|
String | Sys_id of the record created. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const newRecord = new SimpleRecord('task'); newRecord.subject = 'Client-side insert'; newRecord.insert((response) => { const answer = response.responseXML.documentElement.getAttribute('answer'); console.log(answer); }) |
next()
Using Use this method , you can to move to the next record.
Return:
Type | Description |
---|---|
Boolean | This method returns FALSE 'false' if there are no more records in the query set. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('task'); record.addQuery('number', 'like', 'TSK'); record.addQuery('subject', 'startswith', '[SWD-10'); record.query(() => { while (record.next()) { console.log(record.number); // TSK0000128 } }); |
orderBy(column)
Using Use this method , you can specify an to specify an orderBy column. To order by multiple columns, call the method several times.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
Column | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('task'); record.addQuery('number', 'like', 'TSK'); record.orderBy('number'); record.query(() => { while (record.next()) { console.log(record.number); // >TSK0000128 >TSK0000129 >TSK0000130 ... } }); |
query(callback)
This method executes a query taking 0 or more parameters in any order. It takes any pair of literals as a query pair (field: value) and any function as a response function.
Do not make synchronous make synchronous query calls. The call becomes synchronous if a query is performed without a response function. In this case, the display will does not perform counting until it gets the query response.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
responseFunction | Function | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('user'); record.addQuery('sys_id', s_user.userID); record.query(() => { if (record.next()) { console.log(record.email); // admin@admin.ru } }); |
setLimit(maxQuery)
Using Use this method , you can to define the number of records in the query.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
maxQuery | Integer | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('task'); record.addQuery('number', 'like', 'TSK'); record.orderBy('sys_created_at'); // very first record record.setLimit(1); record.query(() => { while (record.next()) { console.log(record.number); // TSK0000002 //... } }); |
setValue(fieldName, value)
Using Use this method , you can to define a value for the field.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
value | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const record = new SimpleRecord('task'); record.setValue('subject', 'Another type of prop assignement'); record.insert((response) => { const answer = response.responseXML.documentElement.getAttribute('answer'); console.log(answer); }) |
Table of Contents | ||||
---|---|---|---|---|
|