Skip to content
This repository was archived by the owner on Jul 7, 2022. It is now read-only.

Commit 649b42a

Browse files
committed
Extract info from #7
1 parent cf8b4a1 commit 649b42a

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@
55

66
A utility for parsing and generating service DSNs
77

8+
## What is a DSN?
9+
10+
A [data source name](http://en.wikipedia.org/wiki/Data_source_name) (DSN) is a string which defines how to connect to a service. Since it's a string, it's portable, not language or implementation dependent and anything capable of parsing it can know how to connect to the service it points at.
11+
12+
## What does this repo do?
13+
14+
This repo only provides a means of converting a DSN string into an array and vice versa.
15+
16+
## Wrapper classes?
17+
18+
When using a wrapper class, this repo provides an array _in the format expected_ by a particular consumer. So for example, the CakePHP wrapper classes provide arrays in the format the framework understands for a given DSN string.
19+
820
## Basic usage
921

1022
The main dsn class implements a parse function which returns a dsn instance:
@@ -46,10 +58,6 @@ In all of the above cases, the returned instance is the "raw" dsn data:
4658

4759
If the behavior of the raw dsn needs to be modified - use a wrapper implementation
4860

49-
## Dsn Wrapper classes
50-
51-
Wrapper classes allow developers to adapt a dsn to their own specific usage.
52-
5361
## References
5462

5563
[12 factor applications][1]

0 commit comments

Comments
 (0)