8b3d9fe · typeable/postgresql-simple

git.iko.soy/typeable/postgresql-simple

Documentation reorganization

I myself am not too enthusiastic about connect and ConnectInfo, so I de-emphasized them in the ordering. Although, it might be nice to add escaping support for constructing your own query strings.

commit8b3d9fe882c8b88ba180ee21b577c4a9dcb293e4 authorLeon P Smith <leon@melding-monads.com> dateWed 4 Jun 2014, 06:29 (12 years ago) parentc1f76b2

2 files changed+7−7

compare with master

unifiedsplit

src/Database/PostgreSQL/Simple.hs+5−5 src/Database/PostgreSQL/Simple/Internal.hs+2−2

src/Database/PostgreSQL/Simple.hs+5−5

@@ -55,8 +55,7 @@ module Database.PostgreSQL.Simple

5555 -- $types

5656

5757 -- * Types

58− Base.ConnectInfo(..)

59− , Connection

58+ Connection

6059 , Query

6160 , ToRow

6261 , FromRow

@@ -71,11 +70,12 @@ module Database.PostgreSQL.Simple

7170 , QueryError(qeMessage, qeQuery)

7271 , ResultError(errSQLType, errHaskellType, errMessage)

7372 -- * Connection management

74− , Base.connect

7573 , Base.connectPostgreSQL

76− , Base.postgreSQLConnectionString

77− , Base.defaultConnectInfo

7874 , Base.close

75+ , Base.connect

76+ , Base.ConnectInfo(..)

77+ , Base.defaultConnectInfo

78+ , Base.postgreSQLConnectionString

7979 -- * Queries that return results

8080 , query

8181 , query_

src/Database/PostgreSQL/Simple/Internal.hs+2−2

@@ -157,7 +157,7 @@ connect = connectPostgreSQL . postgreSQLConnectionString

157157-- This attempts to connect to database named @postgres@ with

158158-- user @postgres@ and password @secret \' \\ pw@. Backslash

159159-- characters will have to be double-quoted in literal Haskell strings,

160−-- of course. Omitting @dbname@ and @user@ with both default to the

160+-- of course. Omitting @dbname@ and @user@ will both default to the

161161-- system username that the client process is running as.

162162--

163163-- Omitting @password@ will default to an appropriate password found

@@ -175,7 +175,7 @@ connect = connectPostgreSQL . postgreSQLConnectionString

175175-- database user, and database sharing a common name, with permissions

176176-- granted to the user on the database.

177177--

178−-- On Windows, in addition you will either need the @pg_hba.conf@

178+-- On Windows, in addition you will either need @pg_hba.conf@

179179-- to specify the use the @trust@ authentication method for the

180180-- the connection, which may not be appropriate for multiuser

181181-- or production machines, or you will need to use a @pgpass@ file