This is an automated email from the ASF dual-hosted git repository.
kmiller pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new 05feafb GEODE-4864 Document the gfsh create jndi-binding command
(#1644)
05feafb is described below
commit 05feafbfe6eed4a7894e1fbc960a518ffe7bfaba
Author: Karen Miller <[email protected]>
AuthorDate: Mon Mar 19 17:29:06 2018 -0700
GEODE-4864 Document the gfsh create jndi-binding command (#1644)
* GEODE-4864 Document the gfsh create jndi-binding command
* GEODE-4864 gfsh create jndi-binding ref page revision, per review
* GEODE-4864 Minor gfsh create jndi-binding description change, per review
---
.../source/subnavs/geode-subnav.erb | 3 ++
.../gfsh/command-pages/create.html.md.erb | 55 +++++++++++++++++++++-
2 files changed, 57 insertions(+), 1 deletion(-)
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index a335acb..0677cea 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -1867,6 +1867,9 @@ gfsh</a>
<a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/create.html#topic_960A5B6FD3D84E1881EE128E299DD12D">create
index</a>
</li>
<li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/create.html#create_jndi-binding">create
jndi-binding</a>
+ </li>
+ <li>
<a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/create.html#create_lucene_index">create
lucene index</a>
</li>
<li>
diff --git a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
index 0195810..3eca607 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
@@ -45,6 +45,10 @@ Create async-event-queues, disk-stores, gateway receivers,
gateway senders, inde
Create an index that can be used when executing queries.
+- **[create jndi-binding](#create_jndi-binding)**
+
+ Create a JNDI binding that specifies resource attributes which describe a
JDBC connection.
+
- **[create lucene index](#create_lucene_index)**
Create a region with given path and configuration.
@@ -669,6 +673,55 @@ Occurred on following members
1. ubuntu(server1:17682)<v1>:27574
```
+## <a id="create_jndi-binding" class="no-quick-link"></a>create jndi-binding
+
+Create a JNDI binding that specifies resource attributes which describe a
+JDBC connection.
+
+**Availability:** Online. You must be connected in <span class="keyword
parmname">gfsh</span> to a JMX Manager member to use this command.
+
+**Syntax:**
+
+``` pre
+create jndi-binding --name=value --type=value --jdbc-driver-class=value
+ --connection-url=value [--blocking-timeout-seconds=value]
+ [--conn-pooled-datasource-class=value] [--idle-timeout-seconds=value]
+ [--init-pool-size=value] [--login-timeout-seconds=value]
+ [--managed-conn-factory-class=value] [--max-pool-size=value]
[--password=value]
+ [--transaction-type=value] [--username=value] [--xa-datasource-class=value]
+ [--if-not-exists(=value)?] [--datasource-config-properties=value(,value)*]
+```
+
+**Parameters, create jndi-binding:**
+
+| Name | Description
| Default |
+|----------------------------------------------------|----------------------------------------------------------------------------------------|---------|
+| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of
the binding to create. | |
+| <span class="keyword parmname">\\-\\-type</span> | *Required.* Type of
the XA datasource. One of: `MANAGED`, `SIMPLE`, `POOLED`, or `XAPOOLED`. |
|
+| <span class="keyword parmname">\\-\\-jdbc-driver-class</span> |
*Required.* The fully qualified name of the JDBC driver class. |
|
+| <span class="keyword parmname">\\-\\-connection-url</span> |
*Required.* the JDBC driver connection URL string. For example,
`jdbc:hsqldb:hsql://localhost:1701`. | |
+| <span class="keyword parmname">\\-\\-blocking-timeout-seconds</span> |
Specifies the maximum time, in seconds, to block while waiting for a connection
before throwing an exception. | |
+| <span class="keyword parmname">\\-\\-conn-pooled-datasource-class</span> |
The fully qualified name of the connection pool implementation that holds XA
datasource connections. |
|
+| <span class="keyword parmname">\\-\\-idle-timeout-seconds</span> |
Specifies the time, in seconds, that a connection may be idle before being
closed. | |
+| <span class="keyword parmname">\\-\\-init-pool-size</span> | Specifies the
initial number of connections the pool should hold. | |
+| <span class="keyword parmname">\\-\\-login-timeout-seconds</span> | The
quantity of seconds after which the client thread will be disconnected due to
inactivity. | |
+| <span class="keyword parmname">\\-\\-managed-conn-factory-class</span> |
The fully qualified name of the connection factory implementation. |
|
+| <span class="keyword parmname">\\-\\-max-pool-size</span> | The maximum
number of connections that may be created in a pool. |
|
+| <span class="keyword parmname">\\-\\-password</span> | The default
password used when creating a new connection. |
|
+| <span class="keyword parmname">\\-\\-transaction-type</span> | Type of the
transaction. One of `XATransaction`, `NoTransaction`, or `LocalTransaction`. |
|
+| <span class="keyword parmname">\\-\\-username</span> | Specifies the
default user name to be used when creating a new connection. |
|
+| <span class="keyword parmname">\\-\\-xa-datasource-class</span> | The
fully qualified name of the `javax.sql.XADataSource` implementation class. |
|
+| <span class="keyword parmname">\\-\\-if-not-exists</span> | When true, a
duplicate jndi binding will not be created if one with the same name already
exists. When false, an attempt to create a duplicate jndi binding results in
an error. The option is set to true if the option is specified without a value.
| false |
+| <span class="keyword parmname">\\-\\-datasource-config-properties</span> |
Properties for the custom `XSDataSource` driver. Append a JSON string
containing a (name, type, value) tuple to set any property. For example:
`--datasource-config-properties={'name':'name1','type':'type1','value':'value1'},{'name':'name2','type':'type2','value':'value2'}`
| |
+
+**Example Commands:**
+
+``` pre
+gfsh>create jndi-binding --name=jndi1 --type=SIMPLE \
+ --jdbc-driver-class=org.apache.derby.jdbc.EmbeddedDriver \
+ --connection-url="jdbc:derby:newDB;create=true"
+```
+
## <a id="create_lucene_index" class="no-quick-link"></a>create lucene index
Create a Lucene index. For details on Lucene index creation, see [Apache
Lucene Integration](../../../tools_modules/lucene_integration.html).
@@ -699,7 +752,7 @@ create lucene index --name=value --region=value
--field=value(,value)*
**Example Commands:**
``` pre
-create lucene index --name=customerIndex --region=/Customer
+gfsh>create lucene index --name=customerIndex --region=/Customer
--field=__REGION_VALUE_FIELD
gfsh>create lucene index --name=analyzerIndex --region=/Person
--
To stop receiving notification emails like this one, please contact
[email protected].
