Commit 590ae55b authored by Amos Latteier's avatar Amos Latteier

Moved ZSQL Method help files from OFSP to the ZSQLMethod product.

parent 9be8c249
<dtml-var standard_html_header>
<h1>Z SQL Method</h1>
<p>Z SQL Methods allows you to access data in SQL databases.</p>
<p>Z SQL Methods define and call SQL statements on databases which are
defined by database connection objects.</p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Add</h1>
<p> This view allows you to create a new Z SQL Method.</p>
<p> The <tt>ID</tt> field specifies the id of the sql
method. The <tt>Title</tt> field allows you to specify the title of
the sql method. The <tt>Connection id</tt> select list specifies the
database connection on which the sql method operates. The
<tt>Arguments</tt> field allows you to specify a list of arguments
that the sql method takes. The arguments should be separated by spaces in the
field. The <tt>Query template</tt> text area specifies the SQL query
that the sql method will execute. The query template can contain DTML markup to
tailor the SQL statement to the arguments. Note: the SQL statement need not be
a SELECT query, it may be any valid SQL statement including an INSERT or
UPDATE. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Advanced</h1>
<p> This view allows you to manage the advanced settings of a sql
method. </p>
<p> The <tt>ID</tt> and <tt>Title</tt> fields
indicate the id and title of the sql method. The <tt>Maximum number of
rows retrieved</tt> field allows you to specify an upper limit for the
number of rows a sql method can retrieve. The <tt>Maximum number of
results in the cache</tt> field allows you to set the size of the sql
method cache. The <tt>Maximum time (seconds) to cache results</tt>
field allows you to specify the how fresh the sql method cache must be. By
setting this time to a number greater than zero you enable sql method caching.
</p>
<p> You can provide a Python class for adding behavior to returns
rows. The results of the sql method will consist of a sequence of instances of
the specified class. The <tt>Class name</tt> field allows you to
specify the name of the Python class. The <tt>Class file</tt> field
allows you to specify the name of the Python module that the class is defined
in. The class file should reside in the Zope Extensions
directory. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Edit</h1>
<p> This view allows you to edit the attributes of a sql method.
</p>
<p> The <tt>ID</tt> field indicates the id of the sql
method. The <tt>Title</tt> field allows you to specify the title of
the sql method. The <tt>Connection id</tt> select list specifies the
database connection on which the sql method operates. The
<tt>Arguments</tt> field allows you to specify a list of arguments
that the sql method takes. The arguments should be separated by spaces in the
field. The <tt>Query template</tt> text area specifies the SQL query
that the sql method will execute. The query template can contain DTML markup to
tailor the SQL statement to the arguments. Note: the SQL statement need not be
a SELECT query, it may be any valid SQL statement including an INSERT or
UPDATE. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Security</h1>
<p> See <a href="../Folder_Security.dtml">Folder&gt;Security</a>. </p>
<dtml-var standard_html_footer>
<dtml-var standard_html_header>
<h1>
<a href="../Z-SQL-Method.dtml">Z SQL Method</a>&gt;Test</h1>
<p> This view allows you to test a sql method. </p>
<p> If arguments have been defined for this method there will be
fields available to provide values for the arguments. To execute the sql method
click the <tt>Submit Query</tt> button and the results if any will be
returned. </p>
<dtml-var standard_html_footer>
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment