Adjust Documentation

byjg · Nov 17, 2018 · d9c926f · d9c926f
1 parent fb487a3
commit d9c926f
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 678 deletions.
diff --git a/README.md b/README.md
@@ -6,11 +6,15 @@
 
 ## Description
 
-A data abstraction layer in PHP to manipulate any set of data with a standardized interface from any data source.
+Anydataset Core Module. Anydataset is an agnostic data source abstraction layer in PHP. 
 
 ## Features
 
-### Read an write* with a number of data sources accessed by a standardized interface ([see more here](docs/Connecting-to-Data-Sources.md)):
+- Access different data sources using the same interface. 
+- Iterable results
+- Convert results to array
+
+## Current Implementations
 
 * Array
 * Relational Databases (based on PDO - Sqlite, MySql, Postgres, Sql Server, Oracle, and others)
@@ -24,187 +28,48 @@ A data abstraction layer in PHP to manipulate any set of data with a standardize
 * Amazon Aws S3
 * SparQL
 
-## Examples
 
-### Querying Datasets (Text, Xml, Json, Sockets, Array, etc)
+## Examples
 
-The easiest way to work is to get an repository and get an iterator for navigate throught the data.
+### Iterating with foreach 
 
 ```php
 <?php
-$repository = new \ByJG\AnyDataset\Core\TextFileDataset(
-    'myfile',
-    ['field1', 'field2', 'field3'],
-    \ByJG\AnyDataset\Core\TextFileDataset::CSVFILE
-);
-$iterator = $repository->getIterator();
-
-// and then:
+$dataset = new \ByJG\AnyDataset\Core\AnyDataset("example");
+
+$iterator = $dataset->getIterator();
 foreach ($iterator as $row) {
-    echo $row->get('field1');  // or $row->toArray();
+    print $row->toArray();
 }
-
-// Or 
-print_r($iterator->toArray());
 ```
 
-### Querying Relational Databases
+### Filtering results
 
 ```php
 <?php
-$dbDriver = \ByJG\AnyDataset\Factory::getDbRelationalInstance('mysql://username:password@host/database');
-$iterator = $dbDriver->getIterator('select * from table where field = :param', ['param' => 'value']);
+$filter = new \ByJG\AnyDataset\Core\IteratorFilter();
+$filter->addRelation("field1", \ByJG\AnyDataset\Core\Enum\Relation::EQUAL, 10);
+$iterator2 = $dataset->getIterator($filter);
 ```
 
-### Cache results
-
-You can easily cache your results with the DbCached class; You need to add to your project an
-implementation of PSR-6. We suggested you add "byjg/cache".
+### Conveting to Array
 
 ```php
 <?php
-$dbDriver = \ByJG\AnyDataset\Factory::getDbRelationalInstance('mysql://username:password@host/database');
-$dbCached = new \ByJG\AnyDataset\Store\DbCached($dbDriver, $psrCacheEngine, 30);
-
-// Use the DbCached instance instead the DbDriver
-$iterator = $dbCached->getIterator('select * from table where field = :param', ['param' => 'value']);
-```
-
-### Connection based on URI
-
-The connection string for databases is based on URL. 
-
-See below the current implemented drivers:
-
-| Database      | Connection String                                     | Factory
-| ------------- | ----------------------------------------------------- | -------------------------  |
-| Sqlite        | sqlite:///path/to/file                                | getDbRelationalInstance()  |
-| MySql/MariaDb | mysql://username:password@hostname:port/database      | getDbRelationalInstance()  |
-| Postgres      | psql://username:password@hostname:port/database       | getDbRelationalInstance()  |
-| Sql Server    | dblib://username:password@hostname:port/database      | getDbRelationalInstance()  |
-| Oracle (OCI)  | oci://username:password@hostname:port/database        | getDbRelationalInstance()  |
-| Oracle (OCI8) | oci8://username:password@hostname:port/database       | getDbRelationalInstance()  |
-| MongoDB       | mongodb://username:passwortd@host:port/database       | getNoSqlInstance()         |
-| Amazon S3     | s3://key:secret@region/bucket                         | getKeyValueInstance()      |
-
-
-### Querying Non-Relational Databases
-
-```php
-<?php
-// Get a document
-$dbDriver = \ByJG\AnyDataset\Factory::getNoSqlInstance('mongodb://host');
-$document = $dbDriver->getDocumentById('iddcouemnt');
-
-// Update some fields in there
-$data = $document->getDocument();
-$data['some_field'] = 'some_value';
-$document->setDocument($data);
-
-// Save the document
-$dbDriver->save($document);
-```
-
-### Querying Key/Value Databases
-
-```php
-<?php
-// Get a document
-$dbDriver = \ByJG\AnyDataset\Factory::getKeyValueInstance('s3://awsid:secret@region');
-$file = $dbDriver->get('key');
-
-// Save the document
-$dbDriver->put('key', file_get_contents('/path/to/file'));
-
-// Delete the document
-$dbDriver->remove('key');
+$iterator = $dataset->getIterator();
+print_r($iterator->toArray());
 ```
 
