...

...

@@ -1,1069 +1,1512 @@

1

1

<?xml version="1.0" encoding="utf-8"?>

2

-

<!-- $Revision$ -->

3

-

<chapter xml:id="mysqlnd.stats" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

2

+

<chapter xml:id="mysqlnd.stats" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">

4

3

<title>Statistics</title>

5

-

<para>

6

-

<emphasis role="bold">Using Statistical Data</emphasis>

7

-

</para>

4

+

8

5

<para>

9

6

MySQL Native Driver contains support for gathering statistics on the

10

7

communication between the client and the server. The statistics

11

8

gathered are of two main types:

9

+

<itemizedlist>

10

+

<listitem>

11

+

<simpara>Client statistics</simpara>

12

+

</listitem>

13

+

<listitem>

14

+

<simpara>Connection statistics</simpara>

15

+

</listitem>

16

+

</itemizedlist>

12

17

</para>

13

-

<itemizedlist>

14

-

<listitem>

15

-

<para>

16

-

Client statistics

17

-

</para>

18

-

</listitem>

19

-

<listitem>

20

-

<para>

21

-

Connection statistics

22

-

</para>

23

-

</listitem>

24

-

</itemizedlist>

25

18

<para>

26

-

If you are using the <literal>mysqli</literal> extension, these

27

-

statistics can be obtained through two API calls:

19

+

When using the <link linkend="book.mysqli">mysqli</link> extension,

20

+

these statistics can be obtained through two API calls:

21

+

<itemizedlist>

22

+

<listitem>

23

+

<simpara><function>mysqli_get_client_stats</function></simpara>

24

+

</listitem>

25

+

<listitem>

26

+

<simpara><function>mysqli_get_connection_stats</function></simpara>

27

+

</listitem>

28

+

</itemizedlist>

28

29

</para>

29

-

<itemizedlist>

30

-

<listitem>

31

-

<para>

32

-

<function>mysqli_get_client_stats</function>

33

-

</para>

34

-

</listitem>

35

-

<listitem>

36

-

<para>

37

-

<function>mysqli_get_connection_stats</function>

38

-

</para>

39

-

</listitem>

40

-

</itemizedlist>

30

+

41

31

<note>

42

-

<para>

43

-

Statistics are aggregated among all extensions that use MySQL Native

44

-

Driver. For example, when compiling both <literal>ext/mysql</literal>

45

-

and <literal>ext/mysqli</literal> against MySQL Native Driver, both

46

-

function calls of <literal>ext/mysql</literal> and

47

-

<literal>ext/mysqli</literal> will change the statistics. There is no

48

-

way to find out how much a certain API call of any extension that has

49

-

been compiled against MySQL Native Driver has impacted a certain

50

-

statistic. You can configure the PDO MySQL Driver,

51

-

<literal>ext/mysql</literal> and <literal>ext/mysqli</literal> to

52

-

optionally use the MySQL Native Driver. When doing so, all three

53

-

extensions will change the statistics.

54

-

</para>

32

+

<simpara>

33

+

Statistics are aggregated among all extensions that use the MySQL Native

34

+

Driver.

35

+

For example, if the <link linkend="book.mysqli">mysqli</link>

36

+

extension and the PDO MySQL driver are both set-up to use MySQLnd,

37

+

then function calls from <link linkend="book.mysqli">mysqli</link>

38

+

and method calls from PDO will affect the statistics.

39

+

</simpara>

40

+

<simpara>

41

+

There is no way to find out how much a certain API call of any extension

42

+

that has been compiled against MySQL Native Driver has impacted a certain

43

+

statistic.

44

+

</simpara>

55

45

</note>

56

-

<para>

57

-

<emphasis role="bold">Accessing Client Statistics</emphasis>

58

-

</para>

59

-

<para>

60

-

To access client statistics, you need to call

61

-

<function>mysqli_get_client_stats</function>. The function call does

62

-

not require any parameters.

63

-

</para>

64

-

<para>

65

-

The function returns an associative array that contains the name of

66

-

the statistic as the key and the statistical data as the value.

67

-

</para>

68

-

<para>

69

-

Client statistics can also be accessed by calling the

70

-

<function>phpinfo</function> function.

71

-

</para>

72

-

<para>

73

-

<emphasis role="bold">Accessing Connection Statistics</emphasis>

74

-

</para>

75

-

<para>

76

-

To access connection statistics call

77

-

<function>mysqli_get_connection_stats</function>. This takes the

78

-

database connection handle as the parameter.

79

-

</para>

80

-

<para>

81

-

The function returns an associative array that contains the name of

82

-

the statistic as the key and the statistical data as the value.

83

-

</para>

84

-

<para>

85

-

<emphasis role="bold">Buffered and Unbuffered Result Sets</emphasis>

86

-

</para>

87

-

<para>

88

-

Result sets can be buffered or unbuffered. Using default settings,

89

-

<literal>ext/mysql</literal> and <literal>ext/mysqli</literal> work

90

-

with buffered result sets for normal (non prepared statement) queries.

91

-

Buffered result sets are cached on the client. After the query

92

-

execution all results are fetched from the MySQL Server and stored in

93

-

a cache on the client. The big advantage of buffered result sets is

94

-

that they allow the server to free all resources allocated to a result

95

-

set, once the results have been fetched by the client.

96

-

</para>

97

-

<para>

98

-

Unbuffered result sets on the other hand are kept much longer on the

99

-

server. If you want to reduce memory consumption on the client, but

100

-

increase load on the server, use unbuffered results. If you experience

101

-

a high server load and the figures for unbuffered result sets are

102

-

high, you should consider moving the load to the clients. Clients

103

-

typically scale better than servers. <quote>Load</quote> does not only

104

-

refer to memory buffers - the server also needs to keep other

105

-

resources open, for example file handles and threads, before a result

106

-

set can be freed.

107

-

</para>

108

-

<para>

109

-

Prepared Statements use unbuffered result sets by default. However,

110

-

you can use <function>mysqli_stmt_store_result</function> to enable

111

-

buffered result sets.

112

-

</para>

113

-

<para>

114

-

<emphasis role="bold">Statistics returned by MySQL Native

115

-

Driver</emphasis>

116

-

</para>

117

-

<para>

118

-

The following tables show a list of statistics returned by the

119

-

<function>mysqli_get_client_stats</function> and

120

-

<function>mysqli_get_connection_stats</function> functions.

121

-

</para>

122

-

<table xml:id="mysqlnd.stats.returns">

123

-

<title>Returned mysqlnd statistics: Network</title>

124

-

<tgroup cols="4">

125

-

<colspec colwidth="10*"/>

126

-

<colspec colwidth="10*"/>

127

-

<colspec colwidth="40*"/>

128

-

<colspec colwidth="40*"/>

129

-

<thead>

130

-

<row>

131

-

<entry>Statistic</entry>

132

-

<entry>Scope</entry>

133

-

<entry>Description</entry>

134

-

<entry>Notes</entry>

135

-

</row>

136

-

</thead>

137

-

<tbody>

138

-

<row>

139

-

<entry><literal>bytes_sent</literal></entry>

140

-

<entry>Connection</entry>

141

-

<entry>Number of bytes sent from PHP to the MySQL server</entry>

142

-

<entry>Can be used to check the efficiency of the compression protocol</entry>

143

-

</row>

144

-

<row>

145

-

<entry><literal>bytes_received</literal></entry>

146

-

<entry>Connection</entry>

147

-

<entry>Number of bytes received from MySQL server</entry>

148

-

<entry>Can be used to check the efficiency of the compression protocol</entry>

149

-

</row>

150

-

<row>

151

-

<entry><literal>packets_sent</literal></entry>

152

-

<entry>Connection</entry>

153

-

<entry>Number of MySQL Client Server protocol packets sent</entry>

154

-

<entry>Used for debugging Client Server protocol implementation</entry>

155

-

</row>

156

-

<row>

157

-

<entry><literal>packets_received</literal></entry>

158

-

<entry>Connection</entry>

159

-

<entry>Number of MySQL Client Server protocol packets received</entry>

160

-

<entry>Used for debugging Client Server protocol implementation</entry>

161

-

</row>

162

-

<row>

163

-

<entry><literal>protocol_overhead_in</literal></entry>

164

-

