├── .gitignore ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── README.md ├── docker-compose.yml ├── docs └── 01_app_walkthrough.md ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main ├── java │ └── com │ │ └── redis │ │ └── om │ │ └── skeleton │ │ ├── SkeletonApplication.java │ │ ├── controllers │ │ ├── PeopleControllerV1.java │ │ └── PeopleControllerV2.java │ │ ├── models │ │ ├── Address.java │ │ └── Person.java │ │ ├── repositories │ │ └── PeopleRepository.java │ │ └── services │ │ └── PeopleService.java └── resources │ └── application.properties └── test └── java └── com └── redis └── om └── skeleton └── SkeletonApplicationTests.java /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/**/target/ 5 | !**/src/test/**/target/ 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | !**/src/main/**/build/ 30 | !**/src/test/**/build/ 31 | 32 | ### VS Code ### 33 | .vscode/ 34 | 35 | ### Mac Artifacts ### 36 | .DS_Store 37 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/redis-om-spring-skeleton-app/08b0dea86392c29907bbfa118f8352b56b0e5db4/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip 2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 🍀 Redis OM Spring Skeleton App 2 | 3 | Redis OM Spring provides powerful repository and custom object-mapping abstractions built on top of the powerful Spring Data Redis (SDR) framework. This app is a simple started application using Redis OM Spring to map, manipulate and query some simple Spring Data models backed by RedisJSON documents. 4 | 5 | Check out our [workshop video](https://youtu.be/YhQX8pHy3hk) for this project on YouTube. 6 | 7 | ### Overview 8 | 9 | The app provides a simple model `Person`: 10 | 11 | * `id`: An autogenerated `String` using [ULIDs](https://github.com/ulid/spec) 12 | * `firstName`: A `String` representing their first or given name. 13 | * `lastName`: A `String` representing theirlast or surname. 14 | * `age`: An `Integer` representing their age in years. 15 | * `personalStatement`: A `String` representing a text personal statement containing facts or other biographical information. 16 | * `homeLoc`: A `org.springframework.data.geo.Point` representing the geo coordinates. 17 | * `address`: An entity of type `Address` representing the Person's postal address. 18 | * `skills`: A `Set`, representing a collection of Strings representing skills the person has. 19 | 20 | #### Mapping Entities to JSON 21 | 22 | The `Person` model is annotated with `@Document`, this enables the models to be saved as RedisJSON documents. 23 | The individuals fields that will be used to create the entity search index are annotated with `@Indexed` or 24 | `@Searchable` (for full-text search capable text fields). 25 | 26 | ```java 27 | @Document 28 | public class Person { 29 | @Id @Indexed 30 | private String id; 31 | 32 | @Indexed 33 | private String firstName; 34 | 35 | @Indexed 36 | private String lastName; 37 | 38 | @Indexed 39 | private Integer age; 40 | 41 | @Searchable 42 | private String personalStatement; 43 | 44 | @Indexed 45 | private Point homeLoc; 46 | 47 | @Indexed 48 | private Address address; 49 | 50 | @Indexed 51 | private Set skills; 52 | } 53 | ``` 54 | 55 | For example, saving the above object using a repository (see below) you'll get a JSON document under the Redis key `com.redis.om.skeleton.models.Person:01FXD97WTHNYFQEA56YQ27BNQ6`: 56 | 57 | ```json 58 | { 59 | "id": "01FXD97WTHNYFQEA56YQ27BNQ6", 60 | "firstName": "Elizabeth", 61 | "lastName": "Olsen", 62 | "age": 32, 63 | "personalStatement": "You Guys Know I Can Move Things With My Mind, Right?", 64 | "homeLoc": "40.6976701,-74.2598641", 65 | "address": { 66 | "houseNumber": "20", 67 | "street": "W 34th St", 68 | "city": "New York", 69 | "state": "NY", 70 | "postalCode": "10001", 71 | "country": "US" 72 | }, 73 | "skills": [ 74 | "loyalty", 75 | "magic" 76 | ] 77 | } 78 | ``` 79 | 80 | The resulting JSON has a generated value for the `id` field using a [ULIDs](https://github.com/ulid/spec). Note that 81 | the `homeLoc` field is mapped to the lon-lat format expected by Redis, and the set of `skills` is mapped into a JSON array. 82 | 83 | ### The SpringBoot App 84 | 85 | Use the `@EnableRedisDocumentRepositories` annotation to scan for `@Document` annotated Spring models, 86 | Inject repositories beans implementing `RedisDocumentRepository` which you can use for CRUD operations and custom queries (all by declaring Spring Data Query Interfaces): 87 | 88 | ```java 89 | @SpringBootApplication 90 | @EnableRedisDocumentRepositories(basePackages = "com.redis.om.skeleton.*") 91 | public class SkeletonApplication { 92 | } 93 | ``` 94 | 95 | ### 🧰 The Repository 96 | 97 | Redis OM Spring data repository's goal, like other Spring Data repositories, is to significantly reduce the amount of boilerplate code required to implement data access. Simply create a Java interface 98 | that extends `RedisDocumentRepository` that takes the domain class to manage as well as the ID type of the domain class as type arguments. `RedisDocumentRepository` extends Spring Data's `PagingAndSortingRepository`. 99 | 100 | Declare query methods on the interface. You can both, expose CRUD methods or create declarations for complex queries that Redis OM Spring will fullfil at runtime: 101 | 102 | ```java 103 | public interface PeopleRepository extends RedisDocumentRepository { 104 | // Find people by age range 105 | Iterable findByAgeBetween(int minAge, int maxAge); 106 | 107 | // Draws a circular geofilter around a spot and returns all people in that radius 108 | Iterable findByHomeLoc(Point point, Distance distance); 109 | 110 | // Find people by their first and last name 111 | Iterable findByFirstNameAndLastName(String firstName, String lastName); 112 | 113 | // Performs full text search on a person's personal Statement 114 | Iterable searchByPersonalStatement(String text); 115 | 116 | // ... 117 | } 118 | ``` 119 | 120 | The repository proxy has two ways to derive a store-specific query from the method name: 121 | 122 | - By deriving the query from the method name directly. 123 | - By using a manually defined query using the `@Query` or `@Aggregation` annotations. 124 | 125 | ### CRUD Operations 126 | 127 | You can inject a Repository and perform the basic CRUD operations as well as any custom queries you've defined: 128 | 129 | ```java 130 | @Autowired 131 | PeopleRepository repo; 132 | 133 | @PostMapping("new") 134 | Person create(@RequestBody Person newPerson) { 135 | return repo.save(newPerson); 136 | } 137 | ``` 138 | 139 | ### 🚤 Querying with Entity Streams 140 | 141 | Redis OM Spring Entity Streams provides a Java 8 Streams interface to Query Redis JSON documents using RediSearch. Entity Streams allow you to process data in a typesafe declarative way similar to SQL statements. Streams can be used to express a query as a chain of operations. 142 | 143 | Entity Streams in Redis OM Spring provide the same semantics as Java 8 streams. Streams can be made of Redis Mapped entities (`@Document`) or one or more properties of an Entity. Entity Streams progressively build the query until a terminal operation is invoked (such as `collect`). Whenever a Terminal operation is applied to a Stream, the Stream cannot accept additional operations to its pipeline and it also means that the Stream is started. 144 | 145 | Let's start with a simple example, a Spring `@Service` which includes `EntityStream` to query for instances of the mapped class `Person`: 146 | 147 | ```java 148 | package com.redis.om.skeleton.services; 149 | 150 | import java.util.stream.Collectors; 151 | 152 | import org.springframework.beans.factory.annotation.Autowired; 153 | import org.springframework.stereotype.Service; 154 | 155 | import com.redis.om.skeleton.models.Person; 156 | import com.redis.om.skeleton.models.Person$; 157 | import com.redis.om.spring.search.stream.EntityStream; 158 | 159 | @Service 160 | public class PeopleService { 161 | @Autowired 162 | EntityStream entityStream; 163 | 164 | // Find all people 165 | public Iterable findAllPeople(int minAge, int maxAge) { 166 | return entityStream // 167 | .of(Person.class) // 168 | .collect(Collectors.toList()); 169 | } 170 | 171 | } 172 | ``` 173 | 174 | The `EntityStream` is injected into the `PeopleService` using `@Autowired`. We can then get a stream for `Person` objects by using `entityStream.of(Person.class)`. At this point the stream represents the equivalent of a `SELECT * FROM Person` on a relational database. The call to `collect` will then execute the underlying query and return a collection of all `Person` objects in Redis. 175 | 176 | #### 👭 Entity Meta-model 177 | 178 | To produce more elaborate queries, you're provided with a generated meta-model, which is a class with the same name as your model but ending with a dollar sign. In the 179 | example below, our entity model is `Person` therefore we get a meta-model named `Person$`. With the meta-model you have access to the operations related to the 180 | underlying search engine field. For example, in the example we have an `age` property which is an integer. Therefore our metamodel has an `AGE` property which has 181 | numeric operations we can use with the stream's `filter` method such as `between`. 182 | 183 | ```java 184 | // Find people by age range 185 | public Iterable findByAgeBetween(int minAge, int maxAge) { 186 | return entityStream // 187 | .of(Person.class) // 188 | .filter(Person$.AGE.between(minAge, maxAge)) // 189 | .sorted(Person$.AGE, SortOrder.ASC) // 190 | .collect(Collectors.toList()); 191 | } 192 | ``` 193 | 194 | In this example we also make use of the Streams `sorted` method to declare that our stream will be sorted by the `Person$.AGE` in `ASC`ending order. 195 | 196 | ### 💾 Get the Source Code 197 | 198 | Clone the repository from GitHub: 199 | 200 | ```bash 201 | $ git clone https://github.com/redis-developer/redis-om-spring-skeleton-app 202 | $ cd redis-om-spring-skeleton-app 203 | ``` 204 | 205 | ### 🚀 Launch Redis 206 | 207 | #### 🥞Redis Stack on Docker Locally 208 | 209 | Redis OM Spring relies on the power of the [RediSearch][redisearch-url] and [RedisJSON][redis-json-url] modules. 210 | We have provided a docker compose YAML file for you to quickly get started. To launch the docker compose application, on the command line (or via Docker Desktop), clone this repository and run (from the root folder): 211 | 212 | ```bash 213 | docker compose up 214 | ``` 215 | 216 | This launches Redis Stack; Redis Stack Server on port 6379, and Redis Insight 8001. 217 | 218 | #### 🌥️Redis Cloud 219 | 220 | If you're using Redis Enterprise Cloud, you'll need the hostname, port number, and password for your database. Use these to set the `application.properties` configuration like this: 221 | 222 | ```bash 223 | spring.data.redis.host= 224 | spring.data.redis.port= 225 | spring.data.redis.password= 226 | spring.data.redis.username= 227 | ``` 228 | 229 | For example if your Redis Enterprise Cloud database is at port `9139` on host `enterprise.redis.com` and your password is `5uper53cret` then you'd set `REDIS_OM_URL` as follows: 230 | 231 | ```bash 232 | spring.data.redis.host=enterprise.redis.com 233 | spring.data.redis.port=9139 234 | spring.data.redis.password=5uper53cret 235 | spring.data.redis.username=default 236 | ``` 237 | 238 | ## 📝 Prerequisites 239 | 240 | * Java 17 or higher 241 | * Spring Boot 3.0.2 242 | * A [Redis](https://redis.io) database with the [RediSearch](https://redisearch.io) module version TODO or higher installed. We've provided a `docker-compose.yml` with Redis Stack for this. You can also [sign up for a free 30Mb database with Redis Enterprise Cloud](https://redis.com/try-free/) - be sure to check the box to configure a Redis Stack instance, follow [this guide](https://developer.redis.com/create/rediscloud/). 243 | * [curl](https://curl.se/), or [Postman](https://www.postman.com/) - to send HTTP requests to the application. We'll provide examples using curl in this document. 244 | * Optional: [RedisInsight](https://redis.com/redis-enterprise/redis-insight/), a free data visualization and database management tool for Redis. When downloading RedisInsight, be sure to select version 2.x. 245 | 246 | ## 🏃Run the App 247 | 248 | ```bash 249 | ./mvnw spring-boot:run 250 | ``` 251 | 252 | ### 🧭Interact with the API 253 | 254 | You can interact with the API directly with CURL or through the [Swagger interface](http://localhost:8080/swagger-ui/index.html). 255 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.9" 2 | services: 3 | redis: 4 | image: "redis/redis-stack:edge" 5 | ports: 6 | - "6379:6379" 7 | environment: 8 | - "REDIS_ARGS=--appendonly yes" 9 | volumes: 10 | - ./data:/data 11 | deploy: 12 | replicas: 1 13 | restart_policy: 14 | condition: on-failure -------------------------------------------------------------------------------- /docs/01_app_walkthrough.md: -------------------------------------------------------------------------------- 1 | # 🍀 Redis OM Spring Skeleton App 2 | 3 | ## What is this? 4 | 5 | ## Creating the application 6 | 7 | ## Adding Redis OM Spring Dependencies 8 | 9 | ## Enabling Document Repositories 10 | 11 | ## Creating the models 12 | 13 | ## Creating the repositories 14 | 15 | ## Loading some seed data 16 | 17 | ## Exploring the data with RedisInsight 18 | 19 | ## Custom querying with Spring Repositories 20 | 21 | ## Adding a controller 22 | 23 | ## Testing our endpoints with Postman 24 | 25 | ## Using Entity Streams for Querying 26 | 27 | ### Create a service class 28 | 29 | ### Testing Entity Streams -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /usr/local/etc/mavenrc ] ; then 40 | . /usr/local/etc/mavenrc 41 | fi 42 | 43 | if [ -f /etc/mavenrc ] ; then 44 | . /etc/mavenrc 45 | fi 46 | 47 | if [ -f "$HOME/.mavenrc" ] ; then 48 | . "$HOME/.mavenrc" 49 | fi 50 | 51 | fi 52 | 53 | # OS specific support. $var _must_ be set to either true or false. 54 | cygwin=false; 55 | darwin=false; 56 | mingw=false 57 | case "`uname`" in 58 | CYGWIN*) cygwin=true ;; 59 | MINGW*) mingw=true;; 60 | Darwin*) darwin=true 61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 63 | if [ -z "$JAVA_HOME" ]; then 64 | if [ -x "/usr/libexec/java_home" ]; then 65 | export JAVA_HOME="`/usr/libexec/java_home`" 66 | else 67 | export JAVA_HOME="/Library/Java/Home" 68 | fi 69 | fi 70 | ;; 71 | esac 72 | 73 | if [ -z "$JAVA_HOME" ] ; then 74 | if [ -r /etc/gentoo-release ] ; then 75 | JAVA_HOME=`java-config --jre-home` 76 | fi 77 | fi 78 | 79 | if [ -z "$M2_HOME" ] ; then 80 | ## resolve links - $0 may be a link to maven's home 81 | PRG="$0" 82 | 83 | # need this for relative symlinks 84 | while [ -h "$PRG" ] ; do 85 | ls=`ls -ld "$PRG"` 86 | link=`expr "$ls" : '.*-> \(.*\)$'` 87 | if expr "$link" : '/.*' > /dev/null; then 88 | PRG="$link" 89 | else 90 | PRG="`dirname "$PRG"`/$link" 91 | fi 92 | done 93 | 94 | saveddir=`pwd` 95 | 96 | M2_HOME=`dirname "$PRG"`/.. 97 | 98 | # make it fully qualified 99 | M2_HOME=`cd "$M2_HOME" && pwd` 100 | 101 | cd "$saveddir" 102 | # echo Using m2 at $M2_HOME 103 | fi 104 | 105 | # For Cygwin, ensure paths are in UNIX format before anything is touched 106 | if $cygwin ; then 107 | [ -n "$M2_HOME" ] && 108 | M2_HOME=`cygpath --unix "$M2_HOME"` 109 | [ -n "$JAVA_HOME" ] && 110 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 111 | [ -n "$CLASSPATH" ] && 112 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 113 | fi 114 | 115 | # For Mingw, ensure paths are in UNIX format before anything is touched 116 | if $mingw ; then 117 | [ -n "$M2_HOME" ] && 118 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 119 | [ -n "$JAVA_HOME" ] && 120 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 121 | fi 122 | 123 | if [ -z "$JAVA_HOME" ]; then 124 | javaExecutable="`which javac`" 125 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 126 | # readlink(1) is not available as standard on Solaris 10. 127 | readLink=`which readlink` 128 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 129 | if $darwin ; then 130 | javaHome="`dirname \"$javaExecutable\"`" 131 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 132 | else 133 | javaExecutable="`readlink -f \"$javaExecutable\"`" 134 | fi 135 | javaHome="`dirname \"$javaExecutable\"`" 136 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 137 | JAVA_HOME="$javaHome" 138 | export JAVA_HOME 139 | fi 140 | fi 141 | fi 142 | 143 | if [ -z "$JAVACMD" ] ; then 144 | if [ -n "$JAVA_HOME" ] ; then 145 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 146 | # IBM's JDK on AIX uses strange locations for the executables 147 | JAVACMD="$JAVA_HOME/jre/sh/java" 148 | else 149 | JAVACMD="$JAVA_HOME/bin/java" 150 | fi 151 | else 152 | JAVACMD="`\\unset -f command; \\command -v java`" 153 | fi 154 | fi 155 | 156 | if [ ! -x "$JAVACMD" ] ; then 157 | echo "Error: JAVA_HOME is not defined correctly." >&2 158 | echo " We cannot execute $JAVACMD" >&2 159 | exit 1 160 | fi 161 | 162 | if [ -z "$JAVA_HOME" ] ; then 163 | echo "Warning: JAVA_HOME environment variable is not set." 164 | fi 165 | 166 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 167 | 168 | # traverses directory structure from process work directory to filesystem root 169 | # first directory with .mvn subdirectory is considered project base directory 170 | find_maven_basedir() { 171 | 172 | if [ -z "$1" ] 173 | then 174 | echo "Path not specified to find_maven_basedir" 175 | return 1 176 | fi 177 | 178 | basedir="$1" 179 | wdir="$1" 180 | while [ "$wdir" != '/' ] ; do 181 | if [ -d "$wdir"/.mvn ] ; then 182 | basedir=$wdir 183 | break 184 | fi 185 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 186 | if [ -d "${wdir}" ]; then 187 | wdir=`cd "$wdir/.."; pwd` 188 | fi 189 | # end of workaround 190 | done 191 | echo "${basedir}" 192 | } 193 | 194 | # concatenates all lines of a file 195 | concat_lines() { 196 | if [ -f "$1" ]; then 197 | echo "$(tr -s '\n' ' ' < "$1")" 198 | fi 199 | } 200 | 201 | BASE_DIR=`find_maven_basedir "$(pwd)"` 202 | if [ -z "$BASE_DIR" ]; then 203 | exit 1; 204 | fi 205 | 206 | ########################################################################################## 207 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 208 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 209 | ########################################################################################## 210 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 211 | if [ "$MVNW_VERBOSE" = true ]; then 212 | echo "Found .mvn/wrapper/maven-wrapper.jar" 213 | fi 214 | else 215 | if [ "$MVNW_VERBOSE" = true ]; then 216 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 217 | fi 218 | if [ -n "$MVNW_REPOURL" ]; then 219 | jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 220 | else 221 | jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 222 | fi 223 | while IFS="=" read key value; do 224 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 225 | esac 226 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 227 | if [ "$MVNW_VERBOSE" = true ]; then 228 | echo "Downloading from: $jarUrl" 229 | fi 230 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 231 | if $cygwin; then 232 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` 233 | fi 234 | 235 | if command -v wget > /dev/null; then 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Found wget ... using wget" 238 | fi 239 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 240 | wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 241 | else 242 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 243 | fi 244 | elif command -v curl > /dev/null; then 245 | if [ "$MVNW_VERBOSE" = true ]; then 246 | echo "Found curl ... using curl" 247 | fi 248 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 249 | curl -o "$wrapperJarPath" "$jarUrl" -f 250 | else 251 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f 252 | fi 253 | 254 | else 255 | if [ "$MVNW_VERBOSE" = true ]; then 256 | echo "Falling back to using Java to download" 257 | fi 258 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 259 | # For Cygwin, switch paths to Windows format before running javac 260 | if $cygwin; then 261 | javaClass=`cygpath --path --windows "$javaClass"` 262 | fi 263 | if [ -e "$javaClass" ]; then 264 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 265 | if [ "$MVNW_VERBOSE" = true ]; then 266 | echo " - Compiling MavenWrapperDownloader.java ..." 267 | fi 268 | # Compiling the Java class 269 | ("$JAVA_HOME/bin/javac" "$javaClass") 270 | fi 271 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 272 | # Running the downloader 273 | if [ "$MVNW_VERBOSE" = true ]; then 274 | echo " - Running MavenWrapperDownloader.java ..." 275 | fi 276 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 277 | fi 278 | fi 279 | fi 280 | fi 281 | ########################################################################################## 282 | # End of extension 283 | ########################################################################################## 284 | 285 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 286 | if [ "$MVNW_VERBOSE" = true ]; then 287 | echo $MAVEN_PROJECTBASEDIR 288 | fi 289 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 290 | 291 | # For Cygwin, switch paths to Windows format before running java 292 | if $cygwin; then 293 | [ -n "$M2_HOME" ] && 294 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 295 | [ -n "$JAVA_HOME" ] && 296 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 297 | [ -n "$CLASSPATH" ] && 298 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 299 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 300 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 301 | fi 302 | 303 | # Provide a "standardized" way to retrieve the CLI args that will 304 | # work with both Windows and non-Windows executions. 305 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 306 | export MAVEN_CMD_LINE_ARGS 307 | 308 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 309 | 310 | exec "$JAVACMD" \ 311 | $MAVEN_OPTS \ 312 | $MAVEN_DEBUG_OPTS \ 313 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 314 | "-Dmaven.home=${M2_HOME}" \ 315 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 316 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 317 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 50 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 124 | 125 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 127 | ) 128 | 129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 131 | if exist %WRAPPER_JAR% ( 132 | if "%MVNW_VERBOSE%" == "true" ( 133 | echo Found %WRAPPER_JAR% 134 | ) 135 | ) else ( 136 | if not "%MVNW_REPOURL%" == "" ( 137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 138 | ) 139 | if "%MVNW_VERBOSE%" == "true" ( 140 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 141 | echo Downloading from: %DOWNLOAD_URL% 142 | ) 143 | 144 | powershell -Command "&{"^ 145 | "$webclient = new-object System.Net.WebClient;"^ 146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 148 | "}"^ 149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ 150 | "}" 151 | if "%MVNW_VERBOSE%" == "true" ( 152 | echo Finished downloading %WRAPPER_JAR% 153 | ) 154 | ) 155 | @REM End of extension 156 | 157 | @REM Provide a "standardized" way to retrieve the CLI args that will 158 | @REM work with both Windows and non-Windows executions. 159 | set MAVEN_CMD_LINE_ARGS=%* 160 | 161 | %MAVEN_JAVA_EXE% ^ 162 | %JVM_CONFIG_MAVEN_PROPS% ^ 163 | %MAVEN_OPTS% ^ 164 | %MAVEN_DEBUG_OPTS% ^ 165 | -classpath %WRAPPER_JAR% ^ 166 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 167 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 168 | if ERRORLEVEL 1 goto error 169 | goto end 170 | 171 | :error 172 | set ERROR_CODE=1 173 | 174 | :end 175 | @endlocal & set ERROR_CODE=%ERROR_CODE% 176 | 177 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 178 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 179 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 180 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 181 | :skipRcPost 182 | 183 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 184 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 185 | 186 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 187 | 188 | cmd /C exit /B %ERROR_CODE% 189 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | org.springframework.boot 8 | spring-boot-starter-parent 9 | 3.1.2 10 | 11 | 12 | com.redis.om 13 | skeleton 14 | 0.0.1-SNAPSHOT 15 | skeleton 16 | Skeleton App for Redis OM Spring 17 | 18 | 17 19 | 4.4.3 20 | 21 | 22 | 23 | org.springframework.boot 24 | spring-boot-starter-web 25 | 26 | 27 | com.redis.om 28 | redis-om-spring 29 | 0.8.6 30 | 31 | 32 | 33 | org.springframework.boot 34 | spring-boot-devtools 35 | runtime 36 | true 37 | 38 | 39 | org.projectlombok 40 | lombok 41 | true 42 | 43 | 44 | org.springdoc 45 | springdoc-openapi-starter-webmvc-ui 46 | 2.0.2 47 | 48 | 49 | org.springframework.boot 50 | spring-boot-starter-test 51 | test 52 | 53 | 54 | 55 | 56 | 57 | snapshots-repo 58 | https://s01.oss.sonatype.org/content/repositories/snapshots/ 59 | 60 | 61 | 62 | 63 | 64 | 65 | org.springframework.boot 66 | spring-boot-maven-plugin 67 | 68 | 69 | 70 | org.projectlombok 71 | lombok 72 | 73 | 74 | 75 | 76 | 77 | maven-compiler-plugin 78 | 3.10.1 79 | 80 | 17 81 | 17 82 | UTF-8 83 | 84 | 85 | 86 | 87 | 88 | -------------------------------------------------------------------------------- /src/main/java/com/redis/om/skeleton/SkeletonApplication.java: -------------------------------------------------------------------------------- 1 | package com.redis.om.skeleton; 2 | 3 | import java.util.List; 4 | import java.util.Set; 5 | 6 | import org.slf4j.Logger; 7 | import org.slf4j.LoggerFactory; 8 | import org.springdoc.core.models.GroupedOpenApi; 9 | import org.springframework.beans.factory.annotation.Autowired; 10 | import org.springframework.boot.CommandLineRunner; 11 | import org.springframework.boot.SpringApplication; 12 | import org.springframework.boot.autoconfigure.SpringBootApplication; 13 | import org.springframework.context.annotation.Bean; 14 | import org.springframework.data.geo.Point; 15 | 16 | import com.redis.om.skeleton.models.Address; 17 | import com.redis.om.skeleton.models.Person; 18 | import com.redis.om.skeleton.repositories.PeopleRepository; 19 | import com.redis.om.spring.annotations.EnableRedisDocumentRepositories; 20 | 21 | import io.swagger.v3.oas.models.OpenAPI; 22 | import io.swagger.v3.oas.models.info.Info; 23 | 24 | @SpringBootApplication 25 | @EnableRedisDocumentRepositories(basePackages = "com.redis.om.skeleton.*") 26 | public class SkeletonApplication { 27 | Logger logger = LoggerFactory.getLogger(SkeletonApplication.class); 28 | 29 | @Autowired 30 | PeopleRepository repo; 31 | 32 | @Bean 33 | CommandLineRunner loadTestData(PeopleRepository repo) { 34 | return args -> { 35 | repo.deleteAll(); 36 | 37 | String thorSays = "The Rabbit Is Correct, And Clearly The Smartest One Among You."; 38 | String ironmanSays = "Doth mother know you weareth her drapes?"; 39 | String blackWidowSays = "Hey, fellas. Either one of you know where the Smithsonian is? I'm here to pick up a fossil."; 40 | String wandaMaximoffSays = "You Guys Know I Can Move Things With My Mind, Right?"; 41 | String gamoraSays = "I Am Going To Die Surrounded By The Biggest Idiots In The Galaxy."; 42 | String nickFurySays = "Sir, I'm Gonna Have To Ask You To Exit The Donut"; 43 | 44 | // Serendipity, 248 Seven Mile Beach Rd, Broken Head NSW 2481, Australia 45 | Address thorsAddress = Address.of("248", "Seven Mile Beach Rd", "Broken Head", "NSW", "2481", "Australia"); 46 | 47 | // 11 Commerce Dr, Riverhead, NY 11901 48 | Address ironmansAddress = Address.of("11", "Commerce Dr", "Riverhead", "NY", "11901", "US"); 49 | 50 | // 605 W 48th St, New York, NY 10019 51 | Address blackWidowAddress = Address.of("605", "48th St", "New York", "NY", "10019", "US"); 52 | 53 | // 20 W 34th St, New York, NY 10001 54 | Address wandaMaximoffsAddress = Address.of("20", "W 34th St", "New York", "NY", "10001", "US"); 55 | 56 | // 107 S Beverly Glen Blvd, Los Angeles, CA 90024 57 | Address gamorasAddress = Address.of("107", "S Beverly Glen Blvd", "Los Angeles", "CA", "90024", "US"); 58 | 59 | // 11461 Sunset Blvd, Los Angeles, CA 90049 60 | Address nickFuryAddress = Address.of("11461", "Sunset Blvd", "Los Angeles", "CA", "90049", "US"); 61 | 62 | Person thor = Person.of("Chris", "Hemsworth", 38, thorSays, new Point(153.616667, -28.716667), thorsAddress, 63 | Set.of("hammer", "biceps", "hair", "heart")); 64 | Person ironman = Person.of("Robert", "Downey", 56, ironmanSays, new Point(40.9190747, -72.5371874), 65 | ironmansAddress, Set.of("tech", "money", "one-liners", "intelligence", "resources")); 66 | Person blackWidow = Person.of("Scarlett", "Johansson", 37, blackWidowSays, new Point(40.7215259, -74.0129994), 67 | blackWidowAddress, Set.of("deception", "martial_arts")); 68 | Person wandaMaximoff = Person.of("Elizabeth", "Olsen", 32, wandaMaximoffSays, new Point(40.6976701, -74.2598641), 69 | wandaMaximoffsAddress, Set.of("magic", "loyalty")); 70 | Person gamora = Person.of("Zoe", "Saldana", 43, gamoraSays, new Point(-118.399968, 34.073087), gamorasAddress, 71 | Set.of("skills", "martial_arts")); 72 | Person nickFury = Person.of("Samuel L.", "Jackson", 73, nickFurySays, new Point(-118.4345534, 34.082615), 73 | nickFuryAddress, Set.of("planning", "deception", "resources")); 74 | 75 | repo.saveAll(List.of(thor, ironman, blackWidow, wandaMaximoff, gamora, nickFury)); 76 | 77 | repo.findAll().forEach(p -> logger.info("🦸 Name: {} {}", p.getFirstName(), p.getLastName())); 78 | }; 79 | } 80 | 81 | @Bean 82 | public OpenAPI apiInfo() { 83 | return new OpenAPI().info(new Info().title("Redis OM Spring Skeleton").version("1.0.0")); 84 | } 85 | 86 | @Bean 87 | public GroupedOpenApi httpApi() { 88 | return GroupedOpenApi.builder() 89 | .group("http") 90 | .pathsToMatch("/**") 91 | .build(); 92 | } 93 | 94 | public static void main(String[] args) { 95 | SpringApplication.run(SkeletonApplication.class, args); 96 | } 97 | 98 | } 99 | -------------------------------------------------------------------------------- /src/main/java/com/redis/om/skeleton/controllers/PeopleControllerV1.java: -------------------------------------------------------------------------------- 1 | package com.redis.om.skeleton.controllers; 2 | 3 | import java.util.Optional; 4 | import java.util.Set; 5 | 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.data.geo.Distance; 8 | import org.springframework.data.geo.Metrics; 9 | import org.springframework.data.geo.Point; 10 | import org.springframework.web.bind.annotation.DeleteMapping; 11 | import org.springframework.web.bind.annotation.GetMapping; 12 | import org.springframework.web.bind.annotation.PathVariable; 13 | import org.springframework.web.bind.annotation.PostMapping; 14 | import org.springframework.web.bind.annotation.PutMapping; 15 | import org.springframework.web.bind.annotation.RequestBody; 16 | import org.springframework.web.bind.annotation.RequestMapping; 17 | import org.springframework.web.bind.annotation.RequestParam; 18 | import org.springframework.web.bind.annotation.RestController; 19 | 20 | import com.redis.om.skeleton.models.Person; 21 | import com.redis.om.skeleton.repositories.PeopleRepository; 22 | 23 | @RestController 24 | @RequestMapping("/api/v1/people") 25 | public class PeopleControllerV1 { 26 | 27 | @Autowired 28 | PeopleRepository repo; 29 | 30 | @GetMapping("age_between") 31 | Iterable byAgeBetween( // 32 | @RequestParam("min") int min, // 33 | @RequestParam("max") int max) { 34 | return repo.findByAgeBetween(min, max); 35 | } 36 | 37 | @GetMapping("homeloc") 38 | Iterable byHomeLoc(// 39 | @RequestParam("lat") double lat, // 40 | @RequestParam("lon") double lon, // 41 | @RequestParam("d") double distance) { 42 | return repo.findByHomeLoc(new Point(lon, lat), new Distance(distance, Metrics.MILES)); 43 | } 44 | 45 | @GetMapping("name") 46 | Iterable byFirstNameAndLastName(@RequestParam("first") String firstName, // 47 | @RequestParam("last") String lastName) { 48 | return repo.findByFirstNameAndLastName(firstName, lastName); 49 | } 50 | 51 | @GetMapping("statement") 52 | Iterable byPersonalStatement(@RequestParam("q") String q) { 53 | return repo.searchByPersonalStatement(q); 54 | } 55 | 56 | @PostMapping("new") 57 | Person create(@RequestBody Person newPerson) { 58 | return repo.save(newPerson); 59 | } 60 | 61 | @GetMapping("{id}") 62 | Optional byId(@PathVariable String id) { 63 | return repo.findById(id); 64 | } 65 | 66 | @PutMapping("{id}") 67 | Person update(@RequestBody Person newPerson, @PathVariable String id) { 68 | return repo.findById(id).map(person -> { 69 | person.setFirstName(newPerson.getFirstName()); 70 | person.setLastName(newPerson.getLastName()); 71 | person.setAge(newPerson.getAge()); 72 | person.setAddress(newPerson.getAddress()); 73 | person.setHomeLoc(newPerson.getHomeLoc()); 74 | person.setPersonalStatement(newPerson.getPersonalStatement()); 75 | 76 | return repo.save(person); 77 | }).orElseGet(() -> { 78 | return repo.save(newPerson); 79 | }); 80 | } 81 | 82 | @DeleteMapping("{id}") 83 | void delete(@PathVariable String id) { 84 | repo.deleteById(id); 85 | } 86 | 87 | @GetMapping("city") 88 | Iterable byCity(@RequestParam("city") String city) { 89 | return repo.findByAddress_City(city); 90 | } 91 | 92 | @GetMapping("city_state") 93 | Iterable byCityAndState(@RequestParam("city") String city, // 94 | @RequestParam("state") String state) { 95 | return repo.findByAddress_CityAndAddress_State(city, state); 96 | } 97 | 98 | @GetMapping("skills") 99 | Iterable byAnySkills(@RequestParam("skills") Set skills) { 100 | return repo.findBySkills(skills); 101 | } 102 | 103 | @GetMapping("skills/all") 104 | Iterable byAllSkills(@RequestParam("skills") Set skills) { 105 | return repo.findBySkillsContainingAll(skills); 106 | } 107 | 108 | @GetMapping("search/{q}") 109 | Iterable fullTextSearch(@PathVariable("q") String q) { 110 | return repo.search(q); 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /src/main/java/com/redis/om/skeleton/controllers/PeopleControllerV2.java: -------------------------------------------------------------------------------- 1 | package com.redis.om.skeleton.controllers; 2 | 3 | import org.springframework.beans.factory.annotation.Autowired; 4 | import org.springframework.data.geo.Distance; 5 | import org.springframework.data.geo.Metrics; 6 | import org.springframework.data.geo.Point; 7 | import org.springframework.web.bind.annotation.GetMapping; 8 | import org.springframework.web.bind.annotation.PathVariable; 9 | import org.springframework.web.bind.annotation.RequestMapping; 10 | import org.springframework.web.bind.annotation.RequestParam; 11 | import org.springframework.web.bind.annotation.RestController; 12 | 13 | import com.redis.om.skeleton.models.Person; 14 | import com.redis.om.skeleton.services.PeopleService; 15 | 16 | @RestController 17 | @RequestMapping("/api/v2/people") 18 | public class PeopleControllerV2 { 19 | 20 | @Autowired 21 | PeopleService service; 22 | 23 | @GetMapping("age_between") 24 | Iterable byAgeBetween( 25 | @RequestParam("min") int min, // 26 | @RequestParam("max") int max) { 27 | return service.findByAgeBetween(min, max); 28 | } 29 | 30 | @GetMapping("name") 31 | Iterable byFirstNameAndLastName( 32 | @RequestParam("first") String firstName, // 33 | @RequestParam("last") String lastName) { 34 | return service.findByFirstNameAndLastName(firstName, lastName); 35 | } 36 | 37 | @GetMapping("homeloc") 38 | Iterable byHomeLoc(// 39 | @RequestParam("lat") double lat, // 40 | @RequestParam("lon") double lon, // 41 | @RequestParam("d") double distance) { 42 | return service.findByHomeLoc(new Point(lon, lat), new Distance(distance, Metrics.MILES)); 43 | } 44 | 45 | @GetMapping("statement/{q}") 46 | Iterable byPersonalStatement(@PathVariable("q") String q) { 47 | return service.searchByPersonalStatement(q); 48 | } 49 | 50 | } 51 | -------------------------------------------------------------------------------- /src/main/java/com/redis/om/skeleton/models/Address.java: -------------------------------------------------------------------------------- 1 | package com.redis.om.skeleton.models; 2 | 3 | import com.redis.om.spring.annotations.Indexed; 4 | import com.redis.om.spring.annotations.Searchable; 5 | 6 | import lombok.Data; 7 | import lombok.NonNull; 8 | import lombok.RequiredArgsConstructor; 9 | 10 | @Data 11 | @RequiredArgsConstructor(staticName = "of") 12 | public class Address { 13 | 14 | @NonNull 15 | @Indexed 16 | private String houseNumber; 17 | 18 | @NonNull 19 | @Searchable(nostem = true) 20 | private String street; 21 | 22 | @NonNull 23 | @Indexed 24 | private String city; 25 | 26 | @NonNull 27 | @Indexed 28 | private String state; 29 | 30 | @NonNull 31 | @Indexed 32 | private String postalCode; 33 | 34 | @NonNull 35 | @Indexed 36 | private String country; 37 | } 38 | -------------------------------------------------------------------------------- /src/main/java/com/redis/om/skeleton/models/Person.java: -------------------------------------------------------------------------------- 1 | package com.redis.om.skeleton.models; 2 | 3 | import java.util.Set; 4 | 5 | import org.springframework.data.annotation.Id; 6 | import org.springframework.data.geo.Point; 7 | 8 | import com.redis.om.spring.annotations.Document; 9 | import com.redis.om.spring.annotations.Indexed; 10 | import com.redis.om.spring.annotations.Searchable; 11 | 12 | import lombok.AccessLevel; 13 | import lombok.AllArgsConstructor; 14 | import lombok.Data; 15 | import lombok.NonNull; 16 | import lombok.RequiredArgsConstructor; 17 | 18 | @RequiredArgsConstructor(staticName = "of") 19 | @AllArgsConstructor(access = AccessLevel.PROTECTED) 20 | @Data 21 | @Document 22 | public class Person { 23 | // Id Field, also indexed 24 | @Id 25 | @Indexed 26 | private String id; 27 | 28 | // Indexed for exact text matching 29 | @Indexed @NonNull 30 | private String firstName; 31 | 32 | @Indexed @NonNull 33 | private String lastName; 34 | 35 | //Indexed for numeric matches 36 | @Indexed @NonNull 37 | private Integer age; 38 | 39 | //Indexed for Full Text matches 40 | @Searchable @NonNull 41 | private String personalStatement; 42 | 43 | //Indexed for Geo Filtering 44 | @Indexed @NonNull 45 | private Point homeLoc; 46 | 47 | // Nest indexed object 48 | @Indexed @NonNull 49 | private Address address; 50 | 51 | @Indexed @NonNull 52 | private Set skills; 53 | } 54 | -------------------------------------------------------------------------------- /src/main/java/com/redis/om/skeleton/repositories/PeopleRepository.java: -------------------------------------------------------------------------------- 1 | package com.redis.om.skeleton.repositories; 2 | 3 | import java.util.Set; 4 | 5 | import org.springframework.data.geo.Distance; 6 | import org.springframework.data.geo.Point; 7 | 8 | import com.redis.om.skeleton.models.Person; 9 | import com.redis.om.spring.repository.RedisDocumentRepository; 10 | 11 | public interface PeopleRepository extends RedisDocumentRepository { 12 | // Find people by age range 13 | Iterable findByAgeBetween(int minAge, int maxAge); 14 | 15 | // Draws a circular geofilter around a spot and returns all people in that radius 16 | Iterable findByHomeLoc(Point point, Distance distance); 17 | 18 | // Find people by their first and last name 19 | Iterable findByFirstNameAndLastName(String firstName, String lastName); 20 | 21 | // Performs full text search on a person's personal Statement 22 | Iterable searchByPersonalStatement(String text); 23 | 24 | // Performing a tag search on city 25 | Iterable findByAddress_City(String city); 26 | 27 | // Performing a full-search on street 28 | Iterable findByAddress_CityAndAddress_State(String city, String state); 29 | 30 | // Search Persons that have one of multiple skills (OR condition) 31 | Iterable findBySkills(Set skills); 32 | 33 | // Search Persons that have all of the skills (AND condition): 34 | Iterable findBySkillsContainingAll(Set skills); 35 | 36 | // Performing a text search on all text fields: 37 | Iterable search(String text); 38 | } -------------------------------------------------------------------------------- /src/main/java/com/redis/om/skeleton/services/PeopleService.java: -------------------------------------------------------------------------------- 1 | package com.redis.om.skeleton.services; 2 | 3 | import java.util.stream.Collectors; 4 | 5 | import org.springframework.beans.factory.annotation.Autowired; 6 | import org.springframework.data.geo.Distance; 7 | import org.springframework.data.geo.Point; 8 | import org.springframework.stereotype.Service; 9 | 10 | import com.redis.om.skeleton.models.Person; 11 | import com.redis.om.skeleton.models.Person$; 12 | import com.redis.om.spring.search.stream.EntityStream; 13 | 14 | import redis.clients.jedis.search.aggr.SortedField.SortOrder; 15 | 16 | @Service 17 | public class PeopleService { 18 | @Autowired 19 | EntityStream entityStream; 20 | 21 | // Find people by age range 22 | public Iterable findByAgeBetween(int minAge, int maxAge) { 23 | return entityStream // 24 | .of(Person.class) // 25 | .filter(Person$.AGE.between(minAge, maxAge)) // 26 | .sorted(Person$.AGE, SortOrder.ASC) // 27 | .collect(Collectors.toList()); 28 | } 29 | 30 | // Find people by their first and last name 31 | public Iterable findByFirstNameAndLastName(String firstName, String lastName) { 32 | return entityStream // 33 | .of(Person.class) // 34 | .filter(Person$.FIRST_NAME.eq(firstName)) // 35 | .filter(Person$.LAST_NAME.eq(lastName)) // 36 | .collect(Collectors.toList()); 37 | } 38 | 39 | public Iterable findByHomeLoc(// 40 | Point point, Distance distance) { 41 | return entityStream // 42 | .of(Person.class) // 43 | .filter(Person$.HOME_LOC.near(point, distance)) // 44 | .collect(Collectors.toList()); 45 | } 46 | 47 | // Performs full text search on a person's personal Statement 48 | public Iterable searchByPersonalStatement(String text) { 49 | return entityStream // 50 | .of(Person.class) // 51 | .filter(Person$.PERSONAL_STATEMENT.eq(text)) // 52 | .collect(Collectors.toList()); 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | spring.mvc.pathmatch.matching-strategy = ANT_PATH_MATCHER 2 | -------------------------------------------------------------------------------- /src/test/java/com/redis/om/skeleton/SkeletonApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.redis.om.skeleton; 2 | 3 | import org.springframework.boot.test.context.SpringBootTest; 4 | 5 | @SpringBootTest 6 | class SkeletonApplicationTests { 7 | 8 | } 9 | --------------------------------------------------------------------------------