hemantk-12 commented on code in PR #3784: URL: https://github.com/apache/ozone/pull/3784#discussion_r1010985671
########## hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/OzoneSnapshot.java: ########## @@ -0,0 +1,120 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.client; + +import org.apache.hadoop.ozone.om.helpers.SnapshotInfo; +import org.apache.hadoop.ozone.om.helpers.WithMetadata; + +/** + * A class that encapsulates OzoneSnapshot. + */ +public class OzoneSnapshot extends WithMetadata { Review Comment: QQ: What's the purpose of `OzoneSnapshot`? or how is it different from `SnapshotInfo`? Is `OzoneSnapshot` for client while `OzoneSnapshot` for server? ########## hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/rpc/RpcClient.java: ########## @@ -931,6 +932,31 @@ public String createSnapshot(String volumeName, bucketName, snapshotName); } + /** + * List snapshots in a volume/bucket. + * @param volumeName volume name + * @param bucketName bucket name + * @return list of snapshot name + * @throws IOException + */ + @Override + public List<OzoneSnapshot> listSnapshot(String volumeName, String bucketName) + throws IOException { + Preconditions.checkArgument(Strings.isNotBlank(volumeName), + "volume can't be null or empty."); + Preconditions.checkArgument(Strings.isNotBlank(bucketName), + "bucket can't be null or empty."); + return ozoneManagerClient.listSnapshot(volumeName, bucketName).stream() Review Comment: May be create a function `toOzoneSnapshot` in `SnapshotInfo`. ``` return ozoneManagerClient.listSnapshot(volumeName, bucketName).stream() .map(snapshotInfo::toOzoneSnapshot) .collect(Collectors.toList()); ``` Or `fromSnapshotInfo` in `OzoneSnapshot` ``` return ozoneManagerClient.listSnapshot(volumeName, bucketName).stream() .map(snapshotInfo -> OzoneSnapshot.fromSnapshotInfo(snapshotInfo)) .collect(Collectors.toList()); ``` ########## hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/protocol/ClientProtocol.java: ########## @@ -968,5 +969,14 @@ Map<DatanodeDetails, OzoneInputStream>> getKeysEveryReplicas( */ String createSnapshot(String volumeName, String bucketName, String snapshotName) throws IOException; - + + /** + * List snapshots in a volume/bucket. + * @param volumeName volume name + * @param bucketName bucket name + * @return list of snapshot name + * @throws IOException + */ + List<OzoneSnapshot> listSnapshot(String volumeName, String bucketName) Review Comment: Just curious why this API is not paginated? ########## hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OmMetadataManagerImpl.java: ########## @@ -1125,6 +1125,69 @@ public List<RepeatedOmKeyInfo> listTrash(String volumeName, String bucketName, return deletedKeys; } + @Override + public List<SnapshotInfo> listSnapshot(String volumeName, String bucketName) + throws IOException { + if (Strings.isNullOrEmpty(volumeName)) { + throw new OMException("Volume name is required.", + ResultCodes.VOLUME_NOT_FOUND); + } + + if (Strings.isNullOrEmpty(bucketName)) { + throw new OMException("Bucket name is required.", + ResultCodes.BUCKET_NOT_FOUND); + } + + List<SnapshotInfo> snapshotInfos = new ArrayList<>(); + TreeMap<String, SnapshotInfo> snapshotInfoMap = new TreeMap<>(); + + snapshotInfoMap.putAll(getSnapshotFromCache()); + snapshotInfoMap.putAll(getSnapshotFromDB()); + + for (Map.Entry<String, SnapshotInfo> cacheKey : snapshotInfoMap + .entrySet()) { + snapshotInfos.add(cacheKey.getValue()); + } + + return snapshotInfos; + } + + private TreeMap<String, SnapshotInfo> getSnapshotFromCache() { + TreeMap<String, SnapshotInfo> result = new TreeMap<>(); + Iterator<Map.Entry<CacheKey<String>, CacheValue<SnapshotInfo>>> iterator = + snapshotInfoTable.cacheIterator(); + while (iterator.hasNext()) { + Map.Entry<CacheKey<String>, CacheValue<SnapshotInfo>> entry = + iterator.next(); + String snapshotKey = entry.getKey().getCacheKey(); + SnapshotInfo snapshotInfo = entry.getValue().getCacheValue(); + if (snapshotInfo != null) { + result.put(snapshotKey, snapshotInfo); + } + } + return result; + } + + private TreeMap<String, SnapshotInfo> getSnapshotFromDB() throws IOException { + TreeMap<String, SnapshotInfo> result = new TreeMap<>(); + try (TableIterator<String, ? extends KeyValue<String, SnapshotInfo>> + snapshotIter = snapshotInfoTable.iterator()) { + KeyValue< String, SnapshotInfo> snapshotinfo; + while (snapshotIter.hasNext()) { + snapshotinfo = snapshotIter.next(); + if (snapshotinfo != null) { + CacheValue<SnapshotInfo> cacheValue = + snapshotInfoTable.getCacheValue( + new CacheKey<>(snapshotinfo.getKey())); + if (cacheValue == null) { Review Comment: +1 Do you mean that cache will fetch key from DB if it is cache miss? ########## hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OmMetadataManagerImpl.java: ########## @@ -1157,6 +1157,69 @@ public List<RepeatedOmKeyInfo> listTrash(String volumeName, String bucketName, return deletedKeys; } + @Override + public List<SnapshotInfo> listSnapshot(String volumeName, String bucketName) + throws IOException { + if (Strings.isNullOrEmpty(volumeName)) { + throw new OMException("Volume name is required.", + ResultCodes.VOLUME_NOT_FOUND); + } + + if (Strings.isNullOrEmpty(bucketName)) { + throw new OMException("Bucket name is required.", + ResultCodes.BUCKET_NOT_FOUND); + } + + List<SnapshotInfo> snapshotInfos = new ArrayList<>(); + TreeMap<String, SnapshotInfo> snapshotInfoMap = new TreeMap<>(); + + appendSnapshotFromCacheToMap(snapshotInfoMap); + appendSnapshotFromDBToMap(snapshotInfoMap); + + for (Map.Entry<String, SnapshotInfo> cacheKey : snapshotInfoMap + .entrySet()) { + snapshotInfos.add(cacheKey.getValue()); + } + + return snapshotInfos; Review Comment: nit: cloud be simplify to: ``` TreeMap<String, SnapshotInfo> snapshotInfoMap = new TreeMap<>(); appendSnapshotFromCacheToMap(snapshotInfoMap); appendSnapshotFromDBToMap(snapshotInfoMap); return ArrayList<SnapshotInfo>(snapshotInfoMap.values()); ``` ########## hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/shell/snapshot/ListSnapshotHandler.java: ########## @@ -0,0 +1,61 @@ +/* + * 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.shell.snapshot; + +import org.apache.hadoop.ozone.client.OzoneClient; +import org.apache.hadoop.ozone.client.OzoneSnapshot; +import org.apache.hadoop.ozone.shell.Handler; +import org.apache.hadoop.ozone.shell.OzoneAddress; +import org.apache.hadoop.ozone.shell.bucket.BucketUri; +import picocli.CommandLine; + +import java.io.IOException; +import java.util.List; + +/** + * a handler for Ozone shell CLI command 'list snapshot'. + */ [email protected](name = "list", + aliases = "ls", + description = "list snapshot for the buckets.") +public class ListSnapshotHandler extends Handler { Review Comment: Should we add listOptions similar to [List Bucket](https://github.com/hemantk-12/ozone/blob/23a0f743bc753048bbfa9ae7220bda198507b343/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/shell/bucket/ListBucketHandler.java#L45) and [List Key](https://github.com/hemantk-12/ozone/blob/23a0f743bc753048bbfa9ae7220bda198507b343/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/shell/keys/ListKeyHandler.java#L45)? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
