QueryBuilder (DataStax Java driver for Apache Cassandra(R) 4.3.0 API)

java.lang.Object
- com.datastax.oss.driver.api.querybuilder.QueryBuilder

```
public class QueryBuilder
extends Object
```
A Domain-Specific Language to build CQL queries using Java code.

Constructor Summary

Constructors
Constructor and Description

QueryBuilder()

Constructors
Constructor and Description
`QueryBuilder()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Term`	`add(Term left, Term right)` The sum of two terms, as in `WHERE k = left + right`.
`static BindMarker`	`bindMarker()` Creates an anonymous bind marker, which appears as `?` in the generated CQL.
`static BindMarker`	`bindMarker(CqlIdentifier id)` Creates a named bind marker, which appears as `:id` in the generated CQL.
`static BindMarker`	`bindMarker(String name)` Shortcut for `bindMarker(CqlIdentifier.fromCql(name))`
`static Term`	`currentDate()` A call to the built-in `currentDate` function as a term.
`static Term`	`currentTime()` A call to the built-in `currentTime` function as a term.
`static Term`	`currentTimestamp()` A call to the built-in `currentTimestamp` function as a term.
`static Term`	`currentTimeUuid()` A call to the built-in `currentTimeUuid` function as a term.
`static DeleteSelection`	`deleteFrom(CqlIdentifier table)` Starts a DELETE query for an unqualified table.
`static DeleteSelection`	`deleteFrom(CqlIdentifier keyspace, CqlIdentifier table)` Starts a DELETE query for a qualified table.
`static DeleteSelection`	`deleteFrom(String table)` Shortcut for `deleteFrom(CqlIdentifier.fromCql(table))`
`static DeleteSelection`	`deleteFrom(String keyspace, String table)` Shortcut for `deleteFrom(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table))`
`static Term`	`divide(Term left, Term right)` The quotient of two terms, as in `WHERE k = left / right`.
`static Term`	`function(CqlIdentifier keyspaceId, CqlIdentifier functionId, Iterable<Term> arguments)` A function call as a term, as in `WHERE k = ks.f(arguments)`.
`static Term`	`function(CqlIdentifier keyspaceId, CqlIdentifier functionId, Term... arguments)` Var-arg equivalent of `function(CqlIdentifier, CqlIdentifier, Iterable)`.
`static Term`	`function(CqlIdentifier functionId, Iterable<Term> arguments)` A function call as a term, as in `WHERE k = f(arguments)`.
`static Term`	`function(CqlIdentifier functionId, Term... arguments)` Var-arg equivalent of `function(CqlIdentifier, Iterable)`.
`static Term`	`function(String functionName, Iterable<Term> arguments)` Shortcut for `function(CqlIdentifier.fromCql(functionName), arguments)`.
`static Term`	`function(String keyspaceName, String functionName, Iterable<Term> arguments)` Shortcut for `function(CqlIdentifier.fromCql(keyspaceName), CqlIdentifier.fromCql(functionName), arguments)`.
`static Term`	`function(String keyspaceName, String functionName, Term... arguments)` Shortcut for `function(CqlIdentifier.fromCql(keyspaceName), CqlIdentifier.fromCql(functionName), arguments)`.
`static Term`	`function(String functionName, Term... arguments)` Shortcut for `function(CqlIdentifier.fromCql(functionName), arguments)`.
`static InsertInto`	`insertInto(CqlIdentifier table)` Starts an INSERT query for an unqualified table.
`static InsertInto`	`insertInto(CqlIdentifier keyspace, CqlIdentifier table)` Starts an INSERT query for a qualified table.
`static InsertInto`	`insertInto(String table)` Shortcut for `insertInto(CqlIdentifier.fromCql(table))`.
`static InsertInto`	`insertInto(String keyspace, String table)` Shortcut for `insertInto(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table))`.
`static Literal`	`literal(Object value)` A literal term, as in `WHERE k = 1`.
`static Literal`	`literal(Object value, CodecRegistry codecRegistry)` A literal term, as in `WHERE k = 1`.
`static <T> Literal`	`literal(T value, TypeCodec<T> codec)` A literal term, as in `WHERE k = 1`.
`static Term`	`maxTimeUuid(Term argument)` A call to the built-in `maxTimeUuid` function as a term.
`static Term`	`minTimeUuid(Term argument)` A call to the built-in `minTimeUuid` function as a term.
`static Term`	`multiply(Term left, Term right)` The product of two terms, as in `WHERE k = left * right`.
`static Term`	`negate(Term argument)` The opposite of a term, as in `WHERE k = -argument`.
`static Term`	`now()` A call to the built-in `now` function as a term.
`static Raw`	`raw(String raw)` A raw CQL snippet.
`static Term`	`remainder(Term left, Term right)` The remainder of two terms, as in `WHERE k = left % right`.
`static SelectFrom`	`selectFrom(CqlIdentifier table)` Starts a SELECT query for an unqualified table.
`static SelectFrom`	`selectFrom(CqlIdentifier keyspace, CqlIdentifier table)` Starts a SELECT query for a qualified table.
`static SelectFrom`	`selectFrom(String table)` Shortcut for `selectFrom(CqlIdentifier.fromCql(table))`
`static SelectFrom`	`selectFrom(String keyspace, String table)` Shortcut for `selectFrom(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table))`
`static Term`	`subtract(Term left, Term right)` The difference of two terms, as in `WHERE k = left - right`.
`static Term`	`toDate(Term argument)` A call to the built-in `toDate` function as a term.
`static Term`	`toTimestamp(Term argument)` A call to the built-in `toTimestamp` function as a term.
`static Term`	`toUnixTimestamp(Term argument)` A call to the built-in `toUnixTimestamp` function as a term.
`static Truncate`	`truncate(CqlIdentifier table)` Creates a new `TRUNCATE` query.
`static Truncate`	`truncate(CqlIdentifier keyspace, CqlIdentifier table)` Creates a new `TRUNCATE` query.
`static Truncate`	`truncate(String table)` Creates a new `TRUNCATE` query.
`static Truncate`	`truncate(String keyspace, String table)` Creates a new `TRUNCATE` query.
`static Term`	`tuple(Iterable<? extends Term> components)` An ordered set of anonymous terms, as in `WHERE (a, b) = (1, 2)` (on the right-hand side).
`static Term`	`tuple(Term... components)` Var-arg equivalent of `tuple(Iterable)`.
`static Term`	`typeHint(Term term, DataType targetType)` Provides a type hint for an expression, as in `WHERE k = (double)1/3`.
`static UserDefinedType`	`udt(CqlIdentifier name)` Shortcut to reference a UDT in methods that use a `DataType`, such as `typeHint(Term, DataType)` and `Selector.cast(Selector, DataType)`.
`static UserDefinedType`	`udt(String name)` Shortcut for `udt(CqlIdentifier.fromCql(name))`.
`static UpdateStart`	`update(CqlIdentifier table)` Starts an UPDATE query for an unqualified table.
`static UpdateStart`	`update(CqlIdentifier keyspace, CqlIdentifier table)` Starts an UPDATE query for a qualified table.
`static UpdateStart`	`update(String table)` Shortcut for `update(CqlIdentifier.fromCql(table))`
`static UpdateStart`	`update(String keyspace, String table)` Shortcut for `update(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table))`

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

