ClientRepository

Extends

CustomRepository

Members

selectAsStore

For core module (without Ext) - do the same as {ClientRepository.selectAsObj}

For EntJS based client (actual implementation in {UB.ux.data.UBStore}) - create store based on request, constructed by Repository. Return promise resolved to loaded {UB.ux.data.UBStore} instance.

 UB.Repository('ubm_navshortcut').attrs(['ID', 'code']).where('code', 'in', ['uba_user', 'ubs_audit'])
 .selectAsStore().done(function(store){
     console.log(store.getTotalCount()); // here store is UB.ux.data.UBStore instance
 });

Overrides:

CustomRepository#selectAsStore

select

Alias to {ClientRepository.selectAsObject}

Overrides:

CustomRepository#select

Enumeration of all condition types. This enumeration defines a set of String values. It exists primarily for documentation purposes - in code use the actual string values like '>', don't reference them through this class like WhereCondition.more.

We define several aliases for the same condition. In case of direct HTTP request (without Repository) use only non-aliased values (i.e. more instead of '>' or 'gt')

Properties:

Name	Type	Description
`gt`	string
`">"`	string
`more`	string
`lt`	string
`"<"`	string
`less`	string
`eq`	string
`"="`	string
`equal`	string
`ge`	string
`geq`	string
`">="`	string
`moreEqual`	string
`le`	string
`leq`	string
`"<="`	string
`lessEqual`	string
`ne`	string
`neq`	string
`"<>"`	string
`"!="`	string
`"!=="`	string
`notEqual`	string
`contains`	string
`like`	string
`notContains`	string
`notLike`	string
`isNull`	string
`null`	string
`notNull`	string
`notIsNull`	string
`isNotNull`	string
`beginWith`	string
`startWith`	string
`startsWith`	string
`startswith`	string
`notBeginWith`	string
`notStartWith`	string
`notStartsWith`	string
`includes`	string
`in`	string
`notIncludes`	string
`notIn`	string
`match`	string
`subquery`	string
`exists`	string
`notExists`	string
`custom`	string

CustomRepository#WhereCondition

Methods

selectAsObject(fieldAliasopt) → Promise

Asynchronously run request, constructed by Repository. Return promise, resolved to array of object representation of response.

 UB.Repository('ubm_navshortcut').attrs(['ID', 'code'])
 .where('code', 'in', ['uba_user', 'ubs_audit'])
 .selectAsObj().done(function(store){
     console.log(store); // output is [{"ID":3000000000004,"code":"uba_user"},{"ID":3000000000039,"code":"ubs_audit"}]
 });

Arguments:

[fieldAlias] (Object) Optional object to change attribute names during transform array to object

Overrides:

CustomRepository#selectAsObject

selectAsArray() → Promise

Asynchronously run request, constructed by Repository. Return promise, resolved to array of array representation of response. Actual data is placed to resultData response property.

 UB.Repository('ubm_navshortcut').attrs(['ID', 'code'])
 .where('code', 'in', ['uba_user', 'ubs_audit'])
 .select().done(UB.logDebug);
 // output is {"resultData":{"data":[[3000000000004,"uba_user"],[3000000000039,"ubs_audit"]],"fields":["ID","code"]},"total":2}

Response MAY (but may not even for the same request) contain other variables, returned by server in case data retrieved not from cache

 UB.Repository('uba_user').attrs(['ID', 'name', 'ID.name']) // since uba_user have `unity` mixin it ID property point us to parent (`uba_subject` in this case)
 .selectAsArray().done(UB.logDebug);
 // {"entity":"uba_user","fieldList":["ID","name","ID.name"],"method":"select","resultData":{"fields":["ID","name","ID.name"],"rowCount":1,"data":[[10,"admin","admin"]]},"total":1}

But resultData is always present

Overrides:

CustomRepository#selectAsArray

using(methodName)

Retrieve a data from server using methodName entity method. By default select method will be used.

Arguments:

methodName (string)

CustomRepository#using

attrs(attr) → CustomRepository

Add fields to collection. Can take one attribute name as string or array of attributes. Duplicate is not checked and in case of duplicate attribute caller got server error.

 UB.Repository('tri_srf_reg').attrs('ID').attrs(['code', 'name']).attrs('fullName', 'newCode');

Can take expression as a field. In this case entity attribute name must be wrapped into [] brackets. In case of client-side execution the only valid expression is one of:

'SUM', 'COUNT', 'AVG', 'MAX', 'MIN', 'CAST', 'COALESCE'

Example:

 UB.Repository('tri_srf_reg').attrs('SUM([payment])').where('documentID', '=', value); //will calculate sum of document payments

If case of server-side execution any valid SQL expression is accepted:

 UB.Repository('uba_user').attrs('[ID] / 100 + 1').selectAsArray()

Arguments:

attr (String|Array)

CustomRepository#attrs

where(expression, condition, valuesopt, clauseNameopt) → CustomRepository

Add where expression. Fix some known issues:

