isabella232 / nosql-spring-sdk

SDK for Spring Data for Oracle NoSQL Database

Oracle NoSQL Database SDK for Spring Data

About

Oracle NoSQL SDK for Spring Data provides a Spring Data implementation module to connect to an Oracle NoSQL Database cluster or to Oracle NoSQL Cloud Service.

Usage

• To use the SDK in your project add maven dependency to your project's pom.xml:

  <dependency>
      <groupId>com.oracle.nosql.sdk</groupId>
      <artifactId>spring-data-oracle-nosql</artifactId>
      <version>x.y.z</version>
  </dependency>

  Note: Packages can be manually installed in a local maven repository by downloading from releases page, and running the following command (-sources and -javadoc files are optional):

  mvn install:install-file \
  -DpomFile=spring-data-oracle-nosql-x.y.z.pom \
  -Dfile=spring-data-oracle-nosql-x.y.z.jar \
  -Dsources=spring-data-oracle-nosql-x.y.z-sources.jar \
  -Djavadoc=spring-data-oracle-nosql-x.y.z-javadoc.jar
  

• The example below also requires an additional dependency:

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

• Define an AppConfig class that provides a nosqlDBConfig bean that returns an Oracle NoSQL DB configuration:

  package org.example.app;
  
  import com.oracle.nosql.spring.data.config.AbstractNosqlConfiguration;
  import com.oracle.nosql.spring.data.config.NosqlDbConfig;
  import com.oracle.nosql.spring.data.repository.config.EnableNosqlRepositories;
  
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  
  import oracle.nosql.driver.kv.StoreAccessTokenProvider;
  
  @Configuration
  @EnableNosqlRepositories
  public class AppConfig extends AbstractNosqlConfiguration {
     
      @Bean
      public NosqlDbConfig nosqlDbConfig() {
          return new NosqlDbConfig(
              "localhost:8080",                   // endpoint URL
              new StoreAccessTokenProvider());    // AuthorizationProvider
      }
  }

Note: Depending on individual scenario use the appropriate AuthorizationProvider:

• For cloud configuration use the following example or see documentation:

  new oracle.nosql.driver.iam.SignatureProvider(
                      tenantId,             // OCID
                      userId,               // OCID
                      fingerprint,          // String
                      File privateKeyFile,
                      char[] passphrase)

  • For cloud configuration when application is running in the same region use instance principal authentication. This requires a one-time setup.

    SignatureProvider.createWithInstancePrincipal()

• For cloud simulator use:

  com.oracle.nosql.spring.data.NosqlDbFactory.CloudSimProvider.getProvider()

• For on-prem configuration use one of the following examples or see documentation:

  • For unsecure example:

    new oracle.nosql.driver.kv.StoreAccessTokenProvider()

  • For secure example use:

    new oracle.nosql.driver.kv.StoreAccessTokenProvider("username", "password".toCharArray())

Note: For convenience one can use the following com.oracle.nosql.spring.data.NosqlDbConfig methods:

• for cloud: NosqlDbConfig.createCloudConfig("endpoint", configFile);
• for cloud simulator: NosqlDbConfig.createCloudSimConfig("endpoint");
• for on-prem unsecure store: NosqlDbConfig.createProxyConfig("endpoint");
• for on-prem secure store: NosqlDbConfig.createProxyConfig("endpoint", user, password);

• Define the entity class:

  package org.example.app;
  
  import com.oracle.nosql.spring.data.core.mapping.NosqlId;
  
  public class Customer {
      @NosqlId(generated = true)
      long customerId;
      String firstName;
      String lastName;
  
      @Override
      public String toString() {
          return "Customer{" +
              "customerId=" + customerId +
              ", firstName='" + firstName + '\'' +
              ", lastName='" + lastName + '\'' +
              '}';
      }
  }

• Declare a repository that extends NosqlRepository:

  package org.example.app;
  
  import com.oracle.nosql.spring.data.repository.NosqlRepository;
  
  public interface CustomerRepository
      extends NosqlRepository<Customer, Long>
  {
      Iterable<Customer> findByLastName(String lastname);
  }

