You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by to...@apache.org on 2017/03/29 20:29:01 UTC

svn commit: r1789413 - in /jackrabbit/oak/trunk: oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/ oak-run/ oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/ oak-run/src/main/java/org/apache/jackrabbit/oak/plugins/document/ o...

Author: tomekr
Date: Wed Mar 29 20:29:01 2017
New Revision: 1789413

URL: http://svn.apache.org/viewvc?rev=1789413&view=rev
Log:
OAK-6000: Support for the checkpoint metadata retrieval/update in oak-run

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/Checkpoints.java
    jackrabbit/oak/trunk/oak-run/README.md
    jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/Checkpoints.java
    jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/DocumentCheckpoints.java
    jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/SegmentTarCheckpoints.java
    jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/plugins/document/CheckpointsHelper.java
    jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/run/CheckpointsCommand.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/Checkpoints.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/Checkpoints.java?rev=1789413&r1=1789412&r2=1789413&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/Checkpoints.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/Checkpoints.java Wed Mar 29 20:29:01 2017
@@ -21,6 +21,7 @@ package org.apache.jackrabbit.oak.plugin
 
 import java.math.BigInteger;
 import java.util.Collections;
+import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.SortedMap;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -198,6 +199,25 @@ class Checkpoints {
         return rv;
     }
 
+    void setInfoProperty(@Nonnull String checkpoint, @Nonnull String key, @Nullable String value) {
+        Revision r = Revision.fromString(checkNotNull(checkpoint));
+        Info info = getCheckpoints().get(r);
+        if (info == null) {
+            throw new IllegalArgumentException("No such checkpoint: " + checkpoint);
+        }
+        Map<String, String> metadata = new LinkedHashMap<>(info.get());
+        if (value == null) {
+            metadata.remove(key);
+        } else {
+            metadata.put(key, value);
+        }
+        Info newInfo = new Info(info.getExpiryTime(), info.getCheckpoint(), metadata);
+
+        UpdateOp op = new UpdateOp(Checkpoints.ID, false);
+        op.setMapEntry(PROP_CHECKPOINT, r, newInfo.toString());
+        store.findAndUpdate(Collection.SETTINGS, op);
+    }
+
     int size() {
         return getCheckpoints().size();
     }

Modified: jackrabbit/oak/trunk/oak-run/README.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/README.md?rev=1789413&r1=1789412&r2=1789413&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/README.md (original)
+++ jackrabbit/oak/trunk/oak-run/README.md Wed Mar 29 20:29:01 2017
@@ -156,6 +156,8 @@ The 'list' option (treated as a default
 The 'rm-all' option will wipe clean the 'checkpoints' node.
 The 'rm-unreferenced' option will remove all checkpoints except the one referenced from the async indexer (/:async@async).
 The 'rm <checkpoint>' option will remove a specific checkpoint from the repository.
+The 'info <checkpoint>' option will return metadata information for the given checkpoint.
+The 'set <checkpoint> <name> \[<value>\]' option will set the metadata property. If the value is omitted, the property will be removed. 
 
 <a name="tika"></a>
 Tika

Modified: jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/Checkpoints.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/Checkpoints.java?rev=1789413&r1=1789412&r2=1789413&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/Checkpoints.java (original)
+++ jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/Checkpoints.java Wed Mar 29 20:29:01 2017
@@ -20,6 +20,7 @@ import java.io.File;
 import java.io.IOException;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 import javax.annotation.Nonnull;
@@ -75,6 +76,26 @@ public abstract class Checkpoints {
      */
     public abstract int remove(String cp);
 
+    /**
+     * Return checkpoint metadata
+     *
+     * @param cp a checkpoint string.
+     * @return checkpoints metadata map or null if checkpoint can't be found
+     */
+    public abstract Map<String, String> getInfo(String cp);
+
+    /**
+     * Set the property in the checkpoint metadata.
+     *
+     * @param cp a checkpoint string.
+     * @param name property name
+     * @param value new value of the property. the property will be removed if the value is {@code null}
+     * @return {@code 1} if the checkpoint was successfully remove, {@code 0} if
+     *          there is no such checkpoint or {@code -1} if the operation did
+     *          not succeed.
+     */
+    public abstract int setInfoProperty(String cp, String name, String value);
+
     @Nonnull
     static Set<String> getReferencedCheckpoints(NodeState root) {
         Set<String> cps = new HashSet<String>();

Modified: jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/DocumentCheckpoints.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/DocumentCheckpoints.java?rev=1789413&r1=1789412&r2=1789413&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/DocumentCheckpoints.java (original)
+++ jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/DocumentCheckpoints.java Wed Mar 29 20:29:01 2017
@@ -73,4 +73,14 @@ class DocumentCheckpoints extends Checkp
         return CheckpointsHelper.remove(store, r);
     }
 
+    @Override
+    public Map<String, String> getInfo(String cp) {
+        return store.checkpointInfo(cp);
+    }
+
+    @Override
+    public int setInfoProperty(String cp, String name, String value) {
+        return CheckpointsHelper.setInfoProperty(store, cp, name, value);
+    }
+
 }

Modified: jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/SegmentTarCheckpoints.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/SegmentTarCheckpoints.java?rev=1789413&r1=1789412&r2=1789413&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/SegmentTarCheckpoints.java (original)
+++ jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/checkpoint/SegmentTarCheckpoints.java Wed Mar 29 20:29:01 2017
@@ -21,11 +21,15 @@ import static org.apache.jackrabbit.oak.
 
 import java.io.File;
 import java.io.IOException;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 import com.google.common.collect.Lists;
 import com.google.common.io.Closer;
+import org.apache.jackrabbit.oak.api.PropertyState;
+import org.apache.jackrabbit.oak.api.Type;
 import org.apache.jackrabbit.oak.segment.SegmentNodeState;
 import org.apache.jackrabbit.oak.segment.file.FileStore;
 import org.apache.jackrabbit.oak.segment.file.InvalidFileStoreVersionException;
@@ -112,6 +116,43 @@ class SegmentTarCheckpoints extends Chec
             if (store.getRevisions().setHead(head.getRecordId(), asSegmentNodeState(builder).getRecordId())) {
                 return 1;
             } else {
+                return -1;
+            }
+        } else {
+            return 0;
+        }
+    }
+
+    @Override
+    public Map<String, String> getInfo(String cp) {
+        SegmentNodeState head = store.getHead();
+        NodeState props = head.getChildNode("checkpoints").getChildNode(cp).getChildNode("properties");
+        if (props.exists()) {
+            Map<String, String> info = new HashMap<>();
+            for (PropertyState p : props.getProperties()) {
+                info.put(p.getName(), p.getValue(Type.STRING));
+            }
+            return info;
+        } else {
+            return null;
+        }
+    }
+
+    @Override
+    public int setInfoProperty(String cp, String name, String value) {
+        SegmentNodeState head = store.getHead();
+        NodeBuilder builder = head.builder();
+
+        NodeBuilder props = builder.getChildNode("checkpoints").getChildNode(cp).getChildNode("properties");
+        if (props.exists()) {
+            if (value == null) {
+                props.removeProperty(name);
+            } else {
+                props.setProperty(name, value, Type.STRING);
+            }
+            if (store.getRevisions().setHead(head.getRecordId(), asSegmentNodeState(builder).getRecordId())) {
+                return 1;
+            } else {
                 return -1;
             }
         } else {

Modified: jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/plugins/document/CheckpointsHelper.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/plugins/document/CheckpointsHelper.java?rev=1789413&r1=1789412&r2=1789413&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/plugins/document/CheckpointsHelper.java (original)
+++ jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/plugins/document/CheckpointsHelper.java Wed Mar 29 20:29:01 2017
@@ -82,4 +82,12 @@ public abstract class CheckpointsHelper
         return r;
     }
 
+    public static int setInfoProperty(DocumentNodeStore store, String rev, String key, String value) {
+        try {
+            store.getCheckpoints().setInfoProperty(rev, key, value);
+        } catch (IllegalArgumentException e) {
+            return 0;
+        }
+        return 1;
+    }
 }

