Skip to content

Commit

Permalink
update meta files
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul M. Jones committed May 7, 2018
1 parent f004e69 commit abc27ed
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 26 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
6 changes: 4 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 0 additions & 4 deletions docs/index.md

This file was deleted.

7 changes: 0 additions & 7 deletions src/Exception.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit abc27ed

Please sign in to comment.