Skip to content

Commit

Permalink
1.0.2: README.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
donpedro committed Jun 29, 2019
1 parent a7a762a commit 6a04277
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# gulp-etl-mysql-adapter #

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).
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).

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:

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "gulp-etl-mysql-adapter",
"version": "1.0.1",
"repository": "https://github.com/gulpetl/gulp-etl-tap-mysql",
"version": "1.0.2",
"repository": "https://github.com/gulpetl/gulp-etl-mysql-adapter",
"description": "Extract data from mysql into gulp-etl Message Stream JSON",
"main": "dist/js/plugin.js",
"typings": "dist/types/plugin.d.ts",
Expand Down

0 comments on commit 6a04277

Please sign in to comment.