Add query extractor

leomarquine · Sep 13, 2018 · eee8c52 · eee8c52
1 parent d56153f
commit eee8c52
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/docs/Extractors/Query.md b/docs/Extractors/Query.md
@@ -0,0 +1,28 @@
+# Query Extractor
+
+Extracts data from a database table using a custom SQL query.
+
+## Options
+
+| Name | Type | Default | Description |
+| ---- |----- | ------- | ----------- |
+| connection | string | default | Name of the database connection to use. |
+| bindings | array | `[]` | Values to bind to the query statement. |
+
+
+## Usage
+
+Default options:
+```php
+$etl->extract('query', 'select * from users');
+```
+
+Custom options:
+```php
+$options = [
+    'connection' => 'app',
+    'bindings' => ['active'],
+];
+
+$etl->extract('query', 'select * from users where status = ?', $options);
+```
diff --git a/docs/Extractors/README.md b/docs/Extractors/README.md
@@ -4,3 +4,4 @@
 * [CSV](Csv.md)
 * [Fixed Width](FixedWidth.md)
 * [JSON](Json.md)
+* [Query](Query.md)
diff --git a/docs/README.md b/docs/README.md
@@ -5,3 +5,4 @@
     * [CSV](Extractors/Csv.md)
     * [Fixed Width](Extractors/FixedWidth.md)
     * [JSON](Extractors/Json.md)
+    * [Query](Extractors/Query.md)