com.arangodb.springframework.annotation.HashIndex Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arangodb-spring-data Show documentation

ArangoDB Spring Data

There is a newer version: 4.5.0

/*
 * DISCLAIMER
 *
 * Copyright 2017 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.springframework.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author Mark Vollmary
 *
 */
@Repeatable(HashIndexes.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
public @interface HashIndex {

	/**
	 * @return A list of attribute paths
	 */
	String[] fields();

	/**
	 * @return if true, then create a unique index
	 */
	boolean unique() default false;

	/**
	 * @return if true, then create a sparse index
	 */
	boolean sparse() default false;

	/**
	 * @return if false, the deduplication of array values is turned off.
	 */
	boolean deduplicate() default true;

}