svn commit: r1876435 - /knox/site/books/knox-1-4-0/
Author: lmccay Date: Mon Apr 13 00:18:34 2020 New Revision: 1876435 URL: http://svn.apache.org/viewvc?rev=1876435=rev Log: add the docs for KnoxShell User Guide part2 Added: knox/site/books/knox-1-4-0/covid19-nj-agg-from-webhdfs-1.png (with props) knox/site/books/knox-1-4-0/covid19-persistence.png (with props) knox/site/books/knox-1-4-0/covid19csv-1.png (with props) knox/site/books/knox-1-4-0/covid19nj-1.png (with props) knox/site/books/knox-1-4-0/covid19nj-aggregate-1.png (with props) knox/site/books/knox-1-4-0/covid19nj-put-webhdfs-1.png (with props) knox/site/books/knox-1-4-0/covid19nj.png (with props) knox/site/books/knox-1-4-0/fs-mount-login-1.png (with props) knox/site/books/knox-1-4-0/knoxline-splash-2.png (with props) knox/site/books/knox-1-4-0/knoxshell-help.png (with props) knox/site/books/knox-1-4-0/knoxshell_user_guide.html Added: knox/site/books/knox-1-4-0/covid19-nj-agg-from-webhdfs-1.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/covid19-nj-agg-from-webhdfs-1.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/covid19-nj-agg-from-webhdfs-1.png -- svn:mime-type = application/octet-stream Added: knox/site/books/knox-1-4-0/covid19-persistence.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/covid19-persistence.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/covid19-persistence.png -- svn:mime-type = application/octet-stream Added: knox/site/books/knox-1-4-0/covid19csv-1.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/covid19csv-1.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/covid19csv-1.png -- svn:mime-type = application/octet-stream Added: knox/site/books/knox-1-4-0/covid19nj-1.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/covid19nj-1.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/covid19nj-1.png -- svn:mime-type = application/octet-stream Added: knox/site/books/knox-1-4-0/covid19nj-aggregate-1.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/covid19nj-aggregate-1.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/covid19nj-aggregate-1.png -- svn:mime-type = application/octet-stream Added: knox/site/books/knox-1-4-0/covid19nj-put-webhdfs-1.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/covid19nj-put-webhdfs-1.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/covid19nj-put-webhdfs-1.png -- svn:mime-type = application/octet-stream Added: knox/site/books/knox-1-4-0/covid19nj.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/covid19nj.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/covid19nj.png -- svn:mime-type = application/octet-stream Added: knox/site/books/knox-1-4-0/fs-mount-login-1.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/fs-mount-login-1.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/fs-mount-login-1.png -- svn:mime-type = application/octet-stream Added: knox/site/books/knox-1-4-0/knoxline-splash-2.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/knoxline-splash-2.png?rev=1876435=auto == Binary file - no diff available. Propchange: knox/site/books/knox-1-4-0/knoxline-splash-2.png --
svn commit: r1876434 - in /knox: site/ site/books/knox-0-12-0/ site/books/knox-0-13-0/ site/books/knox-0-14-0/ site/books/knox-1-0-0/ site/books/knox-1-1-0/ site/books/knox-1-2-0/ site/books/knox-1-3-
Author: lmccay Date: Mon Apr 13 00:15:04 2020 New Revision: 1876434 URL: http://svn.apache.org/viewvc?rev=1876434=rev Log: add docs for KnoxShell User Guide Added: knox/trunk/books/1.4.0/knoxshell-guide/ knox/trunk/books/1.4.0/knoxshell-guide/knoxshell_user_guide.md knox/trunk/books/static/covid19-nj-agg-from-webhdfs-1.png (with props) knox/trunk/books/static/covid19-persistence.png (with props) knox/trunk/books/static/covid19csv-1.png (with props) knox/trunk/books/static/covid19nj-1.png (with props) knox/trunk/books/static/covid19nj-aggregate-1.png (with props) knox/trunk/books/static/covid19nj-put-webhdfs-1.png (with props) knox/trunk/books/static/covid19nj.png (with props) knox/trunk/books/static/fs-mount-login-1.png (with props) knox/trunk/books/static/knoxline-splash-2.png (with props) knox/trunk/books/static/knoxshell-help.png (with props) Modified: knox/site/books/knox-0-12-0/deployment-overview.png knox/site/books/knox-0-12-0/deployment-provider.png knox/site/books/knox-0-12-0/deployment-service.png knox/site/books/knox-0-12-0/general_saml_flow.png knox/site/books/knox-0-12-0/runtime-overview.png knox/site/books/knox-0-12-0/runtime-request-processing.png knox/site/books/knox-0-13-0/deployment-overview.png knox/site/books/knox-0-13-0/deployment-provider.png knox/site/books/knox-0-13-0/deployment-service.png knox/site/books/knox-0-13-0/general_saml_flow.png knox/site/books/knox-0-13-0/runtime-overview.png knox/site/books/knox-0-13-0/runtime-request-processing.png knox/site/books/knox-0-14-0/deployment-overview.png knox/site/books/knox-0-14-0/deployment-provider.png knox/site/books/knox-0-14-0/deployment-service.png knox/site/books/knox-0-14-0/general_saml_flow.png knox/site/books/knox-0-14-0/runtime-overview.png knox/site/books/knox-0-14-0/runtime-request-processing.png knox/site/books/knox-1-0-0/deployment-overview.png knox/site/books/knox-1-0-0/deployment-provider.png knox/site/books/knox-1-0-0/deployment-service.png knox/site/books/knox-1-0-0/general_saml_flow.png knox/site/books/knox-1-0-0/runtime-overview.png knox/site/books/knox-1-0-0/runtime-request-processing.png knox/site/books/knox-1-1-0/deployment-overview.png knox/site/books/knox-1-1-0/deployment-provider.png knox/site/books/knox-1-1-0/deployment-service.png knox/site/books/knox-1-1-0/general_saml_flow.png knox/site/books/knox-1-1-0/runtime-overview.png knox/site/books/knox-1-1-0/runtime-request-processing.png knox/site/books/knox-1-2-0/deployment-overview.png knox/site/books/knox-1-2-0/deployment-provider.png knox/site/books/knox-1-2-0/deployment-service.png knox/site/books/knox-1-2-0/general_saml_flow.png knox/site/books/knox-1-2-0/runtime-overview.png knox/site/books/knox-1-2-0/runtime-request-processing.png knox/site/books/knox-1-3-0/deployment-overview.png knox/site/books/knox-1-3-0/deployment-provider.png knox/site/books/knox-1-3-0/deployment-service.png knox/site/books/knox-1-3-0/general_saml_flow.png knox/site/books/knox-1-3-0/runtime-overview.png knox/site/books/knox-1-3-0/runtime-request-processing.png knox/site/books/knox-1-4-0/deployment-overview.png knox/site/books/knox-1-4-0/deployment-provider.png knox/site/books/knox-1-4-0/deployment-service.png knox/site/books/knox-1-4-0/general_saml_flow.png knox/site/books/knox-1-4-0/runtime-overview.png knox/site/books/knox-1-4-0/runtime-request-processing.png knox/site/index.html knox/site/issue-management.html knox/site/licenses.html knox/site/mailing-lists.html knox/site/project-info.html knox/site/team.html knox/trunk/build.xml Modified: knox/site/books/knox-0-12-0/deployment-overview.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-overview.png?rev=1876434=1876433=1876434=diff == Binary files - no diff available. Modified: knox/site/books/knox-0-12-0/deployment-provider.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-provider.png?rev=1876434=1876433=1876434=diff == Binary files - no diff available. Modified: knox/site/books/knox-0-12-0/deployment-service.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-service.png?rev=1876434=1876433=1876434=diff == Binary files - no diff available. Modified: knox/site/books/knox-0-12-0/general_saml_flow.png URL: http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/general_saml_flow.png?rev=1876434=1876433=1876434=diff == Binary files - no diff available. Modified:
[knox] branch master updated: KNOX-2341 - KnoxShell Custom Commands need Description and Usage Details (#313)
This is an automated email from the ASF dual-hosted git repository.
lmccay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/knox.git
The following commit(s) were added to refs/heads/master by this push:
new 1834c67 KNOX-2341 - KnoxShell Custom Commands need Description and
Usage Details (#313)
1834c67 is described below
commit 1834c67ccdcac118dc2a925072f3f6e6203621a4
Author: lmccay
AuthorDate: Sun Apr 12 17:57:16 2020 -0400
KNOX-2341 - KnoxShell Custom Commands need Description and Usage Details
(#313)
---
.../shell/commands/AbstractKnoxShellCommand.java | 26 ++
.../shell/commands/AbstractSQLCommandSupport.java | 5 +
.../knox/gateway/shell/commands/CSVCommand.java| 4 +++-
.../gateway/shell/commands/DataSourceCommand.java | 4 +++-
.../knox/gateway/shell/commands/SelectCommand.java | 4 +++-
.../gateway/shell/commands/WebHDFSCommand.java | 25 ++---
6 files changed, 52 insertions(+), 16 deletions(-)
diff --git
a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractKnoxShellCommand.java
b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractKnoxShellCommand.java
index a24edad..e670035 100644
---
a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractKnoxShellCommand.java
+++
b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractKnoxShellCommand.java
@@ -27,11 +27,37 @@ import org.codehaus.groovy.tools.shell.Groovysh;
public abstract class AbstractKnoxShellCommand extends CommandSupport {
static final String KNOXSQLHISTORY = "__knoxsqlhistory";
protected static final String KNOXDATASOURCES = "__knoxdatasources";
+ private String description;
+ private String usage;
+ private String help;
public AbstractKnoxShellCommand(Groovysh shell, String name, String
shortcut) {
super(shell, name, shortcut);
}
+ public AbstractKnoxShellCommand(Groovysh shell, String name, String shortcut,
+ String desc, String usage, String help) {
+super(shell, name, shortcut);
+this.description = desc;
+this.usage = usage;
+this.help = help;
+ }
+
+ @Override
+ public String getDescription() {
+ return description;
+ }
+
+ @Override
+ public String getUsage() {
+return usage;
+ }
+
+ @Override
+ public String getHelp() {
+return help;
+ }
+
protected String getBindingVariableNameForResultingTable(List args) {
String variableName = null;
boolean nextOne = false;
diff --git
a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractSQLCommandSupport.java
b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractSQLCommandSupport.java
index d39699f..47bed8a 100644
---
a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractSQLCommandSupport.java
+++
b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/AbstractSQLCommandSupport.java
@@ -40,6 +40,11 @@ public abstract class AbstractSQLCommandSupport extends
AbstractKnoxShellCommand
super(shell, name, shortcut);
}
+ public AbstractSQLCommandSupport(Groovysh shell, String name, String
shortcut, String desc, String usage,
+ String help) {
+super(shell, name, shortcut, desc, usage, help);
+ }
+
@SuppressWarnings("unchecked")
protected Connection getConnectionFromSession(KnoxDataSource ds) {
HashMap connections =
diff --git
a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/CSVCommand.java
b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/CSVCommand.java
index b8c3619..162d440 100644
---
a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/CSVCommand.java
+++
b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/CSVCommand.java
@@ -24,11 +24,13 @@ import org.apache.knox.gateway.shell.table.KnoxShellTable;
import org.codehaus.groovy.tools.shell.Groovysh;
public class CSVCommand extends AbstractKnoxShellCommand {
+ private static final String USAGE = ":csv [withHeaders]
file-url||$variable-name [assign resulting-variable-name]";
+ private static final String DESC = "Build table from CSV file located at
provided URL or KnoxShell $variable-name";
private boolean withHeaders;
private String url;
public CSVCommand(Groovysh shell) {
-super(shell, ":CSV", ":csv");
+super(shell, ":CSV", ":csv", DESC, USAGE, DESC);
}
@SuppressWarnings("unchecked")
diff --git
a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/DataSourceCommand.java
b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/DataSourceCommand.java
index 4758df6..d063ac4 100644
---
a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/DataSourceCommand.java
+++
b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/commands/DataSourceCommand.java
@@ -30,9 +30,11 @@ import
