Distributed Garbage Collector (run-dgc)

Edit online

run-dgc is a utility that causes the specified cluster to perform distributed garbage collection (DGC). Use run-dgc to force a periodic DGC cycle in environments where inline DGC is not in effect. However, automated DGC collection is sufficient for most environments.

This utility relies on the Terracotta Management Server (TMS) to locate and execute backups. The TMS must be running and connected to the TSA for the DGC to be initiated. For more information about connecting the Terracotta Management Server to the TSA, see the Terracotta Management Console User Guide.

For Microsoft Windows: 

[PROMPT] %BIGMEMORY_HOME%\tools\management-console\bin\run-dgc.bat <args>

For UNIX/Linux: 

[PROMPT] ${BIGMEMORY_HOME}/tools/management-console/bin/run-dgc.sh <args>

where <args> are:

  • [l] <tms-host:port> – The host and port used to connect to the TMS. If omitted, localhost:9889 is used by default.
  • [u] <username> – If the TMS requires authentication, a username must be specified.
  • [p] <password> – If the TMS requires authentication, a password must be specified.
  • [a] <agentID> – Specify the agent ID of a TSA. The agent ID is set as a connection name when the connection to the TSA is configured on the TMS. If no agent ID is provided, the TMS returns a list of configured agent IDs.
  • [k] This flag causes invalid TMS SSL certificates to be ignored.
Note: Two DGC cycles cannot run at the same time. Attempting to run a DGC cycle on a server while another DGC cycle is in progress generates an error

For more information on distributed garbage collection, see Managing Distributed Garbage Collection.