From aed32382eec2ff4de650bb42f3ad50aa8a620d17 Mon Sep 17 00:00:00 2001 From: agrgr Date: Tue, 25 Jul 2023 18:05:17 +0300 Subject: [PATCH] updating the order of documentation chapters, minor fixes --- src/main/asciidoc/index.adoc | 11 +++++------ .../{mapping.adoc => aerospike-object-mapping.adoc} | 8 ++++---- .../asciidoc/reference/aerospike-repositories.adoc | 2 +- 3 files changed, 10 insertions(+), 11 deletions(-) rename src/main/asciidoc/reference/{mapping.adoc => aerospike-object-mapping.adoc} (97%) diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index b15081a1c..8bbd11cb2 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -27,16 +27,15 @@ include::reference/introduction.adoc[] include::reference/aerospike.adoc[] include::reference/getting-started.adoc[] include::spring-data-commons-docs/repositories.adoc[] +include::reference/aerospike-repositories.adoc[] +include::reference/aerospike-reactive-repositories.adoc[] include::spring-data-commons-docs/repository-projections.adoc[] +include::reference/projections.adoc[] include::spring-data-commons-docs/query-by-example.adoc[] -include::reference/mapping.adoc[] -include::reference/mapping.adoc[] +include::reference/query-methods.adoc[] include::spring-data-commons-docs/object-mapping.adoc[] -include::reference/aerospike-repositories.adoc[] -include::reference/aerospike-reactive-repositories.adoc[] +include::reference/aerospike-object-mapping.adoc[] include::reference/template.adoc[] -include::reference/query-methods.adoc[] -include::reference/projections.adoc[] include::reference/secondary-indexes.adoc[] include::reference/caching.adoc[] include::spring-data-commons-docs/dependencies.adoc[] diff --git a/src/main/asciidoc/reference/mapping.adoc b/src/main/asciidoc/reference/aerospike-object-mapping.adoc similarity index 97% rename from src/main/asciidoc/reference/mapping.adoc rename to src/main/asciidoc/reference/aerospike-object-mapping.adoc index cdc4303a8..20c9d5bfb 100644 --- a/src/main/asciidoc/reference/mapping.adoc +++ b/src/main/asciidoc/reference/aerospike-object-mapping.adoc @@ -1,5 +1,5 @@ [[mapping-chapter]] -= Mapping += Aerospike Object Mapping Rich mapping support is provided by the `AerospikeMappingConverter`. `AerospikeMappingConverter` has a rich metadata model that provides a full feature set of functionality to map domain objects to Aerospike clusters and objects.The mapping metadata model is populated using annotations on your domain objects. However, the infrastructure is not limited to using annotations as the only source of metadata information. The `AerospikeMappingConverter` also allows you to map objects without providing any additional metadata, by following a set of conventions. @@ -9,13 +9,13 @@ For more details refer to SpringData documentation: <>. [[mapping-conventions]] -== Convention based Mapping +== Convention Based Mapping `AerospikeMappingConverter` has a few conventions for mapping objects to documents when no additional mapping metadata is provided. The conventions are: [[mapping-conventions-id-field]] -=== How the '_id' field is handled in the mapping layer +=== How the '_id' Field Is Handled in the Mapping Layer AerospikeDB requires that you have an '_id' field for all objects. If you don't provide one the driver will assign a ObjectId with a generated value. The "_id" field can be of any type, other than arrays, so long as it is unique. The driver naturally supports all primitive types and Dates. When using the `AerospikeMappingConverter` there are certain rules that govern how properties from the Java class are mapped to this '_id' field. @@ -63,7 +63,7 @@ Also, to have more control over the conversion process (if needed), you can regi NOTE: AbstractAerospikeConfiguration will create an AerospikeTemplate instance and register with the container under the name 'AerospikeTemplate'. [[mapping-usage-annotations]] -=== Mapping annotation overview +=== Mapping Annotation Overview The MappingAerospikeConverter can use metadata to drive the mapping of objects to documents. An overview of the annotations is provided below diff --git a/src/main/asciidoc/reference/aerospike-repositories.adoc b/src/main/asciidoc/reference/aerospike-repositories.adoc index 29feb3b0d..4b5428fd4 100644 --- a/src/main/asciidoc/reference/aerospike-repositories.adoc +++ b/src/main/asciidoc/reference/aerospike-repositories.adoc @@ -4,7 +4,7 @@ [[aerospike-repo-intro]] == Introduction -This chapter will point out the specialties for repository support for Aerospike. This builds on the https://docs.spring.io/spring-data/data-commons/docs/1.6.1.RELEASE/reference/html/repositories.html[core SpringData repository support], so make sure you've got a sound understanding of the basic concepts explained there. +This chapter will point out the specialties for repository support for Aerospike. This builds on the <>, so make sure you've got a sound understanding of the basic concepts explained there. [[aerospike-repo-usage]] == Usage