com.arangodb.springframework.annotation.TtlIndex 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.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation to define given field to be indexed using ArangoDB's TTL index.
 *
 * @author Michele Rastelli
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface TtlIndex {

	/**
	 * attribute path
	 */
	String field();

	/**
	 * The time interval (in seconds) from the point in time of the value of the field specified in {@link this#field()}
	 * after which the documents count as expired. Default is 0, which means that the documents expire as soon as the
	 * server time passes the point in time stored in the document attribute.
	 */
	int expireAfter() default 0;

}