You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
# MariaDB Node.js connector
8
8
9
9
[![npm package][npm-image]][npm-url]
10
-
[![Test Build][travis-image]][travis-url]
10
+
[![CI Tests][ci-image]][ci-url]
11
11
[![License (LGPL version 2.1)][licence-image]][licence-url]
12
12
[![codecov][codecov-image]][codecov-url]
13
13
@@ -18,13 +18,13 @@ MariaDB and MySQL client, 100% JavaScript, with TypeScript definition, with the
18
18
19
19
## Documentation
20
20
21
-
See [promise documentation](https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/master/documentation/promise-api.md) for detailed API.
21
+
See [promise documentation](https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/master/documentation/promise-api.md) for detailed API.
22
22
23
23
[Callback documentation](https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/master/documentation/callback-api.md) describe the callback wrapper for compatibility with existing drivers.
24
24
25
25
See [dedicated part](https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/master/documentation/promise-api.md#migrating-from-2x-or-mysqlmysql2-to-3x) for migration from mysql/mysql2 or from 2.x version.
26
26
27
-
27
+
28
28
## Why a New Client?
29
29
30
30
While there are existing MySQL clients that work with MariaDB, (such as the [`mysql`](https://www.npmjs.com/package/mysql) and [`mysql2`](https://www.npmjs.com/package/mysql2) clients), the MariaDB Node.js Connector offers new functionality, like [Insert Streaming](#insert-streaming), [Pipelining](#pipelining), [ed25519 plugin authentication](https://mariadb.org/history-of-mysql-mariadb-authentication-protocols/) while making no compromises on performance.
@@ -41,7 +41,7 @@ Connector is production grade quality, with multiple features:
41
41
42
42
see some of those features:
43
43
44
-
### Insert Streaming
44
+
### Insert Streaming
45
45
46
46
Using a Readable stream in your application, you can stream `INSERT` statements to MariaDB through the Connector.
47
47
@@ -52,7 +52,7 @@ Using a Readable stream in your application, you can stream `INSERT` statements
52
52
connection.query("INSERT INTO myTable VALUE (?)", [readableStream]);
53
53
});
54
54
```
55
-
55
+
56
56
### Pipelining
57
57
58
58
With Pipelining, the Connector sends commands without waiting for server results, preserving order. For instance, consider the use of executing two `INSERT` statements.
@@ -64,7 +64,7 @@ With Pipelining, the Connector sends commands without waiting for server results
64
64
The Connector doesn't wait for query results before sending the next `INSERT` statement. Instead, it sends queries one after the other, avoiding much of the network latency.
65
65
66
66
For more information, see the [Pipelining](/documentation/pipelining.md) documentation.
67
-
67
+
68
68
### Bulk insert
69
69
70
70
Some use cases require a large amount of data to be inserted into a database table. By using batch processing, these queries can be sent to the database in one call, thus improving performance.
@@ -74,7 +74,7 @@ For more information, see the [Batch](/documentation/batch.md) documentation.
74
74
75
75
## Benchmarks
76
76
77
-
MariaDB provides benchmarks comparing the Connector with other Node.js MariaDB/MySQL clients, including:
77
+
MariaDB provides benchmarks comparing the Connector with other Node.js MariaDB/MySQL clients, including:
78
78
79
79
*[`promise-mysql`](https://www.npmjs.com/package/promise-mysql) version 5.2.0 + [`mysql`](https://www.npmjs.com/package/mysql) version 2.18.1
80
80
*[`mysql2`](https://www.npmjs.com/package/mysql2) version 3.1.0
@@ -139,15 +139,15 @@ A big thanks to all contributors
0 commit comments