Graql (grakn-graql 1.4.2 API)

java.lang.Object
- ai.grakn.graql.Graql

```
public class Graql
extends Object
```
Main class containing static methods for creating Graql queries. It is recommended you statically import these methods.

Author:

Felix Chapman

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Pattern`	`and(Collection<? extends Pattern> patterns)`
`static Pattern`	`and(Pattern... patterns)`
`static <T extends Answer> ComputeQuery<T>`	`compute(GraqlSyntax.Compute.Method<T> method)`
`static ValuePredicate`	`contains(String substring)`
`static ValuePredicate`	`contains(VarPattern varPattern)`
`static Aggregate<Value>`	`count(String... vars)` Create an aggregate that will count the results of a query.
`static DefineQuery`	`define(Collection<? extends VarPattern> varPatterns)`
`static DefineQuery`	`define(VarPattern... varPatterns)`
`static ValuePredicate`	`eq(Object value)`
`static ValuePredicate`	`eq(VarPattern varPattern)`
`static Aggregate<AnswerGroup<ConceptMap>>`	`group(String var)` Create an aggregate that will group a query by a variable.
`static <T extends Answer> Aggregate<AnswerGroup<T>>`	`group(String var, Aggregate<T> aggregate)` Create an aggregate that will group a query by a variable and apply the given aggregate to each group
`static ValuePredicate`	`gt(Comparable value)`
`static ValuePredicate`	`gt(VarPattern varPattern)`
`static ValuePredicate`	`gte(Comparable value)`
`static ValuePredicate`	`gte(VarPattern varPattern)`
`static InsertQuery`	`insert(Collection<? extends VarPattern> varPatterns)`
`static InsertQuery`	`insert(VarPattern... varPatterns)`
`static VarPattern`	`label(Label label)`
`static VarPattern`	`label(String label)`
`static ValuePredicate`	`lt(Comparable value)`
`static ValuePredicate`	`lt(VarPattern varPattern)`
`static ValuePredicate`	`lte(Comparable value)`
`static ValuePredicate`	`lte(VarPattern varPattern)`
`static Match`	`match(Collection<? extends Pattern> patterns)`
`static Match`	`match(Pattern... patterns)`
`static Aggregate<Value>`	`max(String var)` Create an aggregate that will find the maximum of a variable's values.
`static Aggregate<Value>`	`mean(String var)` Create an aggregate that will find the mean of a variable's values.
`static Aggregate<Value>`	`median(String var)` Create an aggregate that will find the median of a variable's values.
`static Aggregate<Value>`	`min(String var)` Create an aggregate that will find the minimum of a variable's values.
`static ValuePredicate`	`neq(Object value)`
`static ValuePredicate`	`neq(VarPattern varPattern)`
`static Pattern`	`or(Collection<? extends Pattern> patterns)`
`static Pattern`	`or(Pattern... patterns)`
`static <T extends Query<?>> T`	`parse(String queryString)`
`static QueryParser`	`parser()` Get a `QueryParser` for parsing queries from strings
`static ValuePredicate`	`regex(String pattern)`
`static Aggregate<Value>`	`std(String var)` Create an aggregate that will find the unbiased sample standard deviation of a variable's values.
`static Aggregate<Value>`	`sum(String var)` Create an aggregate that will sum the values of a variable.
`static UndefineQuery`	`undefine(Collection<? extends VarPattern> varPatterns)`
`static UndefineQuery`	`undefine(VarPattern... varPatterns)`
`static Var`	`var()`
`static Var`	`var(String name)`
`static QueryBuilder`	`withoutGraph()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - withoutGraph
```
@CheckReturnValue
public static QueryBuilder withoutGraph()
```
    Returns:
    
    a query builder without a specified graph
  - match
```
@CheckReturnValue
public static Match match(Pattern... patterns)
```
    Parameters:
    
    patterns - an array of patterns to match in the graph
    
    Returns:
    
    a Match that will find matches of the given patterns
  - match
```
@CheckReturnValue
public static Match match(Collection<? extends Pattern> patterns)
```
    Parameters:
    
    patterns - a collection of patterns to match in the graph
    
    Returns:
    
    a Match that will find matches of the given patterns
  - insert
```
@CheckReturnValue
public static InsertQuery insert(VarPattern... varPatterns)
```
    Parameters:
    
    varPatterns - an array of variable patterns to insert into the graph
    
    Returns:
    
    an insert query that will insert the given variable patterns into the graph
  - insert
```
@CheckReturnValue
public static InsertQuery insert(Collection<? extends VarPattern> varPatterns)
```
    Parameters:
    
    varPatterns - a collection of variable patterns to insert into the graph
    
    Returns:
    
    an insert query that will insert the given variable patterns into the graph
  - define
