About the Oracle NoSQL Database SDK for Spring Data

Connect to the Oracle NoSQL Database with applications using the Spring Data Framework (Spring-based programming model for data) and the Oracle NoSQL Database SDK for Spring Data.

The Spring Data Framework provides a familiar and consistent, Spring-based programming model for data access. For more information about Spring Data Framework, see Spring Data.

The Oracle NoSQL Database SDK for Spring Data provides POJO (Plain Old Java Object) centric modeling and integration between the Oracle NoSQL Database and the Spring Data Framework. One of the key benefits available to the Java programmer is the ability to write your code as a repository-style data access layer, while the Spring Data Framework maps those repository-style data access operations to Oracle NoSQL Database API calls.

The Oracle NoSQL Database SDK for Spring Data is available in the Maven Central repository, details are available here. The main location of the project is is the oracle-spring-sdk project on GitHub.

You can get all the required files for running the Spring Data Framework with the following POM file dependencies. The version changes with each release. Ensure that you install the latest supported version as suggested in the GitHub.

<dependencies>
    <dependency>
        <groupId>com.oracle.nosql.sdk</groupId>
        <artifactId>spring-data-oracle-nosql</artifactId>
        <version>2.1.0</version>
    </dependency>
</dependencies>

Add the additional dependency to use the Spring Data Framework:


<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>3.3.4</version>
</dependency>

The Oracle NoSQL Database SDK for Spring Data provides you with all the Spring Data classes, methods, interfaces, and examples. Documentation is available as nosql-spring-sdk in GitHub or from SDK for Spring Data API Reference.

Note:

The Oracle NoSQL Database SDK for Spring Data requires an Oracle NoSQL Database Proxy to connect to an Oracle NoSQL Database cluster. For more information about setting up an Oracle NoSQL Database Proxy, see Oracle NoSQL Database Proxy in the Administrator's Guide.

Supported Features

The following features are currently supported by the Oracle NoSQL Database SDK for Spring Data.

Generic CRUD operations on a repository using methods in the CrudRepository interface. For more information about the CrudRepository interface, see CrudRepository.
Pagination and sorting operations using methods in the PagingAndSortingRepository interface. For more information about the PagingAndSortingRepository interface, see PagingAndSortingRepository.
Derived Queries.
Native Queries.