com.datastax.oss.driver.api.core.type

Interface DataType

All Superinterfaces:

Detachable

All Known Subinterfaces:

CustomType, ListType, MapType, SetType, TupleType, UserDefinedType

public interface DataType
extends Detachable

The type of a CQL column, field or function argument.

The default implementations returned by the driver are immutable and serializable. If you write your own implementations, they should at least be thread-safe; serializability is not mandatory, but recommended for use with some 3rd-party tools like Apache Spark ™.

See Also:

DataTypes

Method Summary

Modifier and Type	Method and Description
String	asCql(boolean includeFrozen, boolean pretty) Builds an appropriate representation for use in a CQL query.
int	getProtocolCode() The code of the data type in the native protocol specification.

Methods inherited from interface com.datastax.oss.driver.api.core.detach.Detachable

attach, isDetached

Method Detail

getProtocolCode

int getProtocolCode()

The code of the data type in the native protocol specification.

asCql

@NonNull
String asCql(boolean includeFrozen,
                      boolean pretty)

Builds an appropriate representation for use in a CQL query.

Parameters:

includeFrozen - whether to include the frozen<...> keyword if applicable. This will need to be set depending on where the result is used: for example, CREATE TABLE statements use the frozen keyword, whereas it should never appear in CREATE FUNCTION.

pretty - whether to pretty-print UDT names (as described in CqlIdentifier.asCql(boolean).