<entry>Connection</entry>

165

-

<entry>MySQL Client Server protocol overhead in bytes for incoming traffic.

166

-

Currently only the Packet Header (4 bytes) is considered as

167

-

overhead. protocol_overhead_in = packets_received * 4</entry>

168

-

<entry>Used for debugging Client Server protocol implementation</entry>

169

-

</row>

170

-

<row>

171

-

<entry><literal>protocol_overhead_out</literal></entry>

172

-

<entry>Connection</entry>

173

-

<entry>MySQL Client Server protocol overhead in bytes for outgoing traffic.

174

-

Currently only the Packet Header (4 bytes) is considered as

175

-

overhead. protocol_overhead_out = packets_sent * 4</entry>

176

-

<entry>Used for debugging Client Server protocol implementation</entry>

177

-

</row>

178

-

<row>

179

-

<entry><literal>bytes_received_ok_packet</literal></entry>

180

-

<entry>Connection</entry>

181

-

<entry>Total size of bytes of MySQL Client Server protocol OK packets received.

182

-

OK packets can contain a status message. The length of the status

183

-

message can vary and thus the size of an OK packet is not fixed.</entry>

184

-

<entry>Used for debugging CS protocol implementation. Note that the total size

185

-

in bytes includes the size of the header packet (4 bytes, see

186

-

protocol overhead).</entry>

187

-

</row>

188

-

<row>

189

-

<entry><literal>packets_received_ok</literal></entry>

190

-

<entry>Connection</entry>

191

-

<entry>Number of MySQL Client Server protocol OK packets received.</entry>

192

-

<entry>Used for debugging CS protocol implementation. Note that the total size

193

-

in bytes includes the size of the header packet (4 bytes, see

194

-

protocol overhead).</entry>

195

-

</row>

196

-

<row>

197

-

<entry><literal>bytes_received_eof_packet</literal></entry>

198

-

<entry>Connection</entry>

199

-

<entry>Total size in bytes of MySQL Client Server protocol EOF packets

200

-

received. EOF can vary in size depending on the server version.

201

-

Also, EOF can transport an error message.</entry>

202

-

<entry>Used for debugging CS protocol implementation. Note that the total size

203

-

in bytes includes the size of the header packet (4 bytes, see

204

-

protocol overhead).</entry>

205

-

</row>

206

-

<row>

207

-

<entry><literal>packets_received_eof</literal></entry>

208

-

<entry>Connection</entry>

209

-

<entry>Number of MySQL Client Server protocol EOF packets. Like with other

210

-

packet statistics the number of packets will be increased even if

211

-

PHP does not receive the expected packet but, for example, an

212

-

error message.</entry>

213

-

<entry>Used for debugging CS protocol implementation. Note that the total size

214

-

in bytes includes the size of the header packet (4 bytes, see

215

-

protocol overhead).</entry>

216

-

</row>

217

-

<row>

218

-

<entry><literal>bytes_received_rset_header_packet</literal></entry>

219

-

<entry>Connection</entry>

220

-

<entry>Total size in bytes of MySQL Client Server protocol result set header

221

-

packets. The size of the packets varies depending on the payload

46

+

47

+

<section xml:id="mysqlnd.stats.retrieve" annotations="chunk:false">

48

+

<title>Retrieving statistics</title>

49

+

50

+

<simpara>

51

+

Client statistics can be retrieved by calling the

52

+

<function>mysqli_get_client_stats</function> function.

53

+

</simpara>

54

+

55

+

<simpara>

56

+

Connection statistics can be retrieved by calling the

57

+

<function>mysqli_get_connection_stats</function> function.

58

+

</simpara>

59

+

60

+

<simpara>

61

+

Both functions return an associative array,

62

+

where the name of a statistic is the key for the corresponding

63

+

statistical data.

64

+

</simpara>

65

+

</section>

66

+

67

+

<section xml:id="mysqlnd.stats.statistics" annotations="chunk:false">

68

+

<title>MySQL Native Driver Statistics</title>

69

+

<simpara>

70

+

Most statistics are associated to a connection, but some are associated

71

+

to the process in which case this will be mentioned.

72

+

<!-- Process running the server? -->

73

+

</simpara>

74

+

<simpara>

75

+

The following statistics are produced by the MySQL Native Driver:

76

+

</simpara>

77

+

78

+

<variablelist>

79

+

<title>Network Related Statistics</title>

80

+

81

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-sent">

82

+

<term><literal>bytes_sent</literal></term>

83

+

<listitem>

84

+

<simpara>

85

+

Number of bytes sent from PHP to the MySQL server.

86

+

</simpara>

87

+

</listitem>

88

+

</varlistentry>

89

+

90

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received">

91

+

<term><literal>bytes_received</literal></term>

92

+

<listitem>

93

+

<simpara>

94

+

Number of bytes received from the MySQL server.

95

+

</simpara>

96

+

</listitem>

97

+

</varlistentry>

98

+

99

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-sent">

100

+

<term><literal>packets_sent</literal></term>

101

+

<listitem>

102

+

<simpara>

103

+

Number of packets sent by the MySQL Client Server protocol.

104

+

</simpara>

105

+

</listitem>

106

+

</varlistentry>

107

+

108

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-received">

109

+

<term><literal>packets_received</literal></term>

110

+

<listitem>

111

+

<simpara>

112

+

Number of packets received from the MySQL Client Server protocol.

113

+

</simpara>

114

+

</listitem>

115

+

</varlistentry>

116

+

117

+

<varlistentry xml:id="mysqlnd.stats.statistics.protocol-overhead-in">

118

+

<term><literal>protocol_overhead_in</literal></term>

119

+

<listitem>

120

+

<simpara>

121

+

MySQL Client Server protocol overhead in bytes for incoming traffic.

122

+

Currently only the Packet Header (4 bytes) is considered as overhead.

123

+

<code>protocol_overhead_in = packets_received * 4</code>

124

+

</simpara>

125

+

</listitem>

126

+

</varlistentry>

127

+

128

+

<varlistentry xml:id="mysqlnd.stats.statistics.protocol-overhead-out">

129

+

<term><literal>protocol_overhead_out</literal></term>

130

+

<listitem>

131

+

<simpara>

132

+

MySQL Client Server protocol overhead in bytes for outgoing traffic.

133

+

Currently only the Packet Header (4 bytes) is considered as overhead.

134

+

<code>protocol_overhead_out = packets_received * 4</code>

135

+

</simpara>

136

+

</listitem>

137

+

</varlistentry>

138

+

139

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-ok-packet">

140

+

<term><literal>bytes_received_ok_packet</literal></term>

141

+

<listitem>

142

+

<simpara>

143

+

Total size of bytes of MySQL Client Server protocol OK packets received.

144

+

OK packets can contain a status message.

145

+

The length of the status message can vary and thus the size of an OK

146

+

packet is not fixed.

147

+

</simpara>

148

+

<note>

149

+

<simpara>

150

+

The total size in bytes includes the size of the header packet

151

+

(4 bytes, see protocol overhead).

152

+

</simpara>

153

+

</note>

154

+

</listitem>

155

+

</varlistentry>

156

+

157

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-received-ok">

158

+

<term><literal>packets_received_ok</literal></term>

159

+

<listitem>

160

+

<simpara>

161

+

Number of MySQL Client Server protocol OK packets received.

162

+

</simpara>

163

+

</listitem>

164

+

</varlistentry>

165

+

166

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-eof-packet">

167

+

<term><literal>bytes_received_eof_packet</literal></term>

168

+

<listitem>

169

+

<simpara>

170

+

Total size in bytes of MySQL Client Server protocol EOF packets received.

171

+

EOF can vary in size depending on the server version.

172

+

Also, EOF can transport an error message.

173

+

</simpara>

174

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.bytes-received-ok-packet')/db:listitem/db:note)">

175

+

<xi:fallback/>

176

+

</xi:include>

177

+

</listitem>

178

+

</varlistentry>

179

+

180

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-received-eof">

181

+

<term><literal>packets_received_eof</literal></term>

182

+

<listitem>

183

+

<simpara>

184

+

Number of MySQL Client Server protocol EOF packets.

185

+

</simpara>

186

+

<simpara>

187

+

Like with other packet statistics the number of packets will be

188

+