Constructor Detail
- QueryBuilder
```
public QueryBuilder()
```

Method Detail

selectFrom

@NonNull
public static SelectFrom selectFrom(@Nullable
                                             CqlIdentifier keyspace,
                                             @NonNull
                                             CqlIdentifier table)

Starts a SELECT query for a qualified table.

selectFrom

@NonNull
public static SelectFrom selectFrom(@Nullable
                                             String keyspace,
                                             @NonNull
                                             String table)

Shortcut for selectFrom(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table))

selectFrom

@NonNull
public static SelectFrom selectFrom(@NonNull
                                             CqlIdentifier table)

Starts a SELECT query for an unqualified table.

selectFrom

@NonNull
public static SelectFrom selectFrom(@NonNull
                                             String table)

Shortcut for selectFrom(CqlIdentifier.fromCql(table))

insertInto

@NonNull
public static InsertInto insertInto(@Nullable
                                             CqlIdentifier keyspace,
                                             @NonNull
                                             CqlIdentifier table)

Starts an INSERT query for a qualified table.

insertInto

@NonNull
public static InsertInto insertInto(@Nullable
                                             String keyspace,
                                             @NonNull
                                             String table)

Shortcut for insertInto(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table)).

insertInto

@NonNull
public static InsertInto insertInto(@NonNull
                                             CqlIdentifier table)

