Spring Data ArangoOperations interface provides delete() method to delete a document by id or key.
Signature
DocumentEntity delete(Object id, Class<?> entityClass) throws DataAccessException;
DocumentEntity delete(Object id, Class<?> entityClass, DocumentDeleteOptions options) throws DataAccessException;
Deletes the document with the given id from a collection.
‘DocumentDeleteOptions’ is used to add additional options while deleting the document.
Below table summarizes the options can be passed using DocumentDeleteOptions.
|
Option |
Data type |
Description |
|
waitForSync |
Boolean |
Wait until deletion operation has been synced to disk. |
|
ifMatch |
String |
remove a document based on a target revision |
|
returnOld |
Boolean |
Return additionally the complete previous revision of the changed document under the attribute old in the result. |
|
silent |
Boolean |
If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. |
|
streamTransactionId |
String |
If set, the operation will be executed within the transaction. |
Example
DocumentDeleteOptions deleteOptions = new DocumentDeleteOptions();
deleteOptions.returnOld(true);
DocumentDeleteEntity docDeleteEntity = (DocumentDeleteEntity) arangoTemplate.delete(docId, Employee.class,deleteOptions);
Find the below working application.
Step 1: Create new maven project 'arango-template-delete-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-delete-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 com.arangodb.springframework.annotation.ArangoId;
import com.arangodb.springframework.annotation.Document;
import org.springframework.data.annotation.Id;
@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(Integer id, String firstName, String lastName) {
super();
this.id = id;
this.firstName = firstName;
this.lastName = lastName;
}
public Employee() {
}
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 [key=" + key + ", arangoId=" + arangoId + ", id=" + id + ", firstName=" + firstName
+ ", lastName=" + lastName + ", age=" + age + "]";
}
}
Step 4: Define arango 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 java.util.Iterator;
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.DocumentDeleteEntity;
import com.arangodb.entity.DocumentEntity;
import com.arangodb.model.DocumentDeleteOptions;
import com.arangodb.springframework.core.ArangoOperations;
import com.arangodb.springframework.core.CollectionOperations;
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);
}
private void printAllEmps() {
Iterable<Employee> empsIterable = arangoTemplate.findAll(Employee.class);
Iterator<Employee> empsIterator = empsIterable.iterator();
if (!empsIterator.hasNext()) {
System.out.println("\nNo documents present in the collection");
} else {
for (Employee emp : empsIterable) {
System.out.println(emp);
}
}
}
@Bean
public CommandLineRunner demo() {
return (args) -> {
CollectionOperations empsCollection = arangoTemplate.collection(Employee.class);
empsCollection.drop();
Employee emp1 = new Employee(1, "Shanmukha Rao", "Kummari");
DocumentEntity docEntity = arangoTemplate.insert(emp1);
printAllEmps();
String docId = docEntity.getId();
DocumentDeleteOptions deleteOptions = new DocumentDeleteOptions();
deleteOptions.returnOld(true);
DocumentDeleteEntity docDeleteEntity = (DocumentDeleteEntity) arangoTemplate.delete(docId, Employee.class,
deleteOptions);
System.out.println("\nDeleted document : " + docDeleteEntity.getOld());
printAllEmps();
};
}
}
Total project structure looks like below.
Run App.java, you will see below messages in console.
Employee [key=39476, arangoId=employees/39476, id=1, firstName=Shanmukha Rao, lastName=Kummari, age=null] Deleted document : Employee [key=null, arangoId=null, id=1, firstName=Shanmukha Rao, lastName=Kummari, age=null] No documents present in the collection
You can download complete working application from below link.
https://github.com/harikrishna553/springboot/tree/master/arangodb/arango-template-delete-document
No comments:
Post a Comment