Skip to content

Commit 689efef

Browse files
Replace names
1 parent dca3d93 commit 689efef

File tree

5 files changed

+22
-22
lines changed

5 files changed

+22
-22
lines changed

doc/modules/ROOT/pages/common-usage/monitoring-system.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ To facilitate memory management, the Neo4j GDS Library offers two memory reporti
113113
[detailed-memory-listing]
114114
=== Detailed memory listing
115115

116-
Through the `gds.listMemory` procedure, a user can obtain a combined list of their projected graphs and running tasks alongside their memory footprint.
116+
Through the `gds.memory.list` procedure, a user can obtain a combined list of their projected graphs and running tasks alongside their memory footprint.
117117

118118
For graphs, the size of the in-memory graph is returned, whereas for algorithms the memory estimation i.e., the maximum memory needs that this task is expected to require over the course of its execution.
119119

@@ -126,7 +126,7 @@ A user can access only his own graphs or tasks, but an admin can obtain informat
126126
.List the graphs and tasks of a user along with their memory footprint.
127127
[source, cypher, role=noplay]
128128
----
129-
CALL gds.listMemory()
129+
CALL gds.memory.list()
130130
YIELD
131131
user: String,
132132
name: String,
@@ -150,7 +150,7 @@ for a graph or the estimation of a task.
150150
.List running tasks and graphs for Bob.
151151
[source, cypher, role=noplay]
152152
----
153-
CALL gds.listMemory()
153+
CALL gds.memory.list()
154154
YIELD
155155
user, name, entity, memoryInBytes
156156
----
@@ -168,7 +168,7 @@ As we can see, Bob has projected a graph named 'my-graph' occupying 200 bytes m
168168
[memory-summary]
169169
=== Memory Summary
170170

171-
The `gds.listMemory.summary` procedure provides an overview of the total graph memory, and the total memory requirements of running tasks for a given users.
171+
The `gds.memory.summary` procedure provides an overview of the total graph memory, and the total memory requirements of running tasks for a given users.
172172

173173

174174
A user can access only his own graphs or tasks, but an admin can obtain information for all users.
@@ -178,7 +178,7 @@ A user can access only his own graphs or tasks, but an admin can obtain informat
178178
.List the graphs and tasks of a user along with their memory footprint.
179179
[source, cypher, role=noplay]
180180
----
181-
CALL gds.listMemory.summary()
181+
CALL gds.memory.summary()
182182
YIELD
183183
user: String,
184184
totalGraphsMemory : Intger,
@@ -199,7 +199,7 @@ YIELD
199199
.List running tasks and graphs for Bob.
200200
[source, cypher, role=noplay]
201201
----
202-
CALL gds.listMemory.summary()
202+
CALL gds.memory.summary()
203203
YIELD
204204
user, totalGraphsMemory, totalTasksMemory
205205
----

