Skip to content

Commit eb46251

Browse files
krasaevrashtao
krasaev
and
rashtao
authored
add ttl index annotation support (#215)
* add ttl index annotation support * TtlIndexed tests * TtlIndex Co-authored-by: Michele Rastelli <rashtao@gmail.com>
1 parent e4540da commit eb46251

File tree

10 files changed

+288
-64
lines changed

10 files changed

+288
-64
lines changed

‎src/main/java/com/arangodb/springframework/annotation/TtlIndex.java‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
/*
2+
* DISCLAIMER
3+
*
4+
* Copyright 2017 ArangoDB GmbH, Cologne, Germany
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*
18+
* Copyright holder is ArangoDB GmbH, Cologne, Germany
19+
*/
20+
21+
package com.arangodb.springframework.annotation;
22+
23+
import java.lang.annotation.ElementType;
24+
import java.lang.annotation.Retention;
25+
import java.lang.annotation.RetentionPolicy;
26+
import java.lang.annotation.Target;
27+
28+
/**
29+
* Annotation to define given field to be indexed using ArangoDB's TTL index.
30+
*
31+
* @author Michele Rastelli
32+
*/
33+
@Retention(RetentionPolicy.RUNTIME)
34+
@Target({ElementType.TYPE})
35+
public @interface TtlIndex {
36+
37+
/**
38+
* attribute path
39+
*/
40+
String field();
41+
42+
/**
43+
* The time interval (in seconds) from the point in time of the value of the field specified in {@link this#field()}
44+
* after which the documents count as expired. Default is 0, which means that the documents expire as soon as the
45+
* server time passes the point in time stored in the document attribute.
46+
*/
47+
int expireAfter() default 0;
48+
49+
}

‎src/main/java/com/arangodb/springframework/annotation/TtlIndexed.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
package com.arangodb.springframework.annotation;
2+
3+
import java.lang.annotation.ElementType;
4+
import java.lang.annotation.Retention;
5+
import java.lang.annotation.RetentionPolicy;
6+
import java.lang.annotation.Target;
7+
8+
/**
9+
* Annotation to mark a field to be indexed using ArangoDB's Ttl index.
10+
*
11+
* @author Dmitry Krasaev
12+
*/
13+
@Retention(RetentionPolicy.RUNTIME)
14+
@Target(ElementType.FIELD)
15+
public @interface TtlIndexed {
16+
17+
/**
18+
* The time interval (in seconds) from the point in time of the value of the annotated field after which the
19+
* documents count as expired. Default is 0, which means that the documents expire as soon as the server time passes
20+
* the point in time stored in the document attribute.
21+
*/
22+
int expireAfter() default 0;
23+
24+
}

‎src/main/java/com/arangodb/springframework/core/CollectionOperations.java‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
import com.arangodb.model.HashIndexOptions;
3333
import com.arangodb.model.PersistentIndexOptions;
3434
import com.arangodb.model.SkiplistIndexOptions;
35+
import com.arangodb.model.TtlIndexOptions;
3536

3637
/**
3738
* Interface that specifies a basic set of ArangoDB operations on collection
@@ -148,6 +149,18 @@ IndexEntity ensurePersistentIndex(Iterable<String> fields, PersistentIndexOption
148149
*/
149150
IndexEntity ensureFulltextIndex(Iterable<String> fields, FulltextIndexOptions options) throws DataAccessException;
150151

152+
/**
153+
* Creates a ttl index for the collection, if it does not already exist.
154+
*
155+
* @param fields
156+
* A list of attribute paths
157+
* @param options
158+
* Additional options, can be null
159+
* @return information about the index
160+
* @throws DataAccessException
161+
*/
162+
IndexEntity ensureTtlIndex(Iterable<String> fields, TtlIndexOptions options) throws DataAccessException;
163+
151164
/**
152165
* Deletes the index with the given {@code id} from the collection.
153166
*

‎src/main/java/com/arangodb/springframework/core/mapping/ArangoPersistentEntity.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import java.util.Collection;
2424
import java.util.Optional;
2525

26+
import com.arangodb.springframework.annotation.TtlIndex;
2627
import org.springframework.context.ApplicationContextAware;
2728
import org.springframework.data.mapping.IdentifierAccessor;
2829
import org.springframework.data.mapping.PersistentEntity;
@@ -60,6 +61,8 @@ public interface ArangoPersistentEntity<T>
6061

6162
Collection<FulltextIndex> getFulltextIndexes();
6263

64+
Optional<TtlIndex> getTtlIndex();
65+
6366
Collection<ArangoPersistentProperty> getHashIndexedProperties();
6467

6568
Collection<ArangoPersistentProperty> getSkiplistIndexedProperties();
@@ -70,6 +73,8 @@ public interface ArangoPersistentEntity<T>
7073

7174
Collection<ArangoPersistentProperty> getFulltextIndexedProperties();
7275

76+
Optional<ArangoPersistentProperty> getTtlIndexedProperty();
77+
7378
IdentifierAccessor getArangoIdAccessor(Object bean);
7479

7580
}

‎src/main/java/com/arangodb/springframework/core/mapping/ArangoPersistentProperty.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
import com.arangodb.springframework.annotation.Relations;
3434
import com.arangodb.springframework.annotation.SkiplistIndexed;
3535
import com.arangodb.springframework.annotation.To;
36+
import com.arangodb.springframework.annotation.TtlIndexed;
3637

3738
/**
3839
* @author Mark Vollmary
@@ -64,4 +65,5 @@ public interface ArangoPersistentProperty extends PersistentProperty<ArangoPersi
6465

6566
Optional<FulltextIndexed> getFulltextIndexed();
6667

68+
Optional<TtlIndexed> getTtlIndexed();
6769
}

‎src/main/java/com/arangodb/springframework/core/mapping/DefaultArangoPersistentEntity.java‎

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,28 @@
2020

2121
package com.arangodb.springframework.core.mapping;
2222

23-
import java.lang.annotation.Annotation;
24-
import java.util.ArrayList;
25-
import java.util.Arrays;
26-
import java.util.Collection;
27-
import java.util.HashMap;
28-
import java.util.List;
29-
import java.util.Map;
30-
import java.util.Optional;
31-
import java.util.Set;
32-
import java.util.stream.Collectors;
33-
23+
import com.arangodb.entity.CollectionType;
24+
import com.arangodb.model.CollectionCreateOptions;
25+
import com.arangodb.springframework.annotation.Document;
26+
import com.arangodb.springframework.annotation.Edge;
27+
import com.arangodb.springframework.annotation.FulltextIndex;
28+
import com.arangodb.springframework.annotation.FulltextIndexes;
29+
import com.arangodb.springframework.annotation.GeoIndex;
30+
import com.arangodb.springframework.annotation.GeoIndexes;
31+
import com.arangodb.springframework.annotation.HashIndex;
32+
import com.arangodb.springframework.annotation.HashIndexes;
33+
import com.arangodb.springframework.annotation.PersistentIndex;
34+
import com.arangodb.springframework.annotation.PersistentIndexes;
35+
import com.arangodb.springframework.annotation.SkiplistIndex;
36+
import com.arangodb.springframework.annotation.SkiplistIndexes;
37+
import com.arangodb.springframework.annotation.TtlIndex;
3438
import org.springframework.beans.BeansException;
3539
import org.springframework.context.ApplicationContext;
3640
import org.springframework.context.expression.BeanFactoryAccessor;
3741
import org.springframework.context.expression.BeanFactoryResolver;
3842
import org.springframework.core.annotation.AnnotatedElementUtils;
3943
import org.springframework.data.mapping.IdentifierAccessor;
44+
import org.springframework.data.mapping.MappingException;
4045
import org.springframework.data.mapping.TargetAwareIdentifierAccessor;
4146
import org.springframework.data.mapping.model.BasicPersistentEntity;
4247
import org.springframework.data.util.TypeInformation;
@@ -47,20 +52,16 @@
4752
import org.springframework.lang.Nullable;
4853
import org.springframework.util.StringUtils;
4954

50-
import com.arangodb.entity.CollectionType;
51-
import com.arangodb.model.CollectionCreateOptions;
52-
import com.arangodb.springframework.annotation.Document;
53-
import com.arangodb.springframework.annotation.Edge;
54-
import com.arangodb.springframework.annotation.FulltextIndex;
55-
import com.arangodb.springframework.annotation.FulltextIndexes;
56-
import com.arangodb.springframework.annotation.GeoIndex;
57-
import com.arangodb.springframework.annotation.GeoIndexes;
58-
import com.arangodb.springframework.annotation.HashIndex;
59-
import com.arangodb.springframework.annotation.HashIndexes;
60-
import com.arangodb.springframework.annotation.PersistentIndex;
61-
import com.arangodb.springframework.annotation.PersistentIndexes;
62-
import com.arangodb.springframework.annotation.SkiplistIndex;
63-
import com.arangodb.springframework.annotation.SkiplistIndexes;
55+
import java.lang.annotation.Annotation;
56+
import java.util.ArrayList;
57+
import java.util.Arrays;
58+
import java.util.Collection;
59+
import java.util.HashMap;
60+
import java.util.List;
61+
import java.util.Map;
62+
import java.util.Optional;
63+
import java.util.Set;
64+
import java.util.stream.Collectors;
6465

6566
/**
6667
* @author Mark Vollmary
@@ -78,6 +79,7 @@ public class DefaultArangoPersistentEntity<T> extends BasicPersistentEntity<T, A
7879

7980
private ArangoPersistentProperty arangoIdProperty;
8081
private ArangoPersistentProperty revProperty;
82+
private ArangoPersistentProperty ttlIndexedProperty;
8183
private final Collection<ArangoPersistentProperty> hashIndexedProperties;
8284
private final Collection<ArangoPersistentProperty> skiplistIndexedProperties;
8385
private final Collection<ArangoPersistentProperty> persistentIndexedProperties;
@@ -187,11 +189,23 @@ public void setApplicationContext(final ApplicationContext applicationContext) t
187189
public void addPersistentProperty(final ArangoPersistentProperty property) {
188190
super.addPersistentProperty(property);
189191
if (property.isArangoIdProperty()) {
192+
if (arangoIdProperty != null) {
193+
throw new MappingException("Found multiple id indexed properties!");
194+
}
190195
arangoIdProperty = property;
191196
}
192197
if (property.isRevProperty()) {
198+
if (revProperty != null) {
199+
throw new MappingException("Found multiple rev indexed properties!");
200+
}
193201
revProperty = property;
194202
}
203+
if (property.getTtlIndexed().isPresent()) {
204+
if (ttlIndexedProperty != null) {
205+
throw new MappingException("Found multiple ttl indexed properties!");
206+
}
207+
ttlIndexedProperty = property;
208+
}
195209
property.getHashIndexed().ifPresent(i -> hashIndexedProperties.add(property));
196210
property.getSkiplistIndexed().ifPresent(i -> skiplistIndexedProperties.add(property));
197211
property.getPersistentIndexed().ifPresent(i -> persistentIndexedProperties.add(property));
@@ -252,6 +266,15 @@ public Collection<FulltextIndex> getFulltextIndexes() {
252266
return indexes;
253267
}
254268

269+
@Override
270+
public Optional<TtlIndex> getTtlIndex() {
271+
return getIndex(TtlIndex.class);
272+
}
273+
274+
private <A extends Annotation> Optional<A> getIndex(final Class<A> annotation) {
275+
return Optional.ofNullable(AnnotatedElementUtils.findMergedAnnotation(getType(), annotation));
276+
}
277+
255278
public <A extends Annotation> Collection<A> getIndexes(final Class<A> annotation) {
256279
final List<A> indexes = findAnnotations(annotation).stream().filter(a -> annotation.isInstance(a))
257280
.map(a -> annotation.cast(a)).collect(Collectors.toList());
@@ -283,6 +306,11 @@ public Collection<ArangoPersistentProperty> getFulltextIndexedProperties() {
283306
return fulltextIndexedProperties;
284307
}
285308

309+
@Override
310+
public Optional<ArangoPersistentProperty> getTtlIndexedProperty() {
311+
return Optional.ofNullable(ttlIndexedProperty);
312+
}
313+
286314
@SuppressWarnings("unchecked")
287315
public <A extends Annotation> Set<A> findAnnotations(final Class<A> annotationType) {
288316
return (Set<A>) repeatableAnnotationCache.computeIfAbsent(annotationType,

‎src/main/java/com/arangodb/springframework/core/mapping/DefaultArangoPersistentProperty.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
import com.arangodb.springframework.annotation.Rev;
4444
import com.arangodb.springframework.annotation.SkiplistIndexed;
4545
import com.arangodb.springframework.annotation.To;
46+
import com.arangodb.springframework.annotation.TtlIndexed;
4647

4748
/**
4849
* @author Mark Vollmary
@@ -145,4 +146,9 @@ public Optional<FulltextIndexed> getFulltextIndexed() {
145146
return Optional.ofNullable(findAnnotation(FulltextIndexed.class));
146147
}
147148

149+
@Override
150+
public Optional<TtlIndexed> getTtlIndexed() {
151+
return Optional.ofNullable(findAnnotation(TtlIndexed.class));
152+
}
153+
148154
}

0 commit comments

Comments
 (0)