Starts an INSERT query for an unqualified table.

insertInto

@NonNull
public static InsertInto insertInto(@NonNull
                                             String table)

Shortcut for insertInto(CqlIdentifier.fromCql(table)).

update

@NonNull
public static UpdateStart update(@Nullable
                                          CqlIdentifier keyspace,
                                          @NonNull
                                          CqlIdentifier table)

Starts an UPDATE query for a qualified table.

update

@NonNull
public static UpdateStart update(@Nullable
                                          String keyspace,
                                          @NonNull
                                          String table)

Shortcut for update(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table))

update

@NonNull
public static UpdateStart update(@NonNull
                                          CqlIdentifier table)

Starts an UPDATE query for an unqualified table.

update

@NonNull
public static UpdateStart update(@NonNull
                                          String table)

Shortcut for update(CqlIdentifier.fromCql(table))

deleteFrom

@NonNull
public static DeleteSelection deleteFrom(@Nullable
                                                  CqlIdentifier keyspace,
                                                  @NonNull
                                                  CqlIdentifier table)

Starts a DELETE query for a qualified table.

deleteFrom

@NonNull
public static DeleteSelection deleteFrom(@Nullable
                                                  String keyspace,
                                                  @NonNull
                                                  String table)

Shortcut for deleteFrom(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table))

deleteFrom

@NonNull
public static DeleteSelection deleteFrom(@NonNull
                                                  CqlIdentifier table)

Starts a DELETE query for an unqualified table.

deleteFrom

@NonNull
public static DeleteSelection deleteFrom(@NonNull
                                                  String table)

Shortcut for deleteFrom(CqlIdentifier.fromCql(table))

tuple
```
@NonNull
public static Term tuple(@NonNull
                                  Iterable<? extends Term> components)
```
An ordered set of anonymous terms, as in WHERE (a, b) = (1, 2) (on the right-hand side).
For example, this can be used as the right operand of Relation.columns(String...).

tuple

@NonNull
public static Term tuple(@NonNull
                                  Term... components)

Var-arg equivalent of tuple(Iterable).

add

@NonNull
public static Term add(@NonNull
                                Term left,
                                @NonNull
                                Term right)

The sum of two terms, as in WHERE k = left + right.

subtract

@NonNull
public static Term subtract(@NonNull
                                     Term left,
                                     @NonNull
                                     Term right)

The difference of two terms, as in WHERE k = left - right.

multiply

@NonNull
public static Term multiply(@NonNull
                                     Term left,
                                     @NonNull
                                     Term right)

The product of two terms, as in WHERE k = left * right.

divide

@NonNull
public static Term divide(@NonNull
                                   Term left,
                                   @NonNull
                                   Term right)

The quotient of two terms, as in WHERE k = left / right.

remainder

@NonNull
public static Term remainder(@NonNull
                                      Term left,
                                      @NonNull
                                      Term right)

The remainder of two terms, as in WHERE k = left % right.

negate

@NonNull
public static Term negate(@NonNull
                                   Term argument)

The opposite of a term, as in WHERE k = -argument.

function

@NonNull
public static Term function(@NonNull
                                     CqlIdentifier functionId,
                                     @NonNull
                                     Iterable<Term> arguments)