```
@CheckReturnValue
public static DefineQuery define(VarPattern... varPatterns)
```
    Parameters:
    
    varPatterns - an array of VarPatterns defining SchemaConcepts
    
    Returns:
    
    a DefineQuery that will apply the changes described in the patterns
  - define
```
@CheckReturnValue
public static DefineQuery define(Collection<? extends VarPattern> varPatterns)
```
    Parameters:
    
    varPatterns - a collection of VarPatterns defining SchemaConcepts
    
    Returns:
    
    a DefineQuery that will apply the changes described in the patterns
  - undefine
```
@CheckReturnValue
public static UndefineQuery undefine(VarPattern... varPatterns)
```
    Parameters:
    
    varPatterns - an array of VarPatterns undefining SchemaConcepts
    
    Returns:
    
    a UndefineQuery that will remove the changes described in the patterns
  - undefine
```
@CheckReturnValue
public static UndefineQuery undefine(Collection<? extends VarPattern> varPatterns)
```
    Parameters:
    
    varPatterns - a collection of VarPatterns undefining SchemaConcepts
    
    Returns:
    
    a UndefineQuery that will remove the changes described in the patterns
  - compute
```
@CheckReturnValue
public static <T extends Answer> ComputeQuery<T> compute(GraqlSyntax.Compute.Method<T> method)
```
  - parser
```
public static QueryParser parser()
```
    Get a QueryParser for parsing queries from strings
  - parse
```
@CheckReturnValue
public static <T extends Query<?>> T parse(String queryString)
```
    Parameters:
    
    queryString - a string representing a query
    
    Returns:
    
    a query, the type will depend on the type of query.
  - var
```
@CheckReturnValue
public static Var var(String name)
```
    Parameters:
    
    name - the name of the variable
    
    Returns:
    
    a new query variable
  - var
```
@CheckReturnValue
public static Var var()
```
    Returns:
    
    a new, anonymous query variable
  - label
```
@CheckReturnValue
public static VarPattern label(Label label)
```
    Parameters:
    
    label - the label of a concept
    
    Returns:
    
    a variable pattern that identifies a concept by label
  - label
```
@CheckReturnValue
public static VarPattern label(String label)
```
    Parameters:
    
    label - the label of a concept
    
    Returns:
    
    a variable pattern that identifies a concept by label
  - and
```
@CheckReturnValue
public static Pattern and(Pattern... patterns)
```
    Parameters:
    
    patterns - an array of patterns to match
    
    Returns:
    
    a pattern that will match only when all contained patterns match
  - and
```
@CheckReturnValue
public static Pattern and(Collection<? extends Pattern> patterns)
```
    Parameters:
    
    patterns - a collection of patterns to match
    
    Returns:
    
    a pattern that will match only when all contained patterns match
  - or
```
@CheckReturnValue
public static Pattern or(Pattern... patterns)
```
    Parameters:
    
    patterns - an array of patterns to match
    
    Returns:
    
    a pattern that will match when any contained pattern matches
  - or
```
@CheckReturnValue
public static Pattern or(Collection<? extends Pattern> patterns)
```
    Parameters:
    
    patterns - a collection of patterns to match
    
    Returns:
    
    a pattern that will match when any contained pattern matches
  - count
```
@CheckReturnValue
public static Aggregate<Value> count(String... vars)
```
    Create an aggregate that will count the results of a query.
  - sum
```
@CheckReturnValue
public static Aggregate<Value> sum(String var)
```
    Create an aggregate that will sum the values of a variable.
  - min
```
@CheckReturnValue
public static Aggregate<Value> min(String var)
```
    Create an aggregate that will find the minimum of a variable's values.
    
    Parameters:
    
    var - the variable to find the maximum of
  - max
```
@CheckReturnValue
public static Aggregate<Value> max(String var)
```
    Create an aggregate that will find the maximum of a variable's values.
    
    Parameters:
    
    var - the variable to find the maximum of
  - mean
```
@CheckReturnValue
public static Aggregate<Value> mean(String var)
```
    Create an aggregate that will find the mean of a variable's values.
    
    Parameters:
    
    var - the variable to find the mean of
  - median
```
@CheckReturnValue
public static Aggregate<Value> median(String var)
```
    Create an aggregate that will find the median of a variable's values.
    
    Parameters:
    
    var - the variable to find the median of
  - std
```
@CheckReturnValue
public static Aggregate<Value> std(String var)
```
    Create an aggregate that will find the unbiased sample standard deviation of a variable's values.
    
    Parameters:
    
    var - the variable to find the standard deviation of
  - group
