com.datastax.oss.driver.api.querybuilder.select

Interface OngoingSelection

All Known Subinterfaces:

Select, SelectFrom

public interface OngoingSelection

A SELECT query that accepts additional selectors (that is, elements in the SELECT clause to return as columns in the result set, as in: SELECT count(*), sku, price...).

Method Summary

Modifier and Type	Method and Description
default Select	add(Selector left, Selector right) Selects the sum of two arguments, as in SELECT col1 + col2.
default Select	all() Selects all columns, as in SELECT *.
Select	as(CqlIdentifier alias) Aliases the last added selector, as in SELECT count(*) AS total.
default Select	as(String alias) Shortcut for as(CqlIdentifier.fromCql(alias))
default Select	cast(Selector selector, DataType targetType) Casts a selector to a type, as in SELECT CAST(a AS double).
default Select	column(CqlIdentifier columnId) Selects a particular column by its CQL identifier.
default Select	column(String columnName) Shortcut for column(CqlIdentifier.fromCql(columnName))
default Select	columns(CqlIdentifier... columnIds) Var-arg equivalent of columnsIds(Iterable).
default Select	columns(Iterable<String> columnNames) Convenience method to select multiple simple columns at once, as in SELECT a,b,c.
default Select	columns(String... columnNames) Var-arg equivalent of columns(Iterable).
default Select	columnsIds(Iterable<CqlIdentifier> columnIds) Convenience method to select multiple simple columns at once, as in SELECT a,b,c.
default Select	countAll() Selects the count of all returned rows, as in SELECT count(*).
default Select	divide(Selector left, Selector right) Selects the quotient of two arguments, as in SELECT col1 / col2.
default Select	element(CqlIdentifier collectionId, Term index) Shortcut for element selection when the target collection is a simple column.
default Select	element(Selector collection, Term index) Selects an element in a collection column, as in SELECT m['key'].
default Select	element(String collectionName, Term index) Shortcut for element(CqlIdentifier.fromCql(collectionName), index).
default Select	field(CqlIdentifier udtColumnId, CqlIdentifier fieldId) Shortcut to select a UDT field when the UDT is a simple column (as opposed to a more complex selection, like a nested UDT).
default Select	field(Selector udt, CqlIdentifier fieldId) Selects a field inside of a UDT column, as in SELECT user.name.
default Select	field(Selector udt, String fieldName) Shortcut for field(udt, CqlIdentifier.fromCql(fieldName)).
default Select	field(String udtColumnName, String fieldName) Shortcut for field(CqlIdentifier.fromCql(udtColumnName), CqlIdentifier.fromCql(fieldName)).
default Select	function(CqlIdentifier keyspaceId, CqlIdentifier functionId, Iterable<Selector> arguments) Selects the result of a function call, as is SELECT f(a,b)
default Select	function(CqlIdentifier keyspaceId, CqlIdentifier functionId, Selector... arguments) Var-arg equivalent of function(CqlIdentifier,CqlIdentifier, Iterable).
default Select	function(CqlIdentifier functionId, Iterable<Selector> arguments) Selects the result of a function call, as is SELECT f(a,b)
default Select	function(CqlIdentifier functionId, Selector... arguments) Var-arg equivalent of function(CqlIdentifier, Iterable).
default Select	function(String functionName, Iterable<Selector> arguments) Shortcut for function(CqlIdentifier.fromCql(functionName), arguments).
default Select	function(String functionName, Selector... arguments) Var-arg equivalent of function(String, Iterable).
default Select	function(String keyspaceName, String functionName, Iterable<Selector> arguments) Shortcut for function(CqlIdentifier.fromCql(keyspaceName), CqlIdentifier.fromCql(functionName), arguments).
default Select	function(String keyspaceName, String functionName, Selector... arguments) Var-arg equivalent of function(String, String, Iterable).
default Select	listOf(Iterable<Selector> elementSelectors) Selects a group of elements as a list, as in SELECT [a,b,c].
default Select	listOf(Selector... elementSelectors) Var-arg equivalent of listOf(Iterable).
default Select	literal(Object value) Selects literal value, as in WHERE k = 1.
default Select	literal(Object value, CodecRegistry codecRegistry) Selects a literal value, as in WHERE k = 1.
default <T> Select	literal(T value, TypeCodec<T> codec) Selects a literal value, as in WHERE k = 1.
default Select	mapOf(Map<Selector,Selector> elementSelectors) Selects a group of elements as a map, as in SELECT {a:b,c:d}.
default Select	mapOf(Map<Selector,Selector> elementSelectors, DataType keyType, DataType valueType) Selects a group of elements as a map and force the resulting map type, as in SELECT (map<int,text>){a:b,c:d}.
default Select	multiply(Selector left, Selector right) Selects the product of two arguments, as in SELECT col1 * col2.
default Select	negate(Selector argument) Selects the opposite of an argument, as in SELECT -col1.
default Select	range(CqlIdentifier collectionId, Term left, Term right) Shortcut for slice selection when the target collection is a simple column.
default Select	range(Selector collection, Term left, Term right) Selects a slice in a collection column, as in SELECT s[4..8].
default Select	range(String collectionName, Term left, Term right) Shortcut for range(CqlIdentifier.fromCql(collectionName), left, right).
default Select	raw(String rawExpression) Selects an arbitrary expression expressed as a raw string.
default Select	remainder(Selector left, Selector right) Selects the remainder of two arguments, as in SELECT col1 % col2.
Select	selector(Selector selector) Adds a selector.
Select	selectors(Iterable<Selector> additionalSelectors) Adds multiple selectors at once.
default Select	selectors(Selector... additionalSelectors) Var-arg equivalent of selectors(Iterable).
default Select	setOf(Iterable<Selector> elementSelectors) Selects a group of elements as a set, as in SELECT {a,b,c}.
default Select	setOf(Selector... elementSelectors) Var-arg equivalent of setOf(Iterable).
default Select	subtract(Selector left, Selector right) Selects the difference of two terms, as in SELECT col1 - col2.
default Select	toDate(CqlIdentifier columnId) Shortcut to select the result of the built-in toDate function.
default Select	toDate(String columnName) Shortcut for toDate(CqlIdentifier.fromCql(columnName)).
default Select	toTimestamp(CqlIdentifier columnId) Shortcut to select the result of the built-in toTimestamp function.
default Select	toTimestamp(String columnName) Shortcut for toTimestamp(CqlIdentifier.fromCql(columnName)).
default Select	toUnixTimestamp(CqlIdentifier columnId) Shortcut to select the result of the built-in toUnixTimestamp function.
default Select	toUnixTimestamp(String columnName) Shortcut for toUnixTimestamp(CqlIdentifier.fromCql(columnName)).
default Select	ttl(CqlIdentifier columnId) Shortcut to select the result of the built-in ttl function, as in SELECT ttl(c).
default Select	ttl(String columnName) Shortcut for ttl(CqlIdentifier.fromCql(columnName)).
default Select	tupleOf(Iterable<Selector> elementSelectors) Selects a group of elements as a tuple, as in SELECT (a,b,c).
default Select	tupleOf(Selector... elementSelectors) Var-arg equivalent of tupleOf(Iterable).
default Select	typeHint(Selector selector, DataType targetType) Provides a type hint for a selector, as in SELECT (double)1/3.
default Select	writeTime(CqlIdentifier columnId) Shortcut to select the result of the built-in writetime function, as in SELECT writetime(c).
default Select	writeTime(String columnName) Shortcut for writeTime(CqlIdentifier.fromCql(columnName)).

