List:Internals« Previous MessageNext Message »
From:paul Date:March 20 2005 2:33pm
Subject:bk commit - mysqldoc tree (paul:1.2746)
View as plain text  
Below is the list of changes that have just been committed into a local
mysqldoc repository of paul. When paul does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html

ChangeSet
  1.2746 05/03/20 08:33:42 paul@stripped +1 -0
  manual.texi:
    Minor updates to stored routines chapter.

  Docs/manual.texi
    1.2581 05/03/20 08:33:26 paul@stripped +38 -22
    Minor updates to stored routines chapter.

# This is a BitKeeper patch.  What follows are the unified diffs for the
# set of deltas contained in the patch.  The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User:	paul
# Host:	frost.snake.net
# Root:	/Volumes/frost2/MySQL/bk/mysqldoc

--- 1.2580/Docs/manual.texi	2005-03-19 05:52:01 -06:00
+++ 1.2581/Docs/manual.texi	2005-03-20 08:33:26 -06:00
@@ -79327,6 +79327,10 @@
       Comment:
 @end example
 
+You can also get information about stored routines from the @code{ROUTINES}
+table in @code{INFORMATION_SCHEMA}.
+@xref{ROUTINES Table,  , @code{ROUTINES} Table}.
+
 
 @node CALL, BEGIN END, SHOW PROCEDURE STATUS, Stored Procedure Syntax
 @subsection @code{CALL} Statement
@@ -79337,12 +79341,13 @@
 CALL @var{sp_name}([@var{parameter}[,...]])
 @end example
 
-The @code{CALL} statement is used to invoke a procedure that was defined
+The @code{CALL} statement invokes a procedure that was defined
 previously with @code{CREATE PROCEDURE}.
 
-@code{CALL} can return values through its parameters. It also ``returns''
-the number of rows affected, which a client program can obtain at the SQL
-level by calling the @code{ROW_COUNT()} function and from C by calling the
+@code{CALL} can pass back values to its caller using parameters that are
+declared as @code{OUT} or @code{INOUT} parameters. It also ``returns'' the
+number of rows affected, which a client program can obtain at the SQL level
+by calling the @code{ROW_COUNT()} function and from C by calling the
 @code{mysql_affected_rows()} C API function.
 
 
@@ -79361,8 +79366,9 @@
 Stored routines may contain multiple statements, using a
 @code{BEGIN ... END} compound statement.
 
-@var{begin_label} and @var{end_label} must be the same, if both are
-specified.
+A compound statement can be labeled.  @var{end_label} cannot be given unless
+@var{begin_label} also is present, and if both are present, they must be the
+same.
 
 Please note that the optional @code{[NOT] ATOMIC} clause is not yet
 supported. This means that no transactional savepoint is set at the start of
@@ -79391,8 +79397,8 @@
 @code{DECLARE} may be used only inside a @code{BEGIN ... END} compound
 statement and must be at its start, before any other statements.
 
-Cursors must be declared before declaring handlers, and variables must
-be declared before declaring either cursors or handlers.
+Cursors must be declared before declaring handlers, and variables and
+conditions must be declared before declaring either cursors or handlers.
 
 
 @node Variables in Stored Procedures, Conditions and Handlers, DECLARE, Stored Procedure Syntax
@@ -79414,8 +79420,13 @@
 DECLARE @var{var_name}[,...] @var{type} [DEFAULT @var{value}]
 @end example
 
-This statement is used to declare local variables. The scope of a variable is
-within the @code{BEGIN ... END} block.
+This statement is used to declare local variables.  To provide a default
+value for the variable, include a @code{DEFAULT} clause.  The value can be
+specified as an expression; it need not be a constant.
+
+The scope of a local variable is within the @code{BEGIN ... END} block where it
+is declared.  It can be used in nested blocks those that declare a variable
+with the same name.
 
 
 @node SET Statement, SELECT INTO Statement, DECLARE Local Variables, Variables in Stored Procedures
@@ -79434,10 +79445,10 @@
 The @code{SET} statement in stored procedures is implemented as part of the
 pre-existing @code{SET} syntax. This allows an extended syntax of
 @code{SET a=x, b=y, ...} where different variable types (locally declared
-variables, server variables, and global and session server variables) can be
+variables and global and session server variables) can be
 mixed. This also allows combinations of local variables and some options
-that make sense only for global/system variables; in that case, the options
-are accepted but ignored.
+that make sense only for system variables; in that case, the options
+are recognized but ignored.
 
 
 @node SELECT INTO Statement,  , SET Statement, Variables in Stored Procedures
@@ -79727,7 +79738,8 @@
 @code{ELSE} clause is executed. @var{statement_list} can consist of one or
 more statements.
 
-Please note that there is also an @code{IF()} function.
+Please note that there is also an @code{IF()} @emph{function}, which differs
+from the @code{IF} @emph{statement} described here..
 @xref{Control flow functions}.
 
 
@@ -79782,8 +79794,9 @@
 loop are repeated until the loop is exited; usually this is accomplished
 with a @code{LEAVE} statement.
 
-@var{begin_label} and @var{end_label} must be the same, if both are
-specified.
+A @code{LOOP} statement can be labeled.  @var{end_label} cannot be given
+unless @var{begin_label} also is present, and if both are present, they must
+be the same.
 
 
 @node LEAVE Statement, ITERATE Statement, LOOP Statement, Flow Control Constructs
@@ -79795,7 +79808,8 @@
 LEAVE @var{label}
 @end example
 
-This statement is used to exit any flow control construct.
+This statement is used to exit any labeled flow control construct.
+It can be used with @code{BEGIN ... END} or loops.
 
 
 @node ITERATE Statement, REPEAT Statement, LEAVE Statement, Flow Control Constructs
@@ -79808,7 +79822,7 @@
 @end example
 
 @code{ITERATE} can only appear within @code{LOOP}, @code{REPEAT}, and
-@code{WHILE} statements. @code{ITERATE} means ``do the loop iteration again.''
+@code{WHILE} statements. @code{ITERATE} means ``do the loop again.''
 
 For example:
 
@@ -79841,8 +79855,9 @@
 The statement or statements within a @code{REPEAT} statement are repeated
 until the @var{search_condition} is true.
 
-@var{begin_label} and @var{end_label} must be the same, if both are
-specified.
+A @code{REPEAT} statement can be labeled.  @var{end_label} cannot be given
+unless @var{begin_label} also is present, and if both are present, they must
+be the same.
 
 For example:
 
@@ -79884,8 +79899,9 @@
 The statement or statements within a @code{WHILE} statement are repeated as
 long as the @var{search_condition} is true.
 
-@var{begin_label} and @var{end_label} must be the same, if both are
-specified.
+A @code{WHILE} statement can be labeled.  @var{end_label} cannot be given
+unless @var{begin_label} also is present, and if both are present, they must
+be the same.
 
 For example:
 
Thread
bk commit - mysqldoc tree (paul:1.2746)paul20 Mar