Accumulo
  1. Accumulo
  2. ACCUMULO-1104 improve documentation
  3. ACCUMULO-1136

Lack of information regarding `setiter` and `config` for SKVI configuration

    Details

    • Type: Sub-task Sub-task
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.5.0
    • Component/s: docs
    • Labels:
      None

      Description

      In terms of the documentation, it would be great to augment the Table Configuration section of the user manual. Iterators are central to Accumulo's functionality so it would aid users to see an entire iterator life cycle:

      • Develop iterator by extending...
      • Install iterator as jar to lib/ext
      • Run as in a client (fragment is shown)
      • Set via shell (setiter, config for options)

      There are hints to using config for existing filters but not how to configure custom iterator code. For example, installing custom iterator code for non-scan contexts is unclear.

        Activity

        Hide
        Josh Elser added a comment -

        Additions to user manual which information regarding `config` and `setiter` in the shell in the Iterator section of the user manual

        Show
        Josh Elser added a comment - Additions to user manual which information regarding `config` and `setiter` in the shell in the Iterator section of the user manual
        Hide
        Keith Turner added a comment -

        In the documentation that mentions lib/ext, its probably worth mentioning the ability to load iterators from a URL.

        Show
        Keith Turner added a comment - In the documentation that mentions lib/ext, its probably worth mentioning the ability to load iterators from a URL.
        Hide
        Josh Elser added a comment -

        Applied patch in r1452005 and added a note about the VFS classloader

        In the documentation that mentions lib/ext, its probably worth mentioning the ability to load iterators from a URL.

        Keith Turner I assume you meant the VFS classloader? I know it's off by default, but was any documentation written for it? Just the basics: what it uses, how does it work with Accumulo, and how to configure it.

        Show
        Josh Elser added a comment - Applied patch in r1452005 and added a note about the VFS classloader In the documentation that mentions lib/ext, its probably worth mentioning the ability to load iterators from a URL. Keith Turner I assume you meant the VFS classloader? I know it's off by default, but was any documentation written for it? Just the basics: what it uses, how does it work with Accumulo, and how to configure it.
        Hide
        Hudson added a comment -

        Integrated in Accumulo-1.5-Hadoop-2.0 #10 (See https://builds.apache.org/job/Accumulo-1.5-Hadoop-2.0/10/)
        ACCUMULO-1104 ACCUMULO-1136 Applying additional wording for using config as opposed to setiter. Fix various other documentation which are now incorrect in 1.5. (Revision 1452005)

        Result = SUCCESS
        elserj :
        Files :

        • /accumulo/branches/1.5/docs/src/user_manual/accumulo_user_manual.tex
        • /accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex
        • /accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex
        • /accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex
        Show
        Hudson added a comment - Integrated in Accumulo-1.5-Hadoop-2.0 #10 (See https://builds.apache.org/job/Accumulo-1.5-Hadoop-2.0/10/ ) ACCUMULO-1104 ACCUMULO-1136 Applying additional wording for using config as opposed to setiter. Fix various other documentation which are now incorrect in 1.5. (Revision 1452005) Result = SUCCESS elserj : Files : /accumulo/branches/1.5/docs/src/user_manual/accumulo_user_manual.tex /accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex /accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex /accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex
        Hide
        Hudson added a comment -

        Integrated in Accumulo-1.5 #11 (See https://builds.apache.org/job/Accumulo-1.5/11/)
        ACCUMULO-1104 ACCUMULO-1136 Applying additional wording for using config as opposed to setiter. Fix various other documentation which are now incorrect in 1.5. (Revision 1452005)

        Result = SUCCESS
        elserj :
        Files :

        • /accumulo/branches/1.5/docs/src/user_manual/accumulo_user_manual.tex
        • /accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex
        • /accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex
        • /accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex
        Show
        Hudson added a comment - Integrated in Accumulo-1.5 #11 (See https://builds.apache.org/job/Accumulo-1.5/11/ ) ACCUMULO-1104 ACCUMULO-1136 Applying additional wording for using config as opposed to setiter. Fix various other documentation which are now incorrect in 1.5. (Revision 1452005) Result = SUCCESS elserj : Files : /accumulo/branches/1.5/docs/src/user_manual/accumulo_user_manual.tex /accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex /accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex /accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex
        Hide
        Hudson added a comment -

        Integrated in Accumulo-Trunk-Hadoop-2.0 #115 (See https://builds.apache.org/job/Accumulo-Trunk-Hadoop-2.0/115/)
        merged changes from 1.5
        ACCUMULO-1142 Enable redirectTestOutputToFile in surefire plugin to nuke test output
        ACCUMULO-1002 Apply override annotation to the close method on the BatchScanner implementation to be explicit
        ACCUMULO-1002 Add a close method to ScannerBase and a no-op impl to ScannerOptions.
        ACCUMULO-1104 Another update to account for 1.5 changes in the user manual
        ACCUMULO-1071 Changing wording from "hadoop library type" to "Accumulo memory-map type"
        ACCUMULO-1104 ACCUMULO-1136 Applying additional wording for using config as opposed to setiter. Fix various other documentation which are now incorrect in 1.5.
        ACCUMULO-1104 Correcting documented option to show timestamps in shell in user manual. (Revision 1452342)

        Result = SUCCESS
        kturner :
        Files :

        • /accumulo/trunk
        • /accumulo/trunk/assemble
        • /accumulo/trunk/bin/bootstrap_config.sh
        • /accumulo/trunk/core
        • /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/ScannerBase.java
        • /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/impl/ScannerOptions.java
        • /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/impl/TabletServerBatchReader.java
        • /accumulo/trunk/docs/src/user_manual/accumulo_user_manual.tex
        • /accumulo/trunk/docs/src/user_manual/chapters/administration.tex
        • /accumulo/trunk/docs/src/user_manual/chapters/clients.tex
        • /accumulo/trunk/docs/src/user_manual/chapters/shell.tex
        • /accumulo/trunk/docs/src/user_manual/chapters/table_configuration.tex
        • /accumulo/trunk/examples
        • /accumulo/trunk/fate/src/main/java/org/apache/accumulo/fate/ZooStore.java
        • /accumulo/trunk/fate/src/main/java/org/apache/accumulo/fate/zookeeper/ZooSession.java
        • /accumulo/trunk/pom.xml
        • /accumulo/trunk/server
        • /accumulo/trunk/server/src/main/java/org/apache/accumulo/server/monitor/servlets/trace/NullScanner.java
        • /accumulo/trunk/src
        Show
        Hudson added a comment - Integrated in Accumulo-Trunk-Hadoop-2.0 #115 (See https://builds.apache.org/job/Accumulo-Trunk-Hadoop-2.0/115/ ) merged changes from 1.5 ACCUMULO-1142 Enable redirectTestOutputToFile in surefire plugin to nuke test output ACCUMULO-1002 Apply override annotation to the close method on the BatchScanner implementation to be explicit ACCUMULO-1002 Add a close method to ScannerBase and a no-op impl to ScannerOptions. ACCUMULO-1104 Another update to account for 1.5 changes in the user manual ACCUMULO-1071 Changing wording from "hadoop library type" to "Accumulo memory-map type" ACCUMULO-1104 ACCUMULO-1136 Applying additional wording for using config as opposed to setiter. Fix various other documentation which are now incorrect in 1.5. ACCUMULO-1104 Correcting documented option to show timestamps in shell in user manual. (Revision 1452342) Result = SUCCESS kturner : Files : /accumulo/trunk /accumulo/trunk/assemble /accumulo/trunk/bin/bootstrap_config.sh /accumulo/trunk/core /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/ScannerBase.java /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/impl/ScannerOptions.java /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/impl/TabletServerBatchReader.java /accumulo/trunk/docs/src/user_manual/accumulo_user_manual.tex /accumulo/trunk/docs/src/user_manual/chapters/administration.tex /accumulo/trunk/docs/src/user_manual/chapters/clients.tex /accumulo/trunk/docs/src/user_manual/chapters/shell.tex /accumulo/trunk/docs/src/user_manual/chapters/table_configuration.tex /accumulo/trunk/examples /accumulo/trunk/fate/src/main/java/org/apache/accumulo/fate/ZooStore.java /accumulo/trunk/fate/src/main/java/org/apache/accumulo/fate/zookeeper/ZooSession.java /accumulo/trunk/pom.xml /accumulo/trunk/server /accumulo/trunk/server/src/main/java/org/apache/accumulo/server/monitor/servlets/trace/NullScanner.java /accumulo/trunk/src
        Hide
        Hudson added a comment -

        Integrated in Accumulo-Trunk #756 (See https://builds.apache.org/job/Accumulo-Trunk/756/)
        merged changes from 1.5
        ACCUMULO-1142 Enable redirectTestOutputToFile in surefire plugin to nuke test output
        ACCUMULO-1002 Apply override annotation to the close method on the BatchScanner implementation to be explicit
        ACCUMULO-1002 Add a close method to ScannerBase and a no-op impl to ScannerOptions.
        ACCUMULO-1104 Another update to account for 1.5 changes in the user manual
        ACCUMULO-1071 Changing wording from "hadoop library type" to "Accumulo memory-map type"
        ACCUMULO-1104 ACCUMULO-1136 Applying additional wording for using config as opposed to setiter. Fix various other documentation which are now incorrect in 1.5.
        ACCUMULO-1104 Correcting documented option to show timestamps in shell in user manual. (Revision 1452342)

        Result = SUCCESS
        kturner :
        Files :

        • /accumulo/trunk
        • /accumulo/trunk/assemble
        • /accumulo/trunk/bin/bootstrap_config.sh
        • /accumulo/trunk/core
        • /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/ScannerBase.java
        • /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/impl/ScannerOptions.java
        • /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/impl/TabletServerBatchReader.java
        • /accumulo/trunk/docs/src/user_manual/accumulo_user_manual.tex
        • /accumulo/trunk/docs/src/user_manual/chapters/administration.tex
        • /accumulo/trunk/docs/src/user_manual/chapters/clients.tex
        • /accumulo/trunk/docs/src/user_manual/chapters/shell.tex
        • /accumulo/trunk/docs/src/user_manual/chapters/table_configuration.tex
        • /accumulo/trunk/examples
        • /accumulo/trunk/fate/src/main/java/org/apache/accumulo/fate/ZooStore.java
        • /accumulo/trunk/fate/src/main/java/org/apache/accumulo/fate/zookeeper/ZooSession.java
        • /accumulo/trunk/pom.xml
        • /accumulo/trunk/server
        • /accumulo/trunk/server/src/main/java/org/apache/accumulo/server/monitor/servlets/trace/NullScanner.java
        • /accumulo/trunk/src
        Show
        Hudson added a comment - Integrated in Accumulo-Trunk #756 (See https://builds.apache.org/job/Accumulo-Trunk/756/ ) merged changes from 1.5 ACCUMULO-1142 Enable redirectTestOutputToFile in surefire plugin to nuke test output ACCUMULO-1002 Apply override annotation to the close method on the BatchScanner implementation to be explicit ACCUMULO-1002 Add a close method to ScannerBase and a no-op impl to ScannerOptions. ACCUMULO-1104 Another update to account for 1.5 changes in the user manual ACCUMULO-1071 Changing wording from "hadoop library type" to "Accumulo memory-map type" ACCUMULO-1104 ACCUMULO-1136 Applying additional wording for using config as opposed to setiter. Fix various other documentation which are now incorrect in 1.5. ACCUMULO-1104 Correcting documented option to show timestamps in shell in user manual. (Revision 1452342) Result = SUCCESS kturner : Files : /accumulo/trunk /accumulo/trunk/assemble /accumulo/trunk/bin/bootstrap_config.sh /accumulo/trunk/core /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/ScannerBase.java /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/impl/ScannerOptions.java /accumulo/trunk/core/src/main/java/org/apache/accumulo/core/client/impl/TabletServerBatchReader.java /accumulo/trunk/docs/src/user_manual/accumulo_user_manual.tex /accumulo/trunk/docs/src/user_manual/chapters/administration.tex /accumulo/trunk/docs/src/user_manual/chapters/clients.tex /accumulo/trunk/docs/src/user_manual/chapters/shell.tex /accumulo/trunk/docs/src/user_manual/chapters/table_configuration.tex /accumulo/trunk/examples /accumulo/trunk/fate/src/main/java/org/apache/accumulo/fate/ZooStore.java /accumulo/trunk/fate/src/main/java/org/apache/accumulo/fate/zookeeper/ZooSession.java /accumulo/trunk/pom.xml /accumulo/trunk/server /accumulo/trunk/server/src/main/java/org/apache/accumulo/server/monitor/servlets/trace/NullScanner.java /accumulo/trunk/src

          People

          • Assignee:
            Josh Elser
            Reporter:
            Josh Elser
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development