com.stratio.cassandra.lucene.builder.index.Index Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-lucene-index-builder Show documentation
Show all versions of cassandra-lucene-index-builder Show documentation
Cassandra Lucene Index builder
/*
* Copyright (C) 2014 Stratio (http://stratio.com)
*
* 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
*
* http://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 com.stratio.cassandra.lucene.builder.index;
import com.stratio.cassandra.lucene.builder.JSONBuilder;
import com.stratio.cassandra.lucene.builder.index.schema.Schema;
import com.stratio.cassandra.lucene.builder.index.schema.analysis.Analyzer;
import com.stratio.cassandra.lucene.builder.index.schema.mapping.Mapper;
/**
* A Lucene index definition.
*
* @author Andres de la Pena {@literal }
*/
public class Index extends JSONBuilder {
private Schema schema;
private String keyspace;
private String table;
private String name;
private String column;
private Number refreshSeconds;
private String directoryPath;
private Integer ramBufferMb;
private Integer maxMergeMb;
private Integer maxCachedMb;
private Integer indexingThreads;
private Integer indexingQueuesSize;
private String excludedDataCenters;
private Partitioner partitioner;
private Boolean sparse;
/**
* Builds a new {@link Index} creation statement for the specified table and column.
*
* @param table the table name
* @param name the index name
*/
public Index(String table, String name) {
this.schema = new Schema();
this.table = table;
this.name = name;
}
/**
* Sets the name of the keyspace.
*
* @param keyspace the keyspace name
* @return this with the specified keyspace name
*/
public Index keyspace(String keyspace) {
this.keyspace = keyspace;
return this;
}
/**
* Sets the name of the indexed column, if any.
*
* @param column the indexed column name
* @return this with the specified indexed column name
*/
public Index column(String column) {
this.column = column;
return this;
}
/**
* Sets the index searcher refresh period.
*
* @param refreshSeconds the number of seconds between refreshes
* @return this with the specified refresh seconds
*/
public Index refreshSeconds(Number refreshSeconds) {
this.refreshSeconds = refreshSeconds;
return this;
}
/**
* Sets the path of the Lucene directory files.
*
* @param directoryPath the path of the Lucene directory files.
* @return this with the specified directory path
*/
public Index directoryPath(String directoryPath) {
this.directoryPath = directoryPath;
return this;
}
/**
* Sets the Lucene's RAM buffer size in MBs.
*
* @param ramBufferMb the RAM buffer size
* @return this with the specified RAM buffer size
*/
public Index ramBufferMb(Integer ramBufferMb) {
this.ramBufferMb = ramBufferMb;
return this;
}
/**
* Sets the Lucene's max merge MBs.
*
* @param maxMergeMb the max merge MBs
* @return this with the specified max merge MBs
*/
public Index maxMergeMb(Integer maxMergeMb) {
this.maxMergeMb = maxMergeMb;
return this;
}
/**
* Sets the Lucene's max cached MBs.
*
* @param maxCachedMb the Lucene's max cached MBs
* @return this with the specified max cached MBs
*/
public Index maxCachedMb(Integer maxCachedMb) {
this.maxCachedMb = maxCachedMb;
return this;
}
/**
* Sets the number of asynchronous indexing threads, where {@code 0} means synchronous indexing.
*
* @param indexingThreads the number of asynchronous indexing threads
* @return this with the specified number of asynchronous indexing threads
*/
public Index indexingThreads(Integer indexingThreads) {
this.indexingThreads = indexingThreads;
return this;
}
/**
* Sets the max number of queued documents per asynchronous indexing thread.
*
* @param indexingQueuesSize the max number of queued documents
* @return this with the specified max number of queued documents
*/
public Index indexingQueuesSize(Integer indexingQueuesSize) {
this.indexingQueuesSize = indexingQueuesSize;
return this;
}
/**
* Sets the list of excluded data centers.
*
* @param excludedDataCenters the excluded data centers
* @return this with the specified excluded data centers
*/
public Index excludedDataCenters(String excludedDataCenters) {
this.excludedDataCenters = excludedDataCenters;
return this;
}
/**
* Sets the name of the default {@link Analyzer}.
*
* @param name the name of the default {@link Analyzer}
* @return this with the specified default analyzer
*/
public Index defaultAnalyzer(String name) {
schema.defaultAnalyzer(name);
return this;
}
/**
* Adds a new {@link Analyzer}.
*
* @param name the name of the {@link Analyzer} to be added
* @param analyzer the {@link Analyzer} to be added
* @return this with the specified analyzer
*/
public Index analyzer(String name, Analyzer analyzer) {
schema.analyzer(name, analyzer);
return this;
}
/**
* Adds a new {@link Mapper}.
*
* @param field the name of the {@link Mapper} to be added
* @param mapper the {@link Mapper} to be added
* @return this with the specified mapper
*/
public Index mapper(String field, Mapper mapper) {
schema.mapper(field, mapper);
return this;
}
/**
* Sets the {@link Schema}.
*
* @param schema the {@link Schema}
* @return this with the specified schema
*/
public Index schema(Schema schema) {
this.schema = schema;
return this;
}
/**
* Sets the {@link Partitioner}.
*
* Index partitioning is useful to speed up some queries to the detriment of others, depending on the implementation.
* It is also useful to overcome the Lucene's hard limit of 2147483519 documents per index.
*
* @param partitioner the {@link Partitioner}
* @return this with the specified partitioner
*/
public Index partitioner(Partitioner partitioner) {
this.partitioner = partitioner;
return this;
}
/**
* Sets if the index is sparse or not
*
* Any insert or update will trigger an index modification by default, even if the statement does not contain any column that could affect the index.
* When sparse is true, the index is updated only if the statement contains at least one column that could affect it.
* It is useful when the index schema contains only a small subset of the row columns and those columns are updated less frequently then the rest of the row.
*
* @param sparse true if the index is sparse, false otherwise
* @return this with the specified sparse flag set
*/
public Index sparse(Boolean sparse) {
this.sparse = sparse;
return this;
}
/** {@inheritDoc} */
@Override
public String build() {
StringBuilder sb = new StringBuilder();
sb.append("CREATE CUSTOM INDEX ");
sb.append(name).append(" ");
String fullTable = keyspace == null ? table : keyspace + "." + table;
sb.append(String.format("ON %s(%s) ", fullTable, column == null ? "" : column));
sb.append("USING 'com.stratio.cassandra.lucene.Index' WITH OPTIONS = {");
option(sb, "refresh_seconds", refreshSeconds);
option(sb, "directory_path", directoryPath);
option(sb, "ram_buffer_mb", ramBufferMb);
option(sb, "max_merge_mb", maxMergeMb);
option(sb, "max_cached_mb", maxCachedMb);
option(sb, "indexing_threads", indexingThreads);
option(sb, "indexing_queues_size", indexingQueuesSize);
option(sb, "excluded_data_centers", excludedDataCenters);
option(sb, "partitioner", partitioner);
option(sb, "sparse", sparse);
sb.append(String.format("'schema':'%s'}", schema));
return sb.toString();
}
private void option(StringBuilder sb, String name, Object value) {
if (value != null) {
sb.append(String.format("'%s':'%s',", name, value));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy