Spear.start_scavenge
You're seeing just the function
start_scavenge
, go back to Spear module for more information.
Specs
start_scavenge(connection :: Spear.Connection.t(), opts :: Keyword.t()) :: {:ok, Spear.Scavenge.t()} | {:error, any()}
Requests that a scavenge be started
Scavenges are disk-space reclaiming operations run on the EventStoreDB server.
Options
:thread_count
- (default:1
) the number of threads to use for the scavenge process. Scavenging can be resource intensive. Setting this to a low thread count can lower the impact on the server's resources.:start_from_chunk
- (default:0
) the chunk number to start the scavenge from. Generally this is only useful if a prior scavenge has failed on a certain chunk.
Remaining options are passed to request/5
.
Examples
iex> Spear.start_scavenge(conn)
{:ok,
%Spear.Scavenge{id: "d2897ba8-2f0c-4fc4-bb25-798ba75f3562", result: :Started}}