Method Detail

selector

@NonNull
Select selector(@NonNull
                         Selector selector)

Adds a selector.

To create the argument, use one of the factory methods in Selector, for example column. This type also provides shortcuts to create and add the selector in one call, for example column(CqlIdentifier) for selector(Selector.column(...)).

If you add multiple selectors as once, consider selectors(Iterable) as a more efficient alternative.

selectors

@NonNull
Select selectors(@NonNull
                          Iterable<Selector> additionalSelectors)

Adds multiple selectors at once.

This is slightly more efficient than adding the selectors one by one (since the underlying implementation of this object is immutable).

To create the arguments, use one of the factory methods in Selector, for example column.

Throws:

IllegalArgumentException - if one of the selectors is Selector.all() (* can only be used on its own).

See Also:

selector(Selector)

selectors

@NonNull
default Select selectors(@NonNull
                                  Selector... additionalSelectors)

Var-arg equivalent of selectors(Iterable).

all

@NonNull
default Select all()

Selects all columns, as in SELECT *.

This will clear any previously configured selector. Similarly, if any other selector is added later, it will cancel this one.

This is a shortcut for selector(Selector.all()).

See Also:

Selector.all()

countAll

@NonNull
default Select countAll()

Selects the count of all returned rows, as in SELECT count(*).

