Feature/3.6/db properties (#326)

* getDatabaseProperties

* create db with options

* create db with options

* doc

* cluster test bugifx

* async tests

* DatabaseOptions: renamed minReplicationFactor to writeConcern

* doc upd

Author: rashtao

ChangeLog.md

@@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [6.5.0] - 2019-xx-xx
 
+- createDatabase with options (replicationFactor, minReplicationFactor, sharding) (ArangoDB v3.6)
+- extended DatabaseEntity with replicationFactor, minReplicationFactor, sharding (ArangoDB v3.6)
 - timeout option for AQL queries (ArangoDB v3.6)
 - enhancedNgramAnalyzer and enhancedTextAnalyzer (ArangoDB v3.6)
 

docker/start_db_cluster.sh

@@ -68,15 +68,17 @@ docker run -d -v "$LOCATION"/jwtSecret:/jwtSecret -e ARANGO_LICENSE_KEY="$ARANGO
 docker run -d -v "$LOCATION"/jwtSecret:/jwtSecret -e ARANGO_LICENSE_KEY="$ARANGO_LICENSE_KEY" --network arangodb --ip 172.28.2.2 --name dbserver2 "$1" arangodb --cluster.start-dbserver true --cluster.start-coordinator false --starter.join agent1 --auth.jwt-secret /jwtSecret
 docker run -d -v "$LOCATION"/jwtSecret:/jwtSecret -e ARANGO_LICENSE_KEY="$ARANGO_LICENSE_KEY" --network arangodb --ip 172.28.2.3 --name dbserver3 "$1" arangodb --cluster.start-dbserver true --cluster.start-coordinator false --starter.join agent1 --auth.jwt-secret /jwtSecret
 
-docker run -d -v "$LOCATION"/jwtSecret:/jwtSecret -e ARANGO_LICENSE_KEY="$ARANGO_LICENSE_KEY" --network arangodb --ip 172.28.3.1 --name coordinator1 -p 8529:8529 "$1" arangodb --cluster.start-dbserver false --cluster.start-coordinator true --starter.join agent1 --auth.jwt-secret /jwtSecret
+docker run -d -v "$LOCATION"/jwtSecret:/jwtSecret -e ARANGO_LICENSE_KEY="$ARANGO_LICENSE_KEY" --network arangodb --ip 172.28.3.1 --name coordinator1 "$1" arangodb --cluster.start-dbserver false --cluster.start-coordinator true --starter.join agent1 --auth.jwt-secret /jwtSecret
 docker run -d -v "$LOCATION"/jwtSecret:/jwtSecret -e ARANGO_LICENSE_KEY="$ARANGO_LICENSE_KEY" --network arangodb --ip 172.28.3.2 --name coordinator2 "$1" arangodb --cluster.start-dbserver false --cluster.start-coordinator true --starter.join agent1 --auth.jwt-secret /jwtSecret
+docker run -d -v "$LOCATION"/jwtSecret:/jwtSecret -e ARANGO_LICENSE_KEY="$ARANGO_LICENSE_KEY" --network arangodb --ip 172.28.3.3 --name coordinator3 "$1" arangodb --cluster.start-dbserver false --cluster.start-coordinator true --starter.join agent1 --auth.jwt-secret /jwtSecret
 
 echo "Waiting for dbservers and coordinators..."
 wait_server 172.28.2.1:8530
 wait_server 172.28.2.2:8530
 wait_server 172.28.2.3:8530
 wait_server 172.28.3.1:8529
 wait_server 172.28.3.2:8529
+wait_server 172.28.3.3:8529
 
 # wait for port mappings
 wait_server 127.0.0.1:8529

src/main/java/com/arangodb/ArangoDB.java

@@ -34,6 +34,7 @@
 import com.arangodb.internal.util.DefaultArangoSerialization;
 import com.arangodb.internal.velocystream.VstCommunicationSync;
 import com.arangodb.internal.velocystream.VstConnectionFactorySync;
+import com.arangodb.model.DBCreateOptions;
 import com.arangodb.model.LogOptions;
 import com.arangodb.model.UserCreateOptions;
 import com.arangodb.model.UserUpdateOptions;
@@ -243,12 +244,12 @@ public Builder acquireHostList(final Boolean acquireHostList) {
 			setAcquireHostList(acquireHostList);
 			return this;
 		}
-		
+
 		/**
 		 * Setting the Interval for acquireHostList
 		 *
 		 * @param acquireHostListInterval Interval in Seconds
-		 * 
+		 *
 		 * @return {@link ArangoDB.Builder}
 		 */
 		public Builder acquireHostListInterval(final Integer acquireHostListInterval) {
@@ -608,7 +609,7 @@ public synchronized ArangoDB build() {
 			final Collection<Host> hostList = createHostList(max, connectionFactory);
 			final HostResolver hostResolver = createHostResolver(hostList, max, connectionFactory);
 			final HostHandler hostHandler = createHostHandler(hostResolver);
-			
+
 			return new ArangoDBImpl(
 					new VstCommunicationSync.Builder(hostHandler).timeout(timeout).user(user).password(password)
 							.useSsl(useSsl).sslContext(sslContext).chunksize(chunksize).maxConnections(maxConnections)
@@ -653,6 +654,18 @@ public synchronized ArangoDB build() {
 	 */
 	Boolean createDatabase(String name) throws ArangoDBException;
 
+	/**
+	 * Creates a new database with the given name.
+	 *
+	 * @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#create-database">API
+	 *      Documentation</a>
+	 * @param options Creation options
+	 * @return true if the database was created successfully.
+	 * @since ArangoDB 3.6.0
+	 * @throws ArangoDBException
+	 */
+	Boolean createDatabase(DBCreateOptions options) throws ArangoDBException;
+
 	/**
 	 * Retrieves a list of all existing databases
 	 *
@@ -714,7 +727,7 @@ public synchronized ArangoDB build() {
 	 * @throws ArangoDBException
 	 */
 	ServerRole getRole() throws ArangoDBException;
-	
+
 	/**
 	 * Create a new user. This user will not have access to any database. You need permission to the _system database in
 	 * order to execute this call.

src/main/java/com/arangodb/async/ArangoDBAsync.java

@@ -38,6 +38,7 @@
 import com.arangodb.internal.util.ArangoSerializerImpl;
 import com.arangodb.internal.util.DefaultArangoSerialization;
 import com.arangodb.internal.velocystream.VstCommunicationSync;
+import com.arangodb.model.DBCreateOptions;
 import com.arangodb.model.LogOptions;
 import com.arangodb.model.UserCreateOptions;
 import com.arangodb.model.UserUpdateOptions;
@@ -97,6 +98,17 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor {
      */
     CompletableFuture<Boolean> createDatabase(final String name);
 
+    /**
+     * Creates a new database
+     *
+     * @param options Creation options
+     * @return true if the database was created successfully.
+     * @since ArangoDB 3.6.0
+     * @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#create-database">API
+     * Documentation</a>
+     */
+    CompletableFuture<Boolean> createDatabase(final DBCreateOptions options);
+
     /**
      * Retrieves a list of all existing databases
      *

src/main/java/com/arangodb/async/internal/ArangoDBAsyncImpl.java

@@ -34,6 +34,7 @@
 import com.arangodb.internal.velocystream.VstCommunicationSync;
 import com.arangodb.internal.velocystream.VstProtocol;
 import com.arangodb.internal.velocystream.internal.VstConnectionSync;
+import com.arangodb.model.DBCreateOptions;
 import com.arangodb.model.LogOptions;
 import com.arangodb.model.UserCreateOptions;
 import com.arangodb.model.UserUpdateOptions;
@@ -92,7 +93,12 @@ public ArangoDatabaseAsync db(final String name) {
 
     @Override
     public CompletableFuture<Boolean> createDatabase(final String name) {
-        return executor.execute(createDatabaseRequest(name), createDatabaseResponseDeserializer());
+        return createDatabase(new DBCreateOptions().name(name));
+    }
+
+    @Override
+    public CompletableFuture<Boolean> createDatabase(DBCreateOptions options) {
+        return executor.execute(createDatabaseRequest(options), createDatabaseResponseDeserializer());
     }
 
     @Override

src/main/java/com/arangodb/entity/DatabaseEntity.java

@@ -22,44 +22,84 @@
 
 /**
  * @author Mark Vollmary
- * 
- * @see <a href=
- *      "https://www.arangodb.com/docs/stable/http/database-database-management.html#information-of-the-database">API
- *      Documentation</a>
+ * @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html">API Documentation</a>
  */
 public class DatabaseEntity implements Entity {
 
-	private String id;
-	private String name;
-	private String path;
-	private Boolean isSystem;
+    private String id;
+    private String name;
+    private String path;
+    private Boolean isSystem;
+    private final ReplicationFactor replicationFactor;
+    private Integer writeConcern;
+    private String sharding;
 
-	/**
-	 * @return the id of the database
-	 */
-	public String getId() {
-		return id;
-	}
+    public DatabaseEntity() {
+        super();
+        replicationFactor = new ReplicationFactor();
+    }
 
-	/**
-	 * @return the name of the database
-	 */
-	public String getName() {
-		return name;
-	}
+    /**
+     * @return the id of the database
+     */
+    public String getId() {
+        return id;
+    }
 
-	/**
-	 * @return the filesystem path of the database
-	 */
-	public String getPath() {
-		return path;
-	}
+    /**
+     * @return the name of the database
+     */
+    public String getName() {
+        return name;
+    }
 
-	/**
-	 * @return whether or not the database is the _system database
-	 */
-	public Boolean getIsSystem() {
-		return isSystem;
-	}
+    /**
+     * @return the filesystem path of the database
+     */
+    public String getPath() {
+        return path;
+    }
 
+    /**
+     * @return whether or not the database is the _system database
+     */
+    public Boolean getIsSystem() {
+        return isSystem;
+    }
+
+    /**
+     * @return the default replication factor for collections in this database
+     * @since ArangoDB 3.6.0
+     */
+    public Integer getReplicationFactor() {
+        return replicationFactor.getReplicationFactor();
+    }
+
+    /**
+     * Default write concern for new collections created in this database. It determines how many copies of each shard
+     * are required to be in sync on the different DBServers. If there are less then these many copies in the cluster a
+     * shard will refuse to write. Writes to shards with enough up-to-date copies will succeed at the same time however.
+     * The value of writeConcern can not be larger than replicationFactor. (cluster only)
+     *
+     * @since ArangoDB 3.6.0
+     */
+    public Integer getWriteConcern() {
+        return writeConcern;
+    }
+
+    /**
+     * @return whether the collection is a satellite collection. Only in an enterprise cluster setup (else returning null).
+     * @since ArangoDB 3.6.0
+     */
+    public Boolean getSatellite() {
+        return this.replicationFactor.getSatellite();
+    }
+
+    /**
+     * @return information about the default sharding method for collections created in this database
+     * @since ArangoDB 3.6.0
+     */
+    public String getSharding() {
+        return sharding;
+    }
 }

src/main/java/com/arangodb/internal/ArangoDBImpl.java

@@ -34,6 +34,7 @@
 import com.arangodb.internal.util.ArangoSerializationFactory.Serializer;
 import com.arangodb.internal.velocystream.VstCommunicationSync;
 import com.arangodb.internal.velocystream.VstProtocol;
+import com.arangodb.model.DBCreateOptions;
 import com.arangodb.model.LogOptions;
 import com.arangodb.model.UserCreateOptions;
 import com.arangodb.model.UserUpdateOptions;
@@ -132,7 +133,12 @@ public ArangoDatabase db(final String name) {
 
 	@Override
 	public Boolean createDatabase(final String name) throws ArangoDBException {
-		return executor.execute(createDatabaseRequest(name), createDatabaseResponseDeserializer());
+		return createDatabase(new DBCreateOptions().name(name));
+	}
+
+	@Override
+	public Boolean createDatabase(DBCreateOptions options) throws ArangoDBException {
+		return executor.execute(createDatabaseRequest(options), createDatabaseResponseDeserializer());
 	}
 
 	@Override

src/main/java/com/arangodb/internal/InternalArangoDB.java

@@ -62,10 +62,10 @@ protected ResponseDeserializer<ServerRole> getRoleResponseDeserializer() {
 		return response -> util().deserialize(response.getBody().get("role"), ServerRole.class);
 	}
 
-	protected Request createDatabaseRequest(final String name) {
+	protected Request createDatabaseRequest(final DBCreateOptions options) {
 		final Request request = request(ArangoRequestParam.SYSTEM, RequestType.POST,
 			InternalArangoDatabase.PATH_API_DATABASE);
-		request.setBody(util().serialize(OptionsBuilder.build(new DBCreateOptions(), name)));
+		request.setBody(util().serialize(options));
 		return request;
 	}
 

src/main/java/com/arangodb/model/DBCreateOptions.java

@@ -22,28 +22,36 @@
 
 /**
  * @author Mark Vollmary
- *
  */
 public class DBCreateOptions {
 
-	private String name;
-
-	public DBCreateOptions() {
-		super();
-	}
-
-	public String getName() {
-		return name;
-	}
-
-	/**
-	 * @param name
-	 *            Has to contain a valid database name
-	 * @return options
-	 */
-	protected DBCreateOptions name(final String name) {
-		this.name = name;
-		return this;
-	}
+    private String name;
+    private DatabaseOptions options;
+
+    public DBCreateOptions() {
+        super();
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * @param name Has to contain a valid database name
+     * @return options
+     */
+    public DBCreateOptions name(final String name) {
+        this.name = name;
+        return this;
+    }
+
+    public DatabaseOptions getOptions() {
+        return options;
+    }
+
+    public DBCreateOptions options(DatabaseOptions options) {
+        this.options = options;
+        return this;
+    }
 
 }