db: improved listing of db/base exports in docs
This commit is contained in:
parent
82896bfce2
commit
93222d4fba
|
@ -9,13 +9,13 @@
|
||||||
|
|
||||||
@title[#:tag "connect"]{Connections}
|
@title[#:tag "connect"]{Connections}
|
||||||
|
|
||||||
@(declare-exporting db)
|
|
||||||
|
|
||||||
This section describes functions for creating connections as well as
|
This section describes functions for creating connections as well as
|
||||||
administrative functions for managing connections.
|
administrative functions for managing connections.
|
||||||
|
|
||||||
@section[#:tag "creating-connections"]{Base Connections}
|
@section[#:tag "creating-connections"]{Base Connections}
|
||||||
|
|
||||||
|
@declare-exporting[db]
|
||||||
|
|
||||||
Base connections are made using the following functions.
|
Base connections are made using the following functions.
|
||||||
|
|
||||||
@defproc[(postgresql-connect [#:user user string?]
|
@defproc[(postgresql-connect [#:user user string?]
|
||||||
|
@ -304,6 +304,8 @@ Base connections are made using the following functions.
|
||||||
|
|
||||||
@section{Connection Pooling}
|
@section{Connection Pooling}
|
||||||
|
|
||||||
|
@declare-exporting[db db/base]
|
||||||
|
|
||||||
Creating a database connection can be a costly operation; it may
|
Creating a database connection can be a costly operation; it may
|
||||||
involve steps such as process creation and SSL negotiation. A
|
involve steps such as process creation and SSL negotiation. A
|
||||||
@deftech{connection pool} helps reduce connection costs by reusing
|
@deftech{connection pool} helps reduce connection costs by reusing
|
||||||
|
@ -379,6 +381,8 @@ a transaction, the transaction is rolled back.
|
||||||
|
|
||||||
@section{Virtual Connections}
|
@section{Virtual Connections}
|
||||||
|
|
||||||
|
@declare-exporting[db db/base]
|
||||||
|
|
||||||
A @deftech{virtual connection} creates actual connections on demand and
|
A @deftech{virtual connection} creates actual connections on demand and
|
||||||
automatically releases them when they are no longer needed.
|
automatically releases them when they are no longer needed.
|
||||||
|
|
||||||
|
@ -468,6 +472,8 @@ execute parameterized queries expressed as strings or encapsulated via
|
||||||
|
|
||||||
@section[#:tag "kill-safe"]{Kill-safe Connections}
|
@section[#:tag "kill-safe"]{Kill-safe Connections}
|
||||||
|
|
||||||
|
@declare-exporting[db db/base]
|
||||||
|
|
||||||
@defproc[(kill-safe-connection [c connection?])
|
@defproc[(kill-safe-connection [c connection?])
|
||||||
connection?]{
|
connection?]{
|
||||||
|
|
||||||
|
@ -486,6 +492,8 @@ shutting down its ports.
|
||||||
|
|
||||||
@section{Data Source Names}
|
@section{Data Source Names}
|
||||||
|
|
||||||
|
@declare-exporting[db db/base]
|
||||||
|
|
||||||
A DSN (data source name) is a symbol associated with a connection
|
A DSN (data source name) is a symbol associated with a connection
|
||||||
specification in a DSN file. They are inspired by, but distinct from,
|
specification in a DSN file. They are inspired by, but distinct from,
|
||||||
ODBC's DSNs.
|
ODBC's DSNs.
|
||||||
|
@ -623,6 +631,8 @@ ODBC's DSNs.
|
||||||
|
|
||||||
@section[#:tag "managing-connections"]{Mangaging Connections}
|
@section[#:tag "managing-connections"]{Mangaging Connections}
|
||||||
|
|
||||||
|
@declare-exporting[db db/base]
|
||||||
|
|
||||||
@defproc[(connection? [x any/c])
|
@defproc[(connection? [x any/c])
|
||||||
boolean?]{
|
boolean?]{
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
@title[#:tag "query-api"]{Queries}
|
@title[#:tag "query-api"]{Queries}
|
||||||
|
|
||||||
@declare-exporting[db]
|
@declare-exporting[db db/base]
|
||||||
|
|
||||||
This library provides a high-level functional query API,
|
This library provides a high-level functional query API,
|
||||||
unlike many other database libraries, which present a stateful,
|
unlike many other database libraries, which present a stateful,
|
||||||
|
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
@title[#:tag "sql-types"]{SQL Types and Conversions}
|
@title[#:tag "sql-types"]{SQL Types and Conversions}
|
||||||
|
|
||||||
@declare-exporting[db]
|
@declare-exporting[db db/base]
|
||||||
|
|
||||||
Connections automatically convert query results to appropriate Racket
|
Connections automatically convert query results to appropriate Racket
|
||||||
types. Likewise, query parameters are accepted as Racket values and
|
types. Likewise, query parameters are accepted as Racket values and
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
@title[#:tag "util"]{Utilities}
|
@title[#:tag "util"]{Utilities}
|
||||||
|
|
||||||
The bindings described in this section are provided by the specific
|
The bindings described in this section are provided by the specific
|
||||||
modules below, not by @racketmodname[db].
|
modules below, not by @racketmodname[db] or @racketmodname[db/base].
|
||||||
|
|
||||||
@;{========================================}
|
@;{========================================}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user