public class ColumnSpecification extends Object
name(String)
and #type(String)
to set the name and type of the column, respectively. To specify
a clustered PRIMARY KEY
column, use clustered()
or clustered(Ordering)
. To specify that the
PRIMARY KEY
column is or is part of the partition key, use partitioned()
instead of
clustered()
or clustered(Ordering)
.Modifier and Type | Field and Description |
---|---|
static Ordering |
DEFAULT_ORDERING
Default ordering of primary key fields; value is
Ordering.ASCENDING . |
Modifier and Type | Method and Description |
---|---|
ColumnSpecification |
clustered()
Identifies this column as a clustered key column with default ordering.
|
ColumnSpecification |
clustered(Ordering order)
Identifies this column as a clustered key column with the given ordering.
|
ColumnSpecification |
clustered(Ordering order,
boolean primary)
Toggles the identification of this column as a clustered key column.
|
PrimaryKeyType |
getKeyType() |
CqlIdentifier |
getName() |
Ordering |
getOrdering() |
com.datastax.driver.core.DataType |
getType() |
ColumnSpecification |
keyType(PrimaryKeyType keyType)
Sets the column's
keyType . |
static ColumnSpecification |
name(CqlIdentifier name)
Create a new
ColumnSpecification for the given name . |
static ColumnSpecification |
name(String name)
Create a new
ColumnSpecification for the given name . |
ColumnSpecification |
ordering(Ordering ordering)
Sets the column's
ordering . |
ColumnSpecification |
partitioned()
Identifies this column as a primary key column that is also part of a partition key.
|
ColumnSpecification |
partitioned(boolean partitioned)
Toggles the identification of this column as a primary key column that also is or is part of a partition key.
|
String |
toCql() |
StringBuilder |
toCql(StringBuilder cql) |
String |
toString() |
ColumnSpecification |
type(com.datastax.driver.core.DataType type)
Sets the column's type.
|
public static final Ordering DEFAULT_ORDERING
Ordering.ASCENDING
.public static ColumnSpecification name(String name)
ColumnSpecification
for the given name
.name
- must not be null or empty.ColumnSpecification
for name
.public static ColumnSpecification name(CqlIdentifier name)
ColumnSpecification
for the given name
.name
- must not be null.ColumnSpecification
for name
.public ColumnSpecification type(com.datastax.driver.core.DataType type)
public ColumnSpecification partitioned()
keyType
to PrimaryKeyType.PARTITIONED
and its ordering
to null.public ColumnSpecification partitioned(boolean partitioned)
ordering
to null and, if the given boolean is true
, then sets the column's
keyType
to PrimaryKeyType.PARTITIONED
, else sets it to null.public ColumnSpecification clustered()
keyType
to
PrimaryKeyType.CLUSTERED
and its ordering
to DEFAULT_ORDERING
.public ColumnSpecification clustered(Ordering order)
keyType
to
PrimaryKeyType.CLUSTERED
and its ordering
to the given Ordering
.public ColumnSpecification clustered(Ordering order, boolean primary)
true
, then
sets the column's keyType
to PrimaryKeyType.PARTITIONED
and ordering
to the given
Ordering
, else sets both keyType
and ordering
to null.public ColumnSpecification keyType(PrimaryKeyType keyType)
keyType
.public ColumnSpecification ordering(Ordering ordering)
ordering
.public CqlIdentifier getName()
@Nullable public com.datastax.driver.core.DataType getType()
@Nullable public PrimaryKeyType getKeyType()
public String toCql()
public StringBuilder toCql(StringBuilder cql)
Copyright © 2011–2018 Pivotal Software, Inc.. All rights reserved.