CustomRepository

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

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

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

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

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

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

  // 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('uba_auditTrail')
      .correlation('actionUser', 'ID') // here we link to uba_user.ID
      .where('actionTime', '>', new Date(2016, 1, 1))
  )
  .select()

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

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

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

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

Add join condition. Fix some known issues

Add sorting

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

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

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

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

Add options.start value to retrieve first start rows

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

Add options.limit value. Can be combined with start.

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

For debug purpose only.

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

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

Construct a UBQL JSON request. Used in CustomRepository#select

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

Must be implemented in descendants and return (or resolved for async clients) to array of object representation of result, like this

 [{"ID":3000000000004,"code":"uba_user"},{"ID":3000000000039,"code":"uba_auditTrail"}]

Must be implemented in descendants and return (or resolved for async clients) to array of array representation of result, like this

 {"resultData":{"fields":["ID","name","ID.name"],"rowCount":1,"data":[[10,"admin","admin"]]},"total":1,"__totalRecCount": totolRecCountIfWithTotalRequest}

Must be implemented in descendants and return (or resolved for async clients) to DataSet class instance, implemented in caller level. It can be:

• {TubDataStore} for in-server context
• {UB.ux.data.UBStore} for UnityBase adminUI client
• array of array data representation for UnityBase remote connection
• etc.

Must be implemented in descendants as a alias to the most appropriate method

Select a single row. If ubql result is empty - return {undefined}.

WARNING method do not check repository contains the single row and always return a first row from result.

Perform select and return a value of the first attribute from the first row

WARNING method do not check repository contains the single row

Select a single row by ID. If ubql result is empty - return {undefined}

If result not empty - return a object

{attr1: val1, arrt2: val2}

for server side or Promise resolved to object for client

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

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:

      let 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:

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