This is a shortcut for selector(Selector.countAll()).

See Also:

Selector.countAll()

column

@NonNull
default Select column(@NonNull
                               CqlIdentifier columnId)

Selects a particular column by its CQL identifier.

This is a shortcut for selector(Selector.column(columnId)).

See Also:

Selector.column(CqlIdentifier)

column

@NonNull
default Select column(@NonNull
                               String columnName)

Shortcut for column(CqlIdentifier.fromCql(columnName))

columnsIds

@NonNull
default Select columnsIds(@NonNull
                                   Iterable<CqlIdentifier> columnIds)

Convenience method to select multiple simple columns at once, as in SELECT a,b,c.

This is the same as calling column(CqlIdentifier) for each element.

columns

@NonNull
default Select columns(@NonNull
                                CqlIdentifier... columnIds)

Var-arg equivalent of columnsIds(Iterable).

columns

@NonNull
default Select columns(@NonNull
                                Iterable<String> columnNames)

Convenience method to select multiple simple columns at once, as in SELECT a,b,c.

This is the same as calling column(String) for each element.

columns

@NonNull
default Select columns(@NonNull
                                String... columnNames)

Var-arg equivalent of columns(Iterable).

add

@NonNull
default Select add(@NonNull
                            Selector left,
                            @NonNull
                            Selector right)

Selects the sum of two arguments, as in SELECT col1 + col2.

This is available in Cassandra 4 and above.

This is a shortcut for selector(Selector.add(left, right)).

See Also:

Selector.add(Selector, Selector)

subtract

@NonNull
default Select subtract(@NonNull
                                 Selector left,
                                 @NonNull
                                 Selector right)

Selects the difference of two terms, as in SELECT col1 - col2.

This is available in Cassandra 4 and above.

This is a shortcut for selector(Selector.subtract(left, right)).

See Also:

Selector.subtract(Selector, Selector)

multiply

@NonNull
default Select multiply(@NonNull
                                 Selector left,
                                 @NonNull
                                 Selector right)

Selects the product of two arguments, as in SELECT col1 * col2.

This is available in Cassandra 4 and above.

This is a shortcut for selector(Selector.multiply(left, right)).

The arguments will be parenthesized if they are instances of Selector.add(com.datastax.oss.driver.api.querybuilder.select.Selector, com.datastax.oss.driver.api.querybuilder.select.Selector) or Selector.subtract(com.datastax.oss.driver.api.querybuilder.select.Selector, com.datastax.oss.driver.api.querybuilder.select.Selector). If they are raw selectors, you might have to parenthesize them yourself.

See Also:

Selector.multiply(Selector, Selector)

divide

@NonNull
default Select divide(@NonNull
                               Selector left,
                               @NonNull
                               Selector right)

