CustomRepository

Members

WhereCondition: string

Properties:

Methods

attrs(attr) → CustomRepository

Arguments:

1. attr (string|Array.<string>)

Example

// chaining
 UB.Repository('uba_user').attrs('ID').attrs('name', 'firstName').attrs('disabled').selectAsObject()

 // calculate sum over some attribute
 UB.Repository('uba_user').attrs('SUM([disabled])').where('disabled', '=', true).selectScalar()

 // In case of server-side execution any valid SQL expression is accepted by attr:
 UB.Repository('uba_user').attrs('[ID] / 100 + 1').selectAsArray()

 // JOIN `uba_userrole.roleID` is a attribute of type Entity. ORM choose `left join` in case attribute is `allowNull: true`
 UB.Repository('uba_userrole').attrs(['userID', 'userID.name']).selectAsObject()

 // todo Define a way to join for UNITY (@)

 // get values for attribute of type MANY
 UB.Repository('tst_maindata')
   .attrs('ID', 'manyValue', 'manyValue.caption')
   .where('code', '=', 'Код1')
   .selectAsObject({'manyValue.caption': 'captions'})
 // result is `[{"ID":331947938939292,"manyValue":"1,2","captions":"caption 10,caption 20"}]`

 // Get attribute value for multilaguage ("isMultiLang": true in meta file) attribute other when current session language
 UB.Repository('org_employee').attrs(['ID', 'lastName_en^']).selectAsObject()

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

Arguments:

1. subQueryAttribute (string)
2. masterAttribute (string)
3. [condition=eq] (WhereCondition|String)  A subset from WhereCondition list applicable for correlation join
4. [clauseName] (string)  Optional clause name to be used in logic. If not passed unique clause names ('c1', 'c2', ...) where will be generated

exists(subRepository, clauseNameopt) → CustomRepository

Arguments:

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

Example

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

groupBy(attr) → CustomRepository

Arguments:

1. attr (string|Array.<string>)  Grouped attribute(s)

Example

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

join(whereItemName) → CustomRepository

Arguments:

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

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

Arguments:

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

limit(rowsLimit) → CustomRepository

Arguments:

1. rowsLimit (number)

Example

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

logic(predicate) → CustomRepository

Arguments:

1. predicate (string)  logical predicate.

Example

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]))')

misc(flags) → CustomRepository

Arguments:

1. 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.

Example

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

notExists(subRepository, clauseNameopt) → CustomRepository

Arguments:

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

orderBy(attr, directionopt) → CustomRepository

Arguments:

1. attr (string)  Sorted attribute
2. [direction='asc'] (string)  Sort direction ('asc'|'desc')

Example

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

orderByDesc(attr) → CustomRepository

Arguments:

1. attr (string)

Example

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

select(storeConfigopt) abstract

Arguments:

1. [storeConfig]

selectAsArray() abstract

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

selectAsObject(fieldAliasesopt) → Array.<object> abstract

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

Arguments:

1. [fieldAliases] (Object.<string, string>)  Optional object to change attribute names during transform array to object

selectAsStore(storeConfigopt) abstract

Arguments:

1. [storeConfig]

selectById(ID) → Object|undefined abstract

Arguments:

1. ID (Number)  Row identifier

Example

UB.Repository('uba_user').attrs('name', 'ID').selectById(10).then(UB.logDebug)
  // will output: {name: "admin", ID: 10}

selectScalar() → Number|String|undefined abstract

Example

UB.Repository('uba_user')
    .attrs('name')
    .where('ID', '=', 10)
    .selectScalar().then(UB.logDebug) // will output `admin`
**WARNING** does not check if result contains the single row

selectSingle() → *|undefined abstract

Example

UB.Repository('uba_user').attrs('name', 'ID').where('ID', '=', 10)
   .selectSingle().then(UB.logDebug)
  // will output: {name: "admin", ID: 10}
**WARNING** method does not check if result contains the single row and always returns a first row from result

start(start) → CustomRepository

Arguments:

1. start (Number)

Example

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

ubql() → UBQL

Example

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

using(methodName)

Arguments:

1. methodName (string)

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

Arguments:

1. expression (string)  Attribute name (with or without []) or valid expression with attributes in []
2. condition (CustomRepository.WhereCondition|String)  Any value from WhereCondition
3. [values] (*)  Condition value. If undefined values not passed to ubql
4. [clauseName] (string)  Optional clause name to be used in {CustomRepository.logicalPredicates} If not passed where will generate unique clause named 'c1', 'c2', ......

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

withTotal() → CustomRepository

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

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