increased even if PHP does not receive the expected packet but,

189

+

for example, an error message.

190

+

</simpara>

191

+

</listitem>

192

+

</varlistentry>

193

+

194

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-rset-header-packet">

195

+

<term><literal>bytes_received_rset_header_packet</literal></term>

196

+

<listitem>

197

+

<simpara>

198

+

Total size in bytes of MySQL Client Server protocol result set header

199

+

packets.

200

+

The size of the packets varies depending on the payload

222

201

(<literal>LOAD LOCAL INFILE</literal>, <literal>INSERT</literal>,

223

-

<literal>UPDATE</literal>, <literal>SELECT</literal>, error

224

-

message).</entry>

225

-

<entry>Used for debugging CS protocol implementation. Note that the total size

226

-

in bytes includes the size of the header packet (4 bytes, see

227

-

protocol overhead).</entry>

228

-

</row>

229

-

<row>

230

-

<entry><literal>packets_received_rset_header</literal></entry>

231

-

<entry>Connection</entry>

232

-

<entry>Number of MySQL Client Server protocol result set header packets.</entry>

233

-

<entry>Used for debugging CS protocol implementation. Note that the total size

234

-

in bytes includes the size of the header packet (4 bytes, see

235

-

protocol overhead).</entry>

236

-

</row>

237

-

<row>

238

-

<entry><literal>bytes_received_rset_field_meta_packet</literal></entry>

239

-

<entry>Connection</entry>

240

-

<entry>Total size in bytes of MySQL Client Server protocol result set meta data

241

-

(field information) packets. Of course the size varies with the

242

-

fields in the result set. The packet may also transport an error

243

-

or an EOF packet in case of COM_LIST_FIELDS.</entry>

244

-

<entry>Only useful for debugging CS protocol implementation. Note that the

245

-

total size in bytes includes the size of the header packet (4

246

-

bytes, see protocol overhead).</entry>

247

-

</row>

248

-

<row>

249

-

<entry><literal>packets_received_rset_field_meta</literal></entry>

250

-

<entry>Connection</entry>

251

-

<entry>Number of MySQL Client Server protocol result set meta data (field

252

-

information) packets.</entry>

253

-

<entry>Only useful for debugging CS protocol implementation. Note that the

254

-

total size in bytes includes the size of the header packet (4

255

-

bytes, see protocol overhead).</entry>

256

-

</row>

257

-

<row>

258

-

<entry><literal>bytes_received_rset_row_packet</literal></entry>

259

-

<entry>Connection</entry>

260

-

<entry>Total size in bytes of MySQL Client Server protocol result set row data

261

-

packets. The packet may also transport an error or an EOF packet.

262

-

You can reverse engineer the number of error and EOF packets by

263

-

subtracting <literal>rows_fetched_from_server_normal</literal>

264

-

and <literal>rows_fetched_from_server_ps</literal> from

265

-

<literal>bytes_received_rset_row_packet</literal>.</entry>

266

-

<entry>Only useful for debugging CS protocol implementation. Note that the

267

-

total size in bytes includes the size of the header packet (4

268

-

bytes, see protocol overhead).</entry>

269

-

</row>

270

-

<row>

271

-

<entry><literal>packets_received_rset_row</literal></entry>

272

-

<entry>Connection</entry>

273

-

<entry>Number of MySQL Client Server protocol result set row data packets and

274

-

their total size in bytes.</entry>

275

-

<entry>Only useful for debugging CS protocol implementation. Note that the

276

-

total size in bytes includes the size of the header packet (4

277

-

bytes, see protocol overhead).</entry>

278

-

</row>

279

-

<row>

280

-

<entry><literal>bytes_received_prepare_response_packet</literal></entry>

281

-

<entry>Connection</entry>

282

-

<entry>Total size in bytes of MySQL Client Server protocol OK for Prepared

283

-

Statement Initialization packets (prepared statement init

284

-

packets). The packet may also transport an error. The packet size

285

-

depends on the MySQL version: 9 bytes with MySQL 4.1 and 12 bytes

286

-

from MySQL 5.0 on. There is no safe way to know how many errors

287

-

happened. You may be able to guess that an error has occurred if,

288

-

for example, you always connect to MySQL 5.0 or newer and,

289

-

<literal>bytes_received_prepare_response_packet</literal> !=

290

-

<literal>packets_received_prepare_response</literal> * 12. See

291

-

also <literal>ps_prepared_never_executed</literal>,

292

-

<literal>ps_prepared_once_executed</literal>.</entry>

293

-

<entry>Only useful for debugging CS protocol implementation. Note that the

294

-

total size in bytes includes the size of the header packet (4

295

-

bytes, see protocol overhead).</entry>

296

-

</row>

297

-

<row>

298

-

<entry><literal>packets_received_prepare_response</literal></entry>

299

-

<entry>Connection</entry>

300

-

<entry>Number of MySQL Client Server protocol OK for Prepared Statement

301

-

Initialization packets (prepared statement init packets).</entry>

302

-

<entry>Only useful for debugging CS protocol implementation. Note that the

303

-

total size in bytes includes the size of the header packet (4

304

-

bytes, see protocol overhead).</entry>

305

-

</row>

306

-

<row>

307

-

<entry><literal>bytes_received_change_user_packet</literal></entry>

308

-

<entry>Connection</entry>

309

-

<entry>Total size in bytes of MySQL Client Server protocol COM_CHANGE_USER

310

-

packets. The packet may also transport an error or EOF.</entry>

311

-

<entry>Only useful for debugging CS protocol implementation. Note that the

312

-

total size in bytes includes the size of the header packet (4

313

-

bytes, see protocol overhead).</entry>

314

-

</row>

315

-

<row>

316

-

<entry><literal>packets_received_change_user</literal></entry>

317

-

<entry>Connection</entry>

318

-

<entry>Number of MySQL Client Server protocol COM_CHANGE_USER packets</entry>

319

-

<entry>Only useful for debugging CS protocol implementation. Note that the

320

-

total size in bytes includes the size of the header packet (4

321

-

bytes, see protocol overhead).</entry>

322

-

</row>

323

-

<row>

324

-

<entry><literal>packets_sent_command</literal></entry>

325

-

<entry>Connection</entry>

326

-

<entry>Number of MySQL Client Server protocol commands sent from PHP to MySQL.

202

+

<literal>UPDATE</literal>, <literal>SELECT</literal>, error message).

203

+

</simpara>

204

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.bytes-received-ok-packet')/db:listitem/db:note)">

205

+

<xi:fallback/>

206

+

</xi:include>

207

+

</listitem>

208

+

</varlistentry>

209

+

210

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-received-rset-header">

211

+

<term><literal>packets_received_rset_header</literal></term>

212

+

<listitem>

213

+

<simpara>

214

+

Number of MySQL Client Server protocol result set header packets.

215

+

</simpara>

216

+

</listitem>

217

+

</varlistentry>

218

+

219

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-rset-field-meta-packet">

220

+

<term><literal>bytes_received_rset_field_meta_packet</literal></term>

221

+

<listitem>

222

+

<simpara>

223

+

Total size in bytes of MySQL Client Server protocol result set metadata

224

+

(field information) packets.

225

+

Of course the size varies with the fields in the result set.

226

+

The packet may also transport an error or an EOF packet in case of

227

+

COM_LIST_FIELDS.

228

+

</simpara>

229

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.bytes-received-ok-packet')/db:listitem/db:note)">

230

+

<xi:fallback/>

231

+

</xi:include>

232

+

</listitem>

233

+

</varlistentry>

234

+

235

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-received-rset-field-meta">

236

+

<term><literal>packets_received_rset_field_meta</literal></term>

237

+

<listitem>

238

+

<simpara>

239

+

Number of MySQL Client Server protocol result set metadata

240

+

(field information) packets.

241

+

</simpara>

242

+

</listitem>

243

+

</varlistentry>

244

+

245

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-rset-row-packet">

246

+

<term><literal>bytes_received_rset_row_packet</literal></term>

247

+

<listitem>

248

+

<simpara>

249

+

Total size in bytes of MySQL Client Server protocol result set row data

250

+

packets.

251

+

The packet may also transport an error or an EOF packet.

252

+

One can compute the number of error and EOF packets by subtracting

253

+

<literal>rows_fetched_from_server_normal</literal>