A function call as a term, as in WHERE k = f(arguments).

function

@NonNull
public static Term function(@NonNull
                                     CqlIdentifier functionId,
                                     @NonNull
                                     Term... arguments)

Var-arg equivalent of function(CqlIdentifier, Iterable).

function

@NonNull
public static Term function(@NonNull
                                     String functionName,
                                     @NonNull
                                     Iterable<Term> arguments)

Shortcut for function(CqlIdentifier.fromCql(functionName), arguments).

function

@NonNull
public static Term function(@NonNull
                                     String functionName,
                                     @NonNull
                                     Term... arguments)

Shortcut for function(CqlIdentifier.fromCql(functionName), arguments).

function

@NonNull
public static Term function(@Nullable
                                     CqlIdentifier keyspaceId,
                                     @NonNull
                                     CqlIdentifier functionId,
                                     @NonNull
                                     Iterable<Term> arguments)

A function call as a term, as in WHERE k = ks.f(arguments).

function

@NonNull
public static Term function(@Nullable
                                     CqlIdentifier keyspaceId,
                                     @NonNull
                                     CqlIdentifier functionId,
                                     @NonNull
                                     Term... arguments)

Var-arg equivalent of function(CqlIdentifier, CqlIdentifier, Iterable).

function

@NonNull
public static Term function(@Nullable
                                     String keyspaceName,
                                     @NonNull
                                     String functionName,
                                     @NonNull
                                     Iterable<Term> arguments)

Shortcut for function(CqlIdentifier.fromCql(keyspaceName), CqlIdentifier.fromCql(functionName), arguments).

function

@NonNull
public static Term function(@Nullable
                                     String keyspaceName,
                                     @NonNull
                                     String functionName,
                                     @NonNull
                                     Term... arguments)

Shortcut for function(CqlIdentifier.fromCql(keyspaceName), CqlIdentifier.fromCql(functionName), arguments).

typeHint

@NonNull
public static Term typeHint(@NonNull
                                     Term term,
                                     @NonNull
                                     DataType targetType)

Provides a type hint for an expression, as in WHERE k = (double)1/3.

To create the data type, use the constants and static methods in DataTypes, or udt(CqlIdentifier).

now
```
@NonNull
public static Term now()
```
A call to the built-in now function as a term.

currentTimestamp
```
@NonNull
public static Term currentTimestamp()
```
A call to the built-in currentTimestamp function as a term.

currentDate
```
@NonNull
public static Term currentDate()
```
A call to the built-in currentDate function as a term.

currentTime
```
@NonNull
public static Term currentTime()
```
A call to the built-in currentTime function as a term.

currentTimeUuid
```
@NonNull
public static Term currentTimeUuid()
```
A call to the built-in currentTimeUuid function as a term.

minTimeUuid

@NonNull
public static Term minTimeUuid(@NonNull
                                        Term argument)

A call to the built-in minTimeUuid function as a term.

maxTimeUuid

@NonNull
public static Term maxTimeUuid(@NonNull
                                        Term argument)

A call to the built-in maxTimeUuid function as a term.

toDate

@NonNull
public static Term toDate(@NonNull
                                   Term argument)

A call to the built-in toDate function as a term.

toTimestamp

@NonNull
public static Term toTimestamp(@NonNull
                                        Term argument)

A call to the built-in toTimestamp function as a term.

toUnixTimestamp

@NonNull
public static Term toUnixTimestamp(@NonNull
                                            Term argument)

A call to the built-in toUnixTimestamp function as a term.

literal
```
@NonNull
public static Literal literal(@Nullable
                                       Object value)
```
A literal term, as in WHERE k = 1.
This method can process any type for which there is a default Java to CQL mapping, namely: primitive types (Integer=>int, Long=>bigint, String=>text, etc.), and collections, tuples, and user defined types thereof.
A null argument will be rendered as NULL.
For custom mappings, use literal(Object, CodecRegistry) or literal(Object, TypeCodec).

Throws:

CodecNotFoundException - if there is no default CQL mapping for the Java type of value.

literal
```
@NonNull
public static Literal literal(@Nullable
                                       Object value,
                                       @NonNull
                                       CodecRegistry codecRegistry)
```
A literal term, as in WHERE k = 1.
This is an alternative to literal(Object) for custom type mappings. The provided registry should contain a codec that can format the value. Typically, this will be your session's registry, which is accessible via session.getContext().getCodecRegistry().

Throws:

CodecNotFoundException - if codecRegistry does not contain any codec that can handle value.

See Also:

AttachmentPoint.getCodecRegistry()

literal

@NonNull
public static <T> Literal literal(@Nullable
                                           T value,
                                           @Nullable
                                           TypeCodec<T> codec)

A literal term, as in WHERE k = 1.

This is an alternative to literal(Object) for custom type mappings. The value will be turned into a string with TypeCodec.format(Object), and inlined in the query.

raw
```
@NonNull
public static Raw raw(@NonNull
                               String raw)
```
A raw CQL snippet.
The contents will be appended to the query as-is, without any syntax checking or escaping. This method should be used with caution, as it's possible to generate invalid CQL that will fail at execution time; on the other hand, it can be used as a workaround to handle new CQL features that are not yet covered by the query builder.

bindMarker
```
@NonNull
public static BindMarker bindMarker()
```
Creates an anonymous bind marker, which appears as ? in the generated CQL.

bindMarker

@NonNull
public static BindMarker bindMarker(@Nullable
                                             CqlIdentifier id)

Creates a named bind marker, which appears as :id in the generated CQL.

bindMarker

@NonNull
public static BindMarker bindMarker(@Nullable
                                             String name)

Shortcut for bindMarker(CqlIdentifier.fromCql(name))

udt

@NonNull
public static UserDefinedType udt(@NonNull
                                           CqlIdentifier name)

Shortcut to reference a UDT in methods that use a DataType, such as typeHint(Term, DataType) and Selector.cast(Selector, DataType).

udt

@NonNull
public static UserDefinedType udt(@NonNull
                                           String name)

Shortcut for udt(CqlIdentifier.fromCql(name)).

truncate

public static Truncate truncate(@NonNull
                                CqlIdentifier table)

Creates a new TRUNCATE query.

Parameters:: table - the name of the table to truncate.
Returns:: the truncation query.

truncate
```
public static Truncate truncate(@NonNull
                                String table)
```
Creates a new TRUNCATE query.
This is a shortcut for truncate(CqlIdentifier.fromCql(table)).

Parameters:

table - the name of the table to truncate.

Returns:

the truncation query.

truncate

public static Truncate truncate(@Nullable
                                CqlIdentifier keyspace,
                                @NonNull
                                CqlIdentifier table)

Creates a new TRUNCATE query.

Parameters:: keyspace - the name of the keyspace to use.; table - the name of the table to truncate.
Returns:: the truncation query.

truncate

public static Truncate truncate(@Nullable
                                String keyspace,
                                @NonNull
                                String table)

Creates a new TRUNCATE query.

This is a shortcut for truncate(CqlIdentifier.fromCql(keyspace), CqlIdentifier.fromCql(table)).

Parameters:: keyspace - the name of the keyspace to use.; table - the name of the table to truncate.
Returns:: the truncation query.

Class QueryBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryBuilder

Method Detail

selectFrom

selectFrom

selectFrom

selectFrom

insertInto

insertInto

insertInto

insertInto

update

update

update

update

deleteFrom

deleteFrom

deleteFrom

deleteFrom

tuple

tuple

add

subtract

multiply

divide

remainder

negate

function

function

function

function

function

function

function

function

typeHint

now

currentTimestamp

currentDate

currentTime

currentTimeUuid

minTimeUuid

maxTimeUuid

toDate

toTimestamp

toUnixTimestamp

literal

literal

literal

raw

bindMarker

bindMarker

bindMarker

udt

udt

truncate

truncate

truncate

truncate