Selects the quotient of two arguments, as in SELECT col1 / col2.

This is available in Cassandra 4 and above.

This is a shortcut for selector(Selector.divide(left, right)).

The arguments will be parenthesized if they are instances of Selector.add(com.datastax.oss.driver.api.querybuilder.select.Selector, com.datastax.oss.driver.api.querybuilder.select.Selector) or Selector.subtract(com.datastax.oss.driver.api.querybuilder.select.Selector, com.datastax.oss.driver.api.querybuilder.select.Selector). If they are raw selectors, you might have to parenthesize them yourself.

See Also:

Selector.divide(Selector, Selector)

remainder

@NonNull
default Select remainder(@NonNull
                                  Selector left,
                                  @NonNull
                                  Selector right)

Selects the remainder of two arguments, as in SELECT col1 % col2.

This is available in Cassandra 4 and above.

This is a shortcut for selector(Selector.remainder(left, right)).

The arguments will be parenthesized if they are instances of Selector.add(com.datastax.oss.driver.api.querybuilder.select.Selector, com.datastax.oss.driver.api.querybuilder.select.Selector) or Selector.subtract(com.datastax.oss.driver.api.querybuilder.select.Selector, com.datastax.oss.driver.api.querybuilder.select.Selector). If they are raw selectors, you might have to parenthesize them yourself.

See Also:

Selector.remainder(Selector, Selector)

negate

@NonNull
default Select negate(@NonNull
                               Selector argument)

Selects the opposite of an argument, as in SELECT -col1.

This is available in Cassandra 4 and above.

This is a shortcut for selector(Selector.negate(argument)).

The argument will be parenthesized if it is an instance of Selector.add(com.datastax.oss.driver.api.querybuilder.select.Selector, com.datastax.oss.driver.api.querybuilder.select.Selector) or Selector.subtract(com.datastax.oss.driver.api.querybuilder.select.Selector, com.datastax.oss.driver.api.querybuilder.select.Selector). If it is a raw selector, you might have to parenthesize it yourself.

See Also:

Selector.negate(Selector)

field

@NonNull
default Select field(@NonNull
                              Selector udt,
                              @NonNull
                              CqlIdentifier fieldId)

Selects a field inside of a UDT column, as in SELECT user.name.

This is a shortcut for selector(Selector.field(udt, fieldId)).

See Also:

Selector.field(Selector, CqlIdentifier)

field

@NonNull
default Select field(@NonNull
                              Selector udt,
                              @NonNull
                              String fieldName)

Shortcut for field(udt, CqlIdentifier.fromCql(fieldName)).

field

@NonNull
default Select field(@NonNull
                              CqlIdentifier udtColumnId,
                              @NonNull
                              CqlIdentifier fieldId)

Shortcut to select a UDT field when the UDT is a simple column (as opposed to a more complex selection, like a nested UDT).

