com.datastax.dse.driver.api.querybuilder.schema

Interface DseRelationStructure<SelfT extends DseRelationStructure<SelfT>>

All Superinterfaces:

DseRelationOptions<SelfT>, OptionProvider<SelfT>, RelationOptions<SelfT>

All Known Subinterfaces:

CreateDseTable, CreateDseTableWithOptions

public interface DseRelationStructure<SelfT extends DseRelationStructure<SelfT>>
extends DseRelationOptions<SelfT>

Method Summary

Modifier and Type	Method and Description
SelfT	withClusteringOrder(CqlIdentifier columnName, ClusteringOrder order) Adds the provided clustering order.
default SelfT	withClusteringOrder(Map<String,ClusteringOrder> orderings) Shortcut for withClusteringOrderByIds(Map) with the columns specified as case-insensitive names.
default SelfT	withClusteringOrder(String columnName, ClusteringOrder order) Shortcut for withClusteringOrder(CqlIdentifier.fromCql(columnName), order).
SelfT	withClusteringOrderByIds(Map<CqlIdentifier,ClusteringOrder> orderings) Adds the provided CLUSTERING ORDER.

Methods inherited from interface com.datastax.oss.driver.api.querybuilder.schema.RelationOptions

withBloomFilterFpChance, withCaching, withCDC, withComment, withCompaction, withCompression, withCompression, withDcLocalReadRepairChance, withDefaultTimeToLiveSeconds, withDeflateCompression, withDeflateCompression, withGcGraceSeconds, withLZ4Compression, withLZ4Compression, withMaxIndexInterval, withMemtableFlushPeriodInMs, withMinIndexInterval, withNoCompression, withReadRepairChance, withSnappyCompression, withSnappyCompression, withSpeculativeRetry

Methods inherited from interface com.datastax.oss.driver.api.querybuilder.schema.OptionProvider

getOptions, withOption

Method Detail

withClusteringOrderByIds

@NonNull
SelfT withClusteringOrderByIds(@NonNull
                                        Map<CqlIdentifier,ClusteringOrder> orderings)

Adds the provided CLUSTERING ORDER.

They will be appended in the iteration order of the provided map. If an ordering was already defined for a given identifier, it will be removed and the new ordering will appear in its position in the provided map.

withClusteringOrder

@NonNull
default SelfT withClusteringOrder(@NonNull
                                           Map<String,ClusteringOrder> orderings)

Shortcut for withClusteringOrderByIds(Map) with the columns specified as case-insensitive names. They will be wrapped with CqlIdentifier.fromCql(String).

Note that it's possible for two different case-sensitive names to resolve to the same identifier, for example "foo" and "Foo"; if this happens, a runtime exception will be thrown.

withClusteringOrder

@NonNull
SelfT withClusteringOrder(@NonNull
                                   CqlIdentifier columnName,
                                   @NonNull
                                   ClusteringOrder order)

Adds the provided clustering order.

If clustering order was already defined for this identifier, it will be removed and the new clause will be appended at the end of the current clustering order.

withClusteringOrder

@NonNull
default SelfT withClusteringOrder(@NonNull
                                           String columnName,
                                           @NonNull
                                           ClusteringOrder order)

Shortcut for withClusteringOrder(CqlIdentifier.fromCql(columnName), order).