Skip to content

Commit 6a04277

Browse files
committed
1.0.2: README.md update
1 parent a7a762a commit 6a04277

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# gulp-etl-mysql-adapter #
22

3-
This plugin connects to **MySQL** databases, running SQL queries and extracting the resulting rows to **gulp-etl** **Message Stream** files via its **.src()** function. In the future it will also have **.dest()** which writes data to the database. It is a **gulp-etl** wrapper for [mysql](https://www.npmjs.com/package/mysql).
3+
This plugin connects to **MySQL** databases, running SQL queries and extracting the resulting rows to **gulp-etl** **Message Stream** JSON files via its **.src()** function. In the future it will also have **.dest()** which writes data to the database. It is a **gulp-etl** wrapper for [mysql](https://www.npmjs.com/package/mysql).
44

55
This is a **[gulp-etl](https://gulpetl.com/)** adapter, but unlike most of the other gulp-etl modules it is not a [gulp](https://gulpjs.com/) **[plugin](https://gulpjs.com/docs/en/getting-started/using-plugins)**; it is actually a **[vinyl adapter](https://gulpjs.com/docs/en/api/concepts#vinyl-adapters)**--it features a replacement for **[gulp.src()](https://gulpjs.com/docs/en/api/src)** (and soon **[gulp.dest()](https://gulpjs.com/docs/en/api/dest)** as well). **gulp-etl** plugins and adapters work with [ndjson](http://ndjson.org/) data streams/files which we call **Message Streams** and which are compliant with the [Singer specification](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md#output). In the **gulp-etl** ecosystem, **taps** tap into an outside format or system (in this case, a MySQL database) and convert their contents/output to a Message Stream, **targets** convert/output Message Streams to an outside format or system, and **adapters** may do both (functioning as a both a tap and a target). These modules can then be stacked together to convert from one format or system to another, either directly or with tranformations or other parsing in between. Message Streams look like this:
66

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "gulp-etl-mysql-adapter",
3-
"version": "1.0.1",
4-
"repository": "https://github.com/gulpetl/gulp-etl-tap-mysql",
3+
"version": "1.0.2",
4+
"repository": "https://github.com/gulpetl/gulp-etl-mysql-adapter",
55
"description": "Extract data from mysql into gulp-etl Message Stream JSON",
66
"main": "dist/js/plugin.js",
77
"typings": "dist/types/plugin.d.ts",

0 commit comments

Comments
 (0)