Repository: incubator-lens Updated Branches: refs/heads/master dc1fafa91 -> 16be6fba8
LENS-546 : change parameter names to have _ instead of - in cli arg names (Yash Sharma via amareshwari) Project: http://git-wip-us.apache.org/repos/asf/incubator-lens/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-lens/commit/16be6fba Tree: http://git-wip-us.apache.org/repos/asf/incubator-lens/tree/16be6fba Diff: http://git-wip-us.apache.org/repos/asf/incubator-lens/diff/16be6fba Branch: refs/heads/master Commit: 16be6fba8da842e3d7a8ad65c9c68ff61d9b3ad9 Parents: dc1fafa Author: Yash Sharma <[email protected]> Authored: Thu May 14 10:15:25 2015 +0530 Committer: Amareshwari Sriramadasu <[email protected]> Committed: Thu May 14 10:15:25 2015 +0530 ---------------------------------------------------------------------- .../lens/cli/commands/LensCubeCommands.java | 18 ++-- .../cli/commands/LensDimensionCommands.java | 12 +-- .../commands/LensDimensionTableCommands.java | 72 ++++++------- .../lens/cli/commands/LensFactCommands.java | 72 ++++++------- .../lens/cli/commands/LensQueryCommands.java | 34 +++--- src/site/apt/user/cli.apt | 108 +++++++++---------- 6 files changed, 158 insertions(+), 158 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/16be6fba/lens-cli/src/main/java/org/apache/lens/cli/commands/LensCubeCommands.java ---------------------------------------------------------------------- diff --git a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensCubeCommands.java b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensCubeCommands.java index 095d70d..1c83b54 100644 --- a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensCubeCommands.java +++ b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensCubeCommands.java @@ -65,8 +65,8 @@ public class LensCubeCommands extends LensCRUDCommand<XCube> { * @param name the cube name * @return the string */ - @CliCommand(value = "describe cube", help = "describe cube with name <cube-name>") - public String describeCube(@CliOption(key = {"", "name"}, mandatory = true, help = "<cube-name>") String name) { + @CliCommand(value = "describe cube", help = "describe cube with name <cube_name>") + public String describeCube(@CliOption(key = {"", "name"}, mandatory = true, help = "<cube_name>") String name) { return describe(name); } @@ -77,9 +77,9 @@ public class LensCubeCommands extends LensCRUDCommand<XCube> { * @param path path to new spec file * @return the string */ - @CliCommand(value = "update cube", help = "update cube <cube-name> with spec from <path-to-cube-spec-file>") + @CliCommand(value = "update cube", help = "update cube <cube_name> with spec from <path-to-cube-spec-file>") public String updateCube( - @CliOption(key = {"", "name"}, mandatory = true, help = "<cube-name>") String name, + @CliOption(key = {"", "name"}, mandatory = true, help = "<cube_name>") String name, @CliOption(key = {"", "path"}, mandatory = true, help = "<path-to-cube-spec-file>") String path) { return update(name, path); } @@ -90,8 +90,8 @@ public class LensCubeCommands extends LensCRUDCommand<XCube> { * @param name the cube * @return the string */ - @CliCommand(value = "drop cube", help = "drop cube <cube-name>") - public String dropCube(@CliOption(key = {"", "name"}, mandatory = true, help = "<cube-name>") String name) { + @CliCommand(value = "drop cube", help = "drop cube <cube_name>") + public String dropCube(@CliOption(key = {"", "name"}, mandatory = true, help = "<cube_name>") String name) { return drop(name, false); } @@ -103,10 +103,10 @@ public class LensCubeCommands extends LensCRUDCommand<XCube> { * @return the string */ @CliCommand(value = "cube latestdate", - help = "get latest date of data available in cube <cube-name> for time dimension <time-dimension-name>") + help = "get latest date of data available in cube <cube_name> for time dimension <time_dimension_name>") public String getLatest( - @CliOption(key = {"", "cube"}, mandatory = true, help = "<cube-name>") String cube, - @CliOption(key = {"", "timeDimension"}, mandatory = true, help = "<time-dimension-name>") String timeDim) { + @CliOption(key = {"", "cube"}, mandatory = true, help = "<cube_name>") String cube, + @CliOption(key = {"", "timeDimension"}, mandatory = true, help = "<time_dimension_name>") String timeDim) { Date dt = getClient().getLatestDateOfCube(cube, timeDim); return dt == null ? "No Data Available" : formatDate(dt); } http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/16be6fba/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionCommands.java ---------------------------------------------------------------------- diff --git a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionCommands.java b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionCommands.java index dc44f80..84ae6c3 100644 --- a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionCommands.java +++ b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionCommands.java @@ -66,9 +66,9 @@ public class LensDimensionCommands extends LensCRUDCommand<XDimension> { * @param name the dimension name * @return the string */ - @CliCommand(value = "describe dimension", help = "describe dimension <dimension-name>") + @CliCommand(value = "describe dimension", help = "describe dimension <dimension_name>") public String describeDimension( - @CliOption(key = {"", "name"}, mandatory = true, help = "<dimension-name>") String name) { + @CliOption(key = {"", "name"}, mandatory = true, help = "<dimension_name>") String name) { try { return formatJson(mapper.writer(pp).writeValueAsString(getClient().getDimension(name))); } catch (IOException e) { @@ -84,9 +84,9 @@ public class LensDimensionCommands extends LensCRUDCommand<XDimension> { * @return the string */ @CliCommand(value = "update dimension", - help = "update dimension <dimension-name>, taking spec from <path-to-dimension-spec file>") + help = "update dimension <dimension_name>, taking spec from <path-to-dimension-spec file>") public String updateDimension( - @CliOption(key = {"", "name"}, mandatory = true, help = "<dimension-name>") String name, + @CliOption(key = {"", "name"}, mandatory = true, help = "<dimension_name>") String name, @CliOption(key = {"", "path"}, mandatory = true, help = "<path-to-dimension-spec-file>") String path) { return update(name, path); } @@ -97,9 +97,9 @@ public class LensDimensionCommands extends LensCRUDCommand<XDimension> { * @param name the dimension * @return the string */ - @CliCommand(value = "drop dimension", help = "drop dimension <dimension-name>") + @CliCommand(value = "drop dimension", help = "drop dimension <dimension_name>") public String dropDimension( - @CliOption(key = {"", "name"}, mandatory = true, help = "<dimension-name>") String name) { + @CliOption(key = {"", "name"}, mandatory = true, help = "<dimension_name>") String name) { return drop(name, false); } http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/16be6fba/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionTableCommands.java ---------------------------------------------------------------------- diff --git a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionTableCommands.java b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionTableCommands.java index d4b7418..40380b7 100644 --- a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionTableCommands.java +++ b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensDimensionTableCommands.java @@ -46,10 +46,10 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @return the string */ @CliCommand(value = "show dimtables", - help = "display list of dimtables in current database. If optional <dimension-name> is supplied," - + " only facts belonging to dimension <dimension-name> will be displayed") + help = "display list of dimtables in current database. If optional <dimension_name> is supplied," + + " only facts belonging to dimension <dimension_name> will be displayed") public String showDimensionTables( - @CliOption(key = {"", "dimension-name"}, mandatory = false, help = "<dimension-name>") String dimensionName) { + @CliOption(key = {"", "dimension_name"}, mandatory = false, help = "<dimension_name>") String dimensionName) { return showAll(dimensionName); } @@ -72,9 +72,9 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @param name the dim * @return the string */ - @CliCommand(value = "describe dimtable", help = "describe dimtable <dimtable-name>") + @CliCommand(value = "describe dimtable", help = "describe dimtable <dimtable_name>") public String describeDimensionTable( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String name) { + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String name) { return describe(name); } @@ -86,9 +86,9 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @return the string */ @CliCommand(value = "update dimtable", - help = "update dimtable <dimtable-name> taking spec from <path-to-dimtable-spec>") + help = "update dimtable <dimtable_name> taking spec from <path-to-dimtable-spec>") public String updateDimensionTable( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String name, + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String name, @CliOption(key = {"", "path"}, mandatory = true, help = "<path-to-dimtable-spec>") String path) { return update(name, path); } @@ -102,11 +102,11 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @return the string */ @CliCommand(value = "drop dimtable", - help = "drop dimtable <dimtable-name>. " - + " If <cascade> is true, all the storage tables associated with the dimtable <dimtable-name> are also dropped." + help = "drop dimtable <dimtable_name>. " + + " If <cascade> is true, all the storage tables associated with the dimtable <dimtable_name> are also dropped." + " By default <cascade> is false") public String dropDimensionTable( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String name, + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String name, @CliOption(key = {"cascade"}, mandatory = false, unspecifiedDefaultValue = "false", help = "<cascade>") boolean cascade) { return drop(name, cascade); @@ -118,9 +118,9 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @param table the dim * @return the dim storages */ - @CliCommand(value = "dimtable list storages", help = "display list of storage associated to dimtable <dimtable-name>") + @CliCommand(value = "dimtable list storages", help = "display list of storage associated to dimtable <dimtable_name>") public String getDimStorages( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String table) { + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String table) { return showAllStorages(table); } @@ -132,9 +132,9 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @return the string */ @CliCommand(value = "dimtable add storage", - help = "adds a new storage to dimtable <dimtable-name>, taking storage spec from <path-to-storage-spec>") + help = "adds a new storage to dimtable <dimtable_name>, taking storage spec from <path-to-storage-spec>") public String addNewDimStorage( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String tableName, + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String tableName, @CliOption(key = {"", "path"}, mandatory = true, help = "<path-to-storage-spec>") String path) { return addStorage(tableName, path); } @@ -145,10 +145,10 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @param tableName dimtable name * @return path storage spec path */ - @CliCommand(value = "dimtable get storage", help = "describe storage <storage-name> of dimtable <dimtable-name>") + @CliCommand(value = "dimtable get storage", help = "describe storage <storage_name> of dimtable <dimtable_name>") public String getStorageFromDim( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String tableName, - @CliOption(key = {"", "storage-name"}, mandatory = true, help = "<storage-name>") String storage) { + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storage) { return getStorage(tableName, storage); } @@ -159,10 +159,10 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @param storageName storage name * @return the string */ - @CliCommand(value = "dimtable drop storage", help = "drop storage <storage-name> from dimtable <dimtable-name>") + @CliCommand(value = "dimtable drop storage", help = "drop storage <storage_name> from dimtable <dimtable_name>") public String dropStorageFromDim( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String tableName, - @CliOption(key = {"", "storage-name"}, mandatory = true, help = "<storage-name>") String storageName) { + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName) { return dropStorage(tableName, storageName); } @@ -174,7 +174,7 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< */ @CliCommand(value = "dimtable drop all storages", help = "drop all storages associated to dimension table") public String dropAllDimStorages( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String tableName) { + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String tableName) { return dropAllStorages(tableName); } @@ -187,11 +187,11 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @return the all partitions of dim */ @CliCommand(value = "dimtable list partitions", - help = "get all partitions associated with dimtable <dimtable-name>, " - + "storage <storage-name> filtered by <partition-filter>") + help = "get all partitions associated with dimtable <dimtable_name>, " + + "storage <storage_name> filtered by <partition-filter>") public String getAllPartitionsOfDim( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String tableName, - @CliOption(key = {"", "storage-name"}, mandatory = true, help = "<storage-name>") String storageName, + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName, @CliOption(key = {"", "filter"}, mandatory = false, help = "<partition-filter>") String filter) { return getAllPartitions(tableName, storageName, filter); } @@ -206,10 +206,10 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< */ @CliCommand(value = "dimtable drop partitions", help = "drop all partitions associated with dimtable " - + "<dimtable-name>, storage <storage-name> filtered by <partition-filter>") + + "<dimtable_name>, storage <storage_name> filtered by <partition-filter>") public String dropAllPartitionsOfDim( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String tableName, - @CliOption(key = {"", "storage-name"}, mandatory = true, help = "<storage-name>") String storageName, + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName, @CliOption(key = {"", "filter"}, mandatory = false, help = "<partition-filter>") String filter) { return dropPartitions(tableName, storageName, filter); } @@ -223,11 +223,11 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< * @return the string */ @CliCommand(value = "dimtable add single-partition", - help = "add single partition to dimtable <dimtable-name>'s" - + " storage <storage-name>, reading spec from <partition-spec-path>") + help = "add single partition to dimtable <dimtable_name>'s" + + " storage <storage_name>, reading spec from <partition-spec-path>") public String addPartitionToDimtable( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String tableName, - @CliOption(key = {"", "storage-name"}, mandatory = true, help = "<storage-name>") String storageName, + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName, @CliOption(key = {"", "path"}, mandatory = true, help = "<partition-spec-path>") String path) { return addPartition(tableName, storageName, path); } @@ -242,11 +242,11 @@ public class LensDimensionTableCommands extends LensCRUDStoragePartitionCommand< */ @CliCommand(value = "dimtable add partitions", - help = "add multiple partition to dimtable <dimtable-name>'s" - + " storage <storage-name>, reading partition list spec from <partition-list-spec-path>") + help = "add multiple partition to dimtable <dimtable_name>'s" + + " storage <storage_name>, reading partition list spec from <partition-list-spec-path>") public String addPartitionsToDimtable( - @CliOption(key = {"", "dimtable-name"}, mandatory = true, help = "<dimtable-name>") String tableName, - @CliOption(key = {"", "storage-name"}, mandatory = true, help = "<storage-name>") String storageName, + @CliOption(key = {"", "dimtable_name"}, mandatory = true, help = "<dimtable_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName, @CliOption(key = {"", "path"}, mandatory = true, help = "<partition-list-spec-path>") String path) { return addPartitions(tableName, storageName, path); } http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/16be6fba/lens-cli/src/main/java/org/apache/lens/cli/commands/LensFactCommands.java ---------------------------------------------------------------------- diff --git a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensFactCommands.java b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensFactCommands.java index 818bd99..7ef7c23 100644 --- a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensFactCommands.java +++ b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensFactCommands.java @@ -45,9 +45,9 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable */ @CliCommand(value = "show facts", help = "display list of fact tables in current database. " - + "If optional <cube-name> is supplied, only facts belonging to cube <cube-name> will be displayed") + + "If optional <cube_name> is supplied, only facts belonging to cube <cube_name> will be displayed") public String showFacts( - @CliOption(key = {"", "cube-name"}, mandatory = false, help = "<cube-name>") String cubeName) { + @CliOption(key = {"", "cube_name"}, mandatory = false, help = "<cube_name>") String cubeName) { return showAll(cubeName); } @@ -69,9 +69,9 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @param name the fact * @return the string */ - @CliCommand(value = "describe fact", help = "describe fact <fact-name>") + @CliCommand(value = "describe fact", help = "describe fact <fact_name>") public String describeFactTable( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String name) { + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String name) { return describe(name); } @@ -82,9 +82,9 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @param specPath path to the file containing new spec of the fact * @return the string */ - @CliCommand(value = "update fact", help = "update fact <fact-name> taking spec from <path-to-fact-spec>") + @CliCommand(value = "update fact", help = "update fact <fact_name> taking spec from <path-to-fact-spec>") public String updateFactTable( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String name, + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String name, @CliOption(key = {"", "path"}, mandatory = true, help = "<path-to-fact-spec>") String specPath) { return update(name, specPath); } @@ -97,11 +97,11 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @return the string */ @CliCommand(value = "drop fact", - help = "drops fact <fact-name>." - + " If <cascade> is true, all the storage tables associated with the fact <fact-name> are also dropped." + help = "drops fact <fact_name>." + + " If <cascade> is true, all the storage tables associated with the fact <fact_name> are also dropped." + " By default <cascade> is false") public String dropFact( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String fact, + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String fact, @CliOption(key = {"cascade"}, mandatory = false, unspecifiedDefaultValue = "false", help = "<cascade>") boolean cascade) { return drop(fact, cascade); @@ -113,9 +113,9 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @param tableName the fact * @return the fact storages */ - @CliCommand(value = "fact list storage", help = "display list of storages associated to fact <fact-name>") + @CliCommand(value = "fact list storage", help = "display list of storages associated to fact <fact_name>") public String getFactStorages( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String tableName) { + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String tableName) { return showAllStorages(tableName); } @@ -127,9 +127,9 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @return the string */ @CliCommand(value = "fact add storage", - help = "adds a new storage to fact <fact-name>, taking storage spec from <path-to-storage-spec>") + help = "adds a new storage to fact <fact_name>, taking storage spec from <path-to-storage-spec>") public String addNewFactStorage( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String tableName, + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String tableName, @CliOption(key = {"", "path"}, mandatory = true, help = "<path-to-storage-spec>") String path) { return addStorage(tableName, path); } @@ -141,10 +141,10 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @param storage storage spec path * @return the storage from fact */ - @CliCommand(value = "fact get storage", help = "describe storage <storage-name> of fact <fact-name>") + @CliCommand(value = "fact get storage", help = "describe storage <storage_name> of fact <fact_name>") public String getStorageFromFact( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String tableName, - @CliOption(key = {"", "storage-name"}, mandatory = true, help = "<path-to-storage-spec>") String storage) { + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<path-to-storage-spec>") String storage) { return getStorage(tableName, storage); } @@ -155,10 +155,10 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @param storageName the storage name * @return the string */ - @CliCommand(value = "fact drop storage", help = "drop storage <storage-name> from fact <fact-name>") + @CliCommand(value = "fact drop storage", help = "drop storage <storage_name> from fact <fact_name>") public String dropStorageFromFact( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String tableName, - @CliOption(key = {"", "storage-name"}, mandatory = true, help = "<storage-name>") String storageName) { + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName) { return dropStorage(tableName, storageName); } @@ -168,9 +168,9 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @param name the table * @return the string */ - @CliCommand(value = "fact drop all storages", help = "drop all storages associated to fact <fact-name>") + @CliCommand(value = "fact drop all storages", help = "drop all storages associated to fact <fact_name>") public String dropAllFactStorages( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String name) { + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String name) { return dropAllStorages(name); } @@ -183,10 +183,10 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @return the all partitions of fact */ @CliCommand(value = "fact list partitions", - help = "get all partitions associated with fact <fact-name>, storage <storage-name> filtered by <partition-filter>") + help = "get all partitions associated with fact <fact_name>, storage <storage_name> filtered by <partition-filter>") public String getAllPartitionsOfFact( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String tableName, - @CliOption(key = {"", "storage"}, mandatory = true, help = "<storage-name>") String storageName, + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName, @CliOption(key = {"", "filter"}, mandatory = false, help = "<partition-filter>") String filter) { return getAllPartitions(tableName, storageName, filter); } @@ -200,11 +200,11 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @return the string */ @CliCommand(value = "fact drop partitions", - help = "drop all partitions associated with fact <fact-name>, " - + "storage <storage-name> filtered by <partition-filter>") + help = "drop all partitions associated with fact <fact_name>, " + + "storage <storage_name> filtered by <partition-filter>") public String dropAllPartitionsOfFact( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String tableName, - @CliOption(key = {"", "storage"}, mandatory = true, help = "<storage-name>") String storageName, + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName, @CliOption(key = {"", "filter"}, mandatory = false, help = "<partition-filter>") String filter) { return dropPartitions(tableName, storageName, filter); } @@ -218,21 +218,21 @@ public class LensFactCommands extends LensCRUDStoragePartitionCommand<XFactTable * @return the string */ @CliCommand(value = "fact add single-partition", - help = "add single partition to fact <fact-name>'s" - + " storage <storage-name>, reading spec from <partition-spec-path>") + help = "add single partition to fact <fact_name>'s" + + " storage <storage_name>, reading spec from <partition-spec-path>") public String addPartitionToFact( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String tableName, - @CliOption(key = {"", "storage"}, mandatory = true, help = "<storage-name>") String storageName, + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName, @CliOption(key = {"", "path"}, mandatory = true, help = "<partition-spec-path>") String path) { return addPartition(tableName, storageName, path); } @CliCommand(value = "fact add partitions", - help = "add multiple partition to fact <fact-name>'s" - + " storage <storage-name>, reading partition list spec from <partition-list-spec-path>") + help = "add multiple partition to fact <fact_name>'s" + + " storage <storage_name>, reading partition list spec from <partition-list-spec-path>") public String addPartitionsToFact( - @CliOption(key = {"", "fact-name"}, mandatory = true, help = "<fact-name>") String tableName, - @CliOption(key = {"", "storage"}, mandatory = true, help = "<storage-name>") String storageName, + @CliOption(key = {"", "fact_name"}, mandatory = true, help = "<fact_name>") String tableName, + @CliOption(key = {"", "storage_name"}, mandatory = true, help = "<storage_name>") String storageName, @CliOption(key = {"", "path"}, mandatory = true, help = "<partition-list-spec-path>") String path) { return addPartitions(tableName, storageName, path); } http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/16be6fba/lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java ---------------------------------------------------------------------- diff --git a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java index c0616d2..64e9ca4 100644 --- a/lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java +++ b/lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java @@ -133,9 +133,9 @@ public class LensQueryCommands extends BaseLensCommand { * @param qh the qh * @return the status */ - @CliCommand(value = "query status", help = "Fetch status of executed query having query handle <query-handle>") + @CliCommand(value = "query status", help = "Fetch status of executed query having query handle <query_handle>") public String getStatus( - @CliOption(key = {"", "query-handle"}, mandatory = true, help = "<query-handle>") String qh) { + @CliOption(key = {"", "query_handle"}, mandatory = true, help = "<query_handle>") String qh) { QueryStatus status = getClient().getQueryStatus(new QueryHandle(UUID.fromString(qh))); StringBuilder sb = new StringBuilder(); if (status == null) { @@ -165,10 +165,10 @@ public class LensQueryCommands extends BaseLensCommand { * @param qh the qh * @return the query */ - @CliCommand(value = "query details", help = "Get query details of query with handle <query-handle>") + @CliCommand(value = "query details", help = "Get query details of query with handle <query_handle>") public String getDetails( - @CliOption(key = {"", "query-handle"}, mandatory = true, help - = "<query-handle>") String qh) { + @CliOption(key = {"", "query_handle"}, mandatory = true, help + = "<query_handle>") String qh) { LensQuery query = getClient().getQueryDetails(qh); if (query == null) { return "Unable to find query for " + qh; @@ -191,9 +191,9 @@ public class LensQueryCommands extends BaseLensCommand { */ @CliCommand(value = "query explain", help = "Explain execution plan of query <query-string>. Can optionally save the plan" - + " to a file by providing <save-location>") + + " to a file by providing <save_location>") public String explainQuery(@CliOption(key = {"", "query"}, mandatory = true, help = "<query-string>") String sql, - @CliOption(key = {"save-location"}, mandatory = false, help = "<save-location>") String location) + @CliOption(key = {"save_location"}, mandatory = false, help = "<save_location>") String location) throws IOException { QueryPlan plan = getClient().getQueryPlan(sql); if (plan.isError()) { @@ -245,9 +245,9 @@ public class LensQueryCommands extends BaseLensCommand { * @param qh the qh * @return the string */ - @CliCommand(value = "query kill", help = "Kill query with handle <query-handle>") + @CliCommand(value = "query kill", help = "Kill query with handle <query_handle>") public String killQuery( - @CliOption(key = {"", "query-handle"}, mandatory = true, help = "<query-handle>") String qh) { + @CliOption(key = {"", "query_handle"}, mandatory = true, help = "<query_handle>") String qh) { boolean status = getClient().killQuery(new QueryHandle(UUID.fromString(qh))); if (status) { return "Successfully killed " + qh; @@ -262,9 +262,9 @@ public class LensQueryCommands extends BaseLensCommand { * @param qh the qh * @return the query results */ - @CliCommand(value = "query results", help = "get results of async query with query handle <query-handle>") + @CliCommand(value = "query results", help = "get results of async query with query handle <query_handle>") public String getQueryResults( - @CliOption(key = {"", "query-handle"}, mandatory = true, help = "<query-handle>") String qh) { + @CliOption(key = {"", "query_handle"}, mandatory = true, help = "<query_handle>") String qh) { try { LensClient.LensClientResultSetWithStats result = getClient() .getAsyncResults(new QueryHandle(UUID.fromString(qh))); @@ -307,9 +307,9 @@ public class LensQueryCommands extends BaseLensCommand { * @param ph the ph * @return the prepared status */ - @CliCommand(value = "prepQuery details", help = "Get prepared query with handle <prepare-handle>") + @CliCommand(value = "prepQuery details", help = "Get prepared query with handle <prepare_handle>") public String getPreparedStatus( - @CliOption(key = {"", "prepare-handle"}, mandatory = true, help = "<prepare-handle>") String ph) { + @CliOption(key = {"", "prepare_handle"}, mandatory = true, help = "<prepare_handle>") String ph) { LensPreparedQuery prepared = getClient().getPreparedQuery(QueryPrepareHandle.fromString(ph)); if (prepared != null) { StringBuilder sb = new StringBuilder() @@ -334,9 +334,9 @@ public class LensQueryCommands extends BaseLensCommand { * @param ph the ph * @return the string */ - @CliCommand(value = "prepQuery destroy", help = "Destroy prepared query with handle <prepare-handle>") + @CliCommand(value = "prepQuery destroy", help = "Destroy prepared query with handle <prepare_handle>") public String destroyPreparedQuery( - @CliOption(key = {"", "prepare-handle"}, mandatory = true, help = "<prepare-handle>") String ph) { + @CliOption(key = {"", "prepare_handle"}, mandatory = true, help = "<prepare_handle>") String ph) { boolean status = getClient().destroyPrepared(new QueryPrepareHandle(UUID.fromString(ph))); if (status) { return "Successfully destroyed " + ph; @@ -354,11 +354,11 @@ public class LensQueryCommands extends BaseLensCommand { * @return the string */ @CliCommand(value = "prepQuery execute", - help = "Execute prepared query with handle <prepare-handle>." + help = "Execute prepared query with handle <prepare_handle>." + " If <async> is supplied and is true, query is run in async manner and query handle is returned immediately." + " Optionally, <query-name> can be provided, though not required.") public String executePreparedQuery( - @CliOption(key = {"", "prepare-handle"}, mandatory = true, help = "Prepare handle to execute") String phandle, + @CliOption(key = {"", "prepare_handle"}, mandatory = true, help = "Prepare handle to execute") String phandle, @CliOption(key = {"async"}, mandatory = false, unspecifiedDefaultValue = "false", specifiedDefaultValue = "true", help = "<async>") boolean async, @CliOption(key = {"name"}, mandatory = false, help = "<query-name>") String queryName) { http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/16be6fba/src/site/apt/user/cli.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/user/cli.apt b/src/site/apt/user/cli.apt index cbbc3eb..bd39497 100644 --- a/src/site/apt/user/cli.apt +++ b/src/site/apt/user/cli.apt @@ -88,10 +88,6 @@ User CLI Commands *--+--+ |set \<key\>=\<value\>|Assign <<<value>>> to session parameter specified with <<<key>>> on lens server| *--+--+ -|get [--key] \<key\>|Fetches and prints session parameter specified with name <<<key>>> from lens server| -*--+--+ -|show params|Fetches and prints all session parameter from lens server| -*--+--+ |add jar [--path] \<path-to-jar-on-server-side\>|Adds jar resource to the session| *--+--+ |remove jar [--path] \<path-to-jar-on-server-side\>|Removes a jar resource from session| @@ -104,6 +100,10 @@ User CLI Commands *--+--+ |close/bye|Releases all resources of the server session and exits the shell| *--+--+ +|get [--key] \<key\>|Fetches and prints session parameter specified with name <<<key>>> from lens server| +*--+--+ +|show params|Fetches and prints all session parameter from lens server| +*--+--+ <<Lens Connection Commands>> === @@ -115,13 +115,13 @@ User CLI Commands *--+--+ |<<Command>>|<<Description>>| *--+--+ -|show databases|displays list of all databases| +|drop database [--db] \<database-name\>|drop a database with specified name| *--+--+ |use [--db] \<database-name\>|change to new database| *--+--+ |create database [--db] \<database-name\> [--ignoreIfExists \<ignore-if-exists\>]|create a database with specified name. if <<<ignore-if-exists>>> is true, create will not be tried if already exists. Default is false| *--+--+ -|drop database [--db] \<database-name\>|drop a database with specified name| +|show databases|displays list of all databases| *--+--+ <<Lens Database Commands>> @@ -159,13 +159,13 @@ User CLI Commands *--+--+ |create cube [--path] \<path-to-cube-spec-file\>|Create a new Cube, taking spec from <<<path-to-cube-spec-file>>>| *--+--+ -|describe cube [--name] \<cube-name\>|describe cube with name <<<cube-name>>>| +|describe cube [--name] \<cube_name\>|describe cube with name <<<cube_name>>>| *--+--+ -|update cube [--name] \<cube-name\> [--path] \<path-to-cube-spec-file\>|update cube <<<cube-name>>> with spec from <<<path-to-cube-spec-file>>>| +|update cube [--name] \<cube_name\> [--path] \<path-to-cube-spec-file\>|update cube <<<cube_name>>> with spec from <<<path-to-cube-spec-file>>>| *--+--+ -|drop cube [--name] \<cube-name\>|drop cube <<<cube-name>>>| +|drop cube [--name] \<cube_name\>|drop cube <<<cube_name>>>| *--+--+ -|cube latestdate [--cube] \<cube-name\> [--timeDimension] \<time-dimension-name\>|get latest date of data available in cube <<<cube-name>>> for time dimension <<<time-dimension-name>>>| +|cube latestdate [--cube] \<cube_name\> [--timeDimension] \<time_dimension_name\>|get latest date of data available in cube <<<cube_name>>> for time dimension <<<time_dimension_name>>>| *--+--+ <<Lens Cube Commands>> @@ -182,11 +182,11 @@ User CLI Commands *--+--+ |create dimension [--path] \<path-to-dimension-spec file\>|Create a new Dimension, taking spec from <<<path-to-dimension-spec file>>>| *--+--+ -|describe dimension [--name] \<dimension-name\>|describe dimension <<<dimension-name>>>| +|describe dimension [--name] \<dimension_name\>|describe dimension <<<dimension_name>>>| *--+--+ -|update dimension [--name] \<dimension-name\> [--path] \<path-to-dimension-spec-file\>|update dimension <<<dimension-name>>>, taking spec from <<<path-to-dimension-spec file>>>| +|update dimension [--name] \<dimension_name\> [--path] \<path-to-dimension-spec-file\>|update dimension <<<dimension_name>>>, taking spec from <<<path-to-dimension-spec file>>>| *--+--+ -|drop dimension [--name] \<dimension-name\>|drop dimension <<<dimension-name>>>| +|drop dimension [--name] \<dimension_name\>|drop dimension <<<dimension_name>>>| *--+--+ <<Lens Dimension Commands>> @@ -199,33 +199,33 @@ User CLI Commands *--+--+ |<<Command>>|<<Description>>| *--+--+ -|show facts [[--cube-name] \<cube-name\>]|display list of fact tables in current database. If optional <<<cube-name>>> is supplied, only facts belonging to cube <<<cube-name>>> will be displayed| +|show facts [[--cube_name] \<cube_name\>]|display list of fact tables in current database. If optional <<<cube_name>>> is supplied, only facts belonging to cube <<<cube_name>>> will be displayed| *--+--+ |create fact [--path] \<path-to-fact-spec-file\>|create a fact table with spec from <<<path-to-fact-spec-file>>>| *--+--+ -|describe fact [--fact-name] \<fact-name\>|describe fact <<<fact-name>>>| +|describe fact [--fact_name] \<fact_name\>|describe fact <<<fact_name>>>| *--+--+ -|update fact [--fact-name] \<fact-name\> [--path] \<path-to-fact-spec\>|update fact <<<fact-name>>> taking spec from <<<path-to-fact-spec>>>| +|update fact [--fact_name] \<fact_name\> [--path] \<path-to-fact-spec\>|update fact <<<fact_name>>> taking spec from <<<path-to-fact-spec>>>| *--+--+ -|drop fact [--fact-name] \<fact-name\> [--cascade \<cascade\>]|drops fact <<<fact-name>>>. If <<<cascade>>> is true, all the storage tables associated with the fact <<<fact-name>>> are also dropped. By default <<<cascade>>> is false| +|drop fact [--fact_name] \<fact_name\> [--cascade \<cascade\>]|drops fact <<<fact_name>>>. If <<<cascade>>> is true, all the storage tables associated with the fact <<<fact_name>>> are also dropped. By default <<<cascade>>> is false| *--+--+ -|fact list storage [--fact-name] \<fact-name\>|display list of storages associated to fact <<<fact-name>>>| +|fact list storage [--fact_name] \<fact_name\>|display list of storages associated to fact <<<fact_name>>>| *--+--+ -|fact add storage [--fact-name] \<fact-name\> [--path] \<path-to-storage-spec\>|adds a new storage to fact <<<fact-name>>>, taking storage spec from <<<path-to-storage-spec>>>| +|fact add storage [--fact_name] \<fact_name\> [--path] \<path-to-storage-spec\>|adds a new storage to fact <<<fact_name>>>, taking storage spec from <<<path-to-storage-spec>>>| *--+--+ -|fact get storage [--fact-name] \<fact-name\> [--storage-name] \<path-to-storage-spec\>|describe storage <<<storage-name>>> of fact <<<fact-name>>>| +|fact get storage [--fact_name] \<fact_name\> [--storage_name] \<path-to-storage-spec\>|describe storage <<<storage_name>>> of fact <<<fact_name>>>| *--+--+ -|fact drop storage [--fact-name] \<fact-name\> [--storage-name] \<storage-name\>|drop storage <<<storage-name>>> from fact <<<fact-name>>>| +|fact drop storage [--fact_name] \<fact_name\> [--storage_name] \<storage_name\>|drop storage <<<storage_name>>> from fact <<<fact_name>>>| *--+--+ -|fact drop all storages [--fact-name] \<fact-name\>|drop all storages associated to fact <<<fact-name>>>| +|fact drop all storages [--fact_name] \<fact_name\>|drop all storages associated to fact <<<fact_name>>>| *--+--+ -|fact list partitions [--fact-name] \<fact-name\> [--storage] \<storage-name\> [[--filter] \<partition-filter\>]|get all partitions associated with fact <<<fact-name>>>, storage <<<storage-name>>> filtered by <<<partition-filter>>>| +|fact list partitions [--fact_name] \<fact_name\> [--storage_name] \<storage_name\> [[--filter] \<partition-filter\>]|get all partitions associated with fact <<<fact_name>>>, storage <<<storage_name>>> filtered by <<<partition-filter>>>| *--+--+ -|fact drop partitions [--fact-name] \<fact-name\> [--storage] \<storage-name\> [[--filter] \<partition-filter\>]|drop all partitions associated with fact <<<fact-name>>>, storage <<<storage-name>>> filtered by <<<partition-filter>>>| +|fact drop partitions [--fact_name] \<fact_name\> [--storage_name] \<storage_name\> [[--filter] \<partition-filter\>]|drop all partitions associated with fact <<<fact_name>>>, storage <<<storage_name>>> filtered by <<<partition-filter>>>| *--+--+ -|fact add single-partition [--fact-name] \<fact-name\> [--storage] \<storage-name\> [--path] \<partition-spec-path\>|add single partition to fact <<<fact-name>>>'s storage <<<storage-name>>>, reading spec from <<<partition-spec-path>>>| +|fact add single-partition [--fact_name] \<fact_name\> [--storage_name] \<storage_name\> [--path] \<partition-spec-path\>|add single partition to fact <<<fact_name>>>'s storage <<<storage_name>>>, reading spec from <<<partition-spec-path>>>| *--+--+ -|fact add partitions [--fact-name] \<fact-name\> [--storage] \<storage-name\> [--path] \<partition-list-spec-path\>|add multiple partition to fact <<<fact-name>>>'s storage <<<storage-name>>>, reading partition list spec from <<<partition-list-spec-path>>>| +|fact add partitions [--fact_name] \<fact_name\> [--storage_name] \<storage_name\> [--path] \<partition-list-spec-path\>|add multiple partition to fact <<<fact_name>>>'s storage <<<storage_name>>>, reading partition list spec from <<<partition-list-spec-path>>>| *--+--+ <<Lens Fact Commands>> @@ -238,33 +238,33 @@ User CLI Commands *--+--+ |<<Command>>|<<Description>>| *--+--+ -|show dimtables [[--dimension-name] \<dimension-name\>]|display list of dimtables in current database. If optional <<<dimension-name>>> is supplied, only facts belonging to dimension <<<dimension-name>>> will be displayed| +|dimtable drop all storages [--dimtable_name] \<dimtable_name\>|drop all storages associated to dimension table| *--+--+ -|create dimtable [--path] \<path-to-dimtable-spec-file\>|Create a new dimension table taking spec from <<<path-to-dimtable-spec-file>>>| +|dimtable list partitions [--dimtable_name] \<dimtable_name\> [--storage_name] \<storage_name\> [[--filter] \<partition-filter\>]|get all partitions associated with dimtable <<<dimtable_name>>>, storage <<<storage_name>>> filtered by <<<partition-filter>>>| *--+--+ -|describe dimtable [--dimtable-name] \<dimtable-name\>|describe dimtable <<<dimtable-name>>>| +|dimtable drop partitions [--dimtable_name] \<dimtable_name\> [--storage_name] \<storage_name\> [[--filter] \<partition-filter\>]|drop all partitions associated with dimtable <<<dimtable_name>>>, storage <<<storage_name>>> filtered by <<<partition-filter>>>| *--+--+ -|update dimtable [--dimtable-name] \<dimtable-name\> [--path] \<path-to-dimtable-spec\>|update dimtable <<<dimtable-name>>> taking spec from <<<path-to-dimtable-spec>>>| +|dimtable add single-partition [--dimtable_name] \<dimtable_name\> [--storage_name] \<storage_name\> [--path] \<partition-spec-path\>|add single partition to dimtable <<<dimtable_name>>>'s storage <<<storage_name>>>, reading spec from <<<partition-spec-path>>>| *--+--+ -|drop dimtable [--dimtable-name] \<dimtable-name\> [--cascade \<cascade\>]|drop dimtable <<<dimtable-name>>>. If <<<cascade>>> is true, all the storage tables associated with the dimtable <<<dimtable-name>>> are also dropped. By default <<<cascade>>> is false| +|dimtable add partitions [--dimtable_name] \<dimtable_name\> [--storage_name] \<storage_name\> [--path] \<partition-list-spec-path\>|add multiple partition to dimtable <<<dimtable_name>>>'s storage <<<storage_name>>>, reading partition list spec from <<<partition-list-spec-path>>>| *--+--+ -|dimtable list storages [--dimtable-name] \<dimtable-name\>|display list of storage associated to dimtable <<<dimtable-name>>>| +|show dimtables [[--dimension_name] \<dimension_name\>]|display list of dimtables in current database. If optional <<<dimension_name>>> is supplied, only facts belonging to dimension <<<dimension_name>>> will be displayed| *--+--+ -|dimtable add storage [--dimtable-name] \<dimtable-name\> [--path] \<path-to-storage-spec\>|adds a new storage to dimtable <<<dimtable-name>>>, taking storage spec from <<<path-to-storage-spec>>>| +|create dimtable [--path] \<path-to-dimtable-spec-file\>|Create a new dimension table taking spec from <<<path-to-dimtable-spec-file>>>| *--+--+ -|dimtable get storage [--dimtable-name] \<dimtable-name\> [--storage-name] \<storage-name\>|describe storage <<<storage-name>>> of dimtable <<<dimtable-name>>>| +|describe dimtable [--dimtable_name] \<dimtable_name\>|describe dimtable <<<dimtable_name>>>| *--+--+ -|dimtable drop storage [--dimtable-name] \<dimtable-name\> [--storage-name] \<storage-name\>|drop storage <<<storage-name>>> from dimtable <<<dimtable-name>>>| +|update dimtable [--dimtable_name] \<dimtable_name\> [--path] \<path-to-dimtable-spec\>|update dimtable <<<dimtable_name>>> taking spec from <<<path-to-dimtable-spec>>>| *--+--+ -|dimtable drop all storages [--dimtable-name] \<dimtable-name\>|drop all storages associated to dimension table| +|drop dimtable [--dimtable_name] \<dimtable_name\> [--cascade \<cascade\>]|drop dimtable <<<dimtable_name>>>. If <<<cascade>>> is true, all the storage tables associated with the dimtable <<<dimtable_name>>> are also dropped. By default <<<cascade>>> is false| *--+--+ -|dimtable list partitions [--dimtable-name] \<dimtable-name\> [--storage-name] \<storage-name\> [[--filter] \<partition-filter\>]|get all partitions associated with dimtable <<<dimtable-name>>>, storage <<<storage-name>>> filtered by <<<partition-filter>>>| +|dimtable list storages [--dimtable_name] \<dimtable_name\>|display list of storage associated to dimtable <<<dimtable_name>>>| *--+--+ -|dimtable drop partitions [--dimtable-name] \<dimtable-name\> [--storage-name] \<storage-name\> [[--filter] \<partition-filter\>]|drop all partitions associated with dimtable <<<dimtable-name>>>, storage <<<storage-name>>> filtered by <<<partition-filter>>>| +|dimtable add storage [--dimtable_name] \<dimtable_name\> [--path] \<path-to-storage-spec\>|adds a new storage to dimtable <<<dimtable_name>>>, taking storage spec from <<<path-to-storage-spec>>>| *--+--+ -|dimtable add single-partition [--dimtable-name] \<dimtable-name\> [--storage-name] \<storage-name\> [--path] \<partition-spec-path\>|add single partition to dimtable <<<dimtable-name>>>'s storage <<<storage-name>>>, reading spec from <<<partition-spec-path>>>| +|dimtable get storage [--dimtable_name] \<dimtable_name\> [--storage_name] \<storage_name\>|describe storage <<<storage_name>>> of dimtable <<<dimtable_name>>>| *--+--+ -|dimtable add partitions [--dimtable-name] \<dimtable-name\> [--storage-name] \<storage-name\> [--path] \<partition-list-spec-path\>|add multiple partition to dimtable <<<dimtable-name>>>'s storage <<<storage-name>>>, reading partition list spec from <<<partition-list-spec-path>>>| +|dimtable drop storage [--dimtable_name] \<dimtable_name\> [--storage_name] \<storage_name\>|drop storage <<<storage_name>>> from dimtable <<<dimtable_name>>>| *--+--+ <<Lens Dimension Table Commands>> @@ -277,10 +277,10 @@ User CLI Commands *--+--+ |<<Command>>|<<Description>>| *--+--+ -|describe nativetable [--name] \<native-table-name\>|describe nativetable named <<<native-table-name>>>| -*--+--+ |show nativetables|show list of native tables belonging to current database| *--+--+ +|describe nativetable [--name] \<native-table-name\>|describe nativetable named <<<native-table-name>>>| +*--+--+ <<Lens Native Table Commands>> === @@ -300,32 +300,32 @@ User CLI Commands *--+--+ |<<Command>>|<<Description>>| *--+--+ -|prepQuery prepare [--query] \<query-string\> [--name \<query-name\>]|Prepapre query <<<query-string>>> and return prepare handle. Can optionaly provide <<<query-name>>>| +|query status [--query_handle] \<query_handle\>|Fetch status of executed query having query handle <<<query_handle>>>| *--+--+ -|query status [--query-handle] \<query-handle\>|Fetch status of executed query having query handle <<<query-handle>>>| +|query details [--query_handle] \<query_handle\>|Get query details of query with handle <<<query_handle>>>| *--+--+ -|query execute [--query] \<query-string\> [--async \<async\>] [--name \<query-name\>]|Execute query <<<query-string>>>. If <<<async>>> is true, The query is launched in async manner and query handle is returned. It's by default false. <<<query name>>> can also be provided, though not required| -*--+--+ -|query details [--query-handle] \<query-handle\>|Get query details of query with handle <<<query-handle>>>| -*--+--+ -|query explain [--query] \<query-string\> [--save-location \<save-location\>]|Explain execution plan of query <<<query-string>>>. Can optionally save the plan to a file by providing <<<save-location>>>| +|query explain [--query] \<query-string\> [--save_location \<save_location\>]|Explain execution plan of query <<<query-string>>>. Can optionally save the plan to a file by providing <<<save_location>>>| *--+--+ |query list [--state \<query-status\>] [--name \<query-name\>] [--user \<user-who-submitted-query\>] [--fromDate \<submission-time-is-after\>] [--toDate \<submission-time-is-before\>]|Get all queries. Various filter options can be provided(optionally), as can be seen from the command syntax| *--+--+ -|query kill [--query-handle] \<query-handle\>|Kill query with handle <<<query-handle>>>| +|query execute [--query] \<query-string\> [--async \<async\>] [--name \<query-name\>]|Execute query <<<query-string>>>. If <<<async>>> is true, The query is launched in async manner and query handle is returned. It's by default false. <<<query name>>> can also be provided, though not required| +*--+--+ +|query kill [--query_handle] \<query_handle\>|Kill query with handle <<<query_handle>>>| *--+--+ -|query results [--query-handle] \<query-handle\>|get results of async query with query handle <<<query-handle>>>| +|query results [--query_handle] \<query_handle\>|get results of async query with query handle <<<query_handle>>>| *--+--+ |prepQuery list [--name \<query-name\>] [--user \<user-who-submitted-query\>] [--fromDate \<submission-time-is-after\>] [--toDate \<submission-time-is-before\>]|Get all prepared queries. Various filters can be provided(optionally) as can be seen from command syntax| *--+--+ -|prepQuery details [--prepare-handle] \<prepare-handle\>|Get prepared query with handle <<<prepare-handle>>>| +|prepQuery details [--prepare_handle] \<prepare_handle\>|Get prepared query with handle <<<prepare_handle>>>| *--+--+ -|prepQuery destroy [--prepare-handle] \<prepare-handle\>|Destroy prepared query with handle <<<prepare-handle>>>| +|prepQuery destroy [--prepare_handle] \<prepare_handle\>|Destroy prepared query with handle <<<prepare_handle>>>| *--+--+ -|prepQuery execute [--prepare-handle] Prepare handle to execute [--async \<async\>] [--name \<query-name\>]|Execute prepared query with handle <<<prepare-handle>>>. If <<<async>>> is supplied and is true, query is run in async manner and query handle is returned immediately. Optionally, <<<query-name>>> can be provided, though not required.| +|prepQuery execute [--prepare_handle] Prepare handle to execute [--async \<async\>] [--name \<query-name\>]|Execute prepared query with handle <<<prepare_handle>>>. If <<<async>>> is supplied and is true, query is run in async manner and query handle is returned immediately. Optionally, <<<query-name>>> can be provided, though not required.| *--+--+ |prepQuery explain [--query] \<query-string\> [--name \<query-name\>]|Explain and prepare query <<<query-string>>>. Can optionally provide <<<query-name>>>| *--+--+ +|prepQuery prepare [--query] \<query-string\> [--name \<query-name\>]|Prepapre query <<<query-string>>> and return prepare handle. Can optionaly provide <<<query-name>>>| +*--+--+ <<Lens Query Commands>> ===