• Write the main application class. This requires adding dependencies to org .springframework.boot:spring-boot and org.springframework .boot:spring-boot-autoconfigure.

  package org.example.app;
  
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.boot.CommandLineRunner;
  import org.springframework.boot.SpringApplication;
  import org.springframework.boot.autoconfigure.SpringBootApplication;
  import org.springframework.context.ConfigurableApplicationContext;
  
  @SpringBootApplication
  public class App implements CommandLineRunner
  {
      @Autowired
      private CustomerRepository repo;
  
      public static void main( String[] args )
      {
          ConfigurableApplicationContext
              ctx = SpringApplication.run(App.class, args);
          SpringApplication.exit(ctx, () -> 0);
          ctx.close();
          System.exit(0);
      }
  
      @Override
      public void run(String... args) throws Exception {
  
          repo.deleteAll();
  
          Customer s1 = new Customer();
          s1.firstName = "John";
          s1.lastName = "Doe";
  
          repo.save(s1);
          System.out.println("\nsaved: " + s1); // customerId contains generated value
          
          Customer s2 = new Customer();
          s2.firstName = "John";
          s2.lastName = "Smith";
  
          repo.save(s2);
          System.out.println("\nsaved: " + s2); // customerId contains generated value
  
          System.out.println("\nfindAll:");
          Iterable<Customer> customers = repo.findAll();
  
          for (Customer s : customers) {
              System.out.println("  Customer: " + s);
          }
  
          System.out.println("\nfindByLastName: Smith");
          customers = repo.findByLastName("Smith");
  
          for (Customer s : customers) {
              System.out.println("  Customer: " + s);
          }
      }
  }

Build and run the example code

Example code requires an Oracle NoSQL DB instance and a local http proxy running on port 8080.

Start a kvlite instance with helperHosts "localhost:5000":

java -jar /path_to/kvstore.jar kvlite -root kvroot -host localhost -port 5000 -store kvstore -secure-config disable &

Start http proxy with endpoint URL "localhost:8080":

java -jar /path_to/httpproxy.jar -storeName kvstore -httpPort 8080 -helperHosts localhost:5000 -verbose true &

Execute the example code:

mvn exec:java -Dexec.mainClass="org.example.app.App"

To log the internally generated queries, one has to enable the debug level by adding following logging flag:

mvn exec:java -Dexec.mainClass="org.example.app.App" -Dlogging.level.com.oracle.nosql.spring.data=DEBUG

Run unit tests

Running tests require a running store and proxy. The test.serverType and test.endpoint system properties must be specified.

mvn test -Dtest.serverType=onprem -Dtest.endpoint=http://127.0.0.1:8080

By default, if no option is specified, onprem serverType and http://127.0.0 .1:8080 endpoint is assumed.

Tests can be also be run on:

• onprem:

  mvn -B -Ptest-onprem test -DargLine="-Dtest.endpoint=$ONPREM_ENDPOINT"
  

• onprem-secure: Must specify the user, password, trustfile and trust file access password.

  mvn -B -Ptest-onprem-secure test -DargLine="-Dtest.endpoint=$ONPREM_SEC_ENDPOINT -Dtest.user=$DRIVER_USER -Dtest.trust=$DRIVER_TRUST_FILE -Dtest.password=$DRIVER_PASS -Dtest.trust.password=$DRIVER_TRUST_PASS"
  

• cloudsim:

  mvn -B -Ptest-cloudsim test -DargLine="-Dtest.endpoint=$CLOUDSIM_ENDPOINT"
  

Help

• API documentation
• Developer's Guide
• Open an issue in the Issues page
• Post your question on the Oracle NoSQL Database Community.
• Email to [email protected]

When requesting help please be sure to include as much detail as possible, including version of the SDK and simple, standalone example code as needed.

Contributing

This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide.

Security

Please consult the security guide for our responsible security vulnerability disclosure process.

Licenses

See the LICENSE file.

The THIRD_PARTY_LICENSES file contains third party notices and licenses.

Enjoy.