Compact Database Operation

Compact documents:

The following example will compact only documents for the specified database.

// Define the compact settings
$settings = new CompactSettings();
$settings->setDatabaseName("Northwind");
// Set 'Documents' to true to compact all documents in database
// Indexes are not set and will not be compacted
$settings->setDocuments(true);


// Define the compact operation, pass the settings
/** @var OperationIdResult  $compactOp */
$compactOp = new CompactDatabaseOperation($settings);

// Execute compaction by passing the operation to Maintenance.Server.Send
/** @var Operation $operation */
$operation = $documentStore->maintenance()->server()->send($compactOp);

// Wait for operation to complete, during compaction the database is offline
$operation->waitForCompletion();

Compact specific indexes:

The following example will compact only specific indexes.

// Define the compact settings
$settings = new CompactSettings();

// Database to compact
$settings->setDatabaseName("Northwind");

// Setting 'Documents' to false will compact only the specified indexes
$settings->setDocuments(false);

// Specify which indexes to compact
$settings->setIndexes([ "Orders/Totals", "Orders/ByCompany" ]);

// Optimize indexes is Lucene's feature to gain disk space and efficiency
// Set whether to skip this optimization when compacting the indexes
$settings->setSkipOptimizeIndexes(false);


// Define the compact operation, pass the settings
/** @var OperationIdResult $compactOp */
$compactOp = new CompactDatabaseOperation($settings);

// Execute compaction by passing the operation to Maintenance.Server.Send
/** @var Operation $operation */
$operation = $documentStore->maintenance()->server()->send($compactOp);
// Wait for operation to complete
$operation->waitForCompletion();

Compact all indexes:

The following example will compact all indexes and documents.

// Get all indexes names in the database using the 'GetIndexNamesOperation' operation
// Use 'ForDatabase' if the target database is different than the default database defined on the store
/** @var StringArrayResult $allIndexNames */
$allIndexNames = $documentStore->maintenance()->forDatabase("Northwind")
        ->send(new GetIndexNamesOperation(0, PhpClient::INT_MAX_VALUE));

// Define the compact settings
$settings = new CompactSettings();
$settings->setDatabaseName("Northwind");    // Database to compact
$settings->setDocuments(true);              // Compact all documents
$settings->setIndexes($allIndexNames->getArrayCopy());      // All indexes will be compacted
$settings->setSkipOptimizeIndexes(true);    // Skip Lucene's indexes optimization

// Define the compact operation, pass the settings
/** @var OperationIdResult $compactOp */
$compactOp = new CompactDatabaseOperation($settings);

// Execute compaction by passing the operation to Maintenance.Server.Send
/** @var Operation $operation */
$operation = $documentStore->maintenance()->server()->send($compactOp);

// Wait for operation to complete
$operation->waitForCompletion();

Compact on other nodes:

• By default, an operation executes on the server node that is defined by the client configuration.
• The following example will compact the database on all member nodes from its database-group topology.
  forNode is used to execute the operation on a specific node.

// Get all member nodes in the database-group using the 'GetDatabaseRecordOperation' operation
/** @var DatabaseRecordWithEtag $databaseRecord */
$databaseRecord = $documentStore->maintenance()->server()->send(new GetDatabaseRecordOperation("Northwind"));

$allMemberNodes = $databaseRecord->getTopology()->getMembers();

// Define the compact settings as needed
$settings = new CompactSettings();

$settings->setDatabaseName("Northwind");
$settings->setDocuments(true); //Compact all documents in database

// Execute the compact operation on each member node
foreach ($allMemberNodes as $nodeTag) {
    // Define the compact operation, pass the settings
    /** @var OperationIdResult $compactOp */
    $compactOp = new CompactDatabaseOperation($settings);

    // Execute the operation on a specific node
    // Use `ForNode` to specify the node to operate on
    /** @var Operation $operation */
    $operation = $documentStore->maintenance()->server()->forNode($nodeTag)->send($compactOp);
    // Wait for operation to complete
    $operation->waitForCompletion();
}

• When document compression is turned on, compression is applied to the documents when:

  • New documents that are created and saved.
  • Existing documents that are modified and saved.

• You can use the compaction operation to compress existing documents without having to modify and save them.
  Executing compaction triggers compression on ALL existing documents for the collections that are configured for compression.

• Learn more about Compression -vs- Compaction here.

• Compaction can be triggered from the Storage Report view in the Studio.
  The operation will compact the database only on the node being viewed (node info is in the Studio footer).

• To compact the database on another node,
  simply trigger compaction from the Storage Report view in a browser tab opened for that other node.

public CompactDatabaseOperation(CompactSettings compactSettings)