254

+

and <literal>rows_fetched_from_server_ps</literal>

255

+

from <literal>bytes_received_rset_row_packet</literal>.

256

+

</simpara>

257

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.bytes-received-ok-packet')/db:listitem/db:note)">

258

+

<xi:fallback/>

259

+

</xi:include>

260

+

</listitem>

261

+

</varlistentry>

262

+

263

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-received-rset-row">

264

+

<term><literal>packets_received_rset_row</literal></term>

265

+

<listitem>

266

+

<simpara>

267

+

Number of MySQL Client Server protocol result set row data packets.

268

+

</simpara>

269

+

</listitem>

270

+

</varlistentry>

271

+

272

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-prepare-response-packet">

273

+

<term><literal>bytes_received_prepare_response_packet</literal></term>

274

+

<listitem>

275

+

<simpara>

276

+

Total size in bytes of MySQL Client Server protocol OK for Prepared

277

+

Statement Initialization packets (prepared statement init packets).

278

+

The packet may also transport an error.

279

+

The packet size depends on the MySQL version.

280

+

</simpara>

281

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.bytes-received-ok-packet')/db:listitem/db:note)">

282

+

<xi:fallback/>

283

+

</xi:include>

284

+

</listitem>

285

+

</varlistentry>

286

+

287

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-received-prepare-response">

288

+

<term><literal>packets_received_prepare_response</literal></term>

289

+

<listitem>

290

+

<simpara>

291

+

Number of MySQL Client Server protocol OK for Prepared Statement

292

+

Initialization packets (prepared statement init packets).

293

+

</simpara>

294

+

</listitem>

295

+

</varlistentry>

296

+

297

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-change-user-packet">

298

+

<term><literal>bytes_received_change_user_packet</literal></term>

299

+

<listitem>

300

+

<simpara>

301

+

Total size in bytes of MySQL Client Server protocol COM_CHANGE_USER packets.

302

+

The packet may also transport an error or EOF.

303

+

</simpara>

304

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.bytes-received-ok-packet')/db:listitem/db:note)">

305

+

<xi:fallback/>

306

+

</xi:include>

307

+

</listitem>

308

+

</varlistentry>

309

+

310

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-received-change-user">

311

+

<term><literal>packets_received_change_user</literal></term>

312

+

<listitem>

313

+

<simpara>

314

+

Number of MySQL Client Server protocol COM_CHANGE_USER packets.

315

+

</simpara>

316

+

</listitem>

317

+

</varlistentry>

318

+

319

+

<varlistentry xml:id="mysqlnd.stats.statistics.packets-sent-command">

320

+

<term><literal>packets_sent_command</literal></term>

321

+

<listitem>

322

+

<simpara>

323

+

Number of MySQL Client Server protocol commands sent from PHP to MySQL.

324

+

</simpara>

325

+

<simpara>

327

326

There is no way to know which specific commands and how many of

328

-

them have been sent. At its best you can use it to check if PHP

329

-

has sent any commands to MySQL to know if you can consider to

330

-

disable MySQL support in your PHP binary. There is also no way to

331

-

reverse engineer the number of errors that may have occurred while

332

-

sending data to MySQL. The only error that is recorded is

333

-

command_buffer_too_small (see below).</entry>

334

-

<entry>Only useful for debugging CS protocol implementation.</entry>

335

-

</row>

336

-

<row>

337

-

<entry><literal>bytes_received_real_data_normal</literal></entry>

338

-

<entry>Connection</entry>

339

-

<entry>Number of bytes of payload fetched by the PHP client from

340

-

<literal>mysqlnd</literal> using the text protocol.</entry>

341

-

<entry>This is the size of the actual data contained in result sets that do not

342

-

originate from prepared statements and which have been fetched by

343

-

the PHP client. Note that although a full result set may have been

344

-

pulled from MySQL by <literal>mysqlnd</literal>, this statistic

345

-

only counts actual data pulled from <literal>mysqlnd</literal> by

346

-

the PHP client. An example of a code sequence that will increase

347

-

the value is as follows:

348

-

<programlisting>

327

+

them have been sent.

328

+

</simpara>

329

+

</listitem>

330

+

</varlistentry>

331

+

332

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-real-data_normal">

333

+

<term><literal>bytes_received_real_data_normal</literal></term>

334

+

<listitem>

335

+

<simpara>

336

+

Number of bytes of payload fetched by the PHP client from

337

+

<literal>mysqlnd</literal> using the text protocol.

338

+

</simpara>

339

+

<simpara>

340

+

This is the size of the actual data contained in result sets that do not

341

+

originate from prepared statements and which have been fetched by the PHP client.

342

+

</simpara>

343

+

<simpara>

344

+

Note that although a full result set may have been pulled from MySQL

345

+

by <literal>mysqlnd</literal>, this statistic only counts actual data

346

+

pulled from <literal>mysqlnd</literal> by the PHP client.

347

+

</simpara>

348

+

<para>

349

+

An example of a code sequence that will increase the value is as follows:

350

+

<programlisting>

349

351

<![CDATA[

350

352

$mysqli = new mysqli();

351

353

$res = $mysqli->query("SELECT 'abc'");

352

354

$res->fetch_assoc();

353

355

$res->close();

354

356

]]>

355

-

</programlisting>

356

-

<para>

357

-

Every fetch operation will increase the value.

358

-

</para>

359

-

360

-

<para>

361

-

The statistic will not be increased if the result set is only

362

-

buffered on the client, but not fetched, such as in the following

363

-

example:

364

-

</para>

365

-

<programlisting>

357

+

</programlisting>

358

+

Every fetch operation will increase the value.

359

+

</para>

360

+

<para>

361

+

However, the statistic will not be increased if the result set is only

362

+

buffered on the client, but not fetched, such as in the following example:

363

+

<programlisting>

366

364

<![CDATA[

367

365

$mysqli = new mysqli();

368

366

$res = $mysqli->query("SELECT 'abc'");

369

367

$res->close();

370

368

]]>

371

-

</programlisting>

372

-

</entry>

373

-

</row>

374

-

<row>

375

-

<entry><literal>bytes_received_real_data_ps</literal></entry>

376

-

<entry>Connection</entry>

377

-

<entry>Number of bytes of the payload fetched by the PHP client from

378

-

<literal>mysqlnd</literal> using the prepared statement protocol.</entry>

379

-

<entry>This is the size of the actual data contained in result sets that

380

-

originate from prepared statements and which has been fetched by

381

-

the PHP client. The value will not be increased if the result set

382

-

is not subsequently read by the PHP client. Note that although a

383

-

full result set may have been pulled from MySQL by

384

-

<literal>mysqlnd</literal>, this statistic only counts actual data

385

-

pulled from <literal>mysqlnd</literal> by the PHP client. See also

386

-

<literal>bytes_received_real_data_normal</literal>.</entry>

387

-

</row>

388

-

</tbody>

389

-

</tgroup>

390

-

</table>

391

-

<para>

392

-

<emphasis role="bold">Result Set</emphasis>

393

-

</para>

394

-

<table xml:id="mysqlnd.stats.results">

395

-

<title>Returned mysqlnd statistics: Result Set</title>

396

-

<tgroup cols="4">

397

-

<colspec colwidth="10*"/>

398

-

<colspec colwidth="10*"/>

399

-

<colspec colwidth="40*"/>

400

-

<colspec colwidth="40*"/>

401

-

<thead>

402

-

<row>

403

-

<entry>Statistic</entry>

404

-

<entry>Scope</entry>

405

-

<entry>Description</entry>

406

-

<entry>Notes</entry>

407

-

</row>

408

-

</thead>

409

-

<tbody>

410

-

<row>

411

-

<entry><literal>result_set_queries</literal></entry>

412

-

<entry>Connection</entry>

413

-

<entry>Number of queries that have generated a result set. Examples of queries

414

-

that generate a result set: <literal>SELECT</literal>,

415

-

<literal>SHOW</literal>. The statistic will not be incremented if

416

-

there is an error reading the result set header packet from the

417

-

line.</entry>

418

-

<entry>You may use it as an indirect measure for the number of queries PHP has

419

-

sent to MySQL, for example, to identify a client that causes a

420

-

high database load.</entry>

421

-

</row>

422

-

