org.springframework.data.cassandra.core.cql.keyspace.CreateIndexSpecification Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation
Show all versions of spring-data-cassandra Show documentation
Cassandra support for Spring Data
/*
* Copyright 2013-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.cassandra.core.cql.keyspace;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import com.datastax.oss.driver.api.core.CqlIdentifier;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
/**
* Object to configure a {@code CREATE INDEX} specification.
*
* @author Matthew T. Adams
* @author David Webb
* @author Mark Paluch
*/
public class CreateIndexSpecification extends IndexNameSpecification
implements IndexDescriptor {
private @Nullable CqlIdentifier tableName;
private @Nullable CqlIdentifier columnName;
private boolean ifNotExists = false;
private ColumnFunction columnFunction = ColumnFunction.NONE;
private @Nullable String using;
private boolean custom = false;
private final Map options = new LinkedHashMap<>();
private CreateIndexSpecification() {}
private CreateIndexSpecification(CqlIdentifier name) {
super(name);
}
/**
* Entry point into the {@link CreateIndexSpecification}'s fluent API to create a index. Convenient if imported
* statically.
*/
public static CreateIndexSpecification createIndex() {
return new CreateIndexSpecification();
}
/**
* Entry point into the {@link CreateIndexSpecification}'s fluent API given {@code indexName} to create a index.
* Convenient if imported statically.
*
* @param indexName must not be {@literal null} or empty.
* @return a new {@link CreateIndexSpecification}.
*/
public static CreateIndexSpecification createIndex(String indexName) {
return createIndex(CqlIdentifier.fromCql(indexName));
}
/**
* Entry point into the {@link CreateIndexSpecification}'s fluent API given {@code indexName} to create a index.
* Convenient if imported statically.
*
* @param indexName must not be {@literal null}.
* @return a new {@link CreateIndexSpecification}.
*/
public static CreateIndexSpecification createIndex(CqlIdentifier indexName) {
return new CreateIndexSpecification(indexName);
}
/**
* Sets the table name.
*
* @param tableName must not be {@literal null} or empty.
* @return this
*/
public CreateIndexSpecification tableName(String tableName) {
return tableName(CqlIdentifier.fromCql(tableName));
}
/**
* Sets the table name.
*
* @param tableName must not be {@literal null}.
* @return this
*/
public CreateIndexSpecification tableName(CqlIdentifier tableName) {
Assert.notNull(tableName, "CqlIdentifier must not be null");
this.tableName = tableName;
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.keyspace.IndexDescriptor#getTableName()
*/
@Override
public CqlIdentifier getTableName() {
return this.tableName;
}
/**
* Sets the column name.
*
* @param columnName must not be {@literal null} or empty.
* @return this
*/
public CreateIndexSpecification columnName(String columnName) {
return columnName(CqlIdentifier.fromCql(columnName));
}
/**
* Sets the column name.
*
* @param columnName must not be {@literal null}.
* @return this
*/
public CreateIndexSpecification columnName(CqlIdentifier columnName) {
Assert.notNull(columnName, "CqlIdentifier must not be null");
this.columnName = columnName;
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.keyspace.IndexDescriptor#getColumnName()
*/
@Override
public CqlIdentifier getColumnName() {
return this.columnName;
}
/**
* Causes the inclusion of an {@code IF NOT EXISTS} clause.
*
* @return this
*/
public CreateIndexSpecification ifNotExists() {
return ifNotExists(true);
}
/**
* Toggles the inclusion of an {@code IF NOT EXISTS} clause.
*
* @return this
*/
public CreateIndexSpecification ifNotExists(boolean ifNotExists) {
this.ifNotExists = ifNotExists;
return this;
}
public boolean getIfNotExists() {
return this.ifNotExists;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.keyspace.IndexDescriptor#isCustom()
*/
@Override
public boolean isCustom() {
return this.custom;
}
public CreateIndexSpecification using(String className) {
if (StringUtils.hasText(className)) {
this.using = className;
this.custom = true;
} else {
this.using = null;
this.custom = false;
}
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.keyspace.IndexDescriptor#getUsing()
*/
@Override
@Nullable
public String getUsing() {
return this.using;
}
/**
* Causes the inclusion of an {@code KEYS} clause.
*
* @return this
* @since 2.0
*/
public CreateIndexSpecification keys() {
return columnFunction(ColumnFunction.KEYS);
}
/**
* Causes the inclusion of an {@code VALUES} clause.
*
* @return this
* @since 2.0
*/
public CreateIndexSpecification values() {
return columnFunction(ColumnFunction.VALUES);
}
/**
* Causes the inclusion of an {@code ENTRIES} clause.
*
* @return this
* @since 2.0
*/
public CreateIndexSpecification entries() {
return columnFunction(ColumnFunction.ENTRIES);
}
/**
* Causes the inclusion of an {@code FULL} clause.
*
* @return this
* @since 2.0
*/
public CreateIndexSpecification full() {
return columnFunction(ColumnFunction.FULL);
}
/**
* Set a {@link ColumnFunction} such as {@code KEYS(…)}, {@code ENTRIES(…)}.
*
* @param columnFunction column function to apply, must not be {@literal null}.
* @return this
* @since 2.0
*/
public CreateIndexSpecification columnFunction(ColumnFunction columnFunction) {
Assert.notNull(columnFunction, "ColumnFunction must not be null");
this.columnFunction = columnFunction;
return this;
}
public ColumnFunction getColumnFunction() {
return this.columnFunction;
}
/**
* Configure a Index-creation options using key-value pairs.
*
* @param name option name.
* @param value option value.
* @return this
* @since 2.0
*/
public CreateIndexSpecification withOption(String name, String value) {
this.options.put(name, value);
return this;
}
/**
* @return index options map.
*/
public Map getOptions() {
return Collections.unmodifiableMap(this.options);
}
/**
* Column functions to specify indexing behavior.
*
* @since 2.0
*/
public enum ColumnFunction {
/**
* Use the plain column value for indexing.
*/
NONE,
/**
* Index keys for {@link Map} typed columns.
*/
KEYS,
/**
* Index values for {@link Map} typed columns.
*/
VALUES,
/**
* Index keys and values (entry-level indexing) for {@link Map} typed columns.
*/
ENTRIES,
/**
* Index the entire {@link Collection}/{@link Map} as-is to match on whole collections/maps as predicate.
*/
FULL
}
}