Skip to content

Commit 6325fca

Browse files
Update Java embdedded docs to remove ClusterDatabaseManagementServiceBuilder (#161) (#162)
* Update Java embdedded docs to remove ClusterDatabaseManagementServiceBuilder That class does not exist in 5. Also updating various example pieces of code to reflect the current contents of the example files * Update modules/ROOT/pages/java-embedded/setup.adoc --------- Co-authored-by: Nick Giles <100630647+nick-giles-neo@users.noreply.github.com>
1 parent 78e8197 commit 6325fca

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

modules/ROOT/pages/java-embedded/setup.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
:org-neo4j-dbms-DatabaseManagementService: {neo4j-javadocs-base-uri}/org/neo4j/dbms/api/DatabaseManagementService.html
44
:org-neo4j-graphdb-GraphDatabaseService: {neo4j-javadocs-base-uri}/org/neo4j/graphdb/GraphDatabaseService.html
55
:com-neo4j-dbms-api-EnterpriseDatabaseManagementServiceBuilder: {neo4j-javadocs-base-uri}/com/neo4j/dbms/api/EnterpriseDatabaseManagementServiceBuilder.html
6-
:com-neo4j-dbms-api-ClusterDatabaseManagementServiceBuilder: {neo4j-javadocs-base-uri}/com/neo4j/dbms/api/ClusterDatabaseManagementServiceBuilder.html
76

87
[[java-embedded-setup]]
98
= Embedding Neo4j in your Java application
@@ -126,9 +125,8 @@ registerShutdownHook( managementService );
126125
----
127126

128127

129-
If you are using the Enterprise Edition of Neo4j in embedded standalone mode, you have to create your database with the link:{com-neo4j-dbms-api-EnterpriseDatabaseManagementServiceBuilder}[`com.neo4j.dbms.api.EnterpriseDatabaseManagementServiceBuilder`^] to enable the Enterprise Edition features.
130-
131-
If you are intending to operate embedded clusters, then you should use the link:{com-neo4j-dbms-api-ClusterDatabaseManagementServiceBuilder}[`com.neo4j.dbms.api.ClusterDatabaseManagementServiceBuilder`^] with the appropriate configuration.
128+
If you are using the Enterprise Edition of Neo4j in embedded mode, you have to create your database with the link:{com-neo4j-dbms-api-EnterpriseDatabaseManagementServiceBuilder}[`com.neo4j.dbms.api.EnterpriseDatabaseManagementServiceBuilder`^] to enable the Enterprise Edition features.
129+
If you intend to operate embedded clusters, you need to provide the appropriate configuration to the instances you create (for example ports and discovery endpoints).
132130
For maintainability purposes, you can define your embedded DBMS configuration in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/neo4j-conf[_neo4j.conf_] file as follows:
133131

134132
//https://github.com/neo4j/neo4j-documentation/blob/dev/embedded-examples/src/main/java/org/neo4j/examples/EmbeddedNeo4jClusterUsingBuilder.java
@@ -149,8 +147,8 @@ server.http.enabled=true
149147

150148
[source, java]
151149
----
152-
var managementService = new ClusterDatabaseManagementServiceBuilder( homeDirectory )
153-
.loadPropertiesFromFile( "/path/to/neo4j.conf" )
150+
var managementService = new EnterpriseDatabaseManagementServiceBuilder( homeDirectory )
151+
.loadPropertiesFromFile( Path.of( "/path/to/neo4j.conf" ) )
154152
.build();
155153
----
156154

@@ -170,11 +168,12 @@ var initialMembers = List.of(
170168
new SocketAddress( "core03.example.com" )
171169
);
172170
173-
var managementService = new ClusterDatabaseManagementServiceBuilder( homeDirectory )
171+
var managementService = new EnterpriseDatabaseManagementServiceBuilder( homeDirectory )
174172
.setConfig( GraphDatabaseSettings.default_advertised_address, defaultAdvertised )
175173
.setConfig( GraphDatabaseSettings.default_listen_address, defaultListen )
176-
.setConfig( DiscoverySettings.discovery_type, DiscoveryType.LIST )
177-
.setConfig( DiscoverySettings.discovery_endpoints, initialMembers )
174+
.setConfig( ClusterSettings.discovery_type, DiscoveryType.LIST )
175+
.setConfig( ClusterSettings.discovery_endpoints, initialMembers )
176+
.setConfig( EnterpriseEditionSettings.initial_default_primaries_count, 3 )
178177
.setConfig( BoltConnector.enabled, true )
179178
.setConfig( HttpConnector.enabled, true )
180179
.build();
@@ -234,7 +233,7 @@ To start Neo4j with configuration settings, a Neo4j properties file can be loade
234233
[source, java]
235234
----
236235
DatabaseManagementService managementService = new DatabaseManagementServiceBuilder( directory )
237-
.loadPropertiesFromFile( pathToConfig + "neo4j.conf" ).build();
236+
.loadPropertiesFromFile( Path.of( pathToConfig + "neo4j.conf" ) ).build();
238237
GraphDatabaseService graphDb = managementService.database( DEFAULT_DATABASE_NAME );
239238
----
240239

@@ -245,8 +244,8 @@ Configuration settings can also be applied programmatically, as follows:
245244

246245
[source, java]
247246
----
248-
DatabaseManagementService managementService = new DatabaseManagementServiceBuilder( directory)
249-
.setConfig( GraphDatabaseSettings.pagecache_memory, "512M" )
247+
DatabaseManagementService managementService = new DatabaseManagementServiceBuilder( directory )
248+
.setConfig( GraphDatabaseSettings.pagecache_memory, ByteUnit.mebiBytes( 512 ) )
250249
.setConfig( GraphDatabaseSettings.transaction_timeout, Duration.ofSeconds( 60 ) )
251250
.setConfig( GraphDatabaseSettings.preallocate_logical_logs, true ).build();
252251
GraphDatabaseService graphDb = managementService.database( DEFAULT_DATABASE_NAME );

0 commit comments

Comments
 (0)