8000 renamed computed values annotations · arangodb/docs-hugo@1b7c4e3 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1b7c4e3

Browse files
rashtaorashtao
committed
renamed computed values annotations
1 parent 5ea26d3 commit 1b7c4e3

File tree

6 files changed

+111
-111
lines changed

6 files changed

+111
-111
lines changed

‎site/content/3.10/develop/integrations/spring-data-arangodb/reference-version-4/mapping/_index.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -138,35 +138,35 @@ exceptions when reading the entities from the DB.
138138

139139
### Annotation overview
140140

141-
| annotation | level | description |
142-
|-------------------------| ------------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
143-
| @Document | class | marks this class as a candidate for mapping |
144-
| @Edge | class | marks this class as a candidate for mapping |
145-
| @Id | field | stores the field as the system field \_key |
146-
| @ArangoId | field | stores the field as the system field \_id |
147-
| @Rev | field | stores the field as the system field \_rev |
148-
| @Field("alt-name") | field | stores the field with an alternative name |
149-
| @Ref | field | stores the \_id of the referenced document and not the nested document |
150-
| @From | field | stores the \_id of the referenced document as the system field \_from |
151-
| @To | field | stores the \_id of the referenced document as the system field \_to |
152-
| @Relations | field | vertices which are connected over edges |
153-
| @Transient | field, method, annotation | marks a field to be transient for the mapping framework, thus the property is not persisted and not further inspected by the mapping framework |
154-
| @PersistenceConstructor | constructor | marks a given constructor - even a package protected one - to use when instantiating the object from the database |
155-
| @TypeAlias("alias") | class | set a type alias for the class when persisted to the DB |
156-
| @ComputedValueEntry | class | describes a computed value data definition |
157-
| @ComputedValueField | field | marks the field for the mapping framework so that the property is updated with the value coming from the server and optionally describes a computed value data definition |
158-
| @PersistentIndex | class | describes a persistent index |
159-
| @PersistentIndexed | field | describes how to index the field |
160-
| @GeoIndex | class | describes a geo index |
161-
| @GeoIndexed | field | describes how to index the field |
162-
| @FulltextIndex | class | describes a fulltext index |
163-
| @FulltextIndexed | field | describes how to index the field |
164-
| @TtlIndex | class | describes a TTL index |
165-
| @TtlIndexed | field | describes how to index the field |
166-
| @CreatedBy | field | Declares a field as the one representing the principal that created the entity containing the field. |
167-
| @CreatedDate | field | Declares a field as the one representing the date the entity containing the field was created. |
168-
| @LastModifiedBy | field | Declares a field as the one representing the principal that recently modified the entity containing the field. |
169-
| @LastModifiedDate | field | Declares a field as the one representing the date the entity containing the field was recently modified. |
141+
| annotation | level | description |
142+
|--------------------------------| ------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
143+
| @Document | class | marks this class as a candidate for mapping |
144+
| @Edge | class | marks this class as a candidate for mapping |
145+
| @Id | field | stores the field as the system field \_key |
146+
| @ArangoId | field | stores the field as the system field \_id |
147+
| @Rev | field | stores the field as the system field \_rev |
148+
| @Field("alt-name") | field | stores the field with an alternative name |
149+
| @Ref | field | stores the \_id of the referenced document and not the nested document |
150+
| @From | field | stores the \_id of the referenced document as the system field \_from |
151+
| @To | field | stores the \_id of the referenced document as the system field \_to |
152+
| @Relations | field | vertices which are connected over edges |
153+
| @Transient | field, method, annotation | marks a field to be transient for the mapping framework, thus the property is not persisted and not further inspected by the mapping framework |
154+
| @PersistenceConstructor | constructor | marks a given constructor - even a package protected one - to use when instantiating the object from the database |
155+
| @TypeAlias("alias") | class | set a type alias for the class when persisted to the DB |
156+
| @ArangoComputedValueDefinition | class | describes a computed value data definition |
157+
| @ArangoComputedValue | field | marks the field for the mapping framework so that the property is updated with the value coming from the server and optionally describes a computed value data definition |
158+
| @PersistentIndex | class | describes a persistent index |
159+
| @PersistentIndexed | field | describes how to index the field |
160+
| @GeoIndex | class | describes a geo index |
161+
| @GeoIndexed | field | describes how to index the field |
162+
| @FulltextIndex | class | describes a fulltext index |
163+
| @FulltextIndexed | field | describes how to index the field |
164+
| @TtlIndex | class | describes a TTL index |
165+
| @TtlIndexed | field | describes how to index the field |
166+
| @CreatedBy | field | Declares a field as the one representing the principal that created the entity containing the field. |
167+
| @CreatedDate | field | Declares a field as the one representing the date the entity containing the field was created. |
168+
| @LastModifiedBy | field | Declares a field as the one representing the principal that recently modified the entity containing the field. |
169+
| @LastModifiedDate | field | Declares a field as the one representing the date the entity containing the field was recently modified. |
170170

171171
## Invoking conversion manually
172172

‎site/content/3.10/develop/integrations/spring-data-arangodb/reference-version-4/mapping/computed-values.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Spring Data ArangoDB provides annotations to allow mapping computed values to
99
entity properties and to include computed values data definitions during
1010
collection creation.
1111

12-
For reference, see the [indexing](../../../../../concepts/data-structure/documents/computed-values.md)
12+
For reference, see the [computed values](../../../../../concepts/data-structure/documents/computed-values.md)
1313
documentation.
1414

1515
## Mapping
1616

1717
Computed values can be mapped to entity properties by annotating the related
18-
fields with `@ComputedValueField`.
18+
fields with `@ArangoComputedValue`.
1919

2020
If the property is mutable, then the field is automatically updated in place
2121
with the value coming from the server in the following methods:
@@ -28,24 +28,24 @@ with the value coming from the server in the following methods:
2828

2929
Computed values data definitions can be specified through parameters of the
3030
following annotations:
31-
- `@ComputedValueField` on fields
32-
- `@ComputedValueEntry` on classes (optionally within `@ComputedValues`)
31+
- `@ArangoComputedValue` on fields
32+
- `@ArangoComputedValueDefinition` on classes (optionally within `@ArangoComputedValueDefinitions`)
3333

3434
**Example**
3535

3636
```java
3737
@Document
38-
@ComputedValueEntry(
38+
@ArangoComputedValueDefinition(
3939
name = "username",
4040
expression = "RETURN \"unknown\"",
4141
computeOn = ComputedValue.ComputeOn.insert
4242
)
4343
class MyEntity {
4444

45-
@ComputedValueField
45+
@ArangoComputedValue
4646
String username;
4747

48-
@ComputedValueField("RETURN 0")
48+
@ArangoComputedValue("RETURN 0")
4949
int age;
5050

5151
// ...
@@ -54,5 +54,5 @@ class MyEntity {
5454
```
5555

5656
On database collection creation, the computed values metadata is included.
57-
Note that the data definitions is not updated in case the database collection
57+
Note that the data definitions are not updated in case the database collection
5858
already exists.

0 commit comments

Comments
 (0)
0