In other words, this is a shortcut for {field(QueryBuilder.column(udtColumnId), fieldId).

See Also:

Selector.field(CqlIdentifier, CqlIdentifier)

field

@NonNull
default Select field(@NonNull
                              String udtColumnName,
                              @NonNull
                              String fieldName)

Shortcut for field(CqlIdentifier.fromCql(udtColumnName), CqlIdentifier.fromCql(fieldName)).

See Also:

Selector.field(String, String)

element

@NonNull
default Select element(@NonNull
                                Selector collection,
                                @NonNull
                                Term index)

Selects an element in a collection column, as in SELECT m['key'].

As of Cassandra 4, this is only allowed for map and set columns.

This is a shortcut for selector(Selector.element(collection, index)).

See Also:

Selector.element(Selector, Term)

element

@NonNull
default Select element(@NonNull
                                CqlIdentifier collectionId,
                                @NonNull
                                Term index)

Shortcut for element selection when the target collection is a simple column.

In other words, this is the equivalent of element(QueryBuilder.column(collection), index).

See Also:

Selector.element(CqlIdentifier, Term)

element

@NonNull
default Select element(@NonNull
                                String collectionName,
                                @NonNull
                                Term index)

Shortcut for element(CqlIdentifier.fromCql(collectionName), index).

See Also:

Selector.element(String, Term)

range

@NonNull
default Select range(@NonNull
                              Selector collection,
                              @Nullable
                              Term left,
                              @Nullable
                              Term right)

Selects a slice in a collection column, as in SELECT s[4..8].

As of Cassandra 4, this is only allowed for set and map columns. Those collections are ordered, the elements (or keys in the case of a map), will be compared to the bounds for inclusions. Either bound can be unspecified, but not both.

This is a shortcut for selector(Selector.range(collection, left, right)).

Parameters:

left - the left bound (inclusive). Can be null to indicate that the slice is only right-bound.

right - the right bound (inclusive). Can be null to indicate that the slice is only left-bound.

See Also:

Selector.range(Selector, Term, Term)

range

@NonNull
default Select range(@NonNull
                              CqlIdentifier collectionId,
                              @Nullable
                              Term left,
                              @Nullable
                              Term right)

Shortcut for slice selection when the target collection is a simple column.

In other words, this is the equivalent of range(Selector, Term, Term) range(Selector.column(collectionId), left, right)}.

See Also:

Selector.range(CqlIdentifier, Term, Term)

range

@NonNull
default Select range(@NonNull
                              String collectionName,
                              @Nullable
                              Term left,
                              @Nullable
                              Term right)

Shortcut for range(CqlIdentifier.fromCql(collectionName), left, right).

See Also:

Selector.range(String, Term, Term)

listOf

@NonNull
default Select listOf(@NonNull
                               Iterable<Selector> elementSelectors)

Selects a group of elements as a list, as in SELECT [a,b,c].

