ArangoOperations interface provides 'insert' method to create a new document.
Signatures
<T> DocumentEntity insert(T value, DocumentCreateOptions options) throws DataAccessException;
<T> DocumentEntity insert(T value, DocumentCreateOptions options) throws DataAccessException;
DocumentEntity insert(String collectionName, Object value, DocumentCreateOptions options)throws DataAccessException;
DocumentEntity insert(String collectionName, Object value) throws DataAccessException;
Insert method creates a new document from the given document, unless there is already a document with the _key given. If no _key is given, a new unique _key is generated automatically.
‘DocumentCreateOptions’ parameter is used to provide additional options while creating the document.
Following table summarizes different options that are provided using ‘DocumentCreateOptions’.
|
Option |
Datatype |
Description |
|
waitForSync |
Boolean |
If it is set to true, ArangoDB waits until the document is synced to disk. |
|
returnNew |
Boolean |
If this is set to true, then this method return the newly created document. |
|
returnOld |
Boolean |
If this is set tot true, then this return the complete old document under the attribute old in the result. |
|
overwrite |
Boolean |
If it is set true and the document with given key is already exists, then insert method replace the document |
|
overwriteMode |
OverwriteMode |
OverwriteMode is an enum with 4 possible values. a. ignore: if a document with the specified _key value exists already, nothing will be done and no write operation will be carried out. Insert operation just return success in this case. b. replace: if a document with the specified _key value exists already, it will be overwritten with the specified document value. This mode will also be used when no overwrite mode is specified but the overwrite flag is set to true. c. update: if a document with the specified _key value exists already, it will be patched (partially updated) with the specified document value. d. conflict: if a document with the specified _key value exists already, return a unique constraint violation error so that the insert operation fails. This is also the default behavior in case the overwrite mode is not set, and the overwrite flag is false or not set either. |
|
silent |
Boolean |
If it is set to true, an empty object is returned as part of the response (no response from server). |
|
streamTransactionId |
String |
If set, the operation will be executed within the transaction. |
|
mergeObjects |
Boolean |
Controls whether objects (not arrays) will be merged if present in both the existing and the patch document. If set to false, the value in the patch document will overwrite the existing document's value. If set to true, objects will be merged. The default is true. |
Example
Employee emp1 = new Employee(1, "Ram", "Gurram", 31);
DocumentCreateOptions docCreateOptions = new DocumentCreateOptions();
docCreateOptions.returnNew(true);
DocumentCreateEntity docEntity = (DocumentCreateEntity) arangoTemplate.insert(emp1, docCreateOptions);
Find the below working application.
Step 1: Create new maven project ‘arango-template-create-document’.
Step 2: Update pom.xml with maven dependencies.
pom.xml
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.sample.app</groupId>
<artifactId>arango-template-create-document</artifactId>
<version>1</version>
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-parent -->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.5</version>
</parent>
<dependencies>
<dependency>
<groupId>com.arangodb</groupId>
<artifactId>arangodb-spring-boot-starter</artifactId>
<version>2.3.3.RELEASE</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
Step 3: Define entity class.
Employee.java
package com.sample.app.entity;
import org.springframework.data.annotation.Id;
import com.arangodb.springframework.annotation.ArangoId;
import com.arangodb.springframework.annotation.Document;
@Document("employees")
public class Employee {
@Id // db document field: _key
private String key;
@ArangoId // db document field: _id
private String arangoId;
private Integer id;
private String firstName;
private String lastName;
private Integer age;
public Employee() {
}
public Employee(Integer id, String firstName, String lastName, Integer age) {
super();
this.id = id;
this.firstName = firstName;
this.lastName = lastName;
this.age = age;
}
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
public String getArangoId() {
return arangoId;
}
public void setArangoId(String arangoId) {
this.arangoId = arangoId;
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "Employee [id=" + id + ", firstName=" + firstName + ", lastName=" + lastName + ", age=" + age + "]";
}
}
Step 4: Define ArangoDB configuration class.
ArangoConfig.java
package com.sample.app.config;
import org.springframework.context.annotation.Configuration;
import com.arangodb.ArangoDB;
import com.arangodb.springframework.annotation.EnableArangoRepositories;
import com.arangodb.springframework.config.ArangoConfiguration;
@Configuration
@EnableArangoRepositories(basePackages = { "com.sample.app" })
public class ArangoConfig implements ArangoConfiguration {
@Override
public ArangoDB.Builder arango() {
return new ArangoDB.Builder().host("localhost", 8529).user("root").password("tiger");
}
@Override
public String database() {
return "abc_org";
}
}
Step 5: Define main application class.
App.java
package com.sample.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.annotation.Bean;
import com.arangodb.entity.DocumentCreateEntity;
import com.arangodb.entity.DocumentEntity;
import com.arangodb.model.DocumentCreateOptions;
import com.arangodb.springframework.core.ArangoOperations;
import com.sample.app.entity.Employee;
@SpringBootApplication
public class App {
@Autowired
private ArangoOperations arangoTemplate;
public static void main(String args[]) {
SpringApplication.run(App.class, args);
}
@Bean
public CommandLineRunner demo() {
return (args) -> {
Employee emp1 = new Employee(1, "Ram", "Gurram", 31);
DocumentCreateOptions docCreateOptions = new DocumentCreateOptions();
docCreateOptions.returnNew(true);
DocumentCreateEntity docEntity = (DocumentCreateEntity) arangoTemplate.insert(emp1, docCreateOptions);
System.out.println("Document created");
System.out.println("id : " + docEntity.getId());
System.out.println("key : " + docEntity.getKey());
System.out.println("revision : " + docEntity.getRev());
System.out.println("doc : " + docEntity.getNew());
};
}
}
Total project structure looks like below.
Run App.java, you will see below messages in console.
Document created
id : employees/32343
key : 32343
revision : _cUYTPci---
doc : {"_key":"32343","_id":"employees\/32343","_rev":"_cUYTPci---","id":1,"firstName":"Ram","lastName":"Gurram","age":31,"_class":"com.sample.app.entity.Employee"}
You can download complete working application from below link.
https://github.com/harikrishna553/springboot/tree/master/arangodb/arango-template-create-document
No comments:
Post a Comment