Skip to content

Commit 5fc7d5c

Browse files
committed
chore: add ResultSetHeader examples
1 parent c21f9bf commit 5fc7d5c

File tree

1 file changed

+99
-9
lines changed

1 file changed

+99
-9
lines changed

documentation/en/TypeScript-Examples.md

Lines changed: 99 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,19 @@ const conn = mysql.createPool(access);
4444
```
4545

4646
## Query and Execute
47-
### A simple SELECT
47+
### A simple query
4848
```ts
4949
conn.query('SELECT 1 + 1 AS `test`;', (_err, rows) => {
5050
/**
5151
* @rows: [ { test: 2 } ]
5252
*/
5353
});
54+
55+
conn.execute('SELECT 1 + 1 AS `test`;', (_err, rows) => {
56+
/**
57+
* @rows: [ { test: 2 } ]
58+
*/
59+
});
5460
```
5561

5662
The `rows` output will be these possible types:
@@ -76,18 +82,27 @@ const conn = mysql.createConnection({
7682
database: 'test',
7783
});
7884

85+
/** SELECT */
7986
conn.query<RowDataPacket[]>('SELECT 1 + 1 AS `test`;', (_err, rows) => {
8087
console.log(rows);
8188
/**
8289
* @rows: [ { test: 2 } ]
8390
*/
8491
});
92+
93+
/** SHOW */
94+
conn.query<RowDataPacket[]>('SHOW TABLES FROM `test`;', (_err, rows) => {
95+
console.log(rows);
96+
/**
97+
* @rows: [ { Tables_in_test: 'test' } ]
98+
*/
99+
});
85100
```
86101

87102
---
88103

89104
#### RowDataPacket[][]
90-
- `rowsAsArray`
105+
- When `rowsAsArray` option is `true`
91106
```ts
92107
import mysql, { RowDataPacket } from 'mysql2';
93108

@@ -107,9 +122,16 @@ conn.query<RowDataPacket[]>('SELECT 1 + 1 AS `test`;', (_err, rows) => {
107122
* @rows: [ [ 2, 4 ] ]
108123
*/
109124
});
125+
126+
conn.query<RowDataPacket[][]>(sql, (_err, rows) => {
127+
console.log(rows);
128+
/**
129+
* @rows: [ [ 'test' ] ]
130+
*/
131+
});
110132
```
111133

112-
- `multipleStatements` with multiple queries
134+
- When `multipleStatements` is `true` with multiple queries
113135
```ts
114136
import mysql, { RowDataPacket } from 'mysql2';
115137

@@ -132,16 +154,84 @@ conn.query<RowDataPacket[]>('SELECT 1 + 1 AS `test`;', (_err, rows) => {
132154
});
133155
```
134156

157+
---
158+
135159
#### ResultSetHeader
136-
> In progress
160+
For `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, etc.
161+
```ts
162+
import mysql, { ResultSetHeader } from 'mysql2';
137163

138-
#### ProcedureCallPacket
139-
> In progress
164+
const conn = mysql.createConnection({
165+
user: 'test',
166+
database: 'test',
167+
});
140168

141-
#### OkPacket
142-
> In progress
169+
const sql = `
170+
SET @1 = 1;
171+
`;
172+
173+
conn.query<ResultSetHeader>(sql, (_err, result) => {
174+
console.log(result);
175+
/**
176+
* @result: ResultSetHeader {
177+
fieldCount: 0,
178+
affectedRows: 0,
179+
insertId: 0,
180+
info: '',
181+
serverStatus: 2,
182+
warningStatus: 0
183+
}
184+
*/
185+
});
186+
```
187+
188+
---
189+
190+
#### ResultSetHeader[]
191+
> Needs to be fixed ⚠️
192+
193+
For multiples `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, etc. when using `multipleStatements`
194+
195+
```ts
196+
import mysql, { ResultSetHeader } from 'mysql2';
143197

144-
#### OkPacket[]
198+
const conn = mysql.createConnection({
199+
user: 'test',
200+
database: 'test',
201+
multipleStatements: true,
202+
});
203+
204+
const sql = `
205+
SET @1 = 1;
206+
SET @2 = 2;
207+
`;
208+
209+
conn.query<ResultSetHeader[]>(sql, (_err, result) => {
210+
console.log(result);
211+
/**
212+
* @result: [
213+
ResultSetHeader {
214+
fieldCount: 0,
215+
affectedRows: 0,
216+
insertId: 0,
217+
info: '',
218+
serverStatus: 10,
219+
warningStatus: 0
220+
},
221+
ResultSetHeader {
222+
fieldCount: 0,
223+
affectedRows: 0,
224+
insertId: 0,
225+
info: '',
226+
serverStatus: 2,
227+
warningStatus: 0
228+
}
229+
]
230+
*/
231+
});
232+
```
233+
234+
#### ProcedureCallPacket
145235
> In progress
146236
147237
---

0 commit comments

Comments
 (0)