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.1849 04/07/14 12:42:23 paul@stripped +1 -0
manual.texi:
Add tags.
Docs/manual.texi
1.1838 04/07/14 12:42:16 paul@stripped +417 -416
Add tags.
# 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: kite-hub.kitebird.com
# Root: /src/extern/MySQL/bk/mysqldoc
--- 1.1837/Docs/manual.texi 2004-07-14 11:12:49 -05:00
+++ 1.1838/Docs/manual.texi 2004-07-14 12:42:16 -05:00
@@ -10779,9 +10779,9 @@
@item
@code{mysql_shutdown()} has starting from 4.1.3 an extra parameter:
-@code{SHUTDOWN}-level. You should convert any @code{mysql_shutdown(X)}
+@code{SHUTDOWN}-level. You should convert any @code{mysql_shutdown(@var{X})}
call you have in your application to
-@code{mysql_shutdown(X,SHUTDOWN_DEFAULT)}.
+@code{mysql_shutdown(@var{X},SHUTDOWN_DEFAULT)}.
@item
If you are using an old @code{DBD-mysql} module
@@ -23874,7 +23874,7 @@
@item
The @code{PASSWORD()} function is non-repeatable. That is, with a given
-argument @code{X}, successive calls to @code{PASSWORD(X)} generate different
+argument @var{X}, successive calls to @code{PASSWORD(@var{X})} generate different
results.
@end itemize
@@ -25960,9 +25960,9 @@
@multitable @columnfractions .20 .40
@item @strong{File} @tab @strong{Purpose}
-@item @file{tbl_name.frm} @tab Definition (format) file
-@item @file{tbl_name.MYD} @tab Data file
-@item @file{tbl_name.MYI} @tab Index file
+@item @file{@var{tbl_name}.frm} @tab Definition (format) file
+@item @file{@var{tbl_name}.MYD} @tab Data file
+@item @file{@var{tbl_name}.MYI} @tab Index file
@end multitable
Each of these three file types is subject to corruption in various ways, but
@@ -36024,8 +36024,8 @@
@item table-lookup
The column was converted to an @code{ENUM}.
-@item zerofill(n)
-The most significant @code{n} bytes in the value are always 0 and are not
+@item zerofill(@var{n})
+The most significant @var{n} bytes in the value are always 0 and are not
stored.
@item no zeros
@@ -40063,10 +40063,10 @@
thus:
@itemize @bullet
-@item If both @code{CHARACTER SET X} and @code{COLLATE Y} were specified, then
-character set @code{X} and collation @code{Y}.
-@item If @code{CHARACTER SET X} was specified without @code{COLLATE}, then
-character set @code{X} and its default collation.
+@item If both @code{CHARACTER SET @var{X}} and @code{COLLATE @var{Y}} were specified, then
+character set @var{X} and collation @var{Y}.
+@item If @code{CHARACTER SET @var{X}} was specified without @code{COLLATE}, then
+character set @var{X} and its default collation.
@item Otherwise, the server character set and server collation.
@end itemize
@@ -40118,10 +40118,10 @@
MySQL chooses the table character set and collation thus:
@itemize @bullet
-@item If both @code{CHARACTER SET X} and @code{COLLATE Y} were specified, then
-character set @code{X} and collation @code{Y}.
-@item If @code{CHARACTER SET X} was specified without @code{COLLATE}, then
-character set @code{X} and its default collation.
+@item If both @code{CHARACTER SET @var{X}} and @code{COLLATE @var{Y}} were specified, then
+character set @var{X} and collation @var{Y}.
+@item If @code{CHARACTER SET @var{X}} was specified without @code{COLLATE}, then
+character set @var{X} and its default collation.
@item Otherwise, the database character set and collation.
@end itemize
@@ -40161,8 +40161,8 @@
MySQL chooses the column character set and collation thus:
@itemize @bullet
-@item If both @code{CHARACTER SET X} and @code{COLLATE Y} were specified, then
-character set @code{X} and collation @code{Y}.
+@item If both @code{CHARACTER SET @var{X}} and @code{COLLATE @var{Y}} were specified, then
+character set @var{X} and collation @var{Y}.
@item If @code{CHARACTER SET X} was specified without @code{COLLATE}, then
character set @code{X} and its default collation.
@item Otherwise, the table character set and collation.
@@ -40430,10 +40430,10 @@
MySQL determines a literal's character set and collation thus:
@itemize @bullet
-@item If both @code{_X} and @code{COLLATE Y} were specified, then
-character set @code{X} and collation @code{Y}
-@item If @code{_X} is specified but @code{COLLATE} is not specified, then
-character set @code{X} and its default collation
+@item If both @var{_X} and @code{COLLATE @var{Y}} were specified, then
+character set @var{X} and collation @var{Y}
+@item If @var{_X} is specified but @code{COLLATE} is not specified, then
+character set @var{X} and its default collation
@item Otherwise, the character set and collation given by the
@code{character_set_connection} and @code{collation_connection} system
variables
@@ -40791,8 +40791,8 @@
For simple functions that take string input and return a string result as
output, the output's character set and collation are the same as those of
-the principal input value. For example, @code{UPPER(X)} returns a string
-whose character string and collation are the same as that of @code{X}.
+the principal input value. For example, @code{UPPER(@var{X})} returns a string
+whose character string and collation are the same as that of @var{X}.
The same applies for
@code{INSTR()},
@code{LCASE()},
@@ -41156,8 +41156,8 @@
For MaxDB compatibility these two statements are the same:
@example
-CREATE TABLE t1 (f1 CHAR(n) UNICODE);
-CREATE TABLE t1 (f1 CHAR(n) CHARACTER SET ucs2);
+CREATE TABLE t1 (f1 CHAR(@var{n}) UNICODE);
+CREATE TABLE t1 (f1 CHAR(@var{n}) CHARACTER SET ucs2);
@end example
@@ -41837,17 +41837,17 @@
Several of the column type descriptions use these conventions:
@table @code
-@item M
+@item @var{M}
@cindex display size
@cindex sizes, display
Indicates the maximum display size. The maximum legal display size is 255.
-@item D
+@item @var{D}
@cindex digits
@cindex decimal point
Applies to floating-point and fixed-point types and indicates the number of
digits following the decimal point. The maximum possible value is 30, but
-should be no greater than @code{M}@minus{}2.
+should be no greater than @var{M}@minus{}2.
@item
@cindex brackets, square
@@ -41888,7 +41888,7 @@
@table @code
@tindex TINYINT
@c description_for_help_topic TINYINT BOOLEAN BOOL BIT ZEROFILL UNSIGNED INT1
-@item TINYINT[(M)] [UNSIGNED] [ZEROFILL]
+@item TINYINT[(@var{M})] [UNSIGNED] [ZEROFILL]
A very small integer. The signed range is @code{-128} to @code{127}. The
unsigned range is @code{0} to @code{255}.
@@ -41909,7 +41909,7 @@
@tindex SMALLINT
@c description_for_help_topic SMALLINT INT2
-@item SMALLINT[(M)] [UNSIGNED] [ZEROFILL]
+@item SMALLINT[(@var{M})] [UNSIGNED] [ZEROFILL]
A small integer. The signed range is @code{-32768} to @code{32767}. The
unsigned range is @code{0} to @code{65535}.
@@ -41917,7 +41917,7 @@
@tindex MEDIUMINT
@c description_for_help_topic MEDIUMINT INT3 MIDDLEINT
-@item MEDIUMINT[(M)] [UNSIGNED] [ZEROFILL]
+@item MEDIUMINT[(@var{M})] [UNSIGNED] [ZEROFILL]
A medium-size integer. The signed range is @code{-8388608} to
@code{8388607}. The unsigned range is @code{0} to @code{16777215}.
@@ -41925,20 +41925,20 @@
@tindex INT
@c description_for_help_topic INT INT4 UNSIGNED ZEROFILL INTEGER
-@item INT[(M)] [UNSIGNED] [ZEROFILL]
+@item INT[(@var{M})] [UNSIGNED] [ZEROFILL]
A normal-size integer. The signed range is @code{-2147483648} to
@code{2147483647}. The unsigned range is @code{0} to @code{4294967295}.
@tindex INTEGER
-@item INTEGER[(M)] [UNSIGNED] [ZEROFILL]
+@item INTEGER[(@var{M})] [UNSIGNED] [ZEROFILL]
This is a synonym for @code{INT}.
@c end_description_for_help_topic
@tindex BIGINT
@c description_for_help_topic BIGINT UNSIGNED ZEROFILL INT8
-@item BIGINT[(M)] [UNSIGNED] [ZEROFILL]
+@item BIGINT[(@var{M})] [UNSIGNED] [ZEROFILL]
A large integer. The signed range is @code{-9223372036854775808} to
@code{9223372036854775807}. The unsigned range is @code{0} to
@code{18446744073709551615}.
@@ -41980,12 +41980,12 @@
@end itemize
@c description_for_help_topic FLOAT UNSIGNED ZEROFILL FLOAT4
-@item FLOAT(p) [UNSIGNED] [ZEROFILL]
+@item FLOAT(@var{p}) [UNSIGNED] [ZEROFILL]
@cindex floating-point number
@tindex FLOAT
@tindex FLOAT(p)
-A floating-point number. @code{p} represents the precision. It can be from
+A floating-point number. @var{p} represents the precision. It can be from
0 to 24 for a single-precision floating-point number and from 25 to 53 for a
double-precision floating-point number. These types are like the @code{FLOAT}
and @code{DOUBLE} types described immediately following. @code{FLOAT(p)}
@@ -41993,7 +41993,7 @@
types, but the display size and number of decimals are undefined.
As of MySQL 3.23, this is a true floating-point value. In
-earlier MySQL versions, @code{FLOAT(p)} always has two decimals.
+earlier MySQL versions, @code{FLOAT(@var{p})} always has two decimals.
@cindex ODBC compatibility
@cindex compatibility, with ODBC
@@ -42005,36 +42005,38 @@
@tindex FLOAT
@tindex FLOAT(M,D)
-@item FLOAT[(M,D)] [UNSIGNED] [ZEROFILL]
+@tindex FLOAT(p)
+@item FLOAT[(@var{M},@var{D})] [UNSIGNED] [ZEROFILL]
A small (single-precision) floating-point number. Allowable values are
@code{@w{-3.402823466E+38}} to @code{@w{-1.175494351E-38}}, @code{0},
and @code{@w{1.175494351E-38}} to @code{3.402823466E+38}. If
-@code{UNSIGNED} is specified, negative values are disallowed. @code{M}
-is the display width and @code{D} is the number of decimals. @code{FLOAT}
-without arguments or @code{FLOAT(p)} (where @code{p} is in the range from
+@code{UNSIGNED} is specified, negative values are disallowed. @var{M}
+is the display width and @var{D} is the number of decimals. @code{FLOAT}
+without arguments or @code{FLOAT(@var{p})} (where @var{p} is in the range from
0 to 24) stands for a single-precision floating-point number.
@c end_description_for_help_topic
@tindex DOUBLE
+@tindex DOUBLE(M,D)
@tindex FLOAT(p)
@c description_for_help_topic DOUBLE FLOAT8 UNSIGNED ZEROFILL PRECISION REAL
-@item DOUBLE[(M,D)] [UNSIGNED] [ZEROFILL]
+@item DOUBLE[(@var{M},@var{D})] [UNSIGNED] [ZEROFILL]
A normal-size (double-precision) floating-point number.
Allowable values are @code{@w{-1.7976931348623157E+308}} to
@code{@w{-2.2250738585072014E-308}}, @code{0}, and
@code{2.2250738585072014E-308} to @code{1.7976931348623157E+308}. If
@code{UNSIGNED} is specified, negative values are disallowed.
-@code{M} is the display width and @code{D} is the number of decimals.
-@code{DOUBLE} without arguments or @code{FLOAT(p)} (where
-@code{p} is in the
+@var{M} is the display width and @var{D} is the number of decimals.
+@code{DOUBLE} without arguments or @code{FLOAT(@var{p})} (where
+@var{p} is in the
range from 25 to 53) stands for a double-precision floating-point number.
@tindex DOUBLE PRECISION
@tindex REAL
-@item DOUBLE PRECISION[(M,D)] [UNSIGNED] [ZEROFILL]
-@itemx REAL[(M,D)] [UNSIGNED] [ZEROFILL]
+@item DOUBLE PRECISION[(@var{M},@var{D})] [UNSIGNED] [ZEROFILL]
+@itemx REAL[(@var{M},@var{D})] [UNSIGNED] [ZEROFILL]
These are synonyms for @code{DOUBLE}.
Exception: If the server SQL mode includes the @code{REAL_AS_FLOAT} option,
@@ -42043,31 +42045,31 @@
@tindex DECIMAL
@c description_for_help_topic NUMERIC ZEROFILL UNSIGNED DECIMAL DEC FIXED
-@item DECIMAL[(M[,D])] [UNSIGNED] [ZEROFILL]
+@item DECIMAL[(@var{M}[,@var{D}])] [UNSIGNED] [ZEROFILL]
An unpacked fixed-point number. Behaves like a @code{CHAR} column;
``unpacked'' means the number is stored as a string, using one character for
-each digit of the value. @code{M} is the total number of digits and
-@code{D} is the number of decimals. The decimal point and (for negative
-numbers) the @samp{-} sign are not counted in @code{M}, although space for
-them is reserved. If @code{D} is 0, values have no decimal point or
+each digit of the value. @var{M} is the total number of digits and
+@var{D} is the number of decimals. The decimal point and (for negative
+numbers) the @samp{-} sign are not counted in @var{M}, although space for
+them is reserved. If @var{D} is 0, values have no decimal point or
fractional part. The maximum range of @code{DECIMAL} values is the same as
for @code{DOUBLE}, but the actual range for a given @code{DECIMAL} column
-may be constrained by the choice of @code{M} and @code{D}. If
+may be constrained by the choice of @var{M} and @var{D}. If
@code{UNSIGNED} is specified, negative values are disallowed.
-If @code{D} is omitted, the default is 0. If @code{M} is omitted, the
+If @var{D} is omitted, the default is 0. If @var{M} is omitted, the
default is 10.
-Prior to MySQL 3.23, the @code{M} argument must be large enough to
+Prior to MySQL 3.23, the @var{M} argument must be large enough to
include the space needed for the sign and the decimal point.
@tindex DEC
@tindex NUMERIC
@tindex FIXED
-@item DEC[(M[,D])] [UNSIGNED] [ZEROFILL]
-@itemx NUMERIC[(M[,D])] [UNSIGNED] [ZEROFILL]
-@itemx FIXED[(M[,D])] [UNSIGNED] [ZEROFILL]
+@item DEC[(@var{M}[,@var{D}])] [UNSIGNED] [ZEROFILL]
+@itemx NUMERIC[(@var{M}[,@var{D}])] [UNSIGNED] [ZEROFILL]
+@itemx FIXED[(@var{M}[,@var{D}])] [UNSIGNED] [ZEROFILL]
These are synonyms for @code{DECIMAL}.
@@ -42108,7 +42110,7 @@
@tindex TIMESTAMP
@c description_for_help_topic TIMESTAMP TIMESTAMP
-@item TIMESTAMP[(M)]
+@item TIMESTAMP[(@var{M})]
A timestamp. The range is @code{'1970-01-01 00:00:00'} to partway through the
year @code{2037}.
@@ -42127,16 +42129,16 @@
In MySQL 4.0 and earlier, @code{TIMESTAMP} values are displayed in
@code{YYYYMMDDHHMMSS}, @code{YYMMDDHHMMSS}, @code{YYYYMMDD}, or @code{YYMMDD}
-format, depending on whether @code{M} is 14 (or missing), 12,
+format, depending on whether @var{M} is 14 (or missing), 12,
8, or 6, but allows you to assign values to @code{TIMESTAMP}
columns using either strings or numbers.
-The @code{M} argument affects only how a @code{TIMESTAMP} column is displayed,
+The @var{M} argument affects only how a @code{TIMESTAMP} column is displayed,
not storage. Its values always are stored using four bytes each.
From MySQL 4.0.12, the @code{--new} option can be used
to make the server behave as in MySQL 4.1.
-Note that @code{TIMESTAMP(M)} columns where @code{M} is 8 or 14 are reported to
-be numbers, whereas other @code{TIMESTAMP(M)} columns are reported to be
+Note that @code{TIMESTAMP(@var{M})} columns where @var{M} is 8 or 14 are reported to
+be numbers, whereas other @code{TIMESTAMP(@var{M})} columns are reported to be
strings. This is just to ensure that you can reliably dump and restore
the table with these types.
@c end_description_for_help_topic
@@ -42219,12 +42221,12 @@
@tindex CHARACTER
@c description_for_help_topic CHAR NATIONAL CHARACTER NCHAR BINARY
@c UPDATE START
-@item [NATIONAL] CHAR(M) [BINARY | ASCII | UNICODE]
+@item [NATIONAL] CHAR(@var{M}) [BINARY | ASCII | UNICODE]
@c UPDATE STOP
A fixed-length string that is always right-padded with spaces to the
-specified length when stored. @code{M} represents the column length. The
-range of @code{M} is 0 to 255 characters (1 to 255 prior to MySQL 3.23).
+specified length when stored. @var{M} represents the column length. The
+range of @var{M} is 0 to 255 characters (1 to 255 prior to MySQL 3.23).
@strong{Note:} Trailing spaces are removed when @code{CHAR} values are
retrieved.
@@ -42268,10 +42270,10 @@
@tindex VARCHAR
@tindex VARCHARACTER
@c description_for_help_topic VARCHAR BINARY NATIONAL VARYING CHARACTER VARCHARACTER
-@item [NATIONAL] VARCHAR(M) [BINARY]
+@item [NATIONAL] VARCHAR(@var{M}) [BINARY]
-A variable-length string. @code{M} represents the maximum column length.
-The range of @code{M} is 0 to 255 characters (1 to 255 prior to MySQL 4.0.2).
+A variable-length string. @var{M} represents the maximum column length.
+The range of @var{M} is 0 to 255 characters (1 to 255 prior to MySQL 4.0.2).
@strong{Note:} Trailing spaces are removed when @code{VARCHAR} values are
stored, which differs from the standard SQL specification.
@@ -42338,10 +42340,10 @@
@tindex ENUM
@c description_for_help_topic ENUM
-@item ENUM('value1','value2',...)
+@item ENUM('@var{value1}','@var{value2}',...)
An enumeration. A string object that can have only one value, chosen
-from the list of values @code{'value1'}, @code{'value2'}, @code{...},
+from the list of values @code{'@var{value1}'}, @code{'@var{value2}'}, @code{...},
@code{NULL} or the special @code{''} error value. An @code{ENUM} column can
have a maximum of 65,535 distinct values.
@code{ENUM} values are represented internally as integers.
@@ -42349,10 +42351,10 @@
@tindex SET
@c description_for_help_topic type SET
-@item SET('value1','value2',...)
+@item SET('@var{value1}','@var{value2}',...)
A set. A string object that can have zero or more values, each of which must
-be chosen from the list of values @code{'value1'}, @code{'value2'},
+be chosen from the list of values @code{'@var{value1}'}, @code{'@var{value2}'},
@code{...} A @code{SET} column can have a maximum of 64 members.
@code{SET} values are represented internally as integers.
@end table
@@ -42462,19 +42464,19 @@
@item
@code{DECIMAL} columns in MySQL before 3.23 are stored differently and
cannot represent all the values required by standard SQL. This is because
-for a type of @code{DECIMAL(M,D)}, the value of @code{M} includes the bytes
+for a type of @code{DECIMAL(@var{M},@var{D})}, the value of @var{M} includes the bytes
for the sign and the decimal point. The range of the @code{salary} column
before MySQL 3.23 would be @code{-9.99} to @code{99.99}.
@end itemize
-In standard SQL, the syntax @code{DECIMAL(M)} is equivalent to
-@code{DECIMAL(M,0)}. Similarly, the syntax @code{DECIMAL} is equivalent
-to @code{DECIMAL(M,0)}, where the implementation is allowed to decide the
-value of @code{M}. As of MySQL 3.23.6, both of these variant forms of the
+In standard SQL, the syntax @code{DECIMAL(@var{M})} is equivalent to
+@code{DECIMAL(@var{M},0)}. Similarly, the syntax @code{DECIMAL} is equivalent
+to @code{DECIMAL(@var{M},0)}, where the implementation is allowed to decide the
+value of @var{M}. As of MySQL 3.23.6, both of these variant forms of the
@code{DECIMAL} and @code{NUMERIC} data types are supported. The default value
-of @code{M} is 10. Before 3.23.6,
-@code{M} and @code{D} both must be specified explicitly.
+of @var{M} is 10. Before 3.23.6,
+@var{M} and @var{D} both must be specified explicitly.
The maximum range of @code{DECIMAL} and @code{NUMERIC} values is the
same as for @code{DOUBLE}, but the actual range for a given
@@ -43766,10 +43768,10 @@
@item @code{MEDIUMINT} @tab 3 bytes
@item @code{INT}, @code{INTEGER} @tab 4 bytes
@item @code{BIGINT} @tab 8 bytes
-@item @code{FLOAT(p)} @tab 4 bytes if 0 <= p <= 24, 8 bytes if 25 <= p <= 53
+@item @code{FLOAT(@var{p})} @tab 4 bytes if 0 <= @var{p} <= 24, 8 bytes if 25 <= @var{p} <= 53
@item @code{FLOAT} @tab 4 bytes
@item @code{DOUBLE [PRECISION]}, item @code{REAL} @tab 8 bytes
-@item @code{DECIMAL(M,D)}, @code{NUMERIC(M,D)} @tab @code{M+2} bytes if D > 0, @code{M+1} bytes if D = 0 (@code{D}+2, if @code{M < D})
+@item @code{DECIMAL(@var{M},@var{D})}, @code{NUMERIC(@var{M},@var{D})} @tab @var{M}+2 bytes if @var{D} > 0, @code{@var{M}+1} bytes if @var{D} = 0 (@var{D}+2, if @code{@var{M} < @var{D}})
@end multitable
@cindex date types
@@ -43792,20 +43794,19 @@
@multitable @columnfractions .40 .60
@item @strong{Column Type} @tab @strong{Storage Required}
-@item @code{CHAR(M)} @tab @code{M} bytes, 0 @code{<= M <=} 255
-@item @code{VARCHAR(M)} @tab @code{L}+1 bytes, where @code{L <= M} and
-0 @code{<= M <=} 255
-@item @code{TINYBLOB}, @code{TINYTEXT} @tab @code{L}+1 bytes,
-where @code{L} < 2^8
-@item @code{BLOB}, @code{TEXT} @tab @code{L}+2 bytes,
-where @code{L} < 2^16
-@item @code{MEDIUMBLOB}, @code{MEDIUMTEXT} @tab @code{L}+3 bytes,
-where @code{L} < 2^24
-@item @code{LONGBLOB}, @code{LONGTEXT} @tab @code{L}+4 bytes,
-where @code{L} < 2^32
-@item @code{ENUM('value1','value2',...)} @tab 1 or 2 bytes, depending on
+@item @code{CHAR(@var{M})} @tab @code{@var{M}} bytes, 0 @code{<= @var{M} <=} 255
+@item @code{VARCHAR(@var{M})} @tab @var{L}+1 bytes, where @code{@var{L} <= @var{M}} and 0 @code{<= @var{M} <=} 255
+@item @code{TINYBLOB}, @code{TINYTEXT} @tab @var{L}+1 bytes,
+where @var{L} < 2^8
+@item @code{BLOB}, @code{TEXT} @tab @var{L}+2 bytes,
+where @var{L} < 2^16
+@item @code{MEDIUMBLOB}, @code{MEDIUMTEXT} @tab @var{L}+3 bytes,
+where @var{L} < 2^24
+@item @code{LONGBLOB}, @code{LONGTEXT} @tab @var{L}+4 bytes,
+where @var{L} < 2^32
+@item @code{ENUM('@var{value1}','@var{value2}',...)} @tab 1 or 2 bytes, depending on
the number of enumeration values (65,535 values maximum)
-@item @code{SET('value1','value2',...)} @tab 1, 2, 3, 4, or 8 bytes, depending
+@item @code{SET('@var{value1}','@var{value2}',...)} @tab 1, 2, 3, 4, or 8 bytes, depending
on the number of set members (64 members maximum)
@end multitable
@@ -43815,11 +43816,11 @@
@code{VARCHAR} and the @code{BLOB} and @code{TEXT} types are variable-length
types. For each, the storage requirements depend on the actual length of
-column values (represented by @code{L} in the preceding table), rather than
+column values (represented by @var{L} in the preceding table), rather than
on the type's maximum possible size. For example, a @code{VARCHAR(10)}
column can hold a string with a maximum length of 10 characters. The actual
-storage required is the length of the string (@code{L}), plus 1 byte to
-record the length of the string. For the string @code{'abcd'}, @code{L} is 4
+storage required is the length of the string (@var{L}), plus 1 byte to
+record the length of the string. For the string @code{'abcd'}, @var{L} is 4
and the storage requirement is 5 bytes.
The @code{BLOB} and @code{TEXT} types require 1, 2, 3, or 4 bytes to record
@@ -43877,8 +43878,8 @@
@multitable @columnfractions .35 .35
@item @strong{Other Vendor Type} @tab @strong{MySQL Type}
-@item @code{BINARY(M)} @tab @code{CHAR(M) BINARY}
-@item @code{CHAR VARYING(M)} @tab @code{VARCHAR(M)}
+@item @code{BINARY(@var{M})} @tab @code{CHAR(@var{M}) BINARY}
+@item @code{CHAR VARYING(@var{M})} @tab @code{VARCHAR(@var{M})}
@item @code{FLOAT4} @tab @code{FLOAT}
@item @code{FLOAT8} @tab @code{DOUBLE}
@item @code{INT1} @tab @code{TINYINT}
@@ -43890,7 +43891,7 @@
@item @code{LONG VARCHAR} @tab @code{MEDIUMTEXT}
@item @code{LONG} @tab @code{MEDIUMTEXT} (MySQL 4.1.0 on)
@item @code{MIDDLEINT} @tab @code{MEDIUMINT}
-@item @code{VARBINARY(M)} @tab @code{VARCHAR(M) BINARY}
+@item @code{VARBINARY(@var{M})} @tab @code{VARCHAR(@var{M}) BINARY}
@end multitable
Column type mapping occurs at table creation time, after which the original
@@ -44897,7 +44898,7 @@
@code{BIT_LENGTH()} was added in MySQL 4.0.2.
@c description_for_help_topic CHAR function
-@item CHAR(N,...)
+@item CHAR(@var{N},...)
@findex CHAR()
@code{CHAR()} interprets the arguments as integers and returns a string
consisting of the characters given by the code values of those
@@ -44931,7 +44932,7 @@
@c end_description_for_help_topic
@c description_for_help_topic COMPRESS
-@item COMPRESS(string_to_compress)
+@item COMPRESS(@var{string_to_compress})
@findex COMPRESS()
Compresses a string. This function requires MySQL to have been compiled
with a compression library such as @code{zlib}. Otherwise, the return
@@ -44969,7 +44970,7 @@
@c description_for_help_topic CONCAT
-@item CONCAT(str1,str2,...)
+@item CONCAT(@var{str1},@var{str2},...)
@findex CONCAT()
Returns the string that results from concatenating the arguments. Returns
@code{NULL} if any argument is @code{NULL}. May have one or more arguments.
@@ -44987,7 +44988,7 @@
@end example
@c description_for_help_topic CONCAT_WS
-@item CONCAT_WS(separator,str1,str2,...)
+@item CONCAT_WS(@var{separator},@var{str1},@var{str2},...)
@findex CONCAT_WS()
@code{CONCAT_WS()} stands for CONCAT With Separator and is a special form of
@@ -45204,7 +45205,7 @@
@end example
@c description_for_help_topic LOAD_FILE
-@item LOAD_FILE(file_name)
+@item LOAD_FILE(@var{file_name})
@findex FILE
@findex LOAD_FILE()
Reads the file and returns the file contents as a string. The file
@@ -46037,9 +46038,9 @@
@table @code
@c description_for_help_topic ABS
-@item ABS(X)
+@item ABS(@var{X})
@findex ABS()
-Returns the absolute value of @code{X}.
+Returns the absolute value of @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic ABS
@@ -46053,10 +46054,10 @@
This function is safe to use with @code{BIGINT} values.
@c description_for_help_topic ACOS
-@item ACOS(X)
+@item ACOS(@var{X})
@findex ACOS()
-Returns the arc cosine of @code{X}, that is, the value whose cosine is
-@code{X}. Returns @code{NULL} if @code{X} is not in the range @code{-1} to
+Returns the arc cosine of @var{X}, that is, the value whose cosine is
+@var{X}. Returns @code{NULL} if @var{X} is not in the range @code{-1} to
@code{1}.
@c end_description_for_help_topic
@@ -46071,10 +46072,10 @@
@end example
@c description_for_help_topic ASIN
-@item ASIN(X)
+@item ASIN(@var{X})
@findex ASIN()
-Returns the arc sine of @code{X}, that is, the value whose sine is
-@code{X}. Returns @code{NULL} if @code{X} is not in the range @code{-1} to
+Returns the arc sine of @var{X}, that is, the value whose sine is
+@var{X}. Returns @code{NULL} if @var{X} is not in the range @code{-1} to
@code{1}.
@c end_description_for_help_topic
@@ -46087,10 +46088,10 @@
@end example
@c description_for_help_topic ATAN
-@item ATAN(X)
+@item ATAN(@var{X})
@findex ATAN()
-Returns the arc tangent of @code{X}, that is, the value whose tangent is
-@code{X}.
+Returns the arc tangent of @var{X}, that is, the value whose tangent is
+@var{X}.
@c end_description_for_help_topic
@c example_for_help_topic ATAN
@@ -46102,11 +46103,11 @@
@end example
@c description_for_help_topic ATAN2
-@item ATAN(Y,X)
-@itemx ATAN2(Y,X)
+@item ATAN(@var{Y},@var{X})
+@itemx ATAN2(@var{Y},@var{X})
@findex ATAN2()
-Returns the arc tangent of the two variables @code{X} and @code{Y}. It is
-similar to calculating the arc tangent of @code{Y / X}, except that the
+Returns the arc tangent of the two variables @var{X} and @var{Y}. It is
+similar to calculating the arc tangent of @code{@var{Y} / @var{X}}, except that the
signs of both arguments are used to determine the quadrant of the
result.
@c end_description_for_help_topic
@@ -46120,10 +46121,10 @@
@end example
@c description_for_help_topic CEILING CEIL
-@item CEILING(X)
-@itemx CEIL(X)
+@item CEILING(@var{X})
+@itemx CEIL(@var{X})
@findex CEILING()
-Returns the smallest integer value not less than @code{X}.
+Returns the smallest integer value not less than @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic CEILING
@@ -46139,9 +46140,9 @@
The @code{CEIL()} alias was added in MySQL 4.0.6.
@c description_for_help_topic COS
-@item COS(X)
+@item COS(@var{X})
@findex COS()
-Returns the cosine of @code{X}, where @code{X} is given in radians.
+Returns the cosine of @var{X}, where @var{X} is given in radians.
@c end_description_for_help_topic
@c example_for_help_topic COS
@@ -46151,9 +46152,9 @@
@end example
@c description_for_help_topic COT
-@item COT(X)
+@item COT(@var{X})
@findex COT()
-Returns the cotangent of @code{X}.
+Returns the cotangent of @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic COT
@@ -46181,9 +46182,9 @@
@code{CRC32()} is available as of MySQL 4.1.0.
@c description_for_help_topic DEGREES
-@item DEGREES(X)
+@item DEGREES(@var{X})
@findex DEGREES()
-Returns the argument @code{X}, converted from radians to degrees.
+Returns the argument @var{X}, converted from radians to degrees.
@c end_description_for_help_topic
@c example_for_help_topic DEGREES
@@ -46193,10 +46194,10 @@
@end example
@c description_for_help_topic EXP
-@item EXP(X)
+@item EXP(@var{X})
@findex EXP()
Returns the value of @code{e} (the base of natural logarithms) raised to
-the power of @code{X}.
+the power of @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic EXP
@@ -46208,9 +46209,9 @@
@end example
@c description_for_help_topic FLOOR
-@item FLOOR(X)
+@item FLOOR(@var{X})
@findex FLOOR()
-Returns the largest integer value not greater than @code{X}.
+Returns the largest integer value not greater than @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic FLOOR
@@ -46224,9 +46225,9 @@
Note that the return value is converted to a @code{BIGINT}!
@c description_for_help_topic LN
-@item LN(X)
+@item LN(@var{X})
@findex LN()
-Returns the natural logarithm of @code{X}.
+Returns the natural logarithm of @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic LN
@@ -46238,14 +46239,14 @@
@end example
This function was added in MySQL 4.0.3.
-It is synonymous with @code{LOG(X)} in MySQL.
+It is synonymous with @code{LOG(@var{X})} in MySQL.
@c description_for_help_topic LOG
-@item LOG(X)
-@itemx LOG(B,X)
+@item LOG(@var{X})
+@itemx LOG(@var{B},@var{X})
@findex LOG()
If called with one parameter, this function returns the natural logarithm
-of @code{X}.
+of @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic LOG
@@ -46257,7 +46258,7 @@
@end example
If called with two parameters, this function returns the logarithm of
-@code{X} for an arbitrary base @code{B}.
+@var{X} for an arbitrary base @var{B}.
@example
mysql> SELECT LOG(2,65536);
-> 16.000000
@@ -46266,12 +46267,12 @@
@end example
The arbitrary base option was added in MySQL 4.0.3.
-@code{LOG(B,X)} is equivalent to @code{LOG(X)/LOG(B)}.
+@code{LOG(@var{B},@var{X})} is equivalent to @code{LOG(@var{X})/LOG(@var{B})}.
@c description_for_help_topic LOG2
-@item LOG2(X)
+@item LOG2(@var{X})
@findex LOG2()
-Returns the base-2 logarithm of @code{X}.
+Returns the base-2 logarithm of @code{@var{X}}.
@c end_description_for_help_topic
@c example_for_help_topic LOG2
@@ -46285,12 +46286,12 @@
@code{LOG2()} is useful for finding out how many bits a number would
require for storage.
This function was added in MySQL 4.0.3.
-In earlier versions, you can use @code{LOG(X)/LOG(2)} instead.
+In earlier versions, you can use @code{LOG(@var{X})/LOG(2)} instead.
@c description_for_help_topic LOG10
-@item LOG10(X)
+@item LOG10(@var{X})
@findex LOG10()
-Returns the base-10 logarithm of @code{X}.
+Returns the base-10 logarithm of @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic LOG10
@@ -46347,11 +46348,11 @@
@end example
@c description_for_help_topic POWER POW
-@item POW(X,Y)
-@itemx POWER(X,Y)
+@item POW(@var{X},@var{Y})
+@itemx POWER(@var{X},@var{Y})
@findex POW()
@findex POWER()
-Returns the value of @code{X} raised to the power of @code{Y}.
+Returns the value of @var{X} raised to the power of @var{Y}.
@c end_description_for_help_topic
@c example_for_help_topic POWER
@@ -46363,9 +46364,9 @@
@end example
@c description_for_help_topic RADIANS
-@item RADIANS(X)
+@item RADIANS(@var{X})
@findex RADIANS()
-Returns the argument @code{X}, converted from degrees to radians.
+Returns the argument @var{X}, converted from degrees to radians.
@c end_description_for_help_topic
@c example_for_help_topic RADIANS
@@ -46421,12 +46422,12 @@
platforms for the same MySQL version.
@c description_for_help_topic ROUND
-@item ROUND(X)
-@itemx ROUND(X,D)
+@item ROUND(@var{X})
+@itemx ROUND(@var{X},@var{D})
@findex ROUND()
-Returns the argument @code{X}, rounded to the nearest integer.
-With two arguments, returns @code{X} rounded to @code{D} decimals.
-If @code{D} is negative, the integer part of the number is zeroed out.
+Returns the argument @var{X}, rounded to the nearest integer.
+With two arguments, returns @var{X} rounded to @var{D} decimals.
+If @var{D} is negative, the integer part of the number is zeroed out.
@c end_description_for_help_topic
@c example_for_help_topic ROUND
@@ -46453,10 +46454,10 @@
such as @code{TRUNCATE()} or @code{FLOOR()} instead.
@c description_for_help_topic SIGN
-@item SIGN(X)
+@item SIGN(@var{X})
@findex SIGN()
Returns the sign of the argument as @code{-1}, @code{0}, or @code{1}, depending
-on whether @code{X} is negative, zero, or positive.
+on whether @var{X} is negative, zero, or positive.
@c end_description_for_help_topic
@c example_for_help_topic SIGN
@@ -46470,9 +46471,9 @@
@end example
@c description_for_help_topic SIN
-@item SIN(X)
+@item SIN(@var{X})
@findex SIN()
-Returns the sine of @code{X}, where @code{X} is given in radians.
+Returns the sine of @var{X}, where @var{X} is given in radians.
@c end_description_for_help_topic
@c example_for_help_topic SIN
@@ -46482,9 +46483,9 @@
@end example
@c description_for_help_topic SQRT
-@item SQRT(X)
+@item SQRT(@var{X})
@findex SQRT()
-Returns the non-negative square root of @code{X}.
+Returns the non-negative square root of @var{X}.
@c end_description_for_help_topic
@c example_for_help_topic SQRT
@@ -46496,9 +46497,9 @@
@end example
@c description_for_help_topic TAN
-@item TAN(X)
+@item TAN(@var{X})
@findex TAN()
-Returns the tangent of @code{X}, where @code{X} is given in radians.
+Returns the tangent of @var{X}, where @var{X} is given in radians.
@c end_description_for_help_topic
@c example_for_help_topic TAN
@@ -46508,11 +46509,11 @@
@end example
@c description_for_help_topic TRUNCATE
-@item TRUNCATE(X,D)
+@item TRUNCATE(@var{X},@var{D})
@findex TRUNCATE()
-Returns the number @code{X}, truncated to @code{D} decimals. If @code{D}
+Returns the number @var{X}, truncated to @var{D} decimals. If @var{D}
is @code{0}, the result will have no decimal point or fractional part.
-If @code{D} is negative, the integer part of the number is zeroed out.
+If @var{D} is negative, the integer part of the number is zeroed out.
@c end_description_for_help_topic
@c example_for_help_topic TRUNCATE
@@ -46864,10 +46865,10 @@
@end example
@c description_for_help_topic DATE_FORMAT
-@item DATE_FORMAT(date,format)
+@item DATE_FORMAT(@var{date},@var{format})
@findex DATE_FORMAT()
-Formats the @code{date} value according to the @code{format} string. The
-following specifiers may be used in the @code{format} string:
+Formats the @var{date} value according to the @var{format} string. The
+following specifiers may be used in the @var{format} string:
@multitable @columnfractions .20 .70
@item @strong{Specifier} @tab @strong{Description}
@@ -46936,7 +46937,7 @@
@end example
@c description_for_help_topic DAY
-@item DAY(date)
+@item DAY(@var{date})
@findex DAY()
@code{DAY()} is a synonym for @code{DAYOFMONTH()}.
@@ -46944,9 +46945,9 @@
@c end_description_for_help_topic
@c description_for_help_topic DAYNAME
-@item DAYNAME(date)
+@item DAYNAME(@var{date})
@findex DAYNAME()
-Returns the name of the weekday for @code{date}.
+Returns the name of the weekday for @var{date}.
@c end_description_for_help_topic
@c example_for_help_topic DAYNAME
@@ -46956,9 +46957,9 @@
@end example
@c description_for_help_topic DAYOFMONTH
-@item DAYOFMONTH(date)
+@item DAYOFMONTH(@var{date})
@findex DAYOFMONTH()
-Returns the day of the month for @code{date}, in the range @code{1} to
+Returns the day of the month for @var{date}, in the range @code{1} to
@code{31}.
@c end_description_for_help_topic
@@ -46969,10 +46970,10 @@
@end example
@c description_for_help_topic DAYOFWEEK
-@item DAYOFWEEK(date)
+@item DAYOFWEEK(@var{date})
@findex DAYOFWEEK()
Returns the weekday index
-for @code{date} (@code{1} = Sunday, @code{2} = Monday, ..., @code{7} =
+for @var{date} (@code{1} = Sunday, @code{2} = Monday, ..., @code{7} =
Saturday). These index values correspond to the ODBC standard.
@c end_description_for_help_topic
@@ -46983,9 +46984,9 @@
@end example
@c description_for_help_topic DAYOFYEAR
-@item DAYOFYEAR(date)
+@item DAYOFYEAR(@var{date})
@findex DAYOFYEAR()
-Returns the day of the year for @code{date}, in the range @code{1} to
+Returns the day of the year for @var{date}, in the range @code{1} to
@code{366}.
@c end_description_for_help_topic
@@ -46996,7 +46997,7 @@
@end example
@c description_for_help_topic EXTRACT
-@item EXTRACT(type FROM date)
+@item EXTRACT(@var{type} FROM @var{date})
@findex EXTRACT()
The @code{EXTRACT()} function uses the same kinds of interval type
@@ -47036,10 +47037,10 @@
the days that were lost when the calendar was changed.
@c description_for_help_topic FROM_UNIXTIME
-@item FROM_UNIXTIME(unix_timestamp)
-@itemx FROM_UNIXTIME(unix_timestamp,format)
+@item FROM_UNIXTIME(@var{unix_timestamp})
+@itemx FROM_UNIXTIME(@var{unix_timestamp},@var{format})
@findex FROM_UNIXTIME()
-Returns a representation of the @code{unix_timestamp} argument as a value in
+Returns a representation of the @var{unix_timestamp} argument as a value in
@code{'YYYY-MM-DD HH:MM:SS'} or @code{YYYYMMDDHHMMSS} format, depending on
whether the function is used in a string or numeric context.
@@ -47051,8 +47052,8 @@
-> 19971004222300
@end example
-If @code{format} is given, the result is formatted according to the
-@code{format} string. @code{format} may contain the same specifiers as
+If @var{format} is given, the result is formatted according to the
+@var{format} string. @var{format} may contain the same specifiers as
those listed in the entry for the @code{DATE_FORMAT()} function.
@c end_description_for_help_topic
@@ -47116,9 +47117,9 @@
@c INSERT STOP
@c description_for_help_topic HOUR
-@item HOUR(time)
+@item HOUR(@var{time})
@findex HOUR()
-Returns the hour for @code{time}. The range of the return value will be
+Returns the hour for @var{time}. The range of the return value will be
@code{0} to @code{23} for time-of-day values.
@c end_description_for_help_topic
@@ -47137,7 +47138,7 @@
@end example
@c description_for_help_topic LAST_DAY
-@item LAST_DAY(date)
+@item LAST_DAY(@var{date})
@findex LAST_DAY()
Takes a date or datetime value and returns the corresponding value for the
@@ -47179,11 +47180,11 @@
They were added in MySQL 4.0.6.
@c description_for_help_topic MAKEDATE
-@item MAKEDATE(year,dayofyear)
+@item MAKEDATE(@var{year},@var{dayofyear})
@findex MAKEDATE()
Returns a date, given year and day-of-year values.
-@code{dayofyear} must be greater than 0 or the result will be @code{NULL}.
+@var{dayofyear} must be greater than 0 or the result will be @code{NULL}.
@c end_description_for_help_topic
@c example_for_help_topic MAKEDATE
@@ -47199,11 +47200,11 @@
@code{MAKEDATE()} is available as of MySQL 4.1.1.
@c description_for_help_topic MAKETIME
-@item MAKETIME(hour,minute,second)
+@item MAKETIME(@var{hour},@var{minute},@var{second})
@findex MAKETIME()
-Returns a time value calculated from the @code{hour}, @code{minute}, and
-@code{second} arguments.
+Returns a time value calculated from the @var{hour}, @var{minute}, and
+@var{second} arguments.
@c end_description_for_help_topic
@c example_for_help_topic MAKETIME
@@ -47233,9 +47234,9 @@
@code{MICROSECOND()} is available as of MySQL 4.1.1.
@c description_for_help_topic MINUTE
-@item MINUTE(time)
+@item MINUTE(@var{time})
@findex MINUTE()
-Returns the minute for @code{time}, in the range @code{0} to @code{59}.
+Returns the minute for @var{time}, in the range @code{0} to @code{59}.
@c end_description_for_help_topic
@c example_for_help_topic MINUTE
@@ -47245,9 +47246,9 @@
@end example
@c description_for_help_topic MONTH
-@item MONTH(date)
+@item MONTH(@var{date})
@findex MONTH()
-Returns the month for @code{date}, in the range @code{1} to @code{12}.
+Returns the month for @var{date}, in the range @code{1} to @code{12}.
@c end_description_for_help_topic
@c example_for_help_topic MONTH
@@ -47257,9 +47258,9 @@
@end example
@c description_for_help_topic MONTHNAME
-@item MONTHNAME(date)
+@item MONTHNAME(@var{date})
@findex MONTHNAME()
-Returns the full name of the month for @code{date}.
+Returns the full name of the month for @var{date}.
@c end_description_for_help_topic
@c example_for_help_topic MONTHNAME
@@ -47300,11 +47301,11 @@
@end example
@c description_for_help_topic PERIOD_DIFF
-@item PERIOD_DIFF(P1,P2)
+@item PERIOD_DIFF(@var{P1},@var{P2})
@findex PERIOD_DIFF()
-Returns the number of months between periods @code{P1} and @code{P2}.
-@code{P1} and @code{P2} should be in the format @code{YYMM} or @code{YYYYMM}.
-Note that the period arguments @code{P1} and @code{P2} are @emph{not}
+Returns the number of months between periods @var{P1} and @var{P2}.
+@var{P1} and @var{P2} should be in the format @code{YYMM} or @code{YYYYMM}.
+Note that the period arguments @var{P1} and @var{P2} are @emph{not}
date values.
@c end_description_for_help_topic
@@ -47315,9 +47316,9 @@
@end example
@c description_for_help_topic QUARTER
-@item QUARTER(date)
+@item QUARTER(@var{date})
@findex QUARTER()
-Returns the quarter of the year for @code{date}, in the range @code{1}
+Returns the quarter of the year for @var{date}, in the range @code{1}
to @code{4}.
@c end_description_for_help_topic
@@ -47328,9 +47329,9 @@
@end example
@c description_for_help_topic SECOND
-@item SECOND(time)
+@item SECOND(@var{time})
@findex SECOND()
-Returns the second for @code{time}, in the range @code{0} to @code{59}.
+Returns the second for @var{time}, in the range @code{0} to @code{59}.
@c end_description_for_help_topic
@c example_for_help_topic SECOND
@@ -47340,9 +47341,9 @@
@end example
@c description_for_help_topic SEC_TO_TIME
-@item SEC_TO_TIME(seconds)
+@item SEC_TO_TIME(@var{seconds})
@findex SEC_TO_TIME()
-Returns the @code{seconds} argument, converted to hours, minutes, and seconds,
+Returns the @var{seconds} argument, converted to hours, minutes, and seconds,
as a value in @code{'HH:MM:SS'} or @code{HHMMSS} format, depending on whether
the function is used in a string or numeric context.
@c end_description_for_help_topic
@@ -47571,15 +47572,15 @@
@code{TIMESTAMPDIFF()} is available as of MySQL 5.0.0.
@c description_for_help_topic TIME_FORMAT
-@item TIME_FORMAT(time,format)
+@item TIME_FORMAT(@var{time},@var{format})
@findex TIME_FORMAT()
This is used like the @code{DATE_FORMAT()} function, but the
-@code{format} string may contain only those format specifiers that handle
+@var{format} string may contain only those format specifiers that handle
hours, minutes, and seconds. Other specifiers produce a @code{NULL} value or
@code{0}.
@c end_description_for_help_topic
-If the @code{time} value contains an hour part that is greater than
+If the @var{time} value contains an hour part that is greater than
@code{23}, the @code{%H} and @code{%k} hour format specifiers produce a
value larger than the usual range of @code{0..23}. The other hour format
specifiers produce the hour value modulo 12.
@@ -47590,9 +47591,9 @@
@end example
@c description_for_help_topic TIME_TO_SEC
-@item TIME_TO_SEC(time)
+@item TIME_TO_SEC(@var{time})
@findex TIME_TO_SEC()
-Returns the @code{time} argument, converted to seconds.
+Returns the @var{time} argument, converted to seconds.
@c end_description_for_help_topic
@c example_for_help_topic TIME_TO_SEC
@@ -47604,9 +47605,9 @@
@end example
@c description_for_help_topic TO_DAYS
-@item TO_DAYS(date)
+@item TO_DAYS(@var{date})
@findex TO_DAYS()
-Given a date @code{date}, returns a daynumber (the number of days since year
+Given a date @var{date}, returns a daynumber (the number of days since year
0).
@c end_description_for_help_topic
@@ -47635,13 +47636,13 @@
@c description_for_help_topic UNIX_TIMESTAMP
@item UNIX_TIMESTAMP()
-@itemx UNIX_TIMESTAMP(date)
+@itemx UNIX_TIMESTAMP(@var{date})
@findex UNIX_TIMESTAMP()
If called with no argument, returns a Unix timestamp (seconds since
@code{'1970-01-01 00:00:00'} GMT) as an unsigned integer. If
-@code{UNIX_TIMESTAMP()} is called with a @code{date} argument, it
+@code{UNIX_TIMESTAMP()} is called with a @var{date} argument, it
returns the value of the argument as seconds since @code{'1970-01-01
-00:00:00'} GMT. @code{date} may be a @code{DATE} string, a
+00:00:00'} GMT. @var{date} may be a @code{DATE} string, a
@code{DATETIME} string, a @code{TIMESTAMP}, or a number in the format
@code{YYMMDD} or @code{YYYYMMDD} in local time.
@c end_description_for_help_topic
@@ -47717,17 +47718,17 @@
@code{UTC_TIMESTAMP()} is available as of MySQL 4.1.1.
@c description_for_help_topic WEEK
-@item WEEK(date[,mode])
+@item WEEK(@var{date}[,@var{mode}])
@findex WEEK()
-The function returns the week number for @code{date}. The two-argument form
+The function returns the week number for @var{date}. The two-argument form
of @code{WEEK()} allows you to specify whether the week starts on Sunday or
Monday and whether the return value should be in the range from @code{0} to
-@code{53} or from @code{1} to @code{52}. If the @code{mode} argument is
+@code{53} or from @code{1} to @code{52}. If the @var{mode} argument is
omitted, the value of the @code{default_week_format} system variable is
used (or @code{0} before MySQL 4.0.14).
@xref{Server system variables}.
-The following table describes how the @code{mode} argument works:
+The following table describes how the @var{mode} argument works:
@multitable @columnfractions .10 .80
@item @strong{Value} @tab @strong{Meaning}
@@ -47749,7 +47750,7 @@
@code{53}; week 1 is the first week that starts in this year
@end multitable
-The @code{mode} value of @code{3} can be used as of MySQL 4.0.5.
+The @var{mode} value of @code{3} can be used as of MySQL 4.0.5.
Values of @code{4} and above can be used as of MySQL 4.0.17.
@c end_description_for_help_topic
@@ -47765,9 +47766,9 @@
-> 53
@end example
-Note: In MySQL 4.0, @code{WEEK(date,0)} was changed to match the
+Note: In MySQL 4.0, @code{WEEK(@var{date},0)} was changed to match the
calendar in the USA. Before that, @code{WEEK()} was calculated incorrectly
-for dates in the USA. (In effect, @code{WEEK(date)} and @code{WEEK(date,0)} were
+for dates in the USA. (In effect, @code{WEEK(@var{date})} and @code{WEEK(@var{date},0)} were
incorrect for all cases.)
Note that if a date falls in the last week of the previous year, MySQL
@@ -47805,10 +47806,10 @@
@end example
@c description_for_help_topic WEEKDAY
-@item WEEKDAY(date)
+@item WEEKDAY(@var{date})
@findex WEEKDAY()
Returns the weekday index for
-@code{date} (@code{0} = Monday, @code{1} = Tuesday, ... @code{6} = Sunday).
+@var{date} (@code{0} = Monday, @code{1} = Tuesday, ... @code{6} = Sunday).
@c end_description_for_help_topic
@c example_for_help_topic WEEKDAY
@@ -47820,7 +47821,7 @@
@end example
@c description_for_help_topic WEEKOFYEAR
-@item WEEKOFYEAR(date)
+@item WEEKOFYEAR(@var{date})
@findex WEEKOFYEAR()
Returns the calendar week of the date as a number in the
@@ -47836,9 +47837,9 @@
@code{WEEKOFYEAR()} is available as of MySQL 4.1.1.
@c description_for_help_topic YEAR
-@item YEAR(date)
+@item YEAR(@var{date})
@findex YEAR()
-Returns the year for @code{date}, in the range @code{1000} to @code{9999}.
+Returns the year for @var{date}, in the range @code{1000} to @code{9999}.
@c end_description_for_help_topic
@c example_for_help_topic YEAR
@@ -47847,11 +47848,11 @@
-> 1998
@end example
-@item YEARWEEK(date)
-@itemx YEARWEEK(date,start)
+@item YEARWEEK(@var{date})
+@itemx YEARWEEK(@var{date},@var{start})
@c description_for_help_topic YEARWEEK
-Returns year and week for a date. The @code{start} argument works exactly
-like the @code{start} argument to @code{WEEK()}. The year in the
+Returns year and week for a date. The @var{start} argument works exactly
+like the @var{start} argument to @code{WEEK()}. The year in the
result may be
different from the year in the date argument for the first and the last
week of the year.
@@ -49408,11 +49409,11 @@
@table @code
@c description_for_help_topic FORMAT
-@item FORMAT(X,D)
+@item FORMAT(@var{X},@var{D})
@findex FORMAT()
-Formats the number @code{X} to a format like @code{'#,###,###.##'}, rounded
-to @code{D} decimals, and returns the result as a string.
-If @code{D} is @code{0}, the result will have no
+Formats the number @var{X} to a format like @code{'#,###,###.##'}, rounded
+to @var{D} decimals, and returns the result as a string.
+If @var{D} is @code{0}, the result will have no
decimal point or fractional part.
@c end_description_for_help_topic
@@ -68362,62 +68363,62 @@
@table @code
@c description_for_help_topic GeomCollFromText GEOMETRYCOLLECTIONFROMTEXT
-@item GeomCollFromText(wkt[,srid])
-@itemx GeometryCollectionFromText(wkt[,srid])
+@item GeomCollFromText(@var{wkt}[,@var{srid}])
+@itemx GeometryCollectionFromText(@var{wkt}[,@var{srid}])
@findex GeomCollFromText()
@findex GeometryCollectionFromText()
Constructs a @code{GEOMETRYCOLLECTION} value using its WKT representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic GeomFromText GeometryFromText
-@item GeomFromText(wkt[,srid])
-@itemx GeometryFromText(wkt[,srid])
+@item GeomFromText(@var{wkt}[,@var{srid}])
+@itemx GeometryFromText(@var{wkt}[,@var{srid}])
@findex GeomFromText()
@findex GeometryFromText()
Constructs a geometry value of any type using its WKT representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic LineFromText LineStringFromText.
-@item LineFromText(wkt[,srid])
-@itemx LineStringFromText(wkt[,srid])
+@item LineFromText(@var{wkt}[,@var{srid}])
+@itemx LineStringFromText(@var{wkt}[,@var{srid}])
@findex LineFromText()
@findex LineStringFromText()
Constructs a @code{LINESTRING} value using its WKT representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic MLineFromText MultiLineStringFromText
-@item MLineFromText(wkt[,srid])
-@itemx MultiLineStringFromText(wkt[,srid])
+@item MLineFromText(@var{wkt}[,@var{srid}])
+@itemx MultiLineStringFromText(@var{wkt}[,@var{srid}])
@findex MLineFromText()
@findex MultiLineStringFromText()
Constructs a @code{MULTILINESTRING} value using its WKT representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic MPointFromText MultiPointFromText
-@item MPointFromText(wkt[,srid])
-@itemx MultiPointFromText(wkt[,srid])
+@item MPointFromText(@var{wkt}[,@var{srid}])
+@itemx MultiPointFromText(@var{wkt}[,@var{srid}])
@findex MPointFromText()
@findex MultiPointFromText()
Constructs a @code{MULTIPOINT} value using its WKT representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic MPolyFromText MultiPolygonFromText
-@item MPolyFromText(wkt[,srid])
-@itemx MultiPolygonFromText(wkt[,srid])
+@item MPolyFromText(@var{wkt}[,@var{srid}])
+@itemx MultiPolygonFromText(@var{wkt}[,@var{srid}])
@findex MPolyFromText()
@findex MultiPolygonFromText()
Constructs a @code{MULTIPOLYGON} value using its WKT representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic PointFromText
-@item PointFromText(wkt[,srid])
+@item PointFromText(@var{wkt}[,@var{srid}])
@findex PointFromText()
Constructs a @code{POINT} value using its WKT representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic PolyFromText PolygonFromText
-@item PolyFromText(wkt[,srid])
-@itemx PolygonFromText(wkt[,srid])
+@item PolyFromText(@var{wkt}[,@var{srid}])
+@itemx PolygonFromText(@var{wkt}[,@var{srid}])
@findex PolyFromText()
@findex PolygonFromText()
Constructs a @code{POLYGON} value using its WKT representation and SRID.
@@ -68432,13 +68433,13 @@
@table @code
-@item BdMPolyFromText(wkt,srid)
+@item BdMPolyFromText(@var{wkt},@var{srid})
@findex BdMPolyFromText()
Constructs a @code{MultiPolygon} value from a
@code{MultiLineString} value in WKT format containing
an arbitrary collection of closed @code{LineString} values.
-@item BdPolyFromText(wkt,srid)
+@item BdPolyFromText(@var{wkt},@var{srid})
@findex BdPolyFromText()
Constructs a @code{Polygon} value from a
@code{MultiLineString} value in WKT format containing
@@ -68464,62 +68465,62 @@
@table @code
@c description_for_help_topic GeomCollFromWKB GeometryCollectionFromWKB
-@item GeomCollFromWKB(wkb[,srid])
-@itemx GeometryCollectionFromWKB(wkt[,srid])
+@item GeomCollFromWKB(@var{wkb}[,@var{srid}])
+@itemx GeometryCollectionFromWKB(@var{wkt}[,@var{srid}])
@findex GeomCollFromWKB()
@findex GeometryCollectionFromWKB()
Constructs a @code{GEOMETRYCOLLECTION} value using its WKB representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic GeomFromWKB GeometryFromWKB
-@item GeomFromWKB(wkb[,srid])
-@itemx GeometryFromWKB(wkt[,srid])
+@item GeomFromWKB(@var{wkb}[,@var{srid}])
+@itemx GeometryFromWKB(@var{wkt}[,@var{srid}])
@findex GeomFromWKB()
@findex GeometryFromWKB()
Constructs a geometry value of any type using its WKB representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic LineFromWKB LineStringFromWKB
-@item LineFromWKB(wkb[,srid])
-@itemx LineStringFromWKB(wkb[,srid])
+@item LineFromWKB(@var{wkb}[,@var{srid}])
+@itemx LineStringFromWKB(@var{wkb}[,@var{srid}])
@findex LineFromWKB()
@findex LineStringFromWKB()
Constructs a @code{LINESTRING} value using its WKB representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic MLineFromWKB MultiLineStringFromWKB
-@item MLineFromWKB(wkb[,srid])
-@itemx MultiLineStringFromWKB(wkb[,srid])
+@item MLineFromWKB(@var{wkb}[,@var{srid}])
+@itemx MultiLineStringFromWKB(@var{wkb}[,@var{srid}])
@findex MLineFromWKB()
@findex MultiLineStringFromWKB()
Constructs a @code{MULTILINESTRING} value using its WKB representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic MPointFromWKB MultiPointFromWKB
-@item MPointFromWKB(wkb[,srid])
-@itemx MultiPointFromWKB(wkb[,srid])
+@item MPointFromWKB(@var{wkb}[,@var{srid}])
+@itemx MultiPointFromWKB(@var{wkb}[,@var{srid}])
@findex MPointFromWKB()
@findex MultiPointFromWKB()
Constructs a @code{MULTIPOINT} value using its WKB representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic MPolyFromWKB MultiPolygonFromWKB
-@item MPolyFromWKB(wkb[,srid])
-@itemx MultiPolygonFromWKB(wkb[,srid])
+@item MPolyFromWKB(@var{wkb}[,@var{srid}])
+@itemx MultiPolygonFromWKB(@var{wkb}[,@var{srid}])
@findex MPolyFromWKB()
@findex MultiPolygonFromWKB()
Constructs a @code{MULTIPOLYGON} value using its WKB representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic PointFromWKB
-@item PointFromWKB(wkb[,srid])
+@item PointFromWKB(@var{wkb}[,@var{srid}])
@findex PointFromWKB()
Constructs a @code{POINT} value using its WKB representation and SRID.
@c end_description_for_help_topic
@c description_for_help_topic PolyFromWKB PolygonFromWKB
-@item PolyFromWKB(wkb[,srid])
-@itemx PolygonFromWKB(wkb[,srid])
+@item PolyFromWKB(@var{wkb}[,@var{srid}])
+@itemx PolygonFromWKB(@var{wkb}[,@var{srid}])
@findex PolyFromWKB()
@findex PolygonFromWKB()
Constructs a @code{POLYGON} value using its WKB representation and SRID.
@@ -68534,13 +68535,13 @@
@table @code
-@item BdMPolyFromWKB(wkb,srid)
+@item BdMPolyFromWKB(@var{wkb},@var{srid})
@findex BdMPolyFromWKB()
Constructs a @code{MultiPolygon} value from a
@code{MultiLineString} value in WKB format containing
an arbitrary collection of closed @code{LineString} values.
-@item BdPolyFromWKB(wkb,srid)
+@item BdPolyFromWKB(@var{wkb},@var{srid})
@findex BdPolyFromWKB()
Constructs a @code{Polygon} value from a
@code{MultiLineString} value in WKB format containing
@@ -68568,7 +68569,7 @@
@c help_category Geometry constructors@Geographic features
@c description_for_help_topic GEOMETRYCOLLECTION
-@item GeometryCollection(g1,g2,...)
+@item GeometryCollection(@var{g1},@var{g2},...)
@findex GeometryCollection()
Constructs a WKB @code{GeometryCollection}. If any argument is not a
well-formed WKB representation of a geometry, the return value is
@@ -68576,7 +68577,7 @@
@c end_description_for_help_topic
@c description_for_help_topic LINESTRING
-@item LineString(pt1,pt2,...)
+@item LineString(@var{pt1},@var{pt2},...)
@findex LineString()
Constructs a WKB @code{LineString} value from a number of WKB @code{Point}
arguments. If any argument is not a WKB @code{Point}, the return value
@@ -68585,7 +68586,7 @@
@c end_description_for_help_topic
@c description_for_help_topic MULTILINESTRING
-@item MultiLineString(ls1,ls2,...)
+@item MultiLineString(@var{ls1},@var{ls2},...)
@findex MultiLineString()
Constructs a WKB @code{MultiLineString} value using using WKB @code{LineString}
arguments. If any argument is not a WKB @code{LineString}, the return
@@ -68593,14 +68594,14 @@
@c end_description_for_help_topic
@c description_for_help_topic MULTIPOINT
-@item MultiPoint(pt1,pt2,...)
+@item MultiPoint(@var{pt1},@var{pt2},...)
@findex MultiPoint()
Constructs a WKB @code{MultiPoint} value using WKB @code{Point} arguments.
If any argument is not a WKB @code{Point}, the return value is @code{NULL}.
@c end_description_for_help_topic
@c description_for_help_topic MULTIPOLYGON
-@item MultiPolygon(poly1,poly2,...)
+@item MultiPolygon(@var{poly1},@var{poly2},...)
@findex MultiPolygon()
Constructs a WKB @code{MultiPolygon} value from a set of WKB @code{Polygon}
arguments.
@@ -68608,13 +68609,13 @@
@c end_description_for_help_topic
@c description_for_help_topic POINT
-@item Point(x,y)
+@item Point(@var{x},@var{y})
@findex Point()
Constructs a WKB @code{Point} using its coordinates.
@c end_description_for_help_topic
@c description_for_help_topic POLYGON
-@item Polygon(ls1,ls2,...)
+@item Polygon(@var{ls1},@var{ls2},...)
@findex Polygon()
Constructs a WKB @code{Polygon} value from a number of WKB @code{LineString}
arguments. If any argument does not represent the WKB of a @code{LinearRing}
@@ -68867,7 +68868,7 @@
@c help_category WKB@Geographic features
@c description_for_help_topic AsBinary
-@item AsBinary(g)
+@item AsBinary(@var{g})
@findex AsBinary()
Converts a value in internal geometry format to its WKB representation
and returns the binary result.
@@ -68876,7 +68877,7 @@
@c help_category WKT@Geographic features
@c description_for_help_topic AsText
-@item AsText(g)
+@item AsText(@var{g})
@findex AsText()
Converts a value in internal geometry format to its WKT representation
and returns the string result.
@@ -68892,7 +68893,7 @@
+--------------------------+
@end example
-@item GeomFromText(wkt[,srid])
+@item GeomFromText(@var{wkt}[,@var{srid}])
@findex GeomFromText()
Converts a string value from its WKT representation into internal geometry
format and returns the result.
@@ -68900,7 +68901,7 @@
@code{PointFromText()} and @code{LineFromText()}; see
@ref{GIS WKT Functions}.
-@item GeomFromWKB(wkb[,srid])
+@item GeomFromWKB(@var{wkb}[,@var{srid}])
@findex GeomFromWKB()
Converts a binary value from its WKB representation into internal geometry
format and returns the result.
@@ -68944,9 +68945,9 @@
@c help_category Geometry properties@Geographic features
@c description_for_help_topic Dimension
-@item Dimension(g)
+@item Dimension(@var{g})
@findex Dimension()
-Returns the inherent dimension of the geometry value @code{g}. The result
+Returns the inherent dimension of the geometry value @var{g}. The result
can be @minus{}1, 0, 1, or 2. (The meaning of these values is given in
@ref{GIS class geometry}.)
@c end_description_for_help_topic
@@ -68962,9 +68963,9 @@
@end example
@c description_for_help_topic Envelope
-@item Envelope(g)
+@item Envelope(@var{g})
@findex Envelope()
-Returns the Minimum Bounding Rectangle (MBR) for the geometry value @code{g}.
+Returns the Minimum Bounding Rectangle (MBR) for the geometry value @var{g}.
The result is returned as a @code{Polygon} value.
@c example_for_help_topic Envelope
@@ -68985,10 +68986,10 @@
@c end_description_for_help_topic
@c description_for_help_topic GeometryType
-@item GeometryType(g)
+@item GeometryType(@var{g})
@findex GeometryType()
Returns as a string the name of the geometry type of which
-the geometry instance @code{g} is a member.
+the geometry instance @var{g} is a member.
The name will correspond to one of the instantiable @code{Geometry} subclasses.
@c end_description_for_help_topic
@@ -69003,10 +69004,10 @@
@end example
@c description_for_help_topic SRID
-@item SRID(g)
+@item SRID(@var{g})
@findex SRID()
Returns an integer indicating the Spatial Reference System ID for the geometry
-value @code{g}.
+value @var{g}.
@c end_description_for_help_topic
@c example_for_help_topic SRID
@@ -69028,28 +69029,28 @@
@table @code
@c description_for_help_topic Boundary
-@item Boundary(g)
+@item Boundary(@var{g})
@findex Boundary()
Returns a geometry that is the closure of the combinatorial boundary of the
-geometry value @code{g}.
+geometry value @var{g}.
@c end_description_for_help_topic
@c description_for_help_topic IsEmpty
-@item IsEmpty(g)
+@item IsEmpty(@var{g})
@findex IsEmpty()
-Returns 1 if the geometry value @code{g} is the empty geometry, 0 if it is not
+Returns 1 if the geometry value @var{g} is the empty geometry, 0 if it is not
empty, and @minus{}1 if the argument is @code{NULL}.
If the geometry is empty, it represents the empty point set.
@c end_description_for_help_topic
@c description_for_help_topic IsSimple
-@item IsSimple(g)
+@item IsSimple(@var{g})
@findex IsSimple()
Currently, this function is a placeholder and should not be used.
If implemented, its behavior will be as described in the next paragraph.
-Returns 1 if the geometry value @code{g} has no anomalous geometric points,
+Returns 1 if the geometry value @var{g} has no anomalous geometric points,
such as self-intersection or self-tangency. @code{IsSimple()} returns 0 if the
argument is not simple, and @minus{}1 if it is @code{NULL}.
@@ -69071,9 +69072,9 @@
@table @code
@c description_for_help_topic X
-@item X(p)
+@item X(@var{p})
@findex X()
-Returns the X-coordinate value for the point @code{p} as a double-precision
+Returns the X-coordinate value for the point @var{p} as a double-precision
number.
@c end_description_for_help_topic
@c example_for_help_topic X
@@ -69087,9 +69088,9 @@
@end example
@c description_for_help_topic Y
-@item Y(p)
+@item Y(@var{p})
@findex Y()
-Returns the Y-coordinate value for the point @code{p} as a double-precision
+Returns the Y-coordinate value for the point @var{p} as a double-precision
number.
@c end_description_for_help_topic
@c example_for_help_topic Y
@@ -69117,10 +69118,10 @@
@table @code
@c description_for_help_topic EndPoint
-@item EndPoint(ls)
+@item EndPoint(@var{ls})
@findex EndPoint()
Returns the @code{Point} that is the end point of the @code{LineString} value
-@code{ls}.
+@var{ls}.
@c end_description_for_help_topic
@c example_for_help_topic EndPoint
@@ -69135,10 +69136,10 @@
@end example
@c description_for_help_topic GLength
-@item GLength(ls)
+@item GLength(@var{ls})
@findex GLength()
Returns as a double-precision number the length of the @code{LineString}
-value @code{ls} in its associated spatial reference.
+value @var{ls} in its associated spatial reference.
@c end_description_for_help_topic
@c example_for_help_topic GLength
@@ -69153,11 +69154,11 @@
@end example
@c description_for_help_topic IsClosed
-@item IsClosed(ls)
+@item IsClosed(@var{ls})
@findex IsClosed()
-Returns 1 if the @code{LineString} value @code{ls} is closed
+Returns 1 if the @code{LineString} value @var{ls} is closed
(that is, its @code{StartPoint()} and @code{EndPoint()} values are the same).
-Returns 0 if @code{ls} is not closed, and @minus{}1 if it is @code{NULL}.
+Returns 0 if @var{ls} is not closed, and @minus{}1 if it is @code{NULL}.
@c end_description_for_help_topic
@c example_for_help_topic IsClosed
@@ -69172,9 +69173,9 @@
@end example
@c description_for_help_topic NumPoints
-@item NumPoints(ls)
+@item NumPoints(@var{ls})
@findex NumPoints()
-Returns the number of points in the @code{LineString} value @code{ls}.
+Returns the number of points in the @code{LineString} value @var{ls}.
@c end_description_for_help_topic
@c example_for_help_topic NumPoints
@@ -69189,9 +69190,9 @@
@end example
@c description_for_help_topic PointN
-@item PointN(ls,n)
+@item PointN(@var{ls},@var{n})
@findex PointN()
-Returns the @code{n}-th point in the @code{Linestring} value @code{ls}.
+Returns the @var{n}-th point in the @code{Linestring} value @var{ls}.
Point numbers begin at 1.
@c end_description_for_help_topic
@@ -69207,10 +69208,10 @@
@end example
@c description_for_help_topic StartPoint
-@item StartPoint(ls)
+@item StartPoint(@var{ls})
@findex StartPoint()
Returns the @code{Point} that is the start point of the @code{LineString} value
-@code{ls}.
+@var{ls}.
@c end_description_for_help_topic
@c example_for_help_topic StartPoint
@@ -69231,12 +69232,12 @@
@table @code
-@item IsRing(ls)
+@item IsRing(@var{ls})
@findex IsRing()
-Returns 1 if the @code{LineString} value @code{ls} is closed
+Returns 1 if the @code{LineString} value @var{ls} is closed
(that is, its @code{StartPoint()} and @code{EndPoint()} values are the same)
and is simple (does not pass through the same point more than once).
-Returns 0 if @code{ls} is not a ring, and @minus{}1 if it is @code{NULL}.
+Returns 0 if @var{ls} is not a ring, and @minus{}1 if it is @code{NULL}.
@end table
@@ -69248,11 +69249,11 @@
@table @code
-@item GLength(mls)
+@item GLength(@var{mls})
@findex GLength()
Returns as a double-precision number
-the length of the @code{MultiLineString} value @code{mls}. The length of
-@code{mls} is equal to the sum of the lengths of its elements.
+the length of the @code{MultiLineString} value @var{mls}. The length of
+@var{mls} is equal to the sum of the lengths of its elements.
@example
mysql> SET @@mls = 'MultiLineString((1 1,2 2,3 3),(4 4,5 5))';
@@ -69264,12 +69265,12 @@
+-----------------------------+
@end example
-@item IsClosed(mls)
+@item IsClosed(@var{mls})
@findex IsClosed()
-Returns 1 if the @code{MultiLineString} value @code{mls} is closed
+Returns 1 if the @code{MultiLineString} value @var{mls} is closed
(that is, the @code{StartPoint()} and @code{EndPoint()} values are the same
-for each @code{LineString} in @code{mls}).
-Returns 0 if @code{mls} is not closed, and @minus{}1 if it is @code{NULL}.
+for each @code{LineString} in @var{mls}).
+Returns 0 if @var{mls} is not closed, and @minus{}1 if it is @code{NULL}.
@example
mysql> SET @@mls = 'MultiLineString((1 1,2 2,3 3),(4 4,5 5))';
@@ -69294,10 +69295,10 @@
@table @code
@c description_for_help_topic Area
-@item Area(poly)
+@item Area(@var{poly})
@findex Area()
Returns as a double-precision number the area of the @code{Polygon} value
-@code{poly}, as measured in its spatial reference system.
+@var{poly}, as measured in its spatial reference system.
@c end_description_for_help_topic
@c example_for_help_topic Area
@@ -69312,9 +69313,9 @@
@end example
@c description_for_help_topic ExteriorRing
-@item ExteriorRing(poly)
+@item ExteriorRing(@var{poly})
@findex ExteriorRing()
-Returns the exterior ring of the @code{Polygon} value @code{poly}
+Returns the exterior ring of the @code{Polygon} value @var{poly}
as a @code{LineString}.
@c end_description_for_help_topic
@c example_for_help_topic ExteriorRing
@@ -69330,10 +69331,10 @@
@end example
@c description_for_help_topic InteriorRingN
-@item InteriorRingN(poly,n)
+@item InteriorRingN(@var{poly},@var{n})
@findex InteriorRingN()
-Returns the @code{n}-th interior ring for the @code{Polygon} value
-@code{poly} as a @code{LineString}.
+Returns the @var{n}-th interior ring for the @code{Polygon} value
+@var{poly} as a @code{LineString}.
Ring numbers begin at 1.
@c end_description_for_help_topic
@c example_for_help_topic InteriorRingN
@@ -69349,9 +69350,9 @@
@end example
@c description_for_help_topic NumInteriorRings
-@item NumInteriorRings(poly)
+@item NumInteriorRings(@var{poly})
@findex NumInteriorRings()
-Returns the number of interior rings in the @code{Polygon} value @code{poly}.
+Returns the number of interior rings in the @code{Polygon} value @var{poly}.
@c end_description_for_help_topic
@c example_for_help_topic NumInteriorRings
@example
@@ -69374,11 +69375,11 @@
@table @code
-@item Area(mpoly)
+@item Area(@var{mpoly})
@findex Area()
Returns as a double-precision number the area of the @code{MultiPolygon}
-value @code{mpoly}, as measured in its spatial reference system.
+value @var{mpoly}, as measured in its spatial reference system.
@example
mysql> SET @@mpoly =
@@ -69399,16 +69400,16 @@
@table @code
-@item Centroid(mpoly)
+@item Centroid(@var{mpoly})
@findex Centroid()
Returns the mathematical centroid for the @code{MultiPolygon} value
-@code{mpoly} as a @code{Point}. The result is not guaranteed to be on
+@var{mpoly} as a @code{Point}. The result is not guaranteed to be on
the @code{MultiPolygon}.
-@item PointOnSurface(mpoly)
+@item PointOnSurface(@var{mpoly})
@findex PointOnSurface()
Returns a @code{Point} value that is guaranteed to be on the
-@code{MultiPolygon} value @code{mpoly}.
+@code{MultiPolygon} value @var{mpoly}.
@end table
@@ -69422,10 +69423,10 @@
@table @code
@c description_for_help_topic GeometryN
-@item GeometryN(gc,n)
+@item GeometryN(@var{gc},@var{n})
@findex GeometryN()
-Returns the @code{n}-th geometry in the @code{GeometryCollection} value
-@code{gc}. Geometry numbers begin at 1.
+Returns the @var{n}-th geometry in the @code{GeometryCollection} value
+@var{gc}. Geometry numbers begin at 1.
@c end_description_for_help_topic
@c example_for_help_topic GeometryN
@@ -69440,10 +69441,10 @@
@end example
@c description_for_help_topic NumGeometries
-@item NumGeometries(gc)
+@item NumGeometries(@var{gc})
@findex NumGeometries()
Returns the number of geometries in the @code{GeometryCollection} value
-@code{gc}.
+@var{gc}.
@c end_description_for_help_topic
@c example_for_help_topic NumGeometries
@@ -69479,13 +69480,13 @@
from the existing ones:
@itemize @bullet
-@item @code{Envelope(g)}
-@item @code{StartPoint(ls)}
-@item @code{EndPoint(ls)}
-@item @code{PointN(ls,n)}
-@item @code{ExteriorRing(poly)}
-@item @code{InteriorRingN(poly,n)}
-@item @code{GeometryN(gc,n)}
+@item @code{Envelope(@var{g})}
+@item @code{StartPoint(@var{ls})}
+@item @code{EndPoint(@var{ls})}
+@item @code{PointN(@var{ls},@var{n})}
+@item @code{ExteriorRing(@var{poly})}
+@item @code{InteriorRingN(@var{poly},@var{n})}
+@item @code{GeometryN(@var{gc},@var{n})}
@end itemize
@@ -69500,35 +69501,35 @@
@table @code
-@item Buffer(g,d)
+@item Buffer(@var{g},@var{d})
@findex Buffer()
Returns a geometry that represents all points whose distance from the geometry
-value @code{g} is less than or equal to a distance of @code{d}.
+value @var{g} is less than or equal to a distance of @var{d}.
-@item ConvexHull(g)
+@item ConvexHull(@var{g})
@findex ConvexHull()
Returns a geometry that represents the convex hull of the geometry value
-@code{g}.
+@var{g}.
-@item Difference(g1,g2)
+@item Difference(@var{g1},@var{g2})
@findex Difference()
Returns a geometry that represents the point set difference of the geometry
-value @code{g1} with @code{g2}.
+value @var{g1} with @var{g2}.
-@item Intersection(g1,g2)
+@item Intersection(@var{g1},@var{g2})
@findex Intersection()
Returns a geometry that represents the point set intersection of the geometry
-values @code{g1} with @code{g2}.
+values @var{g1} with @var{g2}.
-@item SymDifference(g1,g2)
+@item SymDifference(@var{g1},@var{g2})
@findex SymDifference()
Returns a geometry that represents the point set symmetric difference of the
-geometry value @code{g1} with @code{g2}.
+geometry value @var{g1} with @var{g2}.
-@item Union(g1,g2)
+@item Union(@var{g1},@var{g2})
@findex Union()
Returns a geometry that represents the point set union of the geometry values
-@code{g1} and @code{g2}.
+@var{g1} and @var{g2}.
@end table
@@ -69554,10 +69555,10 @@
@table @code
@c description_for_help_topic MBRContains
-@item MBRContains(g1,g2)
+@item MBRContains(@var{g1},@var{g2})
@findex MBRContains()
Returns 1 or 0 to indicate whether or not the Minimum Bounding Rectangle of
-@code{g1} contains the Minimum Bounding Rectangle of @code{g2}.
+@var{g1} contains the Minimum Bounding Rectangle of @var{g2}.
@c end_description_for_help_topic
@c example_for_help_topic MBRContains
@@ -69573,45 +69574,45 @@
@end example
@c description_for_help_topic MBRDisjoint
-@item MBRDisjoint(g1,g2)
+@item MBRDisjoint(@var{g1},@var{g2})
@findex MBRDisjoint()
Returns 1 or 0 to indicate whether or not the Minimum Bounding Rectangles of
-the two geometries @code{g1} and @code{g2} are disjoint (do not intersect).
+the two geometries @var{g1} and @var{g2} are disjoint (do not intersect).
@c end_description_for_help_topic
@c description_for_help_topic MBREqual
-@item MBREqual(g1,g2)
+@item MBREqual(@var{g1},@var{g2})
@findex MBREqual()
Returns 1 or 0 to indicate whether or not the Minimum Bounding Rectangles of
-the two geometries @code{g1} and @code{g2} are the same.
+the two geometries @var{g1} and @var{g2} are the same.
@c end_description_for_help_topic
@c description_for_help_topic MBRIntersects
-@item MBRIntersects(g1,g2)
+@item MBRIntersects(@var{g1},@var{g2})
@findex MBRIntersects()
Returns 1 or 0 to indicate whether or not the Minimum Bounding Rectangles of
-the two geometries @code{g1} and @code{g2} intersect.
+the two geometries @var{g1} and @var{g2} intersect.
@c end_description_for_help_topic
@c description_for_help_topic MBROverlaps
-@item MBROverlaps(g1,g2)
+@item MBROverlaps(@var{g1},@var{g2})
@findex MBROverlaps()
Returns 1 or 0 to indicate whether or not the Minimum Bounding Rectangles of
-the two geometries @code{g1} and @code{g2} overlap.
+the two geometries @var{g1} and @var{g2} overlap.
@c end_description_for_help_topic
@c description_for_help_topic MBRTouches
-@item MBRTouches(g1,g2)
+@item MBRTouches(@var{g1},@var{g2})
@findex MBRTouches()
Returns 1 or 0 to indicate whether or not the Minimum Bounding Rectangles of
-the two geometries @code{g1} and @code{g2} touch.
+the two geometries @var{g1} and @var{g2} touch.
@c end_description_for_help_topic
@c description_for_help_topic MBRWithin
-@item MBRWithin(g1,g2)
+@item MBRWithin(@var{g1},@var{g2})
@findex MBRWithin()
Returns 1 or 0 to indicate whether or not the Minimum Bounding Rectangle
-of @code{g1} is within the Minimum Bounding Rectangle of @code{g2}.
+of @var{g1} is within the Minimum Bounding Rectangle of @var{g2}.
@c end_description_for_help_topic
@c example_for_help_topic MBRWithin
@@ -69650,18 +69651,18 @@
@c help_category Geometry relations@Geographic features
@c description_for_help_topic Contains
-@item Contains(g1,g2)
+@item Contains(@var{g1},@var{g2})
@findex Contains()
-Returns 1 or 0 to indicate whether or not @code{g1} completely contains
-@code{g2}.
+Returns 1 or 0 to indicate whether or not @var{g1} completely contains
+@var{g2}.
@c end_description_for_help_topic
@c description_for_help_topic Crosses
-@item Crosses(g1,g2)
+@item Crosses(@var{g1},@var{g2})
@findex Crosses()
-Returns 1 if @code{g1} spatially crosses @code{g2}.
+Returns 1 if @var{g1} spatially crosses @var{g2}.
Returns @code{NULL} if @code{g1} is a @code{Polygon} or a @code{MultiPolygon},
-or if @code{g2} is a @code{Point} or a @code{MultiPoint}.
+or if @var{g2} is a @code{Point} or a @code{MultiPoint}.
Otherwise, returns 0.
The term @emph{spatially crosses} denotes a spatial relation between two given
@@ -69684,67 +69685,67 @@
@c end_description_for_help_topic
@c description_for_help_topic Disjoint
-@item Disjoint(g1,g2)
+@item Disjoint(@var{g1},@var{g2})
@findex Disjoint()
-Returns 1 or 0 to indicate whether or not @code{g1} is spatially disjoint
-from (does not intersect) @code{g2}.
+Returns 1 or 0 to indicate whether or not @var{g1} is spatially disjoint
+from (does not intersect) @var{g2}.
@c end_description_for_help_topic
@c description_for_help_topic Distance
-@item Distance(g1,g2)
+@item Distance(@var{g1},@var{g2})
@findex Distance()
Returns as a double-precision number
the shortest distance between any two points in the two geometries.
@c end_description_for_help_topic
@c description_for_help_topic Equals
-@item Equals(g1,g2)
+@item Equals(@var{g1},@var{g2})
@findex Equals()
-Returns 1 or 0 to indicate whether or not @code{g1} is spatially equal to
-@code{g2}.
+Returns 1 or 0 to indicate whether or not @var{g1} is spatially equal to
+@var{g2}.
@c end_description_for_help_topic
@c description_for_help_topic Intersects
-@item Intersects(g1,g2)
+@item Intersects(@var{g1},@var{g2})
@findex Intersects()
-Returns 1 or 0 to indicate whether or not @code{g1} spatially intersects
-@code{g2}.
+Returns 1 or 0 to indicate whether or not @var{g1} spatially intersects
+@var{g2}.
@c end_description_for_help_topic
@c description_for_help_topic Overlaps
-@item Overlaps(g1,g2)
+@item Overlaps(@var{g1},@var{g2})
@findex Overlaps()
-Returns 1 or 0 to indicate whether or not @code{g1} spatially overlaps
-@code{g2}.
+Returns 1 or 0 to indicate whether or not @var{g1} spatially overlaps
+@var{g2}.
The term @emph{spatially overlaps} is used if two
geometries intersect and their intersection results in a geometry of the
same dimension but not equal to either of the given geometries.
@c end_description_for_help_topic
@c description_for_help_topic Related
-@item Related(g1,g2,pattern_matrix)
+@item Related(@var{g1},@var{g2},@var{pattern_matrix})
@findex Related()
Returns 1 or 0 to indicate whether or not the spatial relationship specified
-by @code{pattern_matrix} exists between @code{g1} and @code{g2}.
+by @var{pattern_matrix} exists between @var{g1} and @var{g2}.
Returns @minus{}1 if the arguments are @code{NULL}.
The pattern matrix is a string. Its specification will be noted here if this
function is implemented.
@c end_description_for_help_topic
@c description_for_help_topic Touches
-@item Touches(g1,g2)
+@item Touches(@var{g1},@var{g2})
@findex Touches()
-Returns 1 or 0 to indicate whether or not @code{g1} spatially touches
-@code{g2}. Two geometries @emph{spatially touch} if the interiors of
+Returns 1 or 0 to indicate whether or not @var{g1} spatially touches
+@var{g2}. Two geometries @emph{spatially touch} if the interiors of
the geometries do not intersect, but the boundary of one of the geometries
intersects either the boundary or the interior of the other.
@c end_description_for_help_topic
@c description_for_help_topic Within
-@item Within(g1,g2)
+@item Within(@var{g1},@var{g2})
@findex Within()
-Returns 1 or 0 to indicate whether or not @code{g1} is spatially within
-@code{g2}.
+Returns 1 or 0 to indicate whether or not @var{g1} is spatially within
+@var{g2}.
@c end_description_for_help_topic
@end table
@@ -73243,7 +73244,7 @@
@item @code{protocol=@{TCP | SOCKET | PIPE | MEMORY@}} @tab The protocol to use when connecting to server (New in 4.1)
@item @code{port} @tab Default port number.
@item @code{return-found-rows} @tab Tell @code{mysql_info()} to return found rows instead of updated rows when using @code{UPDATE}.
-@item @code{shared-memory-base-name=name} @tab Shared memory name to use to connect to server (default is "MySQL"). New in MySQL 4.1.
+@item @code{shared-memory-base-name=@var{name}} @tab Shared memory name to use to connect to server (default is "MySQL"). New in MySQL 4.1.
@item @code{socket} @tab Default socket file.
@item @code{user} @tab Default user.
@end multitable
@@ -77452,7 +77453,7 @@
@item
You should have a timestamp in all tables you want to be able to update.
For maximum portability @code{TIMESTAMP(14)} or simple @code{TIMESTAMP}
-is recommended instead of other @code{TIMESTAMP(X)} variations.
+is recommended instead of other @code{TIMESTAMP(@var{X})} variations.
@item
You should have a primary key in the table. If not, new or updated rows
may show up as @code{#DELETED#}.
@@ -85316,7 +85317,7 @@
@code{CHAR}, @code{VARCHAR}, and @code{TEXT} columns now have lengths measured
in characters rather than in bytes.
The character size depends on the column's character set.
-This means, for example, that a @code{CHAR(n)} column
+This means, for example, that a @code{CHAR(@var{n})} column
for a multi-byte character set will take more storage than before.
Similarly, index values on such columns are measured in characters, not bytes.
@item
@@ -88475,7 +88476,7 @@
a number would require for storage).
@item
Added @code{LN()} natural logarithm function for compatibility with
-other databases. It is synonymous with @code{LOG(X)}.
+other databases. It is synonymous with @code{LOG(@var{X})}.
@end itemize
@@ -91140,7 +91141,7 @@
Added @code{Created_tmp_disk_tables} variable to @code{mysqld}.
@item
To make it possible to reliably dump and restore tables with
-@code{TIMESTAMP(X)} columns, MySQL now reports columns with @code{X}
+@code{TIMESTAMP(@var{X})} columns, MySQL now reports columns with @var{X}
other than 14 or 8 to be strings.
@item
Changed sort order for @code{latin1} as it was before MySQL 3.23.23.
@@ -91996,10 +91997,10 @@
Changed that @code{FLOAT} and @code{DOUBLE} (without any length modifiers)
no longer are fixed decimal point numbers.
@item
-Changed the meaning of @code{FLOAT(X)}: Now this is the same as @code{FLOAT} if
-@code{X} <= 24 and a @code{DOUBLE} if 24 < @code{X} <= 53.
+Changed the meaning of @code{FLOAT(@var{X})}: Now this is the same as @code{FLOAT} if
+@var{X} <= 24 and a @code{DOUBLE} if 24 < @var{X} <= 53.
@item
-@code{DECIMAL(X)} is now an alias for @code{DECIMAL(X,0)} and @code{DECIMAL}
+@code{DECIMAL(@var{X})} is now an alias for @code{DECIMAL(@var{X},0)} and @code{DECIMAL}
is now an alias for @code{DECIMAL(10,0)}. The same goes for @code{NUMERIC}.
@item
Added option @code{ROW_FORMAT=@{DEFAULT | DYNAMIC | FIXED | COMPRESSED@}} to
@@ -92252,7 +92253,7 @@
@item
Added the ODBC 3.0 @code{EXTRACT(interval FROM datetime)} function.
@item
-Columns defined as @code{FLOAT(X)} are not rounded on storage and may be
+Columns defined as @code{FLOAT(@var{X})} are not rounded on storage and may be
in scientific notation (1.0 E+10) when retrieved.
@item
@code{REPLACE} is now faster than before.
| Thread |
|---|
| • bk commit - mysqldoc tree (paul:1.1849) | paul | 14 Jul |
