Skip to content

Commit 3482ae0

Browse files
myrrhlindveeden
authored andcommitted
doc: reorder mentioned sth attributes
ALL_CAP attributes before WordCase, and mysql_* private attributes last. alphabetic order within each group.
1 parent a2143fa commit 3482ae0

File tree

1 file changed

+41
-40
lines changed

1 file changed

+41
-40
lines changed

lib/DBD/mysql.pm

+41-40
Original file line numberDiff line numberDiff line change
@@ -1670,35 +1670,61 @@ header of table names together with all rows:
16701670
}
16711671
16721672
For portable applications you should restrict yourself to attributes with
1673-
capitalized or mixed case names. Lower case attribute names are private
1674-
to DBD::mysql. The attribute list includes:
1673+
capitalized or mixed case names. Uppercase attribute names are in the
1674+
statement handle interface described by L<DBI>, while lower case attribute
1675+
names are private to DBD::mysql. The attribute list includes:
16751676
16761677
=over
16771678
1678-
=item ParamValues
1679+
=item NAME
16791680
1680-
This attribute is supported as described in the DBI documentation.
1681+
A reference to an array of column names, as per DBI docs.
16811682
1682-
It returns a hashref, the keys of which are the 'names' of the
1683-
placeholders: integers starting at 1. It returns an empty hashref if
1684-
the statement has no placeholders.
1683+
=item NULLABLE
16851684
1686-
The values for these keys are initially undef; they are populated when
1687-
the C<bind_param> or C<execute> method is called. Supplying the
1688-
parameter values in the arguments to C<execute> will override any
1689-
previously bound values.
1685+
A reference to an array of boolean values; TRUE indicates that this column
1686+
may contain NULL's.
16901687
1691-
After execution, it is possible to use C<bind_param> to change a single
1692-
value in the statement and C<execute> again, with other values
1693-
unchanged. The attribute remains properly populated after the C<finish>
1694-
method is called, with the values from the last execution.
1688+
=item NUM_OF_FIELDS
1689+
1690+
Number of fields returned by a I<SELECT> or I<LISTFIELDS> statement.
1691+
You may use this for checking whether a statement returned a result:
1692+
A zero value indicates a non-SELECT statement like I<INSERT>,
1693+
I<DELETE> or I<UPDATE>.
1694+
1695+
=item TYPE
1696+
1697+
A reference to an array of column types. The engine's native column
1698+
types are mapped to portable types like DBI::SQL_INTEGER() or
1699+
DBI::SQL_VARCHAR(), as good as possible. Not all native types have
1700+
a meaningful equivalent, for example DBD::mysql::FIELD_TYPE_INTERVAL
1701+
is mapped to DBI::SQL_VARCHAR().
1702+
If you need the native column types, use I<mysql_type>. See below.
16951703
16961704
=item ChopBlanks
16971705
16981706
this attribute determines whether a I<fetchrow> will chop preceding
16991707
and trailing blanks off the column values. Chopping blanks does not
17001708
have impact on the I<max_length> attribute.
17011709
1710+
=item ParamValues
1711+
1712+
This attribute is supported as described in the DBI documentation.
1713+
1714+
It returns a hashref, the keys of which are the 'names' of the
1715+
placeholders: integers starting at 1. It returns an empty hashref if
1716+
the statement has no placeholders.
1717+
1718+
The values for these keys are initially undef; they are populated with
1719+
C<bind_param>, or when C<execute> method is called with parameters.
1720+
(Supplying the parameter values in the arguments to C<execute> will
1721+
override any previously bound values.)
1722+
1723+
After execution, it is possible to use C<bind_param> to change a single
1724+
parameter value and C<execute> the statement again, with other values
1725+
unchanged. The attribute remains properly populated after the C<finish>
1726+
method is called, with the values from the last execution.
1727+
17021728
=item mysql_gtids
17031729
17041730
Returns GTID(s) if GTID session tracking is ensabled in the server via
@@ -1750,35 +1776,10 @@ the maximum physically present in the result table, I<length> gives
17501776
the theoretically possible maximum. I<max_length> is valid for MySQL
17511777
only.
17521778
1753-
=item NAME
1754-
1755-
A reference to an array of column names.
1756-
1757-
=item NULLABLE
1758-
1759-
A reference to an array of boolean values; TRUE indicates that this column
1760-
may contain NULL's.
1761-
1762-
=item NUM_OF_FIELDS
1763-
1764-
Number of fields returned by a I<SELECT> or I<LISTFIELDS> statement.
1765-
You may use this for checking whether a statement returned a result:
1766-
A zero value indicates a non-SELECT statement like I<INSERT>,
1767-
I<DELETE> or I<UPDATE>.
1768-
17691779
=item mysql_table
17701780
17711781
A reference to an array of table names, useful in a I<JOIN> result.
17721782
1773-
=item TYPE
1774-
1775-
A reference to an array of column types. The engine's native column
1776-
types are mapped to portable types like DBI::SQL_INTEGER() or
1777-
DBI::SQL_VARCHAR(), as good as possible. Not all native types have
1778-
a meaningful equivalent, for example DBD::mysql::FIELD_TYPE_INTERVAL
1779-
is mapped to DBI::SQL_VARCHAR().
1780-
If you need the native column types, use I<mysql_type>. See below.
1781-
17821783
=item mysql_type
17831784
17841785
A reference to an array of MySQL's native column types, for example

0 commit comments

Comments
 (0)