Query

class caris.bathy.db.ConditionType

This class represents the type of condition.

  • EQUAL_TO
  • NOT_EQUAL_TO
  • LESS_THAN
  • LESS_THAN_EQUAL_TO
  • GREATER_THAN
  • GREATER_THAN_EQUAL_TO
class caris.bathy.db.ObjectQuery((object)arg1, (QueryType)type)

The ObjectQuery can contain one or more QueryRule objects.

add_rule((QueryRule)rule) → None

Add a new rule to the query object.

Parameters:rule (QueryRule) – The rule to add.
ascending

Flag used to indicate the order in which the results should be returned.

True indicates the order is ascending.

False indicates the order is descending.

Type:boolean
geometry

The geometry of the query in a WKT format. Must be Lat/Long on the WGS84 ellipsoid.

Type:str
include_deleted

Flag used to include deleted objects.

True if deleted objects should be returned.

Type:boolean
include_offline

Flag used to include offline objects.

True if offline objects should be returned.

Type:boolean
class caris.bathy.db.QueryCondition((object)arg1)

A query condition based on a single attribute.

For example:

condition.acronym = "OBJNAM"
condition.value = "Big Surface"
condition.operation = caris.bathy.db.QueryCondition.EQUAL
acronym

The acronym of the condition.

Type:str
operation

The operator of the condition.

Type:ConditionType
value

The comparison value of the condition.

Type:str
class caris.bathy.db.QueryRule((object)arg1, (RuleType)type, (RuleLogic)logic)

Contains one or more ConditionType objects that are connected using AND or OR to build a complex query.

add_condition((QueryCondition)condition) → None

Add a new query condition to the rule.

Parameters:condition (QueryCondition) – The query condition to add.
class caris.bathy.db.QueryType

This class represents the type of object to be queried.

  • SURFACE (Surface)
  • PRODUCT_SURFACE (Surface)
  • SURVEY (Survey)
class caris.bathy.db.RuleLogic

This class represents the logic applied between two rules.

  • AND
  • OR
class caris.bathy.db.RuleType

This class represents how the rule will be applied.

  • INCLUDE
  • EXCLUDE