my-first-spring-app

Based on Getting Started - Accessing Oracle NoSQL Database from Spring Data Applications

Author: dario-vega

examples-nosql-spring-sdk/my-first-spring-app/README.md

@@ -0,0 +1,50 @@
+# my-first-spring-app
+
+## Preparation
+
+Clone this repository
+
+## Setup dependencies
+
+see [pom.xml](./pom.xml)
+
+
+## Build and Run the application 
+**Note**: default values are for on-premise and `http://localhost:8080`. See application.properties 
+These can be modified by setting the following env variables
+
+export NOSQL_ENDPOINT=$HOSTNAME
+export NOSQL_PORT=8080
+
+
+Running the App code:
+```shell
+mvn compile exec:java -Dexec.mainClass="org.example.app.App" 
+```
+
+## Deploy KVLite container image and run the application
+
+1. Start up KVLite in a container
+
+pull the image directly from the GitHub Container Registry:
+
+```shell
+docker pull ghcr.io/oracle/nosql:latest-ce
+docker tag ghcr.io/oracle/nosql:latest-ce oracle/nosql:ce
+```
+
+Start up KVLite in a container. You must give it a name and provide a hostname. Startup of
+KVLite is the default `CMD` of the image:
+
+```shell
+docker run -d --name=kvlite --hostname=kvlite --env KV_PROXY_PORT=8080 -p 8080:8080 oracle/nosql:ce
+```
+
+see instuction https://github.com/oracle/docker-images/tree/main/NoSQL
+
+2. Build and Run the application as shown above
+
+## Learn more
+
+* [Getting Started - Accessing Oracle NoSQL Database from Spring Data Applications](https://blogs.oracle.com/nosql/post/getting-started-accessing-oracle-nosql-database-from-spring-data-applications)
+

examples-nosql-spring-sdk/my-first-spring-app/pom.xml

@@ -0,0 +1,43 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>org.example.app</groupId>
+  <artifactId>my-app</artifactId>
+  <packaging>jar</packaging>
+  <version>1.0-SNAPSHOT</version>
+  <name>my-app</name>
+  <url>http://maven.apache.org</url>
+
+
+<properties>
+      <maven.compiler.source>1.8</maven.compiler.source>
+      <maven.compiler.target>1.8</maven.compiler.target>
+      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+</properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>3.8.1</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter</artifactId>
+      <version>2.7.0</version>
+    </dependency>
+
+     <!-- https://mvnrepository.com/artifact/com.oracle.nosql.sdk/spring-data-oracle-nosql -->
+     <dependency>
+         <groupId>com.oracle.nosql.sdk</groupId>
+         <artifactId>spring-data-oracle-nosql</artifactId>
+         <version>1.4.1</version>
+     </dependency>
+
+
+  </dependencies>
+
+</project>

examples-nosql-spring-sdk/my-first-spring-app/src/main/java/org/example/app/App.java

@@ -0,0 +1,57 @@
+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);
+        }
+    }
+}

examples-nosql-spring-sdk/my-first-spring-app/src/main/java/org/example/app/AppConfig.java

@@ -0,0 +1,29 @@
+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 org.springframework.beans.factory.annotation.Value;
+
+
+import oracle.nosql.driver.kv.StoreAccessTokenProvider;
+
+@Configuration
+@EnableNosqlRepositories
+public class AppConfig extends AbstractNosqlConfiguration {
+
+    @Value("${nosql.endpoint}")
+    private String NOSQL_ENDPOINT;
+    @Value("${nosql.port}")
+    private String NOSQL_PORT;
+
+    @Bean
+    public NosqlDbConfig nosqlDbConfig() {
+        return new NosqlDbConfig(
+            "http://" + NOSQL_ENDPOINT + ":" + NOSQL_PORT,                   // endpoint URL
+            new StoreAccessTokenProvider());    // AuthorizationProvider
+    }
+}

examples-nosql-spring-sdk/my-first-spring-app/src/main/java/org/example/app/Customer.java

@@ -0,0 +1,19 @@
+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 + '\'' +
+            '}';
+    }
+}

examples-nosql-spring-sdk/my-first-spring-app/src/main/java/org/example/app/CustomerRepository.java

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

examples-nosql-spring-sdk/my-first-spring-app/src/main/resources/application.properties

@@ -0,0 +1,7 @@
+payroll.ociregion=${OCI_REGION:us-ashburn-1}
+payroll.ocid_comp=${OCI_NOSQL_COMPID:ocid1.compartment.oc1..aaaaaaaa4mlehopmvdluv2wjcdp4tnh2ypjz3nhhpahb4ss7yvxaa3be3diq}
+
+nosql.endpoint=${NOSQL_ENDPOINT:localhost}
+nosql.port=${NOSQL_PORT:8080}
+
+

examples-nosql-spring-sdk/my-first-spring-app/src/test/java/org/example/app/AppTest.java

@@ -0,0 +1,38 @@
+package org.example.app;
+
+import junit.framework.Test;
+import junit.framework.TestCase;
+import junit.framework.TestSuite;
+
+/**
+ * Unit test for simple App.
+ */
+public class AppTest 
+    extends TestCase
+{
+    /**
+     * Create the test case
+     *
+     * @param testName name of the test case
+     */
+    public AppTest( String testName )
+    {
+        super( testName );
+    }
+
+    /**
+     * @return the suite of tests being tested
+     */
+    public static Test suite()
+    {
+        return new TestSuite( AppTest.class );
+    }
+
+    /**
+     * Rigourous Test :-)
+     */
+    public void testApp()
+    {
+        assertTrue( true );
+    }
+}