From abc27ed9a3f6eae055a1737c03b3fbb86b9763ef Mon Sep 17 00:00:00 2001 From: "Paul M. Jones" Date: Mon, 7 May 2018 07:42:19 -0500 Subject: [PATCH] update meta files --- CHANGELOG.md | 10 ++++++++++ README.md | 14 +------------- composer.json | 6 ++++-- docs/index.md | 4 ---- src/Exception.php | 7 ------- 5 files changed, 15 insertions(+), 26 deletions(-) delete mode 100644 docs/index.md diff --git a/CHANGELOG.md b/CHANGELOG.md index ce394e9..dc7dcf2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,16 @@ First stable release. +This package is a descendant of [Aura.Sql](https://github.com/auraphp/Aura.Sql). The Atlas.Pdo _Connection_ differs from the Aura.Sql _ExtendedPdo_ object in significant ways: + +- The _Connection_ does not extend PDO; it cannot fulfill a PDO typehint, though it does proxy method calls to the decorated PDO instance. + +- The _Connection_ does not rebuild the query statements to allow for array binding and repeated placeholders. That kind of work is now left to other Atlas packages. + +- The _Connection_ object is not lazy-loading; creating a _Connection_ actually opens a database connection. Lazy-loading is now in the province of the _ConnectionLocator_. + +- The _ConnectionLocator_ `getRead()` and `getWrite()` methods no longer take a `$name` argument. They will always return the first read or write connection opened with the locator (or the default connection if there are no factories for read or write connections). To get a named connection for a connection type, use the `get()` method. + ## 1.0.0-beta1 This is a hygiene release to update the documentation. diff --git a/README.md b/README.md index d7ace02..a64073d 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,4 @@ This package provides a _Connection_ that decorates any [PDO](http://php.net/PDO This package also provides a _ConnectionLocator_ to register, instantiate, and retain named _Connection_ objects for default, read (slave), and write (master) databases. -Read the documentation [here](./docs/index.md). - -## Lineage - -This package is a descendant of [Aura.Sql](https://github.com/auraphp/Aura.Sql). The Atlas.Pdo _Connection_ differs from the Aura.Sql _ExtendedPdo_ object in significant ways: - -- The _Connection_ does not extend PDO; it cannot fulfill a PDO typehint, though it does proxy method calls to the decorated PDO instance. - -- The _Connection_ does not rebuild the query statements to allow for array binding and repeated placeholders. That kind of work is now left to other Atlas packages. - -- The _Connection_ object is not lazy-loading; creating a _Connection_ actually opens a database connection. Lazy-loading is now in the province of the _ConnectionLocator_. - -- The _ConnectionLocator_ `getRead()` and `getWrite()` methods no longer take a `$name` argument. They will always return the first read or write connection opened with the locator (or the default connection if there are no factories for read or write connections). To get a named connection for a connection type, use the `get()` method. +Read the documentation [here](http://atlasphp.io/cassini/pdo/). diff --git a/composer.json b/composer.json index b49d9c8..170330e 100644 --- a/composer.json +++ b/composer.json @@ -1,10 +1,12 @@ { "name": "atlas/pdo", "type": "library", - "description": "An extension for Atlas PDO connections.", + "description": "Provides a PDO instance decorator with convenience methods, and a connection manager.", "keywords": [ "pdo", - "sql" + "sql", + "database", + "connection" ], "homepage": "https://github.com/atlasphp/Atlas.Pdo", "license": "MIT", diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index f526cb9..0000000 --- a/docs/index.md +++ /dev/null @@ -1,4 +0,0 @@ -# Atlas.Pdo Documentation - -1. [Connection](./connection.md) -2. [Connection Locator](./connection-locator.md) diff --git a/src/Exception.php b/src/Exception.php index 52cb9ab..bb2923d 100644 --- a/src/Exception.php +++ b/src/Exception.php @@ -10,13 +10,6 @@ namespace Atlas\Pdo; -/** - * - * Base Exception class for Aura Sql - * - * @package atlas/pdo - * - */ class Exception extends \Exception { public static function connectionNotFound($type, $name)