ojai.store.QueryCondition.QueryCondition Class Reference

Public Member Functions
def	is_empty (self)
def	is_built (self)
def	and_ (self)
def	or_ (self)
def	element_and (self, field_path)
def	close (self)
def	build (self)
def	condition_ (self, condition_to_add)
def	exists_ (self, field_path)
def	not_exists_ (self, field_path)
def	in_ (self, field_path, list_of_value)
def	not_in_ (self, field_path, list_of_value)
def	type_of_ (self, field_path, value_type)
def	not_type_of_ (self, field_path, value_type)
def	matches_ (self, field_path, regex)
def	not_matches_ (self, field_path, regex)
def	like_ (self, field_path, like_expression, escape_char=None)
def	not_like_ (self, field_path, like_expression, escape_char=None)
def	is_ (self, field_path, op, value)
def	equals_ (self, field_path, value)
def	not_equals_ (self, field_path, value)
def	size_of_ (self, field_path, op, size)

Detailed Description

The public API class contains comprehensive operations for the queries.

Member Function Documentation

and_()

def ojai.store.QueryCondition.QueryCondition.and_

(

self

)

Begins a new AND compound condition block.
:return self for chaining.

build()

def ojai.store.QueryCondition.QueryCondition.build

(

self

)

Closes all nested compound condition blocks.
:return self

close()

def ojai.store.QueryCondition.QueryCondition.close

(

self

)

Closes a compound condition block.

condition_()

def ojai.store.QueryCondition.QueryCondition.condition_	(		self,
			condition_to_add
	)

Appends the specified condition to the current condition block.
:param condition_to_add: specific condition of QueryCondition type
:return self for chained invocation

element_and()

def ojai.store.QueryCondition.QueryCondition.element_and	(		self,
			field_path
	)

Begins a new element-wise AND compound condition block.
:param field_path: the array expression for the fields' container
:return self for chaining

equals_()

def ojai.store.QueryCondition.QueryCondition.equals_	(		self,
			field_path,
			value
	)

Adds a condition that tests if the Value at the specified
FieldPath equals the specified value. Two values are considered equal if and only if they contain the same
key-value pair in the same order.
:param field_path: the path to test. Type may be str, FieldPath.
:param value: the reference to Value.
:return self for chained invocation.

exists_()

def ojai.store.QueryCondition.QueryCondition.exists_	(		self,
			field_path
	)

Adds a condition that tests for existence of the specified.
:param field_path: the path to test. Type may be str, FieldPath.
:return self for chained invocation.

in_()

def ojai.store.QueryCondition.QueryCondition.in_	(		self,
			field_path,
			list_of_value
	)

Adds a condition that tests if the Value at the specified
FieldPath is equal to at least one of the values in the
specified list.
:param field_path: the path to test. Type may be str, FieldPath.
:param list_of_value: the list of values to test against.
:return self for chained invocation.

is_()

def ojai.store.QueryCondition.QueryCondition.is_	(		self,
			field_path,
			op,
			value
	)

Adds a condition that tests if the Value at the specified
FieldPath satisfies the given Op against the specified value.
:param field_path: the path to test. Type may be str, FieldPath.
:param op: the QueryConditionOp to apply.
:param value: the reference to Value.
:return self for chained invocation.

is_built()

def ojai.store.QueryCondition.QueryCondition.is_built

(

self

)

:return True if this condition is built.

is_empty()

def ojai.store.QueryCondition.QueryCondition.is_empty

(

self

)

:return True if this condition is empty.

like_()

def ojai.store.QueryCondition.QueryCondition.like_	(		self,
			field_path,
			like_expression,
			escape_char = None
	)

Adds a condition that tests if the Value at the specified
FieldPath is a String and matches the specified SQL LIKE
expression optionally escaped with the specified escape character.
:param field_path: the path to test. Type may be str, FieldPath.
:param like_expression: he reference LIKE pattern.
:param escape_char: the escape character in the LIKE pattern.
:return self for chained invocation.

matches_()

def ojai.store.QueryCondition.QueryCondition.matches_	(		self,
			field_path,
			regex
	)

Adds a condition that tests if the Value at the specified
FieldPath is a String and matches the specified regular
expression.
:param field_path: the path to test. Type may be str, FieldPath.
:param regex: the reference regular expression.
:return self for chained invocation.

not_equals_()

def ojai.store.QueryCondition.QueryCondition.not_equals_	(		self,
			field_path,
			value
	)

Adds a condition that tests if the Value at the specified
FieldPath does not equal the specified value. Two values are considered equal if and only if they contain the same
key-value pair in the same order.
:param field_path: the path to test. Type may be str, FieldPath.
:param value: the reference to Value.
:return self for chained invocation.

not_exists_()

def ojai.store.QueryCondition.QueryCondition.not_exists_	(		self,
			field_path
	)

Adds a condition that tests for non-existence of the specified FieldPath.
:param field_path: the path to test.Type may be str, FieldPath.
:return self for chained invocation.

not_in_()

def ojai.store.QueryCondition.QueryCondition.not_in_	(		self,
			field_path,
			list_of_value
	)

Adds a condition that tests if the Value at the specified
FieldPath is not equal to any of the values in the
specified list.
:param field_path: the path to test. Type may be str, FieldPath.
:param list_of_value: the list of values to test against.
:return self for chained invocation.

not_like_()

def ojai.store.QueryCondition.QueryCondition.not_like_	(		self,
			field_path,
			like_expression,
			escape_char = None
	)

Adds a condition that tests if the Value at the specified
FieldPath is a String and does not match the specified SQL LIKE
expression optionally escaped with the specified escape character.
:param field_path: the path to test. Type may be str, FieldPath.
:param like_expression: he reference LIKE pattern.
:param escape_char: the escape character in the LIKE pattern.
:return self for chained invocation.

not_matches_()

def ojai.store.QueryCondition.QueryCondition.not_matches_	(		self,
			field_path,
			regex
	)

Adds a condition that tests if the Value at the specified
FieldPath is a String and does not match the specified regular
expression.
:param field_path: the path to test. Type may be str, FieldPath.
:param regex: the reference regular expression.
:return self for chained invocation.

not_type_of_()

def ojai.store.QueryCondition.QueryCondition.not_type_of_	(		self,
			field_path,
			value_type
	)

Adds a condition that tests if the Value at the specified
FieldPath is not of the specified ValueType.
:param field_path: the path to test. Type may be str, FieldPath.
:param value_type: ValueType.
:return self for chained invocation.

or_()

def ojai.store.QueryCondition.QueryCondition.or_

(

self

)

Begins a new OR compound condition block.
:return self for chaining.

size_of_()

def ojai.store.QueryCondition.QueryCondition.size_of_	(		self,
			field_path,
			op,
			size
	)

Adds a condition that tests if the size of the Value at the
specified FieldPath satisfies the given QueryConditionOp and the size.
The value must be one of the following types: STRING,
BINARY, DICTIONARY or ARRAY.
:param field_path: the path to test. Type may be str, FieldPath.
:param op: the QueryConditionOp to apply.
:param size: the reference size of Value.
:return self for chained invocation.

type_of_()

def ojai.store.QueryCondition.QueryCondition.type_of_	(		self,
			field_path,
			value_type
	)

Adds a condition that tests if the Value at the specified
FieldPath is of the specified ValueType.
:param field_path: the path to test. Type may be str, FieldPath.
:param value_type: ValueType.
:return self for chained invocation.

---

The documentation for this class was generated from the following file:

• QueryCondition.py