com.datastax.oss.driver.api.querybuilder

Interface BuildableQuery

All Known Subinterfaces:

AlterDseKeyspace, AlterDseTableAddColumnEnd, AlterDseTableDropColumnEnd, AlterDseTableRenameColumnEnd, AlterDseTableWithOptionsEnd, AlterKeyspace, AlterMaterializedView, AlterTableAddColumnEnd, AlterTableDropColumnEnd, AlterTableRenameColumnEnd, AlterTableWithOptionsEnd, AlterTypeRenameFieldEnd, CreateAggregateEnd, CreateDseAggregateEnd, CreateDseFunctionEnd, CreateDseKeyspace, CreateDseTable, CreateDseTableWithOptions, CreateFunctionEnd, CreateIndex, CreateKeyspace, CreateMaterializedView, CreateMaterializedViewPrimaryKey, CreateTable, CreateTableWithOptions, CreateType, Delete, Drop, Insert, JsonInsert, RegularInsert, Select, Truncate, Update

public interface BuildableQuery

End state for the query builder DSL, which allows the generation of a CQL query.

The API returns this type as soon as there is enough information for a minimal query (in most cases, it's still possible to call more methods to keep building).

Method Summary

Modifier and Type	Method and Description
String	asCql() Builds the CQL query as a raw string.
default SimpleStatement	build() Builds the CQL query and wraps it in a simple statement.
default SimpleStatement	build(Map<String,Object> namedValues) Builds the CQL query and wraps it in a simple statement, also providing named values for bind markers.
default SimpleStatement	build(Object... values) Builds the CQL query and wraps it in a simple statement, also providing positional values for bind markers.
default SimpleStatementBuilder	builder() Builds the CQL query and wraps it in a simple statement builder.

Method Detail

asCql

@NonNull
String asCql()

Builds the CQL query as a raw string.

Use this if you plan to pass the query to SyncCqlSession.execute(String) or SyncCqlSession.prepare(String) without any further customization.

build

@NonNull
default SimpleStatement build()

Builds the CQL query and wraps it in a simple statement.

This is a similar to:

 SimpleStatement.newInstance(asCql())
 

In addition, some implementations might try to infer additional statement properties (such as Request.isIdempotent()).

build

@NonNull
default SimpleStatement build(@NonNull
                                       Object... values)

Builds the CQL query and wraps it in a simple statement, also providing positional values for bind markers.

This is a similar to:

 SimpleStatement.newInstance(asCql(), values)
 

In addition, some implementations might try to infer additional statement properties (such as Request.isIdempotent()).

build

@NonNull
default SimpleStatement build(@NonNull
                                       Map<String,Object> namedValues)

Builds the CQL query and wraps it in a simple statement, also providing named values for bind markers.

This is a similar to:

 SimpleStatement.newInstance(asCql(), namedValues)
 

In addition, some implementations might try to infer additional statement properties (such as Request.isIdempotent()).

builder

@NonNull
default SimpleStatementBuilder builder()

Builds the CQL query and wraps it in a simple statement builder.

This is equivalent to build(), but the builder might be slightly more efficient if you plan to customize multiple properties on the statement, for example:

 SimpleStatementBuilder builder =
     selectFrom("foo")
         .all()
         .whereColumn("k").isEqualTo(bindMarker("k"))
         .whereColumn("c").isLessThan(bindMarker("c"))
         .builder();
 SimpleStatement statement =
     builder.addNamedValue("k", 1).addNamedValue("c", 2).setTracing().build();
 

In addition, some implementations might try to infer additional statement properties (such as Request.isIdempotent()).