Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ public int hashCode() {

@Override
public String toString() {
return metadataEntry;
return toMinimalString();
Comment thread
ArbaazKhan1 marked this conversation as resolved.
Outdated
}

public static StoredTabletFile of(final Text metadataEntry) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map.Entry;
Expand All @@ -40,7 +41,11 @@
import org.apache.accumulo.core.data.Range;
import org.apache.accumulo.core.data.Value;
import org.apache.accumulo.core.iterators.SortedKeyValueIterator;
import org.apache.accumulo.core.metadata.StoredTabletFile;
import org.apache.accumulo.core.metadata.SystemTables;
import org.apache.accumulo.core.metadata.schema.MetadataSchema;
import org.apache.accumulo.core.security.Authorizations;
import org.apache.accumulo.core.util.format.DefaultFormatter;
import org.apache.accumulo.core.util.format.Formatter;
import org.apache.accumulo.core.util.format.FormatterConfig;
import org.apache.accumulo.shell.Shell;
Expand Down Expand Up @@ -75,6 +80,7 @@ public class ScanCommand extends Command {
protected Option contextOpt;
private Option executionHintsOpt;
private Option scanServerOpt;
private Option decodeMetadataOpt;

protected void setupSampling(final String tableName, final CommandLine cl, final Shell shellState,
ScannerBase scanner)
Expand Down Expand Up @@ -155,12 +161,54 @@ public int execute(final String fullCommand, final CommandLine cl, final Shell s
Shell.log.error("Invalid length argument", iae);
}
}
printRecords(cl, shellState, config, scanner, formatter, printFile);
boolean decodeMetadata = cl.hasOption(decodeMetadataOpt.getLongOpt())
&& (tableName.equals(SystemTables.METADATA.tableName())
|| tableName.equals(SystemTables.ROOT.tableName()));

if (decodeMetadata) {
printRecordsWithDecodedRanges(cl, shellState, config, scanner, printFile);
} else {
printRecords(cl, shellState, config, scanner, formatter, printFile);
}
}

return 0;
}

private void printRecordsWithDecodedRanges(final CommandLine cl, final Shell shellState,
final FormatterConfig config, final Scanner scanner, final PrintFile printFile)
throws IOException {

final Text fileCf = new Text(MetadataSchema.TabletsSection.DataFileColumnFamily.STR_NAME);
final Text scanCf = new Text(MetadataSchema.TabletsSection.ScanFileColumnFamily.STR_NAME);

final List<String> lines = new ArrayList<>();

for (Entry<Key,Value> entry : scanner) {
Text cf = entry.getKey().getColumnFamily();

if (fileCf.equals(cf) || scanCf.equals(cf)) {
String metadataRow = entry.getKey().getRow().toString();
String cq = entry.getKey().getColumnQualifier().toString();
try {
StoredTabletFile stf = StoredTabletFile.of(cq);
lines.add(metadataRow + "\t" + stf.toMinimalString());
} catch (RuntimeException e) {
lines.add(DefaultFormatter.formatEntry(entry, config));
}
} else {
// All non-file columns (loc:, srv:, ~tab:, etc.) use normal formatting
lines.add(DefaultFormatter.formatEntry(entry, config));
}
}

if (printFile == null) {
shellState.printLines(lines.iterator(), !cl.hasOption(disablePaginationOpt.getOpt()));
} else {
shellState.printLines(lines.iterator(), false, printFile);
}
}

protected boolean getUseSample(CommandLine cl) {
return cl.hasOption(sampleOpt.getLongOpt());
}
Expand Down Expand Up @@ -352,6 +400,8 @@ public Options getOptions() {
executionHintsOpt = new Option(null, "execution-hints", true, "Execution hints map");
scanServerOpt =
new Option("cl", "consistency-level", true, "set consistency level (experimental)");
decodeMetadataOpt = new Option("dm", "decode-metadata", false,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that we need an option. If the user has the ability to scan the metadata, then we should just show them the un-obfuscated metadata entry.

@phrocker phrocker Aug 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't accumulo already have formatters? metadataformatter that extends default formatter could be a better option and obviate the need for an option. also could be default?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good idea, but I think the intention is to remove formatters. See #3265.

@phrocker phrocker Aug 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, thank you. I encountered this last year sometime when testing 4.0, but I have a very poor memory....

Should this option be flipped? On by default, old method an option just in case someone relies on the encoded form?

I think it's pretty fair to say 4.0 changes the output, though.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My goal was to avoid changing the normal metadata scan output in a way that might make users think that the decoded form is the actual stored metadata representation. I figured adding a new option, allows for the default behavior to remain unchanged, and users only get the decoded/human-readable form when they explicitly ask for it

"Decode fenced file row ranges from metadata and root tables");

scanOptAuths.setArgName("comma-separated-authorizations");
scanOptRow.setArgName("row");
Expand All @@ -366,6 +416,7 @@ public Options getOptions() {
contextOpt.setArgName("context");
executionHintsOpt.setArgName("<key>=<value>{,<key>=<value>}");
scanServerOpt.setArgName("immediate|eventual");
decodeMetadataOpt.setArgName("decode-metadata");

profileOpt = new Option("pn", "profile", true, "iterator profile name");
profileOpt.setArgName("profile");
Expand Down Expand Up @@ -398,6 +449,7 @@ public Options getOptions() {
o.addOption(contextOpt);
o.addOption(executionHintsOpt);
o.addOption(scanServerOpt);
o.addOption(decodeMetadataOpt);

return o;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,8 @@ public class FileMetadataUtil {
StoredTabletFile file = fileEntry.getKey();
DataFileValue dfv = fileEntry.getValue();
files.put(file, dfv);
log.debug("Extent: " + tabletMetadata.getExtent() + "; File Name: " + file.getFileName()
+ "; Range: " + file.getRange() + "; Entries: " + dfv.getNumEntries() + ", Size: "
+ dfv.getSize());
log.debug("Extent: {}; File: {}; Entries: {}; Size: {}", tabletMetadata.getExtent(), file,
Comment thread
ArbaazKhan1 marked this conversation as resolved.
Outdated
dfv.getNumEntries(), dfv.getSize());
i++;
}
}
Expand Down