Skip to content

Commit

Permalink
HDDS-11775. Add tool to create RocksDB checkpoint (#7664)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tejaskriya authored Jan 19, 2025
1 parent 98b4e55 commit 7239594
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,9 @@ Test ozone debug ldb scan with filter option failure
# test filter option for lesser/greater operator on non-numeric field
${output} = Execute And Ignore Error ozone debug ldb --db=/data/metadata/om.db scan --cf=keyTable --filter="keyName:lesser:k1"
Should contain ${output} only on numeric values

Test ozone debug ldb checkpoint command
${output} = Execute ozone debug ldb --db=/data/metadata/om.db checkpoint --output=/data/metadata/checkpoint1.db
Should contain ${output} Created checkpoint at
${output} = Execute ls /data/metadata/checkpoint1.db
Should contain ${output} .sst
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.ozone.debug.ldb;

import org.apache.hadoop.hdds.cli.AbstractSubcommand;
import org.apache.hadoop.hdds.utils.db.managed.ManagedCheckpoint;
import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksDB;
import org.apache.hadoop.ozone.debug.RocksDBUtils;
import org.rocksdb.ColumnFamilyDescriptor;
import org.rocksdb.ColumnFamilyHandle;
import picocli.CommandLine;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;

/**
* Create a checkpoint for a rocksDB.
*/
@CommandLine.Command(
name = "checkpoint",
description = "Create checkpoint for specified db"
)
public class Checkpoint extends AbstractSubcommand implements Callable<Void> {
@CommandLine.Option(names = {"--output"},
required = true,
description = "Path to output directory for the checkpoint.")
private String outputPath;

@CommandLine.ParentCommand
private RDBParser parent;

@Override
public Void call() throws Exception {
List<ColumnFamilyDescriptor> cfDescList =
RocksDBUtils.getColumnFamilyDescriptors(parent.getDbPath());
final List<ColumnFamilyHandle> cfHandleList = new ArrayList<>();

// Create checkpoint
try (ManagedRocksDB db = ManagedRocksDB.openReadOnly(
parent.getDbPath(), cfDescList, cfHandleList)) {
ManagedCheckpoint cp = ManagedCheckpoint.create(db);
cp.get().createCheckpoint(outputPath);
out().println("Created checkpoint at " + outputPath);
}
return null;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
DropTable.class,
ListTables.class,
ValueSchema.class,
Checkpoint.class,
},
description = "Parse rocksdb file content")
@MetaInfServices(DebugSubcommand.class)
Expand Down

0 comments on commit 7239594

Please sign in to comment.