if attribute name without brackets is passed to expression parameter then wrap attribute to brackets "ID" -> "[ID]"
transform some dummy expressions to more simple form: in ['one'] -> equal 'one',in []->0=1,? null->isNull` e.t.c.
expression may contains this functions: 'SUM', 'COUNT', 'AVG', 'MAX', 'MIN', 'CAST', 'COALESCE', 'LENGTH', 'LOWER', 'UPPER', 'DAY', 'MONTH', 'YEAR', 'ROUND', 'FLOOR', 'CEILING'

In and 'notIn` conditions can take a sub-repository as a values parameter value. See CustomRepository.exists for a conplex example

Arguments:

expression (String) Attribute name (with or without []) or valid expression with attributes in [].
condition (WhereCondition|String) Any value from WhereCondition list.
[values] (*) Condition value. In case expression is complex can take {Object} as value. In case values === undefined no values property passed to where list
[clauseName] (String) Optional clause name to be used in {CustomRepository.logicalPredicates}. If not passed where will generate unique clause named 'c1', 'c2', ......

CustomRepository#where

Example

UB.Repository('my_entity').attrs('id')
          .where('code', 'in', ['1', '2', '3'])  // code in ('1', '2', '3')
          .where('code', 'in', UB.Repository('my_codes').attr('code').where('ID', '<', 10)  // code in (select code from my_codes where id = 10)
          .where('[name]', 'contains', 'Homer'). // name like '%homer%'
          .where('[birtday]', 'geq', new Date()).where('birtday', 'leq', new Date() + 10) //(birtday >= '2012-01-01') AND (birtday <= '2012-01-02')
          .where('[age] -10', '>=', {age: 15}, 'byAge') // (age + 10 >= 15)
          .where('LENGTH([code]), '<', 5)
          .where('', 'match', 'myvalue') // for condition match expression not need

exists(subRepository, clauseNameopt) → CustomRepository

Add an expression with EXISTS sub-query. Inside a sub-query there is two macro:

{master} will be replaced by master entity alias

{self} will be replaced by sub-query entity alias

//select users UB.Repository('uba_user').attrs(['ID', 'name'])

// who are not disabled
.where('disabled', '=', 0)
// which allowed access from Kiev
.where('trustedIP', 'in',
  UB.Repository('geo_ip').attrs('IPAddr')
    .where('city', '=', 'Kiev')
)
// who do not login during this year
.notExists(
  UB.Repository('uba_audit')
    .correlation('actionUser', 'name')  // here we link to uba_user.name
    .where('actionTime', '>', new Date(2016, 1, 1))
    .where('actionType', '=', 'LOGIN')
)
// but modify some data
.exists(
  UB.Repository('ubs_audit')
    .correlation('actionUser', 'ID') // here we link to uba_user.ID
    .where('actionTime', '>', new Date(2016, 1, 1))
)
.select()

Arguments:

subRepository (CustomRepository) Repository, what represent a sub-query to be execute inside EXISTS statement
[clauseName] (String) Optional clause name

CustomRepository#exists

notExists(subRepository, clauseNameopt) → CustomRepository

Add an expression with NOT EXISTS sub-query. See CustomRepository.exists for sample

Arguments:

subRepository (CustomRepository) Repository, what represent a sub-query to be execute inside EXISTS statement
[clauseName] (String) Optional clause name

CustomRepository#notExists

correlation(subQueryAttribute, masterAttribute, conditionopt, clauseNameopt) → CustomRepository

If current repository are used as a sub-query for exists, notExists, in or notIn conditions will add a correlation with a master repository

Arguments:

subQueryAttribute (String)
masterAttribute (String)
[condition=eq] (WhereCondition|String) A subset from WhereCondition list applicable for correlation join
[clauseName] (String) Optional clause name to be used in {CustomRepository.logicalPredicates}. If not passed where will generate unique clause named 'c1', 'c2', ......

CustomRepository#correlation

logic(predicate) → CustomRepository

Arrange where expressions in logical order. By default where expressions is joined by AND logical predicate. Here is possible to join it in custom order.

 UB.Repository('my_entity').attrs('id')
     .where('code', 'in', ['1', '2', '3'], 'byCode')  // code in ('1', '2', '3')
     .where('name', 'contains', 'Homer', 'byName') // name like '%homer%'
     .where('birtday', 'geq', new Date()).where('birtday', 'leq', new Date() + 10) //(birtday >= '2012-01-01') AND (birtday <= '2012-01-02')
     .where('[age] -10', '>=', {age: 15}, 'byAge') // (age + 10 >= 15)
     .logic('(([byCode]) OR ([byName]))') // (byCode OR byName) AND (all where items, not included in logic)

Arguments:

predicate (String) logical predicate.

CustomRepository#logic

join(whereItemName) → CustomRepository

Force where expressions to be used in join SQL statement instead of where. Applicable only for not cached entities.

 // will generate
 // SELECT A.ID, B.code FROM tst_document A LEFT JOIN tst_category B ON (B.instanceID = A.ID and B.ubUser = 10)
 // instead of
 // SELECT A.ID, B.code FROM tst_document A LEFT JOIN tst_category B ON B.instanceID = A.ID WHERE B.ubUser = 10
 UB.Repository('tst_document').attrs(['ID', '[caregory.code]'])
     .where('[caregory.ubUser]', '=', 10, 'wantInJoin')
     .join('wantInJoin')
     .selectAsObject().done(UB.logDebug);

Arguments:

whereItemName (String) name of where item to use in join.

CustomRepository#join

joinCondition(expression, condition, valuesopt, clauseNameopt) → CustomRepository

Add join condition. Fix some known issues

Arguments:

expression (String) Attribute name (with or without []) or valid expression with attributes in [].
condition (WhereCondition) Any value from WhereCondition list.
[values] (*) Condition value. In case expression is complex can take {Object} as value. In case values === undefined no values property passed to where list
[clauseName] (String) Optional clause name to be used in {CustomRepository.logicalPredicates}. If not passed where will generate unique clause named 'c1', 'c2', ......

CustomRepository#joinCondition

orderBy(attr, directionopt) → CustomRepository

Add sorting

 UB.CustomRepository('my_entity').attrs('ID').orderBy('code')

Arguments:

attr Sorted attribute
[direction='asc'] Sort direction ('asc'|'desc')

CustomRepository#orderBy

orderByDesc(attr) → CustomRepository

Add desc sorting. The same as orderBy(attr, 'desc')

 UB.Repository('my_entity').attrs('ID').orderBy('code').orderByDesc('date_create') // ORDER BY code, date_create DESC

Arguments:

attr (String)

CustomRepository#orderByDesc

groupBy(attr) → CustomRepository

Add grouping Can take one attribute name as string or array of attributes name

 UB.Repository('my_entity').attrs('ID').groupBy('code')
 UB.Repository('uba_user').attrs('disabled').groupBy('disabled').select()
 UB.Repository('uba_user').attrs(['disabled','uPassword','COUNT([ID])']).groupBy(['disabled','uPassword']).select()

Arguments:

attr Grouped attribute

CustomRepository#groupBy

start(start) → CustomRepository

Add options.start value to retrieve first start rows

 var store = UB.Repository('my_entity').attrs('id').start(15).limit(10).select() //will return ID's from 15 to 25

Arguments:

start (Number)

CustomRepository#start

limit(resultRowsLimit) → CustomRepository

Add options.limit value. Can be combined with {@link CustomRepository#start).

 var store = UB.CRepository('my_entity').attrs('id').limit(2).select() ; //will return first two ID's from my_entity

Arguments:

resultRowsLimit (Number)

CustomRepository#limit

describe(value) → CustomRepository

For debug purpose only.

If set, in GUI mode will put this description into log before query execution

 var store = UB.Repository('my_entity').attrs('ID').describe('Select all record for "my_entity"').select()

Arguments:

value (String)

CustomRepository#describe

ubql() → Object

Construct a UBQL JSON request. Used in CustomRepository#select

  var repo = UB.Repository('my_entity').attrs('ID').where('code', '=', 'a')
  var inst = new TubDataStore(my_entity);
  inst.run('select', repo.ubql());

CustomRepository#ubql

misc(flags) → CustomRepository

Apply miscellaneous options to resulting ubRequest:

     // this server-side call will select all currency, including deleted
     UB.Repository('cdn_currency').attrs(['ID']).misc({__allowSelectSafeDeleted: true}).selectAsArray();

Arguments:

flags (Object)
Properties
1. [__mip_ondate] (Date) Specify date on which to select data for entities with dataHistory mixin. Default to Now()
2. [__mip_recordhistory=false] (Boolean) Select only record history data for specified ID (for entities with dataHistory mixin)
3. [__mip_recordhistory_all=false] (Boolean) Ignore __mip_ondate and select all data (acts as select for entities without dataHistory mixin)
4. [__mip_disablecache=false] (Boolean) For entities with cacheType in ["Session", "SessionEntity"] not check is data modified and always return result
5. [__skipOptimisticLock=false] (Boolean) Skip optimistic lock for entities with mStorage.simpleAudit = true
6. [__allowSelectSafeDeleted=false] (Boolean) Server-side only.
7. [__skipSelectAfterUpdate=false] (Boolean) Server-side only.
8. [__skipSelectAfterInsert=false] (Boolean) Server-side only.
9. [__skipRls=false] (Boolean) Server-side only.
10. [__skipAclRls=false] (Boolean) Server-side only.

CustomRepository#misc

withTotal() → CustomRepository

Calculate total row number. WARNING!! This is VERY slow operation on DB level in case of many record

Result of calculation is returned in __totalRecCount parameter value in case selectAsArray() client call:

     var result = UB.Repository('uba_user').attrs(['ID', 'description']).withTotal().selectAsArray();
            console.log('Total count is:', result.__totalRecCount)

Or into TubDataStore.totalRowCount in case of server side selectAsStore() call:

     var store = UB.Repository('uba_user').attrs(['ID', 'description']).withTotal().selectAsStore();
            console.log('Total count is:', store.totalRowCount);

CustomRepository#withTotal