doc/modules/ROOT/pages/operations-reference/additional-operation-references.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
| xref:common-usage/debug-sysinfo.adoc[Status of the system] | `gds.debug.sysInfo` label:procedure[Procedure]
2828
| xref:installation/configure-apache-arrow-server.adoc[Monitoring] | `gds.debug.arrow` label:procedure[Procedure]
2929
| xref:common-usage/monitoring-system.adoc[Get an overview of the system's workload and available resources] | `gds.systemMonitor` label:procedure[Procedure]
30-
| xref:common-usage/monitoring-system.adoc[Detailed memory footprint reporting] | `gds.listMemory` label:procedure[Procedure]
31-
| xref:common-usage/monitoring-system.adoc[Memory footprint summary] | `gds.listMemory.summary` label:procedure[Procedure]
30+
| xref:common-usage/monitoring-system.adoc[Detailed memory footprint reporting] | `gds.memory.list` label:procedure[Procedure]
31+
| xref:common-usage/monitoring-system.adoc[Memory footprint summary] | `gds.memory.summary` label:procedure[Procedure]
3232
| xref:management-ops/backup-restore.adoc[Back-up graphs and models to disk] | `gds.backup` label:procedure[Procedure]
3333
| xref:management-ops/backup-restore.adoc[Restore persisted graphs and models to memory] | `gds.restore` label:procedure[Procedure]
3434
| xref:production-deployment/defaults-and-limits.adoc[List configured defaults] | `gds.config.defaults.list` label:procedure[Procedure]

open-packaging/src/test/java/org/neo4j/gds/OpenGdsProcedureSmokeTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -519,8 +519,8 @@ class OpenGdsProcedureSmokeTest extends BaseProcTest {
519519
"gds.prizeSteinerTree.stream",
520520
"gds.prizeSteinerTree.stream.estimate",
521521

522-
"gds.listMemory",
523-
"gds.listMemory.summary",
522+
"gds.memory.list",
523+
"gds.memory.summary",
524524

525525
"gds.version"
526526
);

proc/misc/src/integrationTest/java/org/neo4j/gds/MemoryProcTest.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ void setUp() throws Exception {
4343

4444
@Test
4545
void shouldReturnEmptyIfEmpty() {
46-
var rowCount = runQueryWithRowConsumer("CALL gds.listMemory", result->{} );
46+
var rowCount = runQueryWithRowConsumer("CALL gds.memory.list", result->{} );
4747
assertThat(rowCount).isEqualTo(0L);
4848
}
4949

5050
@Test
5151
void shouldReturnEmptySummary() {
5252
var rowCount = runQueryWithRowConsumer("alice",
53-
"CALL gds.listMemory.summary",
53+
"CALL gds.memory.summary",
5454
resultRow -> {
5555
assertThat(resultRow.getString("user")).isEqualTo("alice");
5656
assertThat(resultRow.getNumber("totalGraphsMemory")).asInstanceOf(LONG).isEqualTo(0);
@@ -63,7 +63,7 @@ void shouldReturnEmptySummary() {
6363
void shouldListGraphsAccordingly() {
6464
runQuery("alice", " CALL gds.graph.generate('random',10,1)");
6565
var rowCountAlice = runQueryWithRowConsumer("alice",
66-
"CALL gds.listMemory",
66+
"CALL gds.memory.list",
6767
resultRow -> {
6868
assertThat(resultRow.getString("user")).isEqualTo("alice");
6969
assertThat(resultRow.getString("name")).isEqualTo("random");
@@ -73,7 +73,7 @@ void shouldListGraphsAccordingly() {
7373
assertThat(rowCountAlice).isEqualTo(1L);
7474

7575
var rowCountBob = runQueryWithRowConsumer("bob",
76-
"CALL gds.listMemory",resultRow ->{}
76+
"CALL gds.memory.list",resultRow ->{}
7777
);
7878

7979
assertThat(rowCountBob).isEqualTo(0L);
@@ -83,7 +83,7 @@ void shouldListGraphsAccordingly() {
8383
void shouldSummarizeAccordingly() {
8484
runQuery("alice", " CALL gds.graph.generate('random',10,1)");
8585
var rowCountAlice = runQueryWithRowConsumer("alice",
86-
"CALL gds.listMemory",
86+
"CALL gds.memory.list",
8787
resultRow -> {
8888
assertThat(resultRow.getString("user")).isEqualTo("alice");
8989
assertThat(resultRow.getString("name")).isEqualTo("random");
@@ -94,7 +94,7 @@ void shouldSummarizeAccordingly() {
9494
assertThat(rowCountAlice).isEqualTo(1L);
9595

9696
var rowCountBob = runQueryWithRowConsumer("bob",
97-
"CALL gds.listMemory.summary",
97+
"CALL gds.memory.summary",
9898
resultRow -> {
9999
assertThat(resultRow.getString("user")).isEqualTo("bob");
100100
assertThat(resultRow.getNumber("totalGraphsMemory")).asInstanceOf(LONG).isEqualTo(0);
@@ -108,7 +108,7 @@ void shouldSummarizeAccordingly() {
108108
void canListRunningTask() {
109109
runQuery("alice","CALL gds.test.pl('foo',true,false)");
110110
var rowCountAlice = runQueryWithRowConsumer("alice",
111-
"CALL gds.listMemory",
111+
"CALL gds.memory.list",
112112
resultRow -> {
113113
assertThat(resultRow.getString("user")).isEqualTo("alice");
114114
assertThat(resultRow.getString("entity")).isNotEqualTo("graph");
@@ -117,7 +117,7 @@ void canListRunningTask() {
117117
assertThat(rowCountAlice).isEqualTo(1L);
118118

119119
var rowCountBob = runQueryWithRowConsumer("bob",
120-
"CALL gds.listMemory",resultRow ->{}
120+
"CALL gds.memory.list",resultRow ->{}
121121
);
122122

123123
assertThat(rowCountBob).isEqualTo(0L);
@@ -128,7 +128,7 @@ void canSummarizeRunningTask() {
128128
runQuery("alice","CALL gds.test.pl('foo',true,false)");
129129

130130
var rowCountAlice = runQueryWithRowConsumer("alice",
131-
"CALL gds.listMemory.summary",
131+
"CALL gds.memory.summary",
132132
resultRow -> {
133133
assertThat(resultRow.getString("user")).isEqualTo("alice");
134134
assertThat(resultRow.getNumber("totalGraphsMemory")).asInstanceOf(LONG).isEqualTo(0);
@@ -137,7 +137,7 @@ void canSummarizeRunningTask() {
137137
assertThat(rowCountAlice).isEqualTo(1L);
138138

139139
var rowCountBob = runQueryWithRowConsumer("bob",
140-
"CALL gds.listMemory.summary",
140+
"CALL gds.memory.summary",
141141
resultRow -> {
142142
assertThat(resultRow.getString("user")).isEqualTo("bob");
143143
assertThat(resultRow.getNumber("totalGraphsMemory")).asInstanceOf(LONG).isEqualTo(0);

proc/misc/src/main/java/org/neo4j/gds/memory/MemoryProc.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ public class MemoryProc {
3434
@Context
3535
public MemoryFacade facade;
3636

37-
@Procedure("gds.listMemory")
37+
@Procedure("gds.memory.list")
3838
@Description(DESCRIPTION)
3939
public Stream<UserEntityMemory> listMemory() {
4040
return facade.list();
4141
}
4242

43-
@Procedure("gds.listMemory.summary")
43+
@Procedure("gds.memory.summary")
4444
@Description(DESCRIPTION)
4545
public Stream<UserMemorySummary> summary() {
4646
return facade.memorySummary();

0 commit comments

Comments
 (0)