Updating documentation.
Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/2990b6f8 Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/2990b6f8 Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/2990b6f8 Branch: refs/heads/master Commit: 2990b6f8a31bce6e97378e611220a2de7d6e1476 Parents: e157905 Author: Aaron McCurry <[email protected]> Authored: Thu Jan 1 12:19:32 2015 -0500 Committer: Aaron McCurry <[email protected]> Committed: Thu Jan 1 12:19:32 2015 -0500 ---------------------------------------------------------------------- .../shell/ExecutePlatformCommandCommand.java | 4 +- .../java/org/apache/blur/shell/GenerateDoc.java | 2 + .../main/java/org/apache/blur/shell/Main.java | 5 +++ .../resources/org/apache/blur/doc/header.html | 2 - docs/Blur.html | 3 +- docs/cluster-setup.base.html | 6 +-- docs/cluster-setup.html | 12 +++--- docs/console.html | 2 - docs/data-model.html | 2 - docs/getting-started.html | 8 ++-- docs/index.html | 2 - docs/platform.html | 36 ++++++---------- docs/using-blur.base.html | 2 - docs/using-blur.html | 44 +++++++++++++++++--- 14 files changed, 72 insertions(+), 58 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/blur-shell/src/main/java/org/apache/blur/shell/ExecutePlatformCommandCommand.java ---------------------------------------------------------------------- diff --git a/blur-shell/src/main/java/org/apache/blur/shell/ExecutePlatformCommandCommand.java b/blur-shell/src/main/java/org/apache/blur/shell/ExecutePlatformCommandCommand.java index fe55e88..f4af102 100644 --- a/blur-shell/src/main/java/org/apache/blur/shell/ExecutePlatformCommandCommand.java +++ b/blur-shell/src/main/java/org/apache/blur/shell/ExecutePlatformCommandCommand.java @@ -190,12 +190,12 @@ public class ExecutePlatformCommandCommand extends Command implements CommandFir @Override public String description() { - return "Execute a platform command."; + return "Execute a platform command. Run -h for full argument list."; } @Override public String usage() { - return ""; + return "<command name> ..."; } @Override http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/blur-shell/src/main/java/org/apache/blur/shell/GenerateDoc.java ---------------------------------------------------------------------- diff --git a/blur-shell/src/main/java/org/apache/blur/shell/GenerateDoc.java b/blur-shell/src/main/java/org/apache/blur/shell/GenerateDoc.java index 42d2fb2..2a8e1c9 100644 --- a/blur-shell/src/main/java/org/apache/blur/shell/GenerateDoc.java +++ b/blur-shell/src/main/java/org/apache/blur/shell/GenerateDoc.java @@ -38,6 +38,8 @@ public class GenerateDoc { printCommands("Table Commands", Main.tableCommands, commands, menu, body); printCommands("Data Commands", Main.dataCommands, commands, menu, body); printCommands("Cluster Commands", Main.clusterCommands, commands, menu, body); + printCommands("Server Commands", Main.serverCommands, commands, menu, body); + printCommands("Platform Commands", Main.platformCommands, commands, menu, body); printCommands("Shell Commands", Main.shellCommands, commands, menu, body); menu.close(); body.close(); http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/blur-shell/src/main/java/org/apache/blur/shell/Main.java ---------------------------------------------------------------------- diff --git a/blur-shell/src/main/java/org/apache/blur/shell/Main.java b/blur-shell/src/main/java/org/apache/blur/shell/Main.java index 63ee125..f246eee 100644 --- a/blur-shell/src/main/java/org/apache/blur/shell/Main.java +++ b/blur-shell/src/main/java/org/apache/blur/shell/Main.java @@ -399,6 +399,7 @@ public class Main { public static String[] clusterCommands = { "controllers", "shards", "clusterlist", "cluster", "safemodewait", "top" }; public static String[] shellCommands = { "help", "debug", "timed", "quit", "reset", "user", "whoami", "trace", "trace-remove", "trace-list" }; + public static String[] platformCommands = { "command-list", "command-exec", "command-desc" }; public static String[] serverCommands = { "logger", "logger-reset", "remove-shard" }; private static class HelpCommand extends Command { @@ -440,6 +441,10 @@ public class Main { printCommandAndHelp(out, cmds, serverCommands, bufferLength); out.println(); + out.println(" - Platform commands - "); + printCommandAndHelp(out, cmds, platformCommands, bufferLength); + + out.println(); out.println(" - Shell commands - "); printCommandAndHelp(out, cmds, shellCommands, bufferLength); http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/blur-util/src/main/resources/org/apache/blur/doc/header.html ---------------------------------------------------------------------- diff --git a/blur-util/src/main/resources/org/apache/blur/doc/header.html b/blur-util/src/main/resources/org/apache/blur/doc/header.html index c50f86b..2211ce7 100644 --- a/blur-util/src/main/resources/org/apache/blur/doc/header.html +++ b/blur-util/src/main/resources/org/apache/blur/doc/header.html @@ -43,8 +43,6 @@ <li><a href="using-blur.html">Using Blur</a></li> <li class="active"><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/Blur.html ---------------------------------------------------------------------- diff --git a/docs/Blur.html b/docs/Blur.html index 16daa14..1e68f3f 100644 --- a/docs/Blur.html +++ b/docs/Blur.html @@ -38,13 +38,12 @@ limitations under the License. <ul class="nav navbar-nav"> <li><a href="index.html">Main</a></li> <li><a href="getting-started.html">Getting Started</a></li> +<li><a href="platform.html">Platform</a></li> <li><a href="data-model.html">Data Model</a></li> <li><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li class="active"><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> -<li><a href="site/index.html" target="_blank">Maven Site</a></li> -<li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/cluster-setup.base.html ---------------------------------------------------------------------- diff --git a/docs/cluster-setup.base.html b/docs/cluster-setup.base.html index fbbad14..3006f58 100644 --- a/docs/cluster-setup.base.html +++ b/docs/cluster-setup.base.html @@ -44,8 +44,6 @@ <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> @@ -115,9 +113,9 @@ file: <pre> <code class="bash"># The ZooKeeper connection string, consider adding a root path to the string, it # can help when upgrading Blur. -# Example: zknode1:2181,zknode2:2181,zknode3:2181/blur-0.2.1 +# Example: zknode1:2181,zknode2:2181,zknode3:2181/blur-0.2.4 # -# NOTE: If you provide the root path "/blur-0.2.1", that will have to be manually +# NOTE: If you provide the root path "/blur-0.2.4", that will have to be manually # created before Blur will start. blur.zookeeper.connection=127.0.0.1 http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/cluster-setup.html ---------------------------------------------------------------------- diff --git a/docs/cluster-setup.html b/docs/cluster-setup.html index af24e0b..b2848e8 100644 --- a/docs/cluster-setup.html +++ b/docs/cluster-setup.html @@ -44,8 +44,6 @@ <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> @@ -115,9 +113,9 @@ file: <pre> <code class="bash"># The ZooKeeper connection string, consider adding a root path to the string, it # can help when upgrading Blur. -# Example: zknode1:2181,zknode2:2181,zknode3:2181/blur-0.2.3 +# Example: zknode1:2181,zknode2:2181,zknode3:2181/blur-0.2.4 # -# NOTE: If you provide the root path "/blur-0.2.3", that will have to be manually +# NOTE: If you provide the root path "/blur-0.2.4", that will have to be manually # created before Blur will start. blur.zookeeper.connection=127.0.0.1 @@ -134,7 +132,7 @@ blur.cluster.default.table.uri=hdfs://namenode/blur/tables</code> <h4>Default Properties</h4> <table class="table-bordered table-striped table-condensed"> <tr><td>Property</td><td>Description</td></tr> -<tr><td>blur.zookeeper.timeout (90000)</td><td>The zookeeper session timeout</td></tr><tr><td>blur.hdfs.trace.path</td><td>The path in HDFS where the distributed traces will be stored, if blank trace output will be written to the log or the ZooKeeper store.</td></tr><tr><td>blur.query.max.results.fetch (1000)</td><td>The maximum number of results that can be fetched in a single request</td></tr><tr><td>blur.query.max.row.fetch (100)</td><td>The maximum number of rows that can be fetched in a single request</td></tr><tr><td>blur.query.max.record.fetch (1000)</td><td>The maximum number of records that can be fetched in a single request</td></tr><tr><td>blur.metrics.reporters</td><td>Setup metric reporter</td></tr><tr><td>blur.thrift.max.frame.size (16384000)</td><td>Thrift max frame size</td></tr> +<tr><td>blur.zookeeper.timeout (90000)</td><td>The zookeeper session timeout</td></tr><tr><td>blur.hdfs.trace.path</td><td>The path in HDFS where the distributed traces will be stored, if blank trace output will be written to the log or the ZooKeeper store.</td></tr><tr><td>blur.clientpool.client.max.connections.per.host (64)</td><td>Max number of connections per host.</td></tr><tr><td>blur.clientpool.client.stale.threshold (30)</td><td>Number of seconds between use that a connection will be marked as stale.</td></tr><tr><td>blur.clientpool.client.clean.frequency (10)</td><td>Number of seconds between checking connections.</td></tr><tr><td>blur.query.max.results.fetch (1000)</td><td>The maximum number of results that can be fetched in a single request</td></tr><tr><td>blur.query.max.row.fetch (100)</td><td>The maximum number of rows that can be fetched in a single request</td></tr><tr><td>blur.query.max.record.fetch (1000)</td><td>The maximum number of records that can be fetched in a single request</td></tr><tr><td>blur.metrics.reporters</td><td>Setup metric reporter</td></tr><tr><td>blur.thrift.max.frame.size (16384000)</td><td>Thrift max frame size</td></tr> </table> <h3 id="general-hadoop">Hadoop</h3> <p> @@ -159,7 +157,7 @@ export HADOOP_HOME=<path to your Hadoop install directory></code> <h4>Default Properties</h4> <table class="table-bordered table-striped table-condensed"> <tr><td>Property</td><td>Description</td></tr> -<tr><td>blur.controller.hostname</td><td>Sets the hostname for the controller, if blank the hostname is automatically detected</td></tr><tr><td>blur.controller.bind.address (0.0.0.0)</td><td>The binding address of the controller</td></tr><tr><td>blur.controller.bind.port (40010)</td><td>The default binding port of the controller server</td></tr><tr><td>blur.controller.shard.connection.timeout (60000)</td><td>The connection timeout, NOTE: this will be the maximum amount of time you can wait for a query.</td></tr><tr><td>blur.controller.server.thrift.thread.count (32)</td><td>The number of threads used for thrift requests</td></tr><tr><td>blur.controller.server.remote.thread.count (64)</td><td>The number of threads used for remote thrift requests to the shards server. This should be a large number.</td></tr><tr><td>blur.controller.thrift.selector.threads (2)</td><td>The number of threads used for selector processing inside the thrift server.</td></tr><tr><td>blur.controller.thrift.ma x.read.buffer.bytes (9223372036854775807)</td><td>The maximum number of bytes used for reading requests in the thrift server.</td></tr><tr><td>blur.controller.thrift.accept.queue.size.per.thread (4)</td><td>The size of the blocking queue per selector thread for passing accepted connections to the selector thread.</td></tr><tr><td>blur.controller.remote.fetch.count (150)</td><td>The number of hits to fetch per request to the shard servers</td></tr><tr><td>blur.controller.retry.max.fetch.retries (3)</td><td>The max number of retries to the shard server when there is an error during fetch</td></tr><tr><td>blur.controller.retry.max.mutate.retries (3)</td><td>The max number of retries to the shard server when there is an error during mutate</td></tr><tr><td>blur.controller.retry.max.default.retries (3)</td><td>The max number of retries to the shard server when there is an error during all other request</td></tr><tr><td>blur.controller.retry.fetch.delay (500)</td><td>The starting backoff delay for the first retry for a fetch errors</td></tr><tr><td>blur.controller.retry.mutate.delay (500)</td><td>The starting backoff delay for the first retry for a mutate errors</td></tr><tr><td>blur.controller.retry.default.delay (500)</td><td>The starting backoff delay for the first retry for a all other request errors</td></tr><tr><td>blur.controller.retry.max.fetch.delay (2000)</td><td>The ending backoff delay for the last retry for a fetch errors</td></tr><tr><td>blur.controller.retry.max.mutate.delay (2000)</td><td>The ending backoff delay for the last retry for a mutate errors</td></tr><tr><td>blur.controller.retry.max.default.delay (2000)</td><td>The ending backoff delay for the last retry for a all other request errors</td></tr><tr><td>blur.gui.controller.port (40080)</td><td>The http status page port for the controller server</td></tr><tr><td>blur.controller.filtered.server.class</td><td>To intercept the calls made to the controller server and perform server side changes t o the calls extend org.apache.blur.server.FilteredBlurServer.</td></tr> +<tr><td>blur.controller.hostname</td><td>Sets the hostname for the controller, if blank the hostname is automatically detected</td></tr><tr><td>blur.controller.bind.address (0.0.0.0)</td><td>The binding address of the controller</td></tr><tr><td>blur.controller.bind.port (40010)</td><td>The default binding port of the controller server, 0 for random</td></tr><tr><td>blur.controller.shard.connection.timeout (60000)</td><td>The connection timeout, NOTE: this will be the maximum amount of time you can wait for a query.</td></tr><tr><td>blur.controller.command.driver.threads (16)</td><td>The number of command driver threads.</td></tr><tr><td>blur.controller.command.worker.threads (16)</td><td>The number of command worker threads.</td></tr><tr><td>blur.controller.server.thrift.thread.count (32)</td><td>The number of threads used for thrift requests</td></tr><tr><td>blur.controller.server.remote.thread.count (64)</td><td>The number of threads used for remote thrift requests to the shards server. This should be a large number.</td></tr><tr><td>blur.controller.thrift.selector.threads (2)</td><td>The number of threads used for selector processing inside the thrift server.</td></tr><tr><td>blur.controller.thrift.max.read.buffer.bytes (9223372036854775807)</td><td>The maximum number of bytes used for reading requests in the thrift server.</td></tr><tr><td>blur.controller.thrift.accept.queue.size.per.thread (4)</td><td>The size of the blocking queue per selector thread for passing accepted connections to the selector thread.</td></tr><tr><td>blur.controller.remote.fetch.count (150)</td><td>The number of hits to fetch per request to the shard servers</td></tr><tr><td>blur.controller.retry.max.fetch.retries (3)</td><td>The max number of retries to the shard server when there is an error during fetch</td></tr><tr><td>blur.controller.retry.max.mutate.retries (3)</td><td>The max number of retries to the shard server when there is an error during mutate</td></tr><tr><td>blur.c ontroller.retry.max.default.retries (3)</td><td>The max number of retries to the shard server when there is an error during all other request</td></tr><tr><td>blur.controller.retry.fetch.delay (500)</td><td>The starting backoff delay for the first retry for a fetch errors</td></tr><tr><td>blur.controller.retry.mutate.delay (500)</td><td>The starting backoff delay for the first retry for a mutate errors</td></tr><tr><td>blur.controller.retry.default.delay (500)</td><td>The starting backoff delay for the first retry for a all other request errors</td></tr><tr><td>blur.controller.retry.max.fetch.delay (2000)</td><td>The ending backoff delay for the last retry for a fetch errors</td></tr><tr><td>blur.controller.retry.max.mutate.delay (2000)</td><td>The ending backoff delay for the last retry for a mutate errors</td></tr><tr><td>blur.controller.retry.max.default.delay (2000)</td><td>The ending backoff delay for the last retry for a all other request errors</td></tr><tr><td>blur.gui.contr oller.port (40080)</td><td>The http status page port for the controller server, 0 for random</td></tr><tr><td>blur.controller.filtered.server.class</td><td>To intercept the calls made to the controller server and perform server side changes to the calls extend org.apache.blur.server.FilteredBlurServer.</td></tr> </table> <h3 id="controller-blur-env">blur-env.sh</h3> <pre><code class="bash"># JAVA JVM OPTIONS for the controller servers, jvm tuning parameters are placed here. @@ -206,7 +204,7 @@ Swap can kill java perform, you may want to consider disabling swap.</div> <h4>Default Properties</h4> <table class="table-bordered table-striped table-condensed"> <tr><td>Property</td><td>Description</td></tr> -<tr><td>blur.shard.hostname</td><td>The hostname for the shard, if blank the hostname is automatically detected</td></tr><tr><td>blur.shard.bind.address (0.0.0.0)</td><td>The binding address of the shard</td></tr><tr><td>blur.shard.bind.port (40020)</td><td>The default binding port of the shard server</td></tr><tr><td>blur.shard.data.fetch.thread.count (8)</td><td>The number of fetcher threads</td></tr><tr><td>blur.shard.server.thrift.thread.count (8)</td><td>The number of the thrift threads</td></tr><tr><td>blur.shard.thrift.selector.threads (2)</td><td>The number of threads used for selector processing inside the thrift server.</td></tr><tr><td>blur.shard.thrift.max.read.buffer.bytes (9223372036854775807)</td><td>The maximum number of bytes used for reading requests in the thrift server.</td></tr><tr><td>blur.shard.thrift.accept.queue.size.per.thread (4)</td><td>The size of the blocking queue per selector thread for passing accepted connections to the selector thread.</td></tr><tr ><td>blur.shard.opener.thread.count (8)</td><td>The number of threads that are >used for opening >indexes</td></tr><tr><td>blur.shard.cache.max.querycache.elements >(128)</td><td>The number of cached >queries</td></tr><tr><td>blur.shard.cache.max.timetolive (60000)</td><td>The >time to live for the cache >query</td></tr><tr><td>blur.shard.filter.cache.class >(org.apache.blur.manager.DefaultBlurFilterCache)</td><td>Default >implementation of the blur cache filter, which is a pass through filter that >does nothing</td></tr><tr><td>blur.shard.warmup.disabled >(true)</td><td>Globally disable index >warmup.</td></tr><tr><td>blur.shard.index.warmup.class >(org.apache.blur.manager.indexserver.DefaultBlurIndexWarmup)</td><td>Default >Blur index warmup class that warms the fields provided in the table >descriptor</td></tr><tr><td>blur.shard.index.warmup.throttle >(30000000)</td><td>Throttles the warmup to 30MB/s across all the warmup >threads</td></tr><tr><td>blur.shard.block.cache.version (v2)</td><td>By d efault the v2 version of the block cache is enabled</td></tr><tr><td>blur.shard.block.cache.total.size</td><td>By default the total amount of memory block cache will use is -XX:MaxDirectMemorySize - 64 MiB</td></tr><tr><td>blur.shard.blockcache.direct.memory.allocation (true)</td><td>v1 version of block cache only. By default the block cache using off heap memory</td></tr><tr><td>blur.shard.blockcache.slab.count (-1)</td><td>v1 version of block cache only. The slabs in the blockcache are automatically configured by default (-1) otherwise 1 slab equals 128MB. The auto config is detected through the MaxDirectoryMemorySize provided to the JVM</td></tr><tr><td>blur.shard.block.cache.v2.fileBufferSize (8192)</td><td>v2 version of block cache only. File buffer size, this is the buffer size used to read and write to data to HDFS. For production this will likely be increased.</td></tr><tr><td>blur.shard.block.cache.v2.cacheBlockSize (8192)</td><td>v2 version of block cache only. The is th e size of the blocks in the off heap cache, it is good practice to have this match 'blur.shard.block.cache.v2.fileBufferSize'. For production this will likely be increased.</td></tr><tr><td>blur.shard.block.cache.v2.cacheBlockSize.filter (33554432)</td><td>blur.shard.block.cache.v2.cacheBlockSize.<ext>=</td></tr><tr><td>blur.shard.block.cache.v2.store (OFF_HEAP)</td><td>v2 version of block cache only. This is used to control if the block are created on or off heap. Values are OFF_HEAP | ON_HEAP</td></tr><tr><td>blur.shard.block.cache.v2.read.cache.ext</td><td>v2 version of block cache only. This specifies what file types should be cached during reads. Comma delimited list.</td></tr><tr><td>blur.shard.block.cache.v2.read.nocache.ext (fdt)</td><td>v2 version of block cache only. This specifies what file types should NOT be cached during reads. Comma delimited list.</td></tr><tr><td>blur.shard.block.cache.v2.read.default (true)</td><td>v2 version of block cache only. This specifies the default behavior if a file type is not specified in the cache or nocache lists during reads. Values true | false</td></tr><tr><td>blur.shard.block.cache.v2.write.cache.ext</td><td>v2 version of block cache only. This specifies what file types should be cached during writes. Comma delimited list.</td></tr><tr><td>blur.shard.block.cache.v2.write.nocache.ext (fdt)</td><td>v2 version of block cache only. This specifies what file types should NOT be cached during writes. Comma delimited list.</td></tr><tr><td>blur.shard.block.cache.v2.write.default (true)</td><td>v2 version of block cache only. This specifies the default behavior if a file type is not specified in the cache or nocache lists during writes. Values true | false</td></tr><tr><td>blur.shard.index.compressionmode (FAST)</td><td>Sets the compression of used in the storing of the fields. Valid entries are FAST FAST_DECOMPRESSION HIGH_COMPRESSION</td></tr><tr><td>blur.shard.index.chunksize (16384)</td><td>Sets the chunks ize of the compression in the storing of the fields. Larger values may produce smaller fdt files at the small cost of fetch performance.</td></tr><tr><td>blur.shard.buffercache.8192 (67108864)</td><td>The amount of memory to be used by 8K byte buffers. Note if you change the "blur.shard.block.cache.v2.cacheBlockSize" or "blur.shard.block.cache.v2.fileBufferSize" you should adjust the buffer sizes as well as the total memory allocated. For example if you increased the "blur.shard.block.cache.v2.fileBufferSize" to 64K (65536) then this property should to "blur.shard.buffercache.65536". You can also define as many of these properties as needed.</td></tr><tr><td>blur.shard.buffercache.1024 (8388608)</td><td>The amount of memory to be used by 1K byte buffers. Note if you change the "blur.shard.block.cache.v2.cacheBlockSize" or "blur.shard.block.cache.v2.fileBufferSize" you should adjust the buffer sizes as well as the total memory allocated.</td></tr><tr><td>blur.shard.safemodedelay (5000)</td><td>The number of milliseconds to wait for the cluster to settle once changes have ceased.</td></tr><tr><td>blur.shard.server.minimum.before.safemode.exit (0)</td><td>The number of shard servers in a cluster that have to be registered before the cluster will exit safemode.</td></tr><tr><td>blur.shard.time.between.commits (30000)</td><td>The default time between index commits</td></tr><tr><td>blur.shard.time.between.refreshs (3000)</td><td>The default time between index refreshs</td></tr><tr><td>blur.shard.merge.thread.count (8)</td><td>The max number of threads used during index merges</td></tr><tr><td>blur.max.clause.count (1024)</td><td>The maximum number of clauses in a BooleanQuery</td></tr><tr><td>blur.indexmanager.search.thread.count (8)</td><td>The number of thread used for parallel searching in the index manager</td></tr><tr><td>blur.indexmanager.mutate.thread.count (8)</td><td>The number of thread used for parallel mutating in the index manager</td></tr><tr><td>b lur.indexmanager.facet.thread.count (8)</td><td>The number of thread used for parallel faceting in the index manager</td></tr><tr><td>blur.shard.warmup.thread.count (8)</td><td>Number of threads used for warming up the index</td></tr><tr><td>blur.shard.fetchcount (110)</td><td>The fetch count per Lucene search, this fetches pointers to hits</td></tr><tr><td>blur.max.heap.per.row.fetch (10000000)</td><td>Heap limit on row fetch, once this limit has been reached the request will return</td></tr><tr><td>blur.max.records.per.row.fetch.request (1000)</td><td>The maximum number of records in a single row fetch</td></tr><tr><td>blur.gui.shard.port (40090)</td><td>The http status page port for the shard server</td></tr><tr><td>blur.shard.filtered.server.class</td><td>To intercept the calls made to the shard server and perform server side changes to the calls extend org.apache.blur.server.FilteredBlurServer.</td></tr><tr><td>blur.shard.blurindex.class</td><td>Defines the blur index class to be used to handle index requests. This class has to extend org.apache.blur.manager.writer.BlurIndex. This can be defined globally as well as per table.</td></tr><tr><td>blur.shard.read.interceptor</td><td>Defines the blur read interceptor class that can mask data from query results as well as data fetches.</td></tr><tr><td>blur.lucene.fst.bytearray.factory</td><td>Defines the byte array factory class that blur will use to manage the FST trees in Lucene (extends org.apache.blur.lucene.fst.ByteArrayFactory).</td></tr><tr><td>blur.shard.queue.max.pause.time.when.empty (1000)</td><td>The maximum amount of time to pause before checking the queue for RowMutations.</td></tr><tr><td>blur.shard.queue.max.writer.lock.time (5000)</td><td>The maximum amount of time that the queue can lock the writer before committing. NOTE: Any other writer event will cause the queue to release it's lock on the writer.</td></tr><tr><td>blur.shard.queue.max.queue.batch.size (100)</td><td>The maximum number of RowMutations the writer can drain from the queue at a time.</td></tr><tr><td>blur.shard.queue.max.inmemory.length (100)</td><td>The maximum number of RowMutations that can exist in the inmemory block queue any point in time. NOTE: This is PER SHARD.</td></tr><tr><td>blur.shard.deep.paging.cache.size (1000)</td><td>The number of deep paging cache entries kept in memory for faster deep paging.</td></tr> +<tr><td>blur.shard.hostname</td><td>The hostname for the shard, if blank the hostname is automatically detected</td></tr><tr><td>blur.shard.bind.address (0.0.0.0)</td><td>The binding address of the shard</td></tr><tr><td>blur.shard.bind.port (40020)</td><td>The default binding port of the shard server, 0 for random</td></tr><tr><td>blur.shard.command.driver.threads (16)</td><td>The number of command driver threads.</td></tr><tr><td>blur.shard.command.worker.threads (16)</td><td>The number of command worker threads.</td></tr><tr><td>blur.shard.internal.search.thread.count (16)</td><td>The number of internal lucene worker threads used to make the search call more parallel.</td></tr><tr><td>blur.shard.data.fetch.thread.count (8)</td><td>The number of fetcher threads</td></tr><tr><td>blur.shard.server.thrift.thread.count (8)</td><td>The number of the thrift threads</td></tr><tr><td>blur.shard.thrift.selector.threads (2)</td><td>The number of threads used for selector processing inside t he thrift server.</td></tr><tr><td>blur.shard.thrift.max.read.buffer.bytes (9223372036854775807)</td><td>The maximum number of bytes used for reading requests in the thrift server.</td></tr><tr><td>blur.shard.thrift.accept.queue.size.per.thread (4)</td><td>The size of the blocking queue per selector thread for passing accepted connections to the selector thread.</td></tr><tr><td>blur.shard.opener.thread.count (8)</td><td>The number of threads that are used for opening indexes</td></tr><tr><td>blur.shard.cache.max.querycache.elements (128)</td><td>The number of cached queries</td></tr><tr><td>blur.shard.cache.max.timetolive (60000)</td><td>The time to live for the cache query</td></tr><tr><td>blur.shard.filter.cache.class (org.apache.blur.manager.DefaultBlurFilterCache)</td><td>Default implementation of the blur cache filter, which is a pass through filter that does nothing</td></tr><tr><td>blur.shard.block.cache.version (v2)</td><td>By default the v2 version of the block cache is en abled</td></tr><tr><td>blur.shard.block.cache.total.size</td><td>By default the total amount of memory block cache will use is -XX:MaxDirectMemorySize - 64 MiB</td></tr><tr><td>blur.shard.blockcache.direct.memory.allocation (true)</td><td>v1 version of block cache only. By default the block cache using off heap memory</td></tr><tr><td>blur.shard.blockcache.slab.count (-1)</td><td>v1 version of block cache only. The slabs in the blockcache are automatically configured by default (-1) otherwise 1 slab equals 128MB. The auto config is detected through the MaxDirectoryMemorySize provided to the JVM</td></tr><tr><td>blur.shard.block.cache.v2.fileBufferSize (8192)</td><td>v2 version of block cache only. File buffer size, this is the buffer size used to read and write to data to HDFS. For production this will likely be increased.</td></tr><tr><td>blur.shard.block.cache.v2.cacheBlockSize (8192)</td><td>v2 version of block cache only. The is the size of the blocks in the off heap cache, it is good practice to have this match 'blur.shard.block.cache.v2.fileBufferSize'. For production this will likely be increased.</td></tr><tr><td>blur.shard.block.cache.v2.cacheBlockSize.filter (33554432)</td><td>blur.shard.block.cache.v2.cacheBlockSize.<ext>=</td></tr><tr><td>blur.shard.block.cache.v2.store (OFF_HEAP)</td><td>v2 version of block cache only. This is used to control if the block are created on or off heap. Values are OFF_HEAP | ON_HEAP</td></tr><tr><td>blur.shard.block.cache.v2.read.cache.ext</td><td>v2 version of block cache only. This specifies what file types should be cached during reads. Comma delimited list.</td></tr><tr><td>blur.shard.block.cache.v2.read.nocache.ext (fdt)</td><td>v2 version of block cache only. This specifies what file types should NOT be cached during reads. Comma delimited list.</td></tr><tr><td>blur.shard.block.cache.v2.read.default (true)</td><td>v2 version of block cache only. This specifies the default behavior if a file type is not sp ecified in the cache or nocache lists during reads. Values true | false</td></tr><tr><td>blur.shard.block.cache.v2.write.cache.ext</td><td>v2 version of block cache only. This specifies what file types should be cached during writes. Comma delimited list.</td></tr><tr><td>blur.shard.block.cache.v2.write.nocache.ext (fdt)</td><td>v2 version of block cache only. This specifies what file types should NOT be cached during writes. Comma delimited list.</td></tr><tr><td>blur.shard.block.cache.v2.write.default (true)</td><td>v2 version of block cache only. This specifies the default behavior if a file type is not specified in the cache or nocache lists during writes. Values true | false</td></tr><tr><td>blur.shard.index.compressionmode (FAST)</td><td>Sets the compression of used in the storing of the fields. Valid entries are FAST FAST_DECOMPRESSION HIGH_COMPRESSION</td></tr><tr><td>blur.shard.index.chunksize (16384)</td><td>Sets the chunksize of the compression in the storing of the f ields. Larger values may produce smaller fdt files at the small cost of fetch performance.</td></tr><tr><td>blur.shard.buffercache.8192 (67108864)</td><td>The amount of memory to be used by 8K byte buffers. Note if you change the "blur.shard.block.cache.v2.cacheBlockSize" or "blur.shard.block.cache.v2.fileBufferSize" you should adjust the buffer sizes as well as the total memory allocated. For example if you increased the "blur.shard.block.cache.v2.fileBufferSize" to 64K (65536) then this property should to "blur.shard.buffercache.65536". You can also define as many of these properties as needed.</td></tr><tr><td>blur.shard.buffercache.1024 (8388608)</td><td>The amount of memory to be used by 1K byte buffers. Note if you change the "blur.shard.block.cache.v2.cacheBlockSize" or "blur.shard.block.cache.v2.fileBufferSize" you should adjust the buffer sizes as well as the total memory allocated.</td></tr><tr><td>blur.shard.safemodedelay (5000)</td><td>The number of milliseconds to w ait for the cluster to settle once changes have ceased.</td></tr><tr><td>blur.shard.server.minimum.before.safemode.exit (0)</td><td>The number of shard servers in a cluster that have to be registered before the cluster will exit safemode.</td></tr><tr><td>blur.shard.time.between.commits (30000)</td><td>The default time between index commits.</td></tr><tr><td>blur.shard.time.between.refreshs (3000)</td><td>The default time between index refreshs.</td></tr><tr><td>blur.shard.merge.thread.count (8)</td><td>The max number of threads used during index merges.</td></tr><tr><td>blur.shard.small.merge.threshold (128000000)</td><td>The threshold for a small merge in bytes.</td></tr><tr><td>blur.max.clause.count (1024)</td><td>The maximum number of clauses in a BooleanQuery</td></tr><tr><td>blur.indexmanager.search.thread.count (8)</td><td>The number of thread used for parallel searching in the index manager</td></tr><tr><td>blur.indexmanager.mutate.thread.count (8)</td><td>The number of thre ad used for parallel mutating in the index manager</td></tr><tr><td>blur.indexmanager.facet.thread.count (8)</td><td>The number of thread used for parallel faceting in the index manager</td></tr><tr><td>blur.shard.fetchcount (110)</td><td>The fetch count per Lucene search, this fetches pointers to hits</td></tr><tr><td>blur.max.heap.per.row.fetch (10000000)</td><td>Heap limit on row fetch, once this limit has been reached the request will return</td></tr><tr><td>blur.max.records.per.row.fetch.request (1000)</td><td>The maximum number of records in a single row fetch</td></tr><tr><td>blur.gui.shard.port (40090)</td><td>The http status page port for the shard server, 0 for random</td></tr><tr><td>blur.shard.filtered.server.class</td><td>To intercept the calls made to the shard server and perform server side changes to the calls extend org.apache.blur.server.FilteredBlurServer.</td></tr><tr><td>blur.shard.blurindex.class</td><td>Defines the blur index class to be used to handle index r equests. This class has to extend org.apache.blur.manager.writer.BlurIndex. This can be defined globally as well as per table.</td></tr><tr><td>blur.shard.read.interceptor</td><td>Defines the blur read interceptor class that can mask data from query results as well as data fetches.</td></tr><tr><td>blur.lucene.fst.bytearray.factory</td><td>Defines the byte array factory class that blur will use to manage the FST trees in Lucene (extends org.apache.blur.lucene.fst.ByteArrayFactory).</td></tr><tr><td>blur.shard.queue.max.pause.time.when.empty (1000)</td><td>The maximum amount of time to pause before checking the queue for RowMutations.</td></tr><tr><td>blur.shard.queue.max.writer.lock.time (5000)</td><td>The maximum amount of time that the queue can lock the writer before committing. NOTE: Any other writer event will cause the queue to release it's lock on the writer.</td></tr><tr><td>blur.shard.queue.max.queue.batch.size (100)</td><td>The maximum number of RowMutations the writer can drain from the queue at a time.</td></tr><tr><td>blur.shard.queue.max.inmemory.length (100)</td><td>The maximum number of RowMutations that can exist in the inmemory block queue any point in time. NOTE: This is PER SHARD.</td></tr><tr><td>blur.shard.deep.paging.cache.size (1000)</td><td>The number of deep paging cache entries kept in memory for faster deep paging.</td></tr><tr><td>blur.shard.distributed.layout.factory.class</td><td>Defines the blur layout factor class to use for managing how shards are layed out across the cluster.</td></tr> </table> <h3 id="shard-blur-env">blur-env.sh</h3> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/console.html ---------------------------------------------------------------------- diff --git a/docs/console.html b/docs/console.html index 4d9e4f8..5a2a83d 100644 --- a/docs/console.html +++ b/docs/console.html @@ -44,8 +44,6 @@ <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li class="active"><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/data-model.html ---------------------------------------------------------------------- diff --git a/docs/data-model.html b/docs/data-model.html index eae7ea5..c3f726a 100644 --- a/docs/data-model.html +++ b/docs/data-model.html @@ -44,8 +44,6 @@ <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/getting-started.html ---------------------------------------------------------------------- diff --git a/docs/getting-started.html b/docs/getting-started.html index a513ef9..7d8f1ea 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -44,8 +44,6 @@ <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> @@ -101,9 +99,9 @@ cat ~/.ssh/id_dsa.pub >> ~/.ssh/authorized_keys</code></pre> <h3>Download Source and Binary Artifacts</h3> <p> Both the source and binary artifacts are provided via mirrors here:<br/><br/> - <a href="http://www.apache.org/dyn/closer.cgi/incubator/blur/0.2.4-incubating-SNAPSHOT/apache-blur-0.2.3-incubating-src.tar.gz"; class="btn btn-large btn-primary">Apache Blur 0.2.3 Source</a> - <a href="http://www.apache.org/dyn/closer.cgi/incubator/blur/0.2.4-incubating-SNAPSHOT/apache-blur-0.2.3-incubating-hadoop1-bin.tar.gz"; class="btn btn-large btn-primary">Apache Blur 0.2.3 Hadoop1 Binary</a> - <a href="http://www.apache.org/dyn/closer.cgi/incubator/blur/0.2.4-incubating-SNAPSHOT/apache-blur-0.2.3-incubating-hadoop2-bin.tar.gz"; class="btn btn-large btn-primary">Apache Blur 0.2.3 Hadoop2 Binary</a> + <a href="http://www.apache.org/dyn/closer.cgi/incubator/blur/0.2.4-incubating-SNAPSHOT/apache-blur-0.2.4-incubating-src.tar.gz"; class="btn btn-large btn-primary">Apache Blur 0.2.4 Source</a> + <a href="http://www.apache.org/dyn/closer.cgi/incubator/blur/0.2.4-incubating-SNAPSHOT/apache-blur-0.2.4-incubating-hadoop1-bin.tar.gz"; class="btn btn-large btn-primary">Apache Blur 0.2.4 Hadoop1 Binary</a> + <a href="http://www.apache.org/dyn/closer.cgi/incubator/blur/0.2.4-incubating-SNAPSHOT/apache-blur-0.2.4-incubating-hadoop2-bin.tar.gz"; class="btn btn-large btn-primary">Apache Blur 0.2.4 Hadoop2 Binary</a> </p> </section> <section> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/index.html ---------------------------------------------------------------------- diff --git a/docs/index.html b/docs/index.html index 2e7750c..4f30cdf 100644 --- a/docs/index.html +++ b/docs/index.html @@ -44,8 +44,6 @@ <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/platform.html ---------------------------------------------------------------------- diff --git a/docs/platform.html b/docs/platform.html index 106f958..de1b3b5 100644 --- a/docs/platform.html +++ b/docs/platform.html @@ -36,16 +36,14 @@ </div> <div class="collapse navbar-collapse"> <ul class="nav navbar-nav"> - <li class="active"><a href="index.html">Main</a></li> + <li><a href="index.html">Main</a></li> <li><a href="getting-started.html">Getting Started</a></li> - <li><a href="platform.html">Platform</a></li> + <li class="active"><a href="platform.html">Platform</a></li> <li><a href="data-model.html">Data Model</a></li> <li><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> @@ -174,12 +172,10 @@ gives us that. Getting the answer for a single index requires implementing an <code>execute</code> method. </p> - <pre> -@Override + <pre>@Override public Long execute(IndexContext context) throws IOException { - return new Long(context.getIndexReader().docFreq(new Term(fieldName, term))); -} - </pre> + return (long) context.getIndexReader().numDocs(); +}</pre> <p>We'll learn where the field name and term are defined later in the Arguments section. Inside of the <code>execute</code> method, we're focused on finding the answer for a single shard/index. To find our answer, we're given an <code>IndexContext</code> which @@ -189,23 +185,17 @@ public Long execute(IndexContext context) throws IOException { <p>Now we need to let Blur know how to combine the results from the individual shards into a single logical response. We do this by implementing the <code>combine</code> method. </p> - <pre> -@Override -public Long combine(CombiningContext context, Iterable<Long> results) throws IOException, - InterruptedException { - - Long total = 0l; - - for(Long shardTotal: results) { - total += shardTotal; + <pre>@Override +public Long combine(CombiningContext context, Map<? extends Location<?>, Long> results) throws IOException { + long total = 0; + for (Long l : results.values()) { + total += l; } - return total; -} - </pre> +}</pre> <p> Again, we're given some execution context (which we don't need for our sample command) and we're - given an <code>Iterable</code> of result values. + given an <code>Map<? extends Location<?>, Long></code> of result values. </p> </section> @@ -269,7 +259,7 @@ public class DocFreqCommand extends TableReadCommand<Long> { <h2 id="cli">CLI</h2> </div> <p> - <code>@TODO</code> +See Using Blur -> Shell -> <a href="using-blur.html#shell_platform_commands">Platform Commands</a>. </p> </section> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/using-blur.base.html ---------------------------------------------------------------------- diff --git a/docs/using-blur.base.html b/docs/using-blur.base.html index 08c705d..a2d828c 100644 --- a/docs/using-blur.base.html +++ b/docs/using-blur.base.html @@ -44,8 +44,6 @@ <li class="active"><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/2990b6f8/docs/using-blur.html ---------------------------------------------------------------------- diff --git a/docs/using-blur.html b/docs/using-blur.html index d3952d7..6071d19 100644 --- a/docs/using-blur.html +++ b/docs/using-blur.html @@ -44,8 +44,6 @@ <li class="active"><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> <li><a href="console.html">Console</a></li> - <li><a href="site/index.html" target="_blank">Maven Site</a></li> - <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> </div> </div> @@ -89,6 +87,7 @@ <li><a href="#shell_command_parse"> parse</a></li> <li><a href="#shell_command_definecolumn"> definecolumn</a></li> <li><a href="#shell_command_optimize"> optimize</a></li> +<li><a href="#shell_command_copy"> copy</a></li> </ul></li> <li><a href="#shell_data_commands">Data Commands</a> <ul class="nav"> @@ -112,6 +111,18 @@ <li><a href="#shell_command_safemodewait"> safemodewait</a></li> <li><a href="#shell_command_top"> top</a></li> </ul></li> +<li><a href="#shell_server_commands">Server Commands</a> +<ul class="nav"> +<li><a href="#shell_command_logger"> logger</a></li> +<li><a href="#shell_command_logger-reset"> logger-reset</a></li> +<li><a href="#shell_command_remove-shard"> remove-shard</a></li> +</ul></li> +<li><a href="#shell_platform_commands">Platform Commands</a> +<ul class="nav"> +<li><a href="#shell_command_command-list"> command-list</a></li> +<li><a href="#shell_command_command-exec"> command-exec</a></li> +<li><a href="#shell_command_command-desc"> command-desc</a></li> +</ul></li> <li><a href="#shell_shell_commands">Shell Commands</a> <ul class="nav"> <li><a href="#shell_command_help"> help</a></li> @@ -412,7 +423,7 @@ The following rules are used when interacting with the shell: <h3 id="shell_table_commands">Table Commands</h3> <h4 id="shell_command_create">create</h4> <p>Description: Create the named table. Run -h for full argument list.<br/> -<pre><code class="bash">create -t <tablename> -c <shardcount></code></pre></p> +<pre><code class="bash">create -t <tablename> -c <shardcount> -l <location></code></pre></p> <h4 id="shell_command_enable">enable</h4> <p>Description: Enable the named table.<br/> <pre><code class="bash">enable <tablename></code></pre></p> @@ -449,10 +460,13 @@ The following rules are used when interacting with the shell: <h4 id="shell_command_optimize">optimize</h4> <p>Description: Optimize the named table.<br/> <pre><code class="bash">optimize <tablename> <number of segments per shard></code></pre></p> +<h4 id="shell_command_copy">copy</h4> +<p>Description: Copy the table definitions to a new table. Run -h for full argument list.<br/> +<pre><code class="bash">copy -src <tablename> -dest <desttable> -l <location> -c <cluster></code></pre></p> <h3 id="shell_data_commands">Data Commands</h3> <h4 id="shell_command_query">query</h4> -<p>Description: Query the named table.<br/> -<pre><code class="bash">query <tablename> <query></code></pre></p> +<p>Description: Query the named table. Run -h for full argument list.<br/> +<pre><code class="bash">query <tablename> <query> [<options>]</code></pre></p> <h4 id="shell_command_get">get</h4> <p>Description: display the specified row<br/> <pre><code class="bash">get <tablename> <rowid></code></pre></p> @@ -499,6 +513,26 @@ The following rules are used when interacting with the shell: <h4 id="shell_command_top">top</h4> <p>Description: Top for watching shard clusters.<br/> <pre><code class="bash">top [<cluster>]</code></pre></p> +<h3 id="shell_server_commands">Server Commands</h3> +<h4 id="shell_command_logger">logger</h4> +<p>Description: Change log levels of a server. Levels are: OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL<br/> +<pre><code class="bash">logger <node:port> <log level> <logger name or class name></code></pre></p> +<h4 id="shell_command_logger-reset">logger-reset</h4> +<p>Description: Reset/reload log configuration of a server.<br/> +<pre><code class="bash">logger-reset <node:port></code></pre></p> +<h4 id="shell_command_remove-shard">remove-shard</h4> +<p>Description: Remove a node from ZooKeeper which will cause the cluster to consider it dead.<br/> +<pre><code class="bash">remove-shard <node:port></code></pre></p> +<h3 id="shell_platform_commands">Platform Commands</h3> +<h4 id="shell_command_command-list">command-list</h4> +<p>Description: List platform commands that are installed.<br/> +<pre><code class="bash">command-list </code></pre></p> +<h4 id="shell_command_command-exec">command-exec</h4> +<p>Description: Execute a platform command. Run -h for full argument list.<br/> +<pre><code class="bash">command-exec <command name> ...</code></pre></p> +<h4 id="shell_command_command-desc">command-desc</h4> +<p>Description: Describes the specifed command.<br/> +<pre><code class="bash">command-desc <command name></code></pre></p> <h3 id="shell_shell_commands">Shell Commands</h3> <h4 id="shell_command_help">help</h4> <p>Description: Display help.<br/>