None of the selectors should be aliased (the query builder checks this at runtime), and they should all produce the same data type (the query builder can't check this, so the query will fail at execution time).

This is a shortcut for selector(Selector.listOf(elementSelectors)).

Throws:

IllegalArgumentException - if any of the selectors is aliased.

See Also:

Selector.listOf(Iterable)

listOf

@NonNull
default Select listOf(@NonNull
                               Selector... elementSelectors)

Var-arg equivalent of listOf(Iterable).

setOf

@NonNull
default Select setOf(@NonNull
                              Iterable<Selector> elementSelectors)

Selects a group of elements as a set, as in SELECT {a,b,c}.

None of the selectors should be aliased (the query builder checks this at runtime), and they should all produce the same data type (the query builder can't check this, so the query will fail at execution time).

This is a shortcut for selector(Selector.setOf(elementSelectors)).

Throws:

IllegalArgumentException - if any of the selectors is aliased.

See Also:

Selector.setOf(Iterable)

setOf

@NonNull
default Select setOf(@NonNull
                              Selector... elementSelectors)

Var-arg equivalent of setOf(Iterable).

tupleOf

@NonNull
default Select tupleOf(@NonNull
                                Iterable<Selector> elementSelectors)

Selects a group of elements as a tuple, as in SELECT (a,b,c).

None of the selectors should be aliased (the query builder checks this at runtime).

This is a shortcut for selector(Selector.tupleOf(elementSelectors)).

Throws:

IllegalArgumentException - if any of the selectors is aliased.

See Also:

Selector.tupleOf(Iterable)

tupleOf

@NonNull
default Select tupleOf(@NonNull
                                Selector... elementSelectors)

Var-arg equivalent of tupleOf(Iterable).

mapOf

@NonNull
default Select mapOf(@NonNull
                              Map<Selector,Selector> elementSelectors)

Selects a group of elements as a map, as in SELECT {a:b,c:d}.

None of the selectors should be aliased (the query builder checks this at runtime). In addition, all key selectors should produce the same type, and all value selectors as well (the key and value types can be different); the query builder can't check this, so the query will fail at execution time if the types are not uniform.

This is a shortcut for selector(Selector.mapOf(elementSelectors)).

Note that Cassandra often has trouble inferring the exact map type. This will manifest as the error message:

   Cannot infer type for term xxx in selection clause (try using a cast to force a type)
 

If you run into this, consider providing the types explicitly with mapOf(Map, DataType, DataType).

Throws:

IllegalArgumentException - if any of the selectors is aliased.

See Also:

Selector.mapOf(Map)

mapOf

@NonNull
default Select mapOf(@NonNull
                              Map<Selector,Selector> elementSelectors,
                              @NonNull
                              DataType keyType,
                              @NonNull
                              DataType valueType)

Selects a group of elements as a map and force the resulting map type, as in SELECT (map<int,text>){a:b,c:d}.

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

This is a shortcut for selector(Selector.mapOf(elementSelectors, keyType, valueType)).

See Also:

mapOf(Map), Selector.mapOf(Map, DataType, DataType)

typeHint

@NonNull
default Select typeHint(@NonNull
                                 Selector selector,
                                 @NonNull
                                 DataType targetType)

Provides a type hint for a selector, as in SELECT (double)1/3.

Use the constants and static methods in DataTypes to create the data type.

This is a shortcut for selector(Selector.typeHint(selector, targetType)).

See Also:

Selector.typeHint(Selector, DataType)

function

@NonNull
default Select function(@NonNull
                                 CqlIdentifier functionId,
                                 @NonNull
                                 Iterable<Selector> arguments)

Selects the result of a function call, as is SELECT f(a,b)

None of the arguments should be aliased (the query builder checks this at runtime).

This is a shortcut for selector(Selector.function(functionId, arguments)).

Throws:

IllegalArgumentException - if any of the selectors is aliased.

See Also:

Selector.function(CqlIdentifier, Iterable)

function

@NonNull
default Select function(@NonNull
                                 CqlIdentifier functionId,
                                 @NonNull
                                 Selector... arguments)

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

See Also:

Selector.function(CqlIdentifier, Selector...)

function

@NonNull
default Select function(@NonNull
                                 String functionName,
                                 @NonNull
                                 Iterable<Selector> arguments)

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

See Also:

Selector.function(String, Iterable)

function

@NonNull
default Select function(@NonNull
                                 String functionName,
                                 @NonNull
                                 Selector... arguments)

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

See Also:

Selector.function(String, Selector...)

function

@NonNull
default Select function(@Nullable
                                 CqlIdentifier keyspaceId,
                                 @NonNull
                                 CqlIdentifier functionId,
                                 @NonNull
                                 Iterable<Selector> arguments)

Selects the result of a function call, as is SELECT f(a,b)

None of the arguments should be aliased (the query builder checks this at runtime).

This is a shortcut for selector(Selector.function(keyspaceId, functionId, arguments)).

Throws:

IllegalArgumentException - if any of the selectors is aliased.

See Also:

Selector.function(CqlIdentifier, CqlIdentifier, Iterable)

function

@NonNull
default Select function(@Nullable
                                 CqlIdentifier keyspaceId,
                                 @NonNull
                                 CqlIdentifier functionId,
                                 @NonNull
                                 Selector... arguments)

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

See Also:

Selector.function(CqlIdentifier, CqlIdentifier, Selector...)

function

@NonNull
default Select function(@Nullable
                                 String keyspaceName,
                                 @NonNull
                                 String functionName,
                                 @NonNull
                                 Iterable<Selector> arguments)

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

See Also:

Selector.function(String, String, Iterable)

function

@NonNull
default Select function(@Nullable
                                 String keyspaceName,
                                 @NonNull
                                 String functionName,
                                 @NonNull
                                 Selector... arguments)

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

See Also:

Selector.function(String, String, Selector...)

writeTime

@NonNull
default Select writeTime(@NonNull
                                  CqlIdentifier columnId)

Shortcut to select the result of the built-in writetime function, as in SELECT writetime(c).

See Also:

Selector.writeTime(CqlIdentifier)

writeTime

@NonNull
default Select writeTime(@NonNull
                                  String columnName)

Shortcut for writeTime(CqlIdentifier.fromCql(columnName)).

See Also:

Selector.writeTime(String)

ttl

@NonNull
default Select ttl(@NonNull
                            CqlIdentifier columnId)

Shortcut to select the result of the built-in ttl function, as in SELECT ttl(c).

See Also:

Selector.ttl(CqlIdentifier)

ttl

@NonNull
default Select ttl(@NonNull
                            String columnName)

Shortcut for ttl(CqlIdentifier.fromCql(columnName)).

See Also:

Selector.ttl(String)

cast

@NonNull
default Select cast(@NonNull
                             Selector selector,
                             @NonNull
                             DataType targetType)

Casts a selector to a type, as in SELECT CAST(a AS double).

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

This is a shortcut for selector(Selector.function(keyspaceId, functionId, arguments)).

Throws:

IllegalArgumentException - if the selector is aliased.

See Also:

Selector.cast(Selector, DataType)

toDate

@NonNull
default Select toDate(@NonNull
                               CqlIdentifier columnId)

Shortcut to select the result of the built-in toDate function.

See Also:

Selector.toDate(CqlIdentifier)

toDate

@NonNull
default Select toDate(@NonNull
                               String columnName)

Shortcut for toDate(CqlIdentifier.fromCql(columnName)).

toTimestamp

@NonNull
default Select toTimestamp(@NonNull
                                    CqlIdentifier columnId)

Shortcut to select the result of the built-in toTimestamp function.

See Also:

Selector.toTimestamp(CqlIdentifier)

toTimestamp

@NonNull
default Select toTimestamp(@NonNull
                                    String columnName)

Shortcut for toTimestamp(CqlIdentifier.fromCql(columnName)).

toUnixTimestamp

@NonNull
default Select toUnixTimestamp(@NonNull
                                        CqlIdentifier columnId)

Shortcut to select the result of the built-in toUnixTimestamp function.

See Also:

Selector.toUnixTimestamp(CqlIdentifier)

toUnixTimestamp

@NonNull
default Select toUnixTimestamp(@NonNull
                                        String columnName)

Shortcut for toUnixTimestamp(CqlIdentifier.fromCql(columnName)).

literal

@NonNull
default Select literal(@Nullable
                                Object value)

Selects literal value, 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.

See Also:

QueryBuilder.literal(Object)

literal

@NonNull
default Select literal(@Nullable
                                Object value,
                                @NonNull
                                CodecRegistry codecRegistry)

Selects a literal value, 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(), QueryBuilder.literal(Object, CodecRegistry)

literal

@NonNull
default <T> Select literal(@Nullable
                                    T value,
                                    @Nullable
                                    TypeCodec<T> codec)

Selects a literal value, 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.

See Also:

QueryBuilder.literal(Object, TypeCodec)

raw

@NonNull
default Select raw(@NonNull
                            String rawExpression)

Selects an arbitrary expression expressed as a raw string.

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.

This is a shortcut for selector(QueryBuilder.raw(rawExpression)).

as

@NonNull
Select as(@NonNull
                   CqlIdentifier alias)

Aliases the last added selector, as in SELECT count(*) AS total.

It is the caller's responsibility to ensure that this method is called at most once after each selector, and that this selector can legally be aliased:

• if it is called multiple times (countAll().as("total1").as("total2")), the last alias will override the previous ones.
• if it is called before any selector was set, or after all(), an IllegalStateException is thrown.
• if it is called after a raw(String) selector that already defines an alias, the query will fail at runtime.

as

@NonNull
default Select as(@NonNull
                           String alias)

Shortcut for as(CqlIdentifier.fromCql(alias))