org.springframework.data.gemfire.config.annotation.EnableIndexing Maven / Gradle / Ivy
/*
* Copyright 2016-2020 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.gemfire.config.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.apache.geode.cache.lucene.LuceneIndex;
import org.apache.geode.cache.query.Index;
import org.springframework.context.annotation.Configuration;
/**
* The {@link EnableIndexing} annotation marks a Spring {@link Configuration @Configuration} annotated application class
* to enable the creation of Pivotal GemFire/Apache Geode {@link Index Indexes} and {@link LuceneIndex LuceneIndexes} based on
* application persistent entity field/property annotations, such as the {@link @Id}, {@link @Indexed}
* and {@link @LuceneIndex} annotations.
*
* @author John Blum
* @see org.apache.geode.cache.lucene.LuceneIndex
* @see org.apache.geode.cache.query.Index
* @see org.springframework.data.gemfire.IndexFactoryBean
* @see org.springframework.data.gemfire.config.annotation.IndexConfiguration
* @see org.springframework.data.gemfire.config.annotation.IndexConfigurer
* @see org.springframework.data.gemfire.search.lucene.LuceneIndexFactoryBean
* @since 1.9.0
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@SuppressWarnings({ "unused" })
public @interface EnableIndexing {
/**
* Determines whether all Pivotal GemFire/Apache Geode {@link Index Indexes} will be defined before created.
* If set to {@literal true}, then all {@link Index Indexes} are defined first and the created
* in a single, bulk operation, thereby improving {@link Index} creation process efficiency.
*
* Only applies to OQL-based {@link Index Indexes}. {@link LuceneIndex LuceneIndexes} are managed differently
* by Pivotal GemFire/Apache Geode.
*
* Defaults to {@literal false}.
*/
boolean define() default false;
}