Spring data: ArangoDB: CollectionOperations: read the properties of a collection

CollectionOperations interface provides 'getProperties' method to get properties of the specified collection.

 

Signature

CollectionPropertiesEntity getProperties() throws DataAccessException;

 

Example

CollectionOperations empsCollection = arangoTemplate.collection(Employee.class);
CollectionPropertiesEntity collectionPropertiesEntity = empsCollection.getProperties();

 

Find the below working application.

 

Step 1: Create new maven project ‘collection-operations-collection-properties’.

 

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>collection-operations-collection-properties</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, Integer age) {
        super();
        this.id = id;
        this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
    }

    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.Arrays;

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.CollectionPropertiesEntity;
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 static void printCollectionProperties(CollectionPropertiesEntity collectionPropertiesEntity) {
        System.out.println("id :  " + collectionPropertiesEntity.getId());
        System.out.println("name : " + collectionPropertiesEntity.getName());
        System.out.println("Sharding strategy : " + collectionPropertiesEntity.getShardingStrategy());
        System.out.println("Smart join attribute : " + collectionPropertiesEntity.getSmartJoinAttribute());
        System.out.println("Index buckets : " + collectionPropertiesEntity.getIndexBuckets());
        System.out.println("Journal size : " + collectionPropertiesEntity.getJournalSize());
        System.out.println("Minimum replication factor : " + collectionPropertiesEntity.getMinReplicationFactor());
        System.out.println("Number of shards " + collectionPropertiesEntity.getNumberOfShards());
    }

    @Bean
    public CommandLineRunner demo() {

        return (args) -> {
            Employee emp1 = new Employee(1, "Krishna", "Gurram", 33);
            Employee emp2 = new Employee(2, "Lahari", "G", 20);
            Employee emp3 = new Employee(3, "Thulasi", "G", 19);

            arangoTemplate.insert(Arrays.asList(emp1, emp2, emp3), Employee.class);

            Iterable<Employee> empsIterable = arangoTemplate.findAll(Employee.class);

            System.out.println("Documents in employees collection");
            for (Employee emp : empsIterable) {
                System.out.println(emp);
            }

            CollectionOperations empsCollection = arangoTemplate.collection(Employee.class);

            CollectionPropertiesEntity collectionPropertiesEntity = empsCollection.getProperties();
            printCollectionProperties(collectionPropertiesEntity);

            System.out.println("\nDropping the collection");

            empsCollection.drop();

        };
    }
}

 

Total project structure looks like below.

 

 

Run App.java, you will see below messages in console.

Documents in employees collection
Employee [key=50242, arangoId=employees/50242, id=1, firstName=Krishna, lastName=Gurram, age=33]
Employee [key=50243, arangoId=employees/50243, id=2, firstName=Lahari, lastName=G, age=20]
Employee [key=50244, arangoId=employees/50244, id=3, firstName=Thulasi, lastName=G, age=19]
id :  50237
name : employees
Sharding strategy : null
Smart join attribute : null
Index buckets : null
Journal size : null
Minimum replication factor : null
Number of shards null

Dropping the collection

 

You can download complete working application from below link.

https://github.com/harikrishna553/springboot/tree/master/arangodb/collection-operations-collection-properties

 

 

 

Previous                                                 Next                                                 Home