Chapter 20. Search Predicates and Data Types

This page lists all of the comparison predicates that JanusGraph supports in global graph search and local traversals.

20.1. Compare Predicate

The Compare enum specifies the following comparison predicates used for index query construction and used in the examples above:

  • eq (equal)
  • neq (not equal)
  • gt (greater than)
  • gte (greater than or equal)
  • lt (less than)
  • lte (less than or equal)

20.2. Text Predicate

The Text enum specifies the search operator used to query for matching text or string values. We differentiate between two types of predicates:

  • Text search predicates which match against the individual words inside a text string after it has been tokenized. These predicates are not case sensitive.

    • textContains: is true if (at least) one word inside the text string matches the query string
    • textContainsPrefix: is true if (at least) one word inside the text string begins with the query string
    • textContainsRegex: is true if (at least) one word inside the text string matches the given regular expression
  • String search predicates which match against the entire string value

    • textPrefix: if the string value starts with the given query string
    • textRegex: if the string value matches the given regular expression in its entirety

See Section 21.1, “Full-Text Search” for more information about full-text and string search.

20.3. Geo Predicate

The Geo enum specifies the geo-location predicate geoWithin which holds true if one geometric object contains the other.

20.4. Query Examples

The following query examples demonstrate some of the predicates on the tutorial graph.

g.V().has("name", "hercules")
// 2) Find all vertices with an age greater than 50
g.V().has("age", gt(50))
// or find all vertices between 1000 (inclusive) and 5000 (exclusive) years of age and order by increasing age
g.V().has("age", inside(1000, 5000)).order().by("age", incr)
// which returns the same result set as the following query but in reverse order
g.V().has("age", inside(1000, 5000)).order().by("age", decr)
// 3) Find all edges where the place is at most 50 kilometers from the given latitude-longitude pair
g.E().has("place", geoWithin(, 23.72, 50)))
// 4) Find all edges where reason contains the word "loves"
g.E().has("reason", textContains("loves"))
// or all edges which contain two words (need to chunk into individual words)
g.E().has("reason", textContains("loves")).has("reason", textContains("breezes"))
// or all edges which contain words that start with "lov"
g.E().has("reason", textContainsPrefix("lov"))
// or all edges which contain words that match the regular expression "br[ez]*s" in their entirety
g.E().has("reason", textContainsRegex("br[ez]*s"))
// 5) Find all vertices older than a thousand years and named "saturn"
g.V().has("age", gt(1000)).has("name", "saturn")

20.5. Data Type Support

While JanusGraph’s composite indexes support any data type that can be stored in JanusGraph, the mixed indexes are limited to the following data types.

  • Byte
  • Short
  • Integer
  • Long
  • Float
  • Double
  • Decimal
  • Precision
  • String
  • Geoshape
  • Date
  • Instant

Additional data types will be supported in the future.

20.6. Geoshape Data Type

The Geoshape data type supports representing a point, circle or box. However all index backends currently only support indexing points. Geospatial index lookups are only supported via mixed indexes.

To construct a Geoshape use the following methods:

 //lat, lng
Geoshape.point(37.97, 23.72)
//lat, lng, radius in km, 23.72, 50)
//SW lat, SW lng, NE lat, NE lng, 23.72, 38.97, 24.72)

In addition when importing a graph via GraphSON Point may be represented by:

"37.97, 23.72"
[37.97, 23.72]
//GeoJSON feature
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [125.6, 10.1]
  "properties": {
    "name": "Dinagat Islands"
//GeoJSON geometry
  "type": "Point",
  "coordinates": [125.6, 10.1]

GeoJSON may be specified as Point, Circle or Polygon. However polygons must form a box. Note that unlike the JanusGraph API GeoJSON specifies coordinates as lng lat.

20.7. Collections

If you are using Elasticsearch then you can index properties with SET and LIST cardinality. For instance:

mgmt = graph.openManagement()
nameProperty = mgmt.makePropertyKey("names").dataType(String.class).cardinality(Cardinality.SET).make()
mgmt.buildIndex("search", Vertex.class).addKey(nameProperty, Mapping.STRING.asParameter()).buildMixedIndex("search")
//Insert a vertex
person = graph.addVertex()"names", "Robert")"names", "Bob")
//Now query it
g.V().has("names", "Bob").count().next() //1
g.V().has("names", "Robert").count().next() //1