<row>

423

-

<entry><literal>non_result_set_queries</literal></entry>

424

-

<entry>Connection</entry>

425

-

<entry>Number of queries that did not generate a result set. Examples of

426

-

queries that do not generate a result set:

427

-

<literal>INSERT</literal>, <literal>UPDATE</literal>,

428

-

<literal>LOAD DATA</literal>. The

429

-

statistic will not be incremented if there is an error reading the

430

-

result set header packet from the line.</entry>

431

-

<entry>You may use it as an indirect measure for the number of queries PHP has

432

-

sent to MySQL, for example, to identify a client that causes a

433

-

high database load.</entry>

434

-

</row>

435

-

<row>

436

-

<entry><literal>no_index_used</literal></entry>

437

-

<entry>Connection</entry>

438

-

<entry>Number of queries that have generated a result set but did not use an

439

-

index (see also mysqld start option

440

-

–log-queries-not-using-indexes). If you want these queries to be

441

-

reported you can use mysqli_report(MYSQLI_REPORT_INDEX) to make

442

-

ext/mysqli throw an exception. If you prefer a warning instead of

443

-

an exception use mysqli_report(MYSQLI_REPORT_INDEX ^

444

-

MYSQLI_REPORT_STRICT).</entry>

445

-

<entry></entry>

446

-

</row>

447

-

<row>

448

-

<entry><literal>bad_index_used</literal></entry>

449

-

<entry>Connection</entry>

450

-

<entry>Number of queries that have generated a result set and did not use a

451

-

good index (see also mysqld start option –log-slow-queries).</entry>

452

-

<entry>If you want these queries to be reported you can use

453

-

mysqli_report(MYSQLI_REPORT_INDEX) to make ext/mysqli throw an

454

-

exception. If you prefer a warning instead of an exception use

455

-

mysqli_report(MYSQLI_REPORT_INDEX ^ MYSQLI_REPORT_STRICT)</entry>

456

-

</row>

457

-

<row>

458

-

<entry><literal>slow_queries</literal></entry>

459

-

<entry>Connection</entry>

460

-

<entry>SQL statements that took more than <literal>long_query_time</literal>

369

+

</programlisting>

370

+

</para>

371

+

</listitem>

372

+

</varlistentry>

373

+

374

+

<varlistentry xml:id="mysqlnd.stats.statistics.bytes-received-real-data-ps">

375

+

<term><literal>bytes_received_real_data_ps</literal></term>

376

+

<listitem>

377

+

<simpara>

378

+

Number of bytes of the payload fetched by the PHP client from

379

+

<literal>mysqlnd</literal> using the prepared statement protocol.

380

+

</simpara>

381

+

<simpara>

382

+

This is the size of the actual data contained in result sets that

383

+

originate from prepared statements and which have been fetched by the PHP client.

384

+

</simpara>

385

+

<simpara>

386

+

The value will not be increased if the result set is not subsequently read by the PHP client.

387

+

</simpara>

388

+

<simpara>

389

+

Note that although a full result set may have been pulled from MySQL

390

+

by <literal>mysqlnd</literal>, this statistic only counts actual data

391

+

pulled from <literal>mysqlnd</literal> by the PHP client.

392

+

</simpara>

393

+

<simpara>

394

+

See also <literal>bytes_received_real_data_normal</literal>.

395

+

</simpara>

396

+

</listitem>

397

+

</varlistentry>

398

+

</variablelist>

399

+

400

+

<variablelist>

401

+

<title>Result Set Related Statistics</title>

402

+

403

+

<varlistentry xml:id="mysqlnd.stats.statistics.result-set-queries">

404

+

<term><literal>result_set_queries</literal></term>

405

+

<listitem>

406

+

<simpara>

407

+

Number of queries that have generated a result set.

408

+

Examples of queries that generate a result set:

409

+

<literal>SELECT</literal>, <literal>SHOW</literal>.

410

+

</simpara>

411

+

<simpara>

412

+

The statistic will not be incremented if there is an error reading

413

+

the result set header packet from the line.

414

+

</simpara>

415

+

<note>

416

+

<simpara>

417

+

This statistic can be used as an indirect measure for the number of

418

+

queries PHP has sent to MySQL.

419

+

This could help identifying a client that causes a high database load.

420

+

</simpara>

421

+

</note>

422

+

</listitem>

423

+

</varlistentry>

424

+

425

+

<varlistentry xml:id="mysqlnd.stats.statistics.non-result-set-queries">

426

+

<term><literal>non_result_set_queries</literal></term>

427

+

<listitem>

428

+

<simpara>

429

+

Number of queries that did not generate a result set.

430

+

Examples of queries that do not generate a result set:

431

+

<literal>INSERT</literal>, <literal>UPDATE</literal>, <literal>LOAD DATA</literal>.

432

+

</simpara>

433

+

<simpara>

434

+

The statistic will not be incremented if there is an error reading

435

+

the result set header packet from the line.

436

+

</simpara>

437

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.result-set-queries')/db:listitem/db:note)">

438

+

<xi:fallback/>

439

+

</xi:include>

440

+

</listitem>

441

+

</varlistentry>

442

+

443

+

<varlistentry xml:id="mysqlnd.stats.statistics.no-index-used">

444

+

<term><literal>no_index_used</literal></term>

445

+

<listitem>

446

+

<simpara>

447

+

Number of queries that have generated a result set but did not use an index.

448

+

(See also the mysqld start option <literal>--log-queries-not-using-indexes</literal>).

449

+

</simpara>

450

+

<note>

451

+

<simpara>

452

+

Those queries can be reported via an exception by calling

453

+

<code>mysqli_report(MYSQLI_REPORT_INDEX);</code>.

454

+

It is possible to have them be reported via a warning instead by calling

455

+

<code>mysqli_report(MYSQLI_REPORT_INDEX ^ MYSQLI_REPORT_STRICT);</code>.

456

+

</simpara>

457

+

</note>

458

+

</listitem>

459

+

</varlistentry>

460

+

461

+

<varlistentry xml:id="mysqlnd.stats.statistics.bad-index-used">

462

+

<term><literal>bad_index_used</literal></term>

463

+

<listitem>

464

+

<simpara>

465

+

Number of queries that have generated a result set and did not use a good index.

466

+

(See also the mysqld start option <literal>--log-slow-queries</literal>).

467

+

</simpara>

468

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.no-index-used')/db:listitem/db:note)">

469

+

<xi:fallback/>

470

+

</xi:include>

471

+

</listitem>

472

+

</varlistentry>

473

+

474

+

<varlistentry xml:id="mysqlnd.stats.statistics.slow-queries">

475

+

<term><literal>slow_queries</literal></term>

476

+

<listitem>

477

+

<simpara>

478

+

SQL statements that took more than <literal>long_query_time</literal>

461

479

seconds to execute and required at least

462

-

<literal>min_examined_row_limit</literal> rows to be examined.</entry>

463

-

<entry>Not reported through <function>mysqli_report</function></entry>

464

-

</row>

465

-

<row>

466

-

<entry><literal>buffered_sets</literal></entry>

467

-

<entry>Connection</entry>

468

-

<entry>Number of buffered result sets returned by <quote>normal</quote>

469

-

queries. <quote>Normal</quote> means <quote>not prepared

470

-

statement</quote> in the following notes.</entry>

471

-

<entry>Examples of API calls that will buffer result sets on the client:

472

-

<function>mysql_query</function>,

473

-

<function>mysqli_query</function>,

474

-

<function>mysqli_store_result</function>,

475

-

<function>mysqli_stmt_get_result</function>. Buffering result sets

476

-

on the client ensures that server resources are freed as soon as

477

-

possible and it makes result set scrolling easier. The downside is

478

-

the additional memory consumption on the client for buffering

479

-

data. Note that mysqlnd (unlike the MySQL Client Library) respects

480

-

the PHP memory limit because it uses PHP internal memory

481

-

management functions to allocate memory. This is also the reason

482

-

why <function>memory_get_usage</function> reports a higher memory

483

-

consumption when using mysqlnd instead of the MySQL Client

484

-

Library. <function>memory_get_usage</function> does not measure

485

-

the memory consumption of the MySQL Client Library at all because

486

-

the MySQL Client Library does not use PHP internal memory

487

-

