GEODE-3410 Doc update for gfsh query command changes
- the --interactive option is gone
- there is a new --file option
- correct default value for APP_FETCH_SIZE gfsh env var
- gfsh env var APP_COLLECTION_LIMIT is no longer used
This closes #708
(cherry picked from commit 7528f1290aa8fc343787432d163cf43dd3fdfe21)
Project: http://git-wip-us.apache.org/repos/asf/geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/828b2469
Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/828b2469
Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/828b2469
Branch: refs/heads/release/1.2.1
Commit: 828b24697823ee665b301ce3c54dbb15d0ccbce5
Parents: 26a4145
Author: Karen Miller <[email protected]>
Authored: Thu Aug 10 12:53:25 2017 -0700
Committer: Anthony Baker <[email protected]>
Committed: Mon Aug 21 12:12:56 2017 -0700
----------------------------------------------------------------------
.../gfsh/command-pages/query.html.md.erb | 24 ++++++++++----------
.../gfsh/configuring_gfsh.html.md.erb | 5 ++--
.../useful_gfsh_shell_variables.html.md.erb | 19 ++++++++--------
3 files changed, 24 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/geode/blob/828b2469/geode-docs/tools_modules/gfsh/command-pages/query.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/tools_modules/gfsh/command-pages/query.html.md.erb
b/geode-docs/tools_modules/gfsh/command-pages/query.html.md.erb
index 1ff3028..8df594e 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/query.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/query.html.md.erb
@@ -21,7 +21,13 @@ limitations under the License.
Run queries against Geode regions.
-Run the specified OQL query as a single quoted string and displays results in
pages allows to move between pages. If limit is not set in the query, then a
default limit of 1000 (derived from GFSH environment variable APP\_FETCH\_SIZE)
will be applied. Page size is derived from GFSH environment variable
APP\_COLLECTION\_LIMIT (default value=20).
+If a limit restricting the result size is not set in the query,
+then a default limit of the gfsh environment variable `APP_FETCH_SIZE`,
+as defined in
+[Useful gfsh Shell Variables](../useful_gfsh_shell_variables.html),
+will be applied.
+
+Surround the OQL query with single quote marks.
**Note:**
This command should not be executed from `gfsh` if the objects being queried
contain cyclic references.
@@ -31,24 +37,18 @@ This command should not be executed from `gfsh` if the
objects being queried con
**Syntax:**
``` pre
-query --query=value [--step-name=value] [--interactive=value]
+query --query=value [--step-name=value] [--file=path/to/results/file]
```
<a id="concept_89A129F729DF4D3B9056C8D9016AA760__table_ocr_gcg_2w"></a>
-| Name | Description
| Default Value |
-|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------|---------------|
-| <span class="keyword parmname">\\-\\-query </span> | *Required.* The
OQL string.
| Â |
-| <span class="keyword parmname">\\-\\-interactive</span> | Specifies whether
or not this query is interactive. If false, then all results will be displayed
at once. | true |
+| Name | Description
|
+|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
+| <span class="keyword parmname">\\-\\-query </span> | *Required.* The
OQL string.
|
+| <span class="keyword parmname">\\-\\-file</span> | When specified, all query
results are written to the specified file. An error is issued if the file
already exists. |
<span class="tablecap">Table 1. Query Parameters</span>
-**Example Commands:**
-
-``` pre
-query --query=value [--step-name=value] [--interactive=value]
-```
-
**Sample Output:**
``` pre
http://git-wip-us.apache.org/repos/asf/geode/blob/828b2469/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb
b/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb
index b112e66..d4cdea0 100644
--- a/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb
@@ -48,10 +48,11 @@ You may also need to verify that the ports are available
and open to client conn
## <a
id="concept_3B9C6CE2F64841E98C33D9F6441DF487__section_C69A2711A7664A9091A5E634221053CB"
class="no-quick-link"></a>Configuring gfsh Environment Variables
-In addition, you can set several gfsh-specific preset SHELL variables by using
the `set variable` command. For example, you can set `gfsh` to run in quiet
mode. Not all `gfsh` variables are modifiable; user-configurable variables
include:
+In addition, you can set gfsh-specific preset SHELL variables by using the
`set variable` command. For example, you can set `gfsh` to run in quiet mode.
+Not all `gfsh` variables are modifiable.
+User-configurable variables include:
- APP\_FETCH\_SIZE
-- APP\_COLLECTION\_LIMIT
- APP\_QUIET\_EXECUTION
See [Useful gfsh Shell
Variables](useful_gfsh_shell_variables.html#concept_731ECA5E40E943CBA5C1198A0745D8EE)
for more information.
http://git-wip-us.apache.org/repos/asf/geode/blob/828b2469/geode-docs/tools_modules/gfsh/useful_gfsh_shell_variables.html.md.erb
----------------------------------------------------------------------
diff --git
a/geode-docs/tools_modules/gfsh/useful_gfsh_shell_variables.html.md.erb
b/geode-docs/tools_modules/gfsh/useful_gfsh_shell_variables.html.md.erb
index 731953c..e355e9f 100644
--- a/geode-docs/tools_modules/gfsh/useful_gfsh_shell_variables.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/useful_gfsh_shell_variables.html.md.erb
@@ -58,15 +58,14 @@ gfsh>echo --string=${SYS_CLASSPATH}
| |
|
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| APP\_COLLECTION\_LIMIT | Number of items in the embedded
collection of a result to be iterated Values: 1-100. Default value is 20.
|
-| APP\_FETCH\_SIZE | Fetch size to be used while querying.
Values: 0 - 2147483647. Default value is 1000.
|
-| APP\_LAST\_EXIT\_STATUS | Last command exit status. Similar to $?
(Unix) and %errorlevel% (Windows). Values: 0 (successful), 1 (error), 2(crash)
(read only).
|
-| APP\_LOGGING\_ENABLED | Whether gfsh logging is enabled.
Default: false (read only). You can enable gfsh logging by setting the
`gfsh.log-level` Java system property to a [supported Java log
level](http://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html). |
-| APP\_LOG\_FILE | Path and name of current gfsh log file
(read only).
|
-| APP\_NAME | Name of the application-- "gfsh" (read
only).
|
-| APP\_PWD | Current working directory where gfsh
was launched (read only).
|
-| APP\_QUERY\_RESULTS\_DISPLAY\_MODE | Toggle the display mode for returning
query results. Values: table or catalog. Default value is table.
|
-| APP\_QUIET\_EXECUTION | Whether the execution should be in
quiet mode. Values (case insensitive): true, false. Default value is false.
|
-| APP\_RESULT\_VIEWER | Unix only. Set this variable to
`external` to enable viewing of the output using the UNIX `less` command.
Default value is basic (gfsh).
|
+| APP\_FETCH\_SIZE | Fetch size to be used while querying.
Values: 0 - 2147483647. Default value is 100. |
+| APP\_LAST\_EXIT\_STATUS | Last command exit status. Similar to $?
(Unix) and %errorlevel% (Windows). Values: 0 (successful), 1 (error), 2(crash)
(read only). |
+| APP\_LOGGING\_ENABLED | Whether gfsh logging is enabled.
Default: false (read only). You can enable gfsh logging by setting the
`gfsh.log-level` Java system property to a [supported Java log
level](http://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html).|
+| APP\_LOG\_FILE | Path and name of current gfsh log file
(read only). |
+| APP\_NAME | Name of the application-- "gfsh" (read
only). |
+| APP\_PWD | Current working directory where gfsh
was launched (read only). |
+| APP\_QUERY\_RESULTS\_DISPLAY\_MODE | Toggle the display mode for returning
query results. Values: table or catalog. Default value is table.
|
+| APP\_QUIET\_EXECUTION | Whether the execution should be in
quiet mode. Values (case insensitive): true, false. Default value is false.
|
+| APP\_RESULT\_VIEWER | Unix only. Set this variable to
`external` to enable viewing of the output using the UNIX `less` command.
Default value is basic (gfsh). |