Modified: jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/run/CheckpointsCommand.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/run/CheckpointsCommand.java?rev=1789413&r1=1789412&r2=1789413&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/run/CheckpointsCommand.java (original)
+++ jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/run/CheckpointsCommand.java Wed Mar 29 20:29:01 2017
@@ -19,6 +19,8 @@ package org.apache.jackrabbit.oak.run;
 
 import java.io.File;
 import java.sql.Timestamp;
+import java.util.List;
+import java.util.Map;
 
 import org.apache.jackrabbit.oak.checkpoint.Checkpoints;
 import org.apache.jackrabbit.oak.plugins.document.DocumentMK;
@@ -40,7 +42,7 @@ class CheckpointsCommand implements Comm
         OptionSet options = parser.parse(args);
 
         if (options.nonOptionArguments().isEmpty()) {
-            System.out.println("usage: checkpoints {<path>|<mongo-uri>} [list|rm-all|rm-unreferenced|rm <checkpoint>] [--segment]");
+            System.out.println("usage: checkpoints {<path>|<mongo-uri>} [list|rm-all|rm-unreferenced|rm <checkpoint>|info <checkpoint>|set <checkpoint> <name> [<value>]] [--segment]");
             System.exit(1);
         }
 
@@ -51,7 +53,7 @@ class CheckpointsCommand implements Comm
             String op = "list";
             if (options.nonOptionArguments().size() >= 2) {
                 op = options.nonOptionArguments().get(1).toString();
-                if (!"list".equals(op) && !"rm-all".equals(op) && !"rm-unreferenced".equals(op) && !"rm".equals(op)) {
+                if (!"list".equals(op) && !"rm-all".equals(op) && !"rm-unreferenced".equals(op) && !"rm".equals(op) && !"info".equals(op) && !"set".equals(op)) {
                     failWith("Unknown command.");
                 }
             }
@@ -112,6 +114,45 @@ class CheckpointsCommand implements Comm
                                     + time + "ms.");
                         } else {
                             failWith("Failed to remove checkpoint " + cp);
+                        }
+                    } else {
+                        failWith("Checkpoint '" + cp + "' not found.");
+                    }
+                }
+            } else if ("info".equals(op)) {
+                if (options.nonOptionArguments().size() < 3) {
+                    failWith("Missing checkpoint id");
+                } else {
+                    String cp = options.nonOptionArguments().get(2).toString();
+                    Map<String, String> info = cps.getInfo(cp);
+                    if (info != null) {
+                        for (Map.Entry<String, String> e : info.entrySet()) {
+                            System.out.println(e.getKey() + '\t' + e.getValue());
+                        }
+                    } else {
+                        failWith("Checkpoint '" + cp + "' not found.");
+                    }
+                }
+            } else if ("set".equals(op)) {
+                if (options.nonOptionArguments().size() < 4) {
+                    failWith("Missing checkpoint id");
+                } else {
+                    List<?> l = options.nonOptionArguments();
+                    String cp = l.get(2).toString();
+                    String name = l.get(3).toString();
+                    String value = null;
+                    if (l.size() >= 5) {
+                        value = l.get(4).toString();
+                    }
+                    long time = System.currentTimeMillis();
+                    int cnt = cps.setInfoProperty(cp, name, value);
+                    time = System.currentTimeMillis() - time;
+                    if (cnt != 0) {
+                        if (cnt == 1) {
+                            System.out.println("Updated checkpoint " + cp + " in "
+                                    + time + "ms.");
+                        } else {
+                            failWith("Failed to remove checkpoint " + cp);
                         }
                     } else {
                         failWith("Checkpoint '" + cp + "' not found.");