```
@CheckReturnValue
public static Aggregate<AnswerGroup<ConceptMap>> group(String var)
```
    Create an aggregate that will group a query by a variable.
    
    Parameters:
    
    var - the variable to group results by
  - group
```
@CheckReturnValue
public static <T extends Answer> Aggregate<AnswerGroup<T>> group(String var,
                                                                                   Aggregate<T> aggregate)
```
    Create an aggregate that will group a query by a variable and apply the given aggregate to each group
    
    Type Parameters:
    
    T - the type the aggregate returns
    
    Parameters:
    
    var - the variable to group results by
    
    aggregate - the aggregate to apply to each group
  - eq
```
@CheckReturnValue
public static ValuePredicate eq(Object value)
```
    Parameters:
    
    value - the value
    
    Returns:
    
    a predicate that is true when a value equals the specified value
  - eq
```
@CheckReturnValue
public static ValuePredicate eq(VarPattern varPattern)
```
    Parameters:
    
    varPattern - the variable pattern representing a resource
    
    Returns:
    
    a predicate that is true when a value equals the specified value
  - neq
```
@CheckReturnValue
public static ValuePredicate neq(Object value)
```
    Parameters:
    
    value - the value
    
    Returns:
    
    a predicate that is true when a value does not equal the specified value
  - neq
```
@CheckReturnValue
public static ValuePredicate neq(VarPattern varPattern)
```
    Parameters:
    
    varPattern - the variable pattern representing a resource
    
    Returns:
    
    a predicate that is true when a value does not equal the specified value
  - gt
```
@CheckReturnValue
public static ValuePredicate gt(Comparable value)
```
    Parameters:
    
    value - the value
    
    Returns:
    
    a predicate that is true when a value is strictly greater than the specified value
  - gt
```
@CheckReturnValue
public static ValuePredicate gt(VarPattern varPattern)
```
    Parameters:
    
    varPattern - the variable pattern representing a resource
    
    Returns:
    
    a predicate that is true when a value is strictly greater than the specified value
  - gte
```
@CheckReturnValue
public static ValuePredicate gte(Comparable value)
```
    Parameters:
    
    value - the value
    
    Returns:
    
    a predicate that is true when a value is greater or equal to the specified value
  - gte
```
@CheckReturnValue
public static ValuePredicate gte(VarPattern varPattern)
```
    Parameters:
    
    varPattern - the variable pattern representing a resource
    
    Returns:
    
    a predicate that is true when a value is greater or equal to the specified value
  - lt
```
@CheckReturnValue
public static ValuePredicate lt(Comparable value)
```
    Parameters:
    
    value - the value
    
    Returns:
    
    a predicate that is true when a value is strictly less than the specified value
  - lt
```
@CheckReturnValue
public static ValuePredicate lt(VarPattern varPattern)
```
    Parameters:
    
    varPattern - the variable pattern representing a resource
    
    Returns:
    
    a predicate that is true when a value is strictly less than the specified value
  - lte
```
@CheckReturnValue
public static ValuePredicate lte(Comparable value)
```
    Parameters:
    
    value - the value
    
    Returns:
    
    a predicate that is true when a value is less or equal to the specified value
  - lte
```
@CheckReturnValue
public static ValuePredicate lte(VarPattern varPattern)
```
    Parameters:
    
    varPattern - the variable pattern representing a resource
    
    Returns:
    
    a predicate that is true when a value is less or equal to the specified value
  - regex
```
@CheckReturnValue
public static ValuePredicate regex(String pattern)
```
    Parameters:
    
    pattern - a regex pattern
    
    Returns:
    
    a predicate that returns true when a value matches the given regular expression
  - contains
```
@CheckReturnValue
public static ValuePredicate contains(String substring)
```
    Parameters:
    
    substring - a substring to match
    
    Returns:
    
    a predicate that returns true when a value contains the given substring
  - contains
```
@CheckReturnValue
public static ValuePredicate contains(VarPattern varPattern)
```
    Parameters:
    
    varPattern - the variable pattern representing a resource
    
    Returns:
    
    a predicate that returns true when a value contains the given substring

Class Graql

Method Summary

Methods inherited from class java.lang.Object

Method Detail

withoutGraph

match

match

insert

insert

define

define

undefine

undefine

compute

parser

parse

var

var

label

label

and

and

or

or

count

sum

min

max

mean

median

std

group

group

eq

eq

neq

neq

gt

gt

gte

gte

lt

lt

lte

lte

regex

contains

contains