management functions monitored by the function!</entry>

488

-

</row>

489

-

<row>

490

-

<entry><literal>unbuffered_sets</literal></entry>

491

-

<entry>Connection</entry>

492

-

<entry>Number of unbuffered result sets returned by normal (non prepared

493

-

statement) queries.</entry>

494

-

<entry>Examples of API calls that will not buffer result sets on the client:

495

-

<function>mysqli_use_result</function></entry>

496

-

</row>

497

-

<row>

498

-

<entry><literal>ps_buffered_sets</literal></entry>

499

-

<entry>Connection</entry>

500

-

<entry>Number of buffered result sets returned by prepared statements. By

501

-

default prepared statements are unbuffered.</entry>

502

-

<entry>Examples of API calls that will buffer result sets on the client:

503

-

<literal>mysqli_stmt_store_result</literal></entry>

504

-

</row>

505

-

<row>

506

-

<entry><literal>ps_unbuffered_sets</literal></entry>

507

-

<entry>Connection</entry>

508

-

<entry>Number of unbuffered result sets returned by prepared statements.</entry>

509

-

<entry>By default prepared statements are unbuffered.</entry>

510

-

</row>

511

-

<row>

512

-

<entry><literal>flushed_normal_sets</literal></entry>

513

-

<entry>Connection</entry>

514

-

<entry>Number of result sets from normal (non prepared statement) queries with

515

-

unread data which have been flushed silently for you. Flushing

516

-

happens only with unbuffered result sets.</entry>

517

-

<entry>Unbuffered result sets must be fetched completely before a new query can

518

-

be run on the connection otherwise MySQL will throw an error. If

519

-

the application does not fetch all rows from an unbuffered result

520

-

set, mysqlnd does implicitly fetch the result set to clear the

521

-

line. See also <literal>rows_skipped_normal</literal>,

522

-

<literal>rows_skipped_ps</literal>. Some possible causes for an

523

-

implicit flush:

524

-

<itemizedlist>

525

-

<listitem>

526

-

<para>

527

-

Faulty client application

528

-

</para>

529

-

</listitem>

530

-

<listitem>

531

-

<para>

532

-

Client stopped reading after it found what it was looking for

533

-

but has made MySQL calculate more records than needed

534

-

</para>

535

-

</listitem>

536

-

<listitem>

537

-

<para>

538

-

Client application has stopped unexpectedly

539

-

</para>

540

-

</listitem>

541

-

</itemizedlist></entry>

542

-

</row>

543

-

<row>

544

-

<entry><literal>flushed_ps_sets</literal></entry>

545

-

<entry>Connection</entry>

546

-

<entry>Number of result sets from prepared statements with unread data which

547

-

have been flushed silently for you. Flushing happens only with

548

-

unbuffered result sets.</entry>

549

-

<entry>Unbuffered result sets must be fetched completely before a new query can

550

-

be run on the connection otherwise MySQL will throw an error. If

551

-

the application does not fetch all rows from an unbuffered result

552

-

set, mysqlnd does implicitly fetch the result set to clear the

553

-

line. See also <literal>rows_skipped_normal</literal>,

554

-

<literal>rows_skipped_ps</literal>. Some possible causes for an

555

-

implicit flush:

480

+

<literal>min_examined_row_limit</literal> rows to be examined.

481

+

</simpara>

482

+

<caution>

483

+

<simpara>

484

+

Not reported through <function>mysqli_report</function>.

485

+

</simpara>

486

+

</caution>

487

+

</listitem>

488

+

</varlistentry>

489

+

490

+

<varlistentry xml:id="mysqlnd.stats.statistics.buffered-sets">

491

+

<term><literal>buffered_sets</literal></term>

492

+

<listitem>

493

+

<simpara>

494

+

Number of buffered result sets returned by normal

495

+

(i.e. not via a prepared statement) queries.

496

+

</simpara>

497

+

<para>

498

+

Examples of API calls that will buffer result sets on the client:

499

+

<simplelist type="inline">

500

+

<member><function>mysqli_query</function></member>

501

+

<member><function>mysqli_store_result</function></member>

502

+

<member><function>mysqli_stmt_get_result</function></member>

503

+

</simplelist>

504

+

</para>

505

+

</listitem>

506

+

</varlistentry>

507

+

508

+

<varlistentry xml:id="mysqlnd.stats.statistics.unbuffered-sets">

509

+

<term><literal>unbuffered_sets</literal></term>

510

+

<listitem>

511

+

<simpara>

512

+

Number of unbuffered result sets returned by normal

513

+

(i.e. not via a prepared statement) queries.

514

+

</simpara>

515

+

<para>

516

+

Examples of API calls that will not buffer result sets on the client:

517

+

<simplelist type="inline">

518

+

<member><function>mysqli_use_result</function></member>

519

+

</simplelist>

520

+

</para>

521

+

</listitem>

522

+

</varlistentry>

523

+

524

+

<varlistentry xml:id="mysqlnd.stats.statistics.ps-buffered-sets">

525

+

<term><literal>ps_buffered_sets</literal></term>

526

+

<listitem>

527

+

<simpara>

528

+

Number of buffered result sets returned by prepared statements.

529

+

</simpara>

530

+

<para>

531

+

Examples of API calls that will buffer result sets on the client:

532

+

<simplelist type="inline">

533

+

<member><function>mysqli_stmt_store_result</function></member>

534

+

</simplelist>

535

+

</para>

536

+

</listitem>

537

+

</varlistentry>

538

+

539

+

<varlistentry xml:id="mysqlnd.stats.statistics.ps-unbuffered-sets">

540

+

<term><literal>ps_unbuffered_sets</literal></term>

541

+

<listitem>

542

+

<simpara>

543

+

Number of unbuffered result sets returned by prepared statements.

544

+

</simpara>

545

+

<simpara>

546

+

By default prepared statements are unbuffered,

547

+

thus most prepared statements will be accounted in this statistic.

548

+

</simpara>

549

+

</listitem>

550

+

</varlistentry>

551

+

552

+

<varlistentry xml:id="mysqlnd.stats.statistics.flushed-normal-sets">

553

+

<term><literal>flushed_normal_sets</literal></term>

554

+

<listitem>

555

+

<simpara>

556

+

Number of result sets returned by normal

557

+

(i.e. not via a prepared statement) queries

558

+

with unread data that have been silently flushed.

559

+

</simpara>

560

+

561

+

<note>

562

+

<simpara>

563

+

Flushing happens only with unbuffered result sets.

564

+

</simpara>

565

+

<simpara>

566

+

Unbuffered result sets must be fetched completely before a new query can

567

+

be run on the connection otherwise MySQL will throw an error.

568

+

If the application does not fetch all rows from an unbuffered result set,

569

+

mysqlnd does implicitly fetch the result set to clear the line.

570

+

</simpara>

571

+

<simpara>

572

+

See also <literal>rows_skipped_normal</literal>, <literal>rows_skipped_ps</literal>.

573

+

</simpara>

574

+

<para>

575

+

Some possible causes for an implicit flush:

576

+

<itemizedlist>

577

+

<listitem>

578

+

<simpara>

579

+

Faulty client application

580

+

</simpara>

581

+

</listitem>

582

+

<listitem>

583

+

<simpara>

584

+

Client stopped reading after it found what it was looking for

585

+

but has made MySQL calculate more records than needed

586

+

</simpara>

587

+

</listitem>

588

+

<listitem>

589

+

<simpara>

590

+

Client application has stopped unexpectedly

591

+

</simpara>

592

+

</listitem>

593

+

</itemizedlist>

594

+

</para>

595

+

</note>

596

+

</listitem>

597

+

</varlistentry>

598

+

599

+

<varlistentry xml:id="mysqlnd.stats.statistics.flushed-ps-sets">

600

+

<term><literal>flushed_ps_sets</literal></term>

601

+

<listitem>

602

+

<simpara>

603

+

Number of result sets from prepared statements

604

+

with unread data that have been silently flushed.

605

+

</simpara>

606

+

607

+

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('mysqlnd.stats.statistics.flushed-normal-sets')/db:listitem/db:note)">

608

+

<xi:fallback/>

609

+

</xi:include>

610

+

</listitem>

611

+

</varlistentry>

612

+

613

+

