Skip to content

Commit

Permalink
Introduce checkpoint command for ldb
Browse files Browse the repository at this point in the history
  • Loading branch information
tejaskriya committed Jan 10, 2025
1 parent 397ae90 commit 3024fa2
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 32 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* 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.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.io.PrintWriter;
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 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;

@CommandLine.Spec
private static CommandLine.Model.CommandSpec spec;

@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;
}

private static PrintWriter out() {
return spec.commandLine().getOut();
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
import org.apache.hadoop.hdds.utils.db.FixedLengthStringCodec;
import org.apache.hadoop.hdds.utils.db.LongCodec;
import org.apache.hadoop.hdds.utils.db.RocksDatabase;
import org.apache.hadoop.hdds.utils.db.managed.ManagedCheckpoint;
import org.apache.hadoop.hdds.utils.db.managed.ManagedReadOptions;
import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksDB;
import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksIterator;
Expand Down Expand Up @@ -66,7 +65,6 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.UUID;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
Expand Down Expand Up @@ -201,28 +199,9 @@ public Void call() throws Exception {
parent.getDbPath().contains(OzoneConsts.CONTAINER_DB_NAME);

boolean success;
if (parent.getCheckpoint()) {
String checkpointDir = parent.getDbPath() + "/checkpoint-ldb-" + (new Random()).nextInt(100);
// Create checkpoint
try (ManagedRocksDB db = ManagedRocksDB.openReadOnly(
parent.getDbPath(), cfDescList, cfHandleList)) {
ManagedCheckpoint cp = ManagedCheckpoint.create(db);
cp.get().createCheckpoint(checkpointDir);
err().println("Created checkpoint at " + checkpointDir);
}
//Use the checkpoint for ldb operations
List<ColumnFamilyDescriptor> cfDescListForCheckpoint =
RocksDBUtils.getColumnFamilyDescriptors(checkpointDir);
final List<ColumnFamilyHandle> cfHandleListForCheckpoint = new ArrayList<>();
try (ManagedRocksDB db = ManagedRocksDB.openReadOnly(
checkpointDir, cfDescListForCheckpoint, cfHandleListForCheckpoint)) {
success = printTable(cfHandleListForCheckpoint, db, parent.getDbPath(), schemaV3);
}
} else {
try (ManagedRocksDB db = ManagedRocksDB.openReadOnly(
parent.getDbPath(), cfDescList, cfHandleList)) {
success = printTable(cfHandleList, db, parent.getDbPath(), schemaV3);
}
try (ManagedRocksDB db = ManagedRocksDB.openReadOnly(
parent.getDbPath(), cfDescList, cfHandleList)) {
success = printTable(cfHandleList, db, parent.getDbPath(), schemaV3);
}

if (!success) {
Expand Down
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 All @@ -43,18 +44,10 @@ public class RDBParser implements DebugSubcommand {
description = "Database File Path")
private String dbPath;

@CommandLine.Option(names = {"--checkpoint"},
description = "Create a checkpoint on the DB passed to use for the operations.")
private boolean checkpoint;

public String getDbPath() {
return dbPath;
}

public boolean getCheckpoint() {
return checkpoint;
}

public void setDbPath(String dbPath) {
this.dbPath = dbPath;
}
Expand Down

0 comments on commit 3024fa2

Please sign in to comment.