Introduction to Data Pagination With Quarkus and MongoDB: A Comprehensive Tutorial

1
git clone git@github.com:mongodb-developer/quarkus-pagination-sample.git

1
docker run --rm -d --name mongodb-instance -p 27017:27017 mongo

1
<dependencies>
2
    <dependency>
3
        <groupId>io.quarkus</groupId>
4
        <artifactId>quarkus-smallrye-openapi</artifactId>
5
    </dependency>
6
    <dependency>
7
        <groupId>io.quarkiverse.jnosql</groupId>
8
        <artifactId>quarkus-jnosql-document-mongodb</artifactId>
9
        <version>3.3.0</version>
10
    </dependency>
11
    <dependency>
12
        <groupId>io.quarkus</groupId>
13
        <artifactId>quarkus-resteasy</artifactId>
14
    </dependency>
15
    <dependency>
16
        <groupId>io.quarkus</groupId>
17
        <artifactId>quarkus-resteasy-jackson</artifactId>
18
    </dependency>
19
    <dependency>
20
        <groupId>io.quarkus</groupId>
21
        <artifactId>quarkus-arc</artifactId>
22
    </dependency>
23
    <dependency>
24
        <groupId>io.quarkus</groupId>
25
        <artifactId>quarkus-junit5</artifactId>
26
        <scope>test</scope>
27
    </dependency>
28
    <dependency>
29
        <groupId>io.rest-assured</groupId>
30
        <artifactId>rest-assured</artifactId>
31
        <scope>test</scope>
32
    </dependency>
33
</dependencies>

1
quarkus.mongodb.connection-string = mongodb://localhost
2
jnosql.document.database = fruits

1
import jakarta.nosql.Column;
2
import jakarta.nosql.Convert;
3
import jakarta.nosql.Entity;
4
import jakarta.nosql.Id;
5
import org.eclipse.jnosql.databases.mongodb.mapping.ObjectIdConverter;
6
7
@Entity
8
public class Fruit {
9
10
    @Id
11
    @Convert(ObjectIdConverter.class)
12
    private String id;
13
14
    @Column
15
    private String name;
16
17
    public String getId() {
18
        return id;
19
    }
20
21
    public void setId(String id) {
22
        this.id = id;
23
    }
24
25
    public String getName() {
26
        return name;
27
    }
28
29
    public void setName(String name) {
30
        this.name = name;
31
    }
32
33
    @Override
34
    public String toString() {
35
        return "Fruit{" +
36
                "id='" + id + '\'' +
37
                ", name='" + name + '\'' +
38
                '}';
39
    }
40
41
    public static Fruit of(String name) {
42
        Fruit fruit = new Fruit();
43
        fruit.setName(name);
44
        return fruit;
45
    }
46
47
}

1
import jakarta.data.Sort;
2
import jakarta.data.page.CursoredPage;
3
import jakarta.data.page.Page;
4
import jakarta.data.page.PageRequest;
5
import jakarta.data.repository.BasicRepository;
6
import jakarta.data.repository.Find;
7
import jakarta.data.repository.OrderBy;
8
import jakarta.data.repository.Repository;
9
10
@Repository
11
public interface FruitRepository extends BasicRepository<Fruit, String> {
12
13
    @Find
14
    CursoredPage<Fruit> cursor(PageRequest pageRequest, Sort<Fruit> order);
15
16
    @Find
17
    @OrderBy("name")
18
    Page<Fruit> offSet(PageRequest pageRequest);
19
20
    long countBy();
21
22
}