-
-
-### Load balance and connection pooling 
-
-The API have support for connection load balancing, connection pooling and persistent connection.
-
-There is the Route class an DbDriverInterface implementation with route capabilities. Basically you have to define 
-the routes and the system will choose the proper DbDriver based on your route definition.
-
-Example:
-
-```php
-<?php
-$dbDriver = new \ByJG\AnyDataset\Store\Route();
-
-// Define the available connections (even different databases)
-$dbDriver
-    ->addDbDriverInterface('route1', 'sqlite:///tmp/a.db')
-    ->addDbDriverInterface('route2', 'sqlite:///tmp/b.db')
-    ->addDbDriverInterface('route3', 'sqlite:///tmp/c.db')
-;
-
-// Define the route
-$dbDriver
-    ->addRouteForWrite('route1')
-    ->addRouteForRead('route2', 'mytable')
-    ->addRouteForRead('route3')
-;
-
-// Query the database
-$iterator = $dbDriver->getIterator('select * from mytable'); // Will select route2
-$iterator = $dbDriver->getIterator('select * from othertable'); // Will select route3
-$dbDriver->execute('insert into table (a) values (1)'); // Will select route1;
-```  
-
-### And more
-
-And more...
-
-
 ## Install
 
-Just type: `composer require "byjg/anydataset=3.0.*"`
+Just type: `composer require "byjg/anydataset=4.0.*"`
 
 #### Running Unit tests
 
 Running the Unit tests
 
 ```php
-phpunit
-```
-
-#### Running database tests
-
-Run integration tests require you to have the databases up e run with the follow configuration
-
-The easiest way to run the tests is:
-
-**Prepare the environment**
-
-```php
-npm i
-node_modules/.bin/usdocker --refresh
-node_modules/.bin/usdocker -v --no-link mssql up
-node_modules/.bin/usdocker -v --no-link mysql up
-node_modules/.bin/usdocker -v --no-link postgres up
-node_modules/.bin/usdocker -v --no-link mongodb up
-```
-
-**Run the tests**
-
-
-```
-phpunit testsdb/PdoMySqlTest.php 
-phpunit testsdb/PdoSqliteTest.php 
-phpunit testsdb/PdoPostgresTest.php 
-phpunit testsdb/PdoDblibTest.php 
-phpunit testsdb/MongoDbDriverTest.php 
-```
-
-Optionally you can set the password for Mysql and PostgresSQL
-
-```bash
-export MYSQL_PASSWORD=newpassword    # use '.' if want have a null password
-export PSQL_PASSWORD=newpassword     # use '.' if want have a null password
+vendor/bin/phpunit
 ```
 
 ----

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
   "name": "byjg/anydataset",
-  "description": "A data abstraction layer in PHP for access read and write Relational Databases, No Sql, Text, Xml, Json, SparQl and others",
+  "description": "Anydataset is an agnostic data source abstraction layer in PHP. Core Module.",
   "authors": [
     {
       "name": "João Gilberto Magalhães",

diff --git a/docs/Connecting-to-Data-Sources.md b/docs/Connecting-to-Data-Sources.md
diff --git a/docs/Connecting-to-MongoDB.md b/docs/Connecting-to-MongoDB.md
diff --git a/docs/Connecting-to-MySQL-via-SSL.md b/docs/Connecting-to-MySQL-via-SSL.md