cterasdk.core.query module

cterasdk.core.query module#

class cterasdk.core.query.Filter(field)#

Bases: Object

class cterasdk.core.query.FilterBuilder(name, reference=False)#

Bases: Object

after(value)#
before(value)#
eq(value)#
ge(value)#
gt(value)#
le(value)#
like(value)#
lt(value)#
ne(value)#
notLike(value)#
static ref(name)#
setValue(value)#
class cterasdk.core.query.FilterType#

Bases: object

Boolean = 'BooleanFilter'#
BooleanRefFilter = 'BooleanRefFilter'#
DateTime = 'DateTimeFilter'#
IntRefFilter = 'IntRefFilter'#
Integer = 'IntFilter'#
RefFilter = 'RefFilter'#
String = 'StringFilter'#
static fromValue(value, ref)#
class cterasdk.core.query.QueryParamBuilder#

Bases: object

addFilter(query_filter)#
allPortals(allPortals)#
build()#
countLimit(countLimit)#
include(include)#
include_classname()#
orFilter(orFilter)#
ownedBy(ownedBy)#
put(key, value)#
sortBy(sortBy)#
startFrom(startFrom)#
class cterasdk.core.query.QueryParams#

Bases: Object

include_classname()#
increment()#
class cterasdk.core.query.Restriction#

Bases: object

EQUALS = 'eq'#
GREATER_EQUALS = 'ge'#
GREATER_THAN = 'gt'#
LESS_EQUALS = 'le'#
LESS_THAN = 'lt'#
LIKE = 'like'#
NOT_EQUALS = 'ne'#
UNLIKE = 'notLike'#
cterasdk.core.query.iterator(core, path, param=None, name=None, *, callback_response=None, version=None)#

Create iterator

Parameters:

  • core (cterasdk.objects.core.Portal) – Portal object

  • path (str) – URL Path

  • name (str,optional) – Schema method name

  • param (cterasdk.core.query.QueryParams or dict,optional) – Query parameters, either as a QueryParams object or a dictionary of key-value pairs.

  • callback_response (cterasdk.lib.iterator.BaseResponse) – Class to consume callback response

  • version (str,optional) – Iterator API Version

Returns:

Query iterator object

cterasdk.core.query.run(core, path, param, *, version=None)#
cterasdk.core.query.v1_callback_function(core, path, name=None, *, callback_response=None)#

Create a query callback function

Parameters:
Returns:

Command object

class cterasdk.core.query.v2QueryParams(**kwargs)#

Bases: Object

increment()#
cterasdk.core.query.v2_callback_function(core, path)#