1
import jakarta.enterprise.context.ApplicationScoped;
2
3
import jakarta.enterprise.event.Observes;
4
5
import io.quarkus.runtime.ShutdownEvent;
6
import io.quarkus.runtime.StartupEvent;
7
import org.jboss.logging.Logger;
8
9
import java.util.List;
10
11
@ApplicationScoped
12
public class SetupDatabase {
13
14
    private static final Logger LOGGER = Logger.getLogger(SetupDatabase.class.getName());
15
16
    private final FruitRepository fruitRepository;
17
18
    public SetupDatabase(FruitRepository fruitRepository) {
19
        this.fruitRepository = fruitRepository;
20
    }
21
22
23
    void onStart(@Observes StartupEvent ev) {
24
        LOGGER.info("The application is starting...");
25
        long count = fruitRepository.countBy();
26
        if (count > 0) {
27
            LOGGER.info("Database already populated");
28
            return;
29
        }
30
        List<Fruit> fruits = List.of(
31
                Fruit.of("apple"),
32
                Fruit.of("banana"),
33
                Fruit.of("cherry"),
34
                Fruit.of("date"),
35
                Fruit.of("elderberry"),
36
                Fruit.of("fig"),
37
                Fruit.of("grape"),
38
                Fruit.of("honeydew"),
39
                Fruit.of("kiwi"),
40
                Fruit.of("lemon")
41
        );
42
        fruitRepository.saveAll(fruits);
43
    }
44
45
    void onStop(@Observes ShutdownEvent ev) {
46
        LOGGER.info("The application is stopping...");
47
        fruitRepository.deleteAll(fruitRepository.findAll().toList());
48
    }
49
50
}

1
import jakarta.data.Sort;
2
import jakarta.data.page.PageRequest;
3
import jakarta.ws.rs.DefaultValue;
4
import jakarta.ws.rs.GET;
5
import jakarta.ws.rs.Path;
6
import jakarta.ws.rs.Produces;
7
import jakarta.ws.rs.QueryParam;
8
import jakarta.ws.rs.core.MediaType;
9
10
@Path("/fruits")
11
public class FruitResource {
12
13
    private final FruitRepository fruitRepository;
14
15
    private static final Sort<Fruit> ASC = Sort.asc("name");
16
    private static final Sort<Fruit> DESC = Sort.asc("name");
17
18
    public FruitResource(FruitRepository fruitRepository) {
19
        this.fruitRepository = fruitRepository;
20
    }
21
22
    @Path("/offset")
23
    @GET
24
    @Produces(MediaType.APPLICATION_JSON)
25
    public Iterable<Fruit> hello(@QueryParam("page") @DefaultValue("1") long page,
26
                                 @QueryParam("size") @DefaultValue("2") int size) {
27
        var pageRequest = PageRequest.ofPage(page).size(size);
28
        return fruitRepository.offSet(pageRequest).content();
29
    }
30
31
    @Path("/cursor")
32
    @GET
33
    @Produces(MediaType.APPLICATION_JSON)
34
    public Iterable<Fruit> cursor(@QueryParam("after") @DefaultValue("") String after,
35
                                  @QueryParam("before") @DefaultValue("") String before,
36
                                  @QueryParam("size") @DefaultValue("2") int size) {
37
        if (!after.isBlank()) {
38
            var pageRequest = PageRequest.ofSize(size).afterCursor(PageRequest.Cursor.forKey(after));
39
            return fruitRepository.cursor(pageRequest, ASC).content();
40
        } else if (!before.isBlank()) {
41
            var pageRequest = PageRequest.ofSize(size).beforeCursor(PageRequest.Cursor.forKey(before));
42
            return fruitRepository.cursor(pageRequest, DESC).stream().toList();
43
        }
44
        var pageRequest = PageRequest.ofSize(size);
45
        return fruitRepository.cursor(pageRequest, ASC).content();
46
    }
47
48
}

1
./mvnw compile quarkus:dev

1
curl --location http://localhost:8080/fruits/offset?page=1

1
curl --location http://localhost:8080/fruits/offset?page=2

1
curl --location http://localhost:8080/fruits/offset?page=5

1
curl --location http://localhost:8080/fruits/cursor

1
curl --location http://localhost:8080/fruits/cursor?after=banana

1
curl --location http://localhost:8080/fruits/cursor?before=date