<varlistentry xml:id="mysqlnd.stats.statistics.ps-prepared-never-executed">

614

+

<term><literal>ps_prepared_never_executed</literal></term>

615

+

<listitem>

616

+

<simpara>

617

+

Number of statements prepared but never executed.

618

+

</simpara>

619

+

</listitem>

620

+

</varlistentry>

621

+

622

+

<varlistentry xml:id="mysqlnd.stats.statistics.ps-prepared-once-executed">

623

+

<term><literal>ps_prepared_once_executed</literal></term>

624

+

<listitem>

625

+

<simpara>

626

+

Number of prepared statements executed only once.

627

+

</simpara>

628

+

</listitem>

629

+

</varlistentry>

630

+

631

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-fetched-from-server-normal">

632

+

<term><literal>rows_fetched_from_server_normal</literal></term>

633

+

<term><literal>rows_fetched_from_server_ps</literal></term>

634

+

<listitem>

635

+

<simpara>

636

+

Total number of result set rows fetched from the server.

637

+

This includes the rows which were not read by the client but

638

+

had been implicitly fetched due to flushed unbuffered result sets.

639

+

</simpara>

640

+

<simpara>

641

+

See also <literal>packets_received_rset_row</literal>.

642

+

</simpara>

643

+

</listitem>

644

+

</varlistentry>

645

+

646

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-buffered-from-server-normal">

647

+

<term><literal>rows_buffered_from_client_normal</literal></term>

648

+

<listitem>

649

+

<simpara>

650

+

Total number of buffered rows originating from a normal query.

651

+

</simpara>

652

+

<simpara>

653

+

This is the number of rows that have been fetched from MySQL and buffered on client.

654

+

</simpara>

655

+

<para>

656

+

Examples of queries that will buffer results:

657

+

<simplelist>

658

+

<member><function>mysqli_query</function></member>

659

+

<member><function>mysqli_store_result</function></member>

660

+

</simplelist>

661

+

</para>

662

+

</listitem>

663

+

</varlistentry>

664

+

665

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-buffered-from-server-ps">

666

+

<term><literal>rows_buffered_from_server_ps</literal></term>

667

+

<listitem>

668

+

<simpara>

669

+

Same as <literal>rows_buffered_from_client_normal</literal>

670

+

but for prepared statements.

671

+

</simpara>

672

+

</listitem>

673

+

</varlistentry>

674

+

675

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-fetched-from-client-normal-buffered">

676

+

<term><literal>rows_fetched_from_client_normal_buffered</literal></term>

677

+

<listitem>

678

+

<simpara>

679

+

Total number of rows fetched by the client from a buffered result set

680

+

created by a normal query.

681

+

</simpara>

682

+

</listitem>

683

+

</varlistentry>

684

+

685

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-fetched-from-client-ps-buffered">

686

+

<term><literal>rows_fetched_from_client_ps_buffered</literal></term>

687

+

<listitem>

688

+

<simpara>

689

+

Total number of rows fetched by the client from a buffered result set

690

+

created by a prepared statement.

691

+

</simpara>

692

+

</listitem>

693

+

</varlistentry>

694

+

695

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-fetched-from-client-normal-unbuffered">

696

+

<term><literal>rows_fetched_from_client_normal_unbuffered</literal></term>

697

+

<listitem>

698

+

<simpara>

699

+

Total number of rows fetched by the client from an unbuffered result set

700

+

created by a normal query.

701

+

</simpara>

702

+

</listitem>

703

+

</varlistentry>

704

+

705

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-fetched-from-client-ps-unbuffered">

706

+

<term><literal>rows_fetched_from_client_ps_unbuffered</literal></term>

707

+

<listitem>

708

+

<simpara>

709

+

Total number of rows fetched by the client from an unbuffered result set

710

+

created by a prepared statement.

711

+

</simpara>

712

+

</listitem>

713

+

</varlistentry>

714

+

715

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-fetched-from-client-ps-cursor">

716

+

<term><literal>rows_fetched_from_client_ps_cursor</literal></term>

717

+

<listitem>

718

+

<simpara>

719

+

Total number of rows fetch by the client from a cursor created by a

720

+

prepared statement.

721

+

</simpara>

722

+

</listitem>

723

+

</varlistentry>

724

+

725

+

<!-- TODO: This seems to actually be supported, check and document -->

726

+

<varlistentry xml:id="mysqlnd.stats.statistics.rows-skipped-normal">

727

+

<term><literal>rows_skipped_normal</literal></term>

728

+

<term><literal>rows_skipped_ps</literal></term>

729

+

<listitem>

730

+

<simpara>

731

+

Reserved for future use (currently not supported).

732

+

</simpara>

733

+

</listitem>

734

+

</varlistentry>

735

+

736

+

<varlistentry xml:id="mysqlnd.stats.statistics.copy-on-write">

737

+

<term><literal>copy_on_write_saved</literal></term>

738

+

<term><literal>copy_on_write_performed</literal></term>

739

+

<listitem>

740

+

<simpara>

741

+

This is a process level scope statistic.

742

+

</simpara>

743

+

<simpara>

744

+

With mysqlnd, variables returned by the extensions point into mysqlnd

745

+

internal network result buffers.

746

+

If the data are not changed, the fetched data is kept only once in memory.

747

+

However, any modification to the data will require mysqlnd to perform

748

+

a copy-on-write operation.

749

+

</simpara>

750

+

</listitem>

751

+

</varlistentry>

752

+

753

+

<varlistentry xml:id="mysqlnd.stats.statistics.free-result">

754

+

<term><literal>explicit_free_result</literal></term>

755

+

<term><literal>implicit_free_result</literal></term>

756

+

<listitem>

757

+

<simpara>

758

+

This is a connection and process level scope statistic.

759

+

</simpara>

760

+

<simpara>

761

+

Total number of freed result sets.

762

+

</simpara>

763

+

</listitem>

764

+

</varlistentry>

765

+

766

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-null">

767

+

<term><literal>proto_text_fetched_null</literal></term>

768

+

<listitem>

769

+

<simpara>

770

+

Total number of columns of type

771

+

<literal>MYSQL_TYPE_NULL</literal>

772

+

fetched from a normal query (MySQL text protocol).

773

+

</simpara>

774

+

</listitem>

775

+

</varlistentry>

776

+

777

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-null">

778

+

<term><literal>proto_binary_fetched_null</literal></term>

779

+

<listitem>

780

+

<simpara>

781

+

Total number of columns of type

782

+

<literal>MYSQL_TYPE_NULL</literal>

783

+

fetched from a prepared statement (MySQL binary protocol).

784

+

</simpara>

785

+

</listitem>

786

+

</varlistentry>

787

+

788

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-bit">

789

+

<term><literal>proto_text_fetched_bit</literal></term>

790

+

<listitem>

791

+

<simpara>

792

+

Total number of columns of type

793

+

<literal>MYSQL_TYPE_BIT</literal>

794

+

fetched from a normal query (MySQL text protocol).

795

+

</simpara>

796

+

</listitem>

797

+

</varlistentry>

798

+

799

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-bit">

800

+

<term><literal>proto_binary_fetched_bit</literal></term>

801

+

<listitem>

802

+

<simpara>

803

+

Total number of columns of type

804

+

<literal>MYSQL_TYPE_BIT</literal>

805

+

fetched from a prepared statement (MySQL binary protocol).

806

+

</simpara>

807

+

</listitem>

808

+

</varlistentry>

809

+

810

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-tinyint">

811

+

<term><literal>proto_text_fetched_tinyint</literal></term>

812

+

<listitem>

813

+

<simpara>

814

+

Total number of columns of type

815

+

<literal>MYSQL_TYPE_TINY</literal>

816

+

fetched from a normal query (MySQL text protocol).

817

+

</simpara>

818

+

</listitem>

819

+

</varlistentry>

820

+

821

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-tinyint">

822

+

<term><literal>proto_binary_fetched_tinyint</literal></term>

823

+

<listitem>

824

+

<simpara>

825

+

Total number of columns of type

826

+

<literal>MYSQL_TYPE_TINY</literal>

827

+

fetched from a prepared statement (MySQL binary protocol).

828

+

</simpara>

829

+

</listitem>

830

+

</varlistentry>

831

+

832

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-short">

833

+

<term><literal>proto_text_fetched_short</literal></term>

834

+

<listitem>

835

+

<simpara>

836

+

Total number of columns of type

837

+

<literal>MYSQL_TYPE_SHORT</literal>

838

+

fetched from a normal query (MySQL text protocol).

839

+

</simpara>

840

+

</listitem>

841

+

</varlistentry>

842

+

843

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-short">

844

+

<term><literal>proto_binary_fetched_short</literal></term>

845

+

<listitem>

846

+

<simpara>

847

+

Total number of columns of type

848

+

<literal>MYSQL_TYPE_SHORT</literal>

849

+

fetched from a prepared statement (MySQL binary protocol).

850

+

</simpara>

851

+

</listitem>

852

+

</varlistentry>

853

+

854

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-int24">

855

+

<term><literal>proto_text_fetched_int24</literal></term>

856

+

<listitem>

857

+

<simpara>

858

+

Total number of columns of type

859

+

<literal>MYSQL_TYPE_INT24</literal>

860

+

fetched from a normal query (MySQL text protocol).

861

+

</simpara>

862

+

</listitem>

863

+

</varlistentry>

864

+

865

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-int24">

866

+

<term><literal>proto_binary_fetched_int24</literal></term>

867

+

<listitem>

868

+

<simpara>

869

+

Total number of columns of type

870

+

<literal>MYSQL_TYPE_INT24</literal>

871

+

fetched from a prepared statement (MySQL binary protocol).

872

+

</simpara>

873

+

</listitem>

874

+

</varlistentry>

875

+

876

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-int">

877

+

<term><literal>proto_text_fetched_int</literal></term>

878

+

<listitem>

879

+

<simpara>

880

+

Total number of columns of type

881

+

<literal>MYSQL_TYPE_LONG</literal>

882

+

fetched from a normal query (MySQL text protocol).

883

+

</simpara>

884

+

</listitem>

885

+

</varlistentry>

886

+

887

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-int">

888

+

<term><literal>proto_binary_fetched_int</literal></term>

889

+

<listitem>

890

+

<simpara>

891

+

Total number of columns of type

892

+

<literal>MYSQL_TYPE_LONG</literal>

893

+

fetched from a prepared statement (MySQL binary protocol).

894

+

</simpara>

895

+

</listitem>

896

+

</varlistentry>

897

+

898

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-bigint">

899

+

<term><literal>proto_text_fetched_bigint</literal></term>

900

+

<listitem>

901

+

<simpara>

902

+

Total number of columns of type

903

+

<literal>MYSQL_TYPE_LONGLONG</literal>

904

+

fetched from a normal query (MySQL text protocol).

905

+

</simpara>

906

+

</listitem>

907

+

</varlistentry>

908

+

909

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-bigint">

910

+

<term><literal>proto_binary_fetched_bigint</literal></term>

911

+

<listitem>

912

+

<simpara>

913

+

Total number of columns of type

914

+

<literal>MYSQL_TYPE_LONGLONG</literal>

915

+

fetched from a prepared statement (MySQL binary protocol).

916

+

</simpara>

917

+

</listitem>

918

+

</varlistentry>

919

+

920

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-decimal">

921

+

<term><literal>proto_text_fetched_decimal</literal></term>

922

+

<listitem>

923

+

<simpara>

924

+

Total number of columns of type

925

+

<literal>MYSQL_TYPE_DECIMAL</literal>, or <literal>MYSQL_TYPE_NEWDECIMAL</literal>

926

+

fetched from a normal query (MySQL text protocol).

927

+

</simpara>

928

+

</listitem>

929

+

</varlistentry>

930

+

931

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-decimal">

932

+

<term><literal>proto_binary_fetched_decimal</literal></term>

933

+

<listitem>

934

+

<simpara>

935

+

Total number of columns of type

936

+

<literal>MYSQL_TYPE_DECIMAL</literal>, or <literal>MYSQL_TYPE_NEWDECIMAL</literal>

937

+

fetched from a prepared statement (MySQL binary protocol).

938

+

</simpara>

939

+

</listitem>

940

+

</varlistentry>

941

+

942

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-float">

943

+

<term><literal>proto_text_fetched_float</literal></term>

944

+

<listitem>

945

+

<simpara>

946

+

Total number of columns of type

947

+

<literal>MYSQL_TYPE_FLOAT</literal>

948

+

fetched from a normal query (MySQL text protocol).

949

+

</simpara>

950

+

</listitem>

951

+

</varlistentry>

952

+

953

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-float">

954

+

<term><literal>proto_binary_fetched_float</literal></term>

955

+

<listitem>

956

+

<simpara>

957

+

Total number of columns of type

958

+

<literal>MYSQL_TYPE_FLOAT</literal>

959

+

fetched from a prepared statement (MySQL binary protocol).

960

+

</simpara>

961

+

</listitem>

962

+

</varlistentry>

963

+

964

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-double">

965

+

<term><literal>proto_text_fetched_double</literal></term>

966

+

<listitem>

967

+

<simpara>

968

+

Total number of columns of type

969

+

<literal>MYSQL_TYPE_DOUBLE</literal>

970

+

fetched from a normal query (MySQL text protocol).

971

+

</simpara>

972

+

</listitem>

973

+

</varlistentry>

974

+

975

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-double">

976

+

<term><literal>proto_binary_fetched_double</literal></term>

977

+

<listitem>

978

+

<simpara>

979

+

Total number of columns of type

980

+

<literal>MYSQL_TYPE_DOUBLE</literal>

981

+

fetched from a prepared statement (MySQL binary protocol).

982

+

</simpara>

983

+

</listitem>

984

+

</varlistentry>

985

+

986

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-date">

987

+

<term><literal>proto_text_fetched_date</literal></term>

988

+

<listitem>

989

+

<simpara>

990

+

Total number of columns of type

991

+

<literal>MYSQL_TYPE_DATE</literal>, or <literal>MYSQL_TYPE_NEWDATE</literal>

992

+

fetched from a normal query (MySQL text protocol).

993

+

</simpara>

994

+

</listitem>

995

+

</varlistentry>

996

+

997

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-date">

998

+

<term><literal>proto_binary_fetched_date</literal></term>

999

+

<listitem>

1000

+

<simpara>

1001

+

Total number of columns of type

1002

+

<literal>MYSQL_TYPE_DATE</literal>, or <literal>MYSQL_TYPE_NEWDATE</literal>

1003

+

fetched from a prepared statement (MySQL binary protocol).

1004

+

</simpara>

1005

+

</listitem>

1006

+

</varlistentry>

1007

+

1008

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-year">

1009

+

<term><literal>proto_text_fetched_year</literal></term>

1010

+

<listitem>

1011

+

<simpara>

1012

+

Total number of columns of type

1013

+

<literal>MYSQL_TYPE_YEAR</literal>

1014

+

fetched from a normal query (MySQL text protocol).

1015

+

</simpara>

1016

+

</listitem>

1017

+

</varlistentry>

1018

+

1019

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-year">

1020

+

<term><literal>proto_binary_fetched_year</literal></term>

1021

+

<listitem>

1022

+

<simpara>

1023

+

Total number of columns of type

1024

+

<literal>MYSQL_TYPE_YEAR</literal>

1025

+

fetched from a prepared statement (MySQL binary protocol).

1026

+

</simpara>

1027

+

</listitem>

1028

+

</varlistentry>

1029

+

1030

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-text-fetched-time">

1031

+

<term><literal>proto_text_fetched_time</literal></term>

1032

+

<listitem>

1033

+

<simpara>

1034

+

Total number of columns of type

1035

+

<literal>MYSQL_TYPE_TIME</literal>

1036

+

fetched from a normal query (MySQL text protocol).

1037

+

</simpara>

1038

+

</listitem>

1039

+

</varlistentry>

1040

+

1041

+

<varlistentry xml:id="mysqlnd.stats.statistics.proto-binary-fetched-time">

1042

+

<term><literal>proto_binary_fetched_time</literal></term>

1043

+

<listitem>

1044

+

<simpara>

1045

+

Total number of columns of type

1046

+

<literal>MYSQL_TYPE_TIME</literal>

1047

+

fetched from a prepared statement (MySQL binary protocol).

1048

+

</simpara>

1049

+

</listitem>

1050

+