From 93222d4fbaba7ed61f258d0263280a85692c1a09 Mon Sep 17 00:00:00 2001 From: Ryan Culpepper Date: Thu, 25 Aug 2011 02:01:04 -0600 Subject: [PATCH] db: improved listing of db/base exports in docs --- collects/db/scribblings/connect.scrbl | 14 ++++++++++++-- collects/db/scribblings/query.scrbl | 2 +- collects/db/scribblings/sql-types.scrbl | 2 +- collects/db/scribblings/util.scrbl | 2 +- 4 files changed, 15 insertions(+), 5 deletions(-) diff --git a/collects/db/scribblings/connect.scrbl b/collects/db/scribblings/connect.scrbl index f446896c51..c4bbfac0fc 100644 --- a/collects/db/scribblings/connect.scrbl +++ b/collects/db/scribblings/connect.scrbl @@ -9,13 +9,13 @@ @title[#:tag "connect"]{Connections} -@(declare-exporting db) - This section describes functions for creating connections as well as administrative functions for managing connections. @section[#:tag "creating-connections"]{Base Connections} +@declare-exporting[db] + Base connections are made using the following functions. @defproc[(postgresql-connect [#:user user string?] @@ -304,6 +304,8 @@ Base connections are made using the following functions. @section{Connection Pooling} +@declare-exporting[db db/base] + Creating a database connection can be a costly operation; it may involve steps such as process creation and SSL negotiation. A @deftech{connection pool} helps reduce connection costs by reusing @@ -379,6 +381,8 @@ a transaction, the transaction is rolled back. @section{Virtual Connections} +@declare-exporting[db db/base] + A @deftech{virtual connection} creates actual connections on demand and 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} +@declare-exporting[db db/base] + @defproc[(kill-safe-connection [c connection?]) connection?]{ @@ -486,6 +492,8 @@ shutting down its ports. @section{Data Source Names} +@declare-exporting[db db/base] + A DSN (data source name) is a symbol associated with a connection specification in a DSN file. They are inspired by, but distinct from, ODBC's DSNs. @@ -623,6 +631,8 @@ ODBC's DSNs. @section[#:tag "managing-connections"]{Mangaging Connections} +@declare-exporting[db db/base] + @defproc[(connection? [x any/c]) boolean?]{ diff --git a/collects/db/scribblings/query.scrbl b/collects/db/scribblings/query.scrbl index fd167af124..a202e7f5ad 100644 --- a/collects/db/scribblings/query.scrbl +++ b/collects/db/scribblings/query.scrbl @@ -10,7 +10,7 @@ @title[#:tag "query-api"]{Queries} -@declare-exporting[db] +@declare-exporting[db db/base] This library provides a high-level functional query API, unlike many other database libraries, which present a stateful, diff --git a/collects/db/scribblings/sql-types.scrbl b/collects/db/scribblings/sql-types.scrbl index 54786892d4..1b27b1b7d4 100644 --- a/collects/db/scribblings/sql-types.scrbl +++ b/collects/db/scribblings/sql-types.scrbl @@ -10,7 +10,7 @@ @title[#:tag "sql-types"]{SQL Types and Conversions} -@declare-exporting[db] +@declare-exporting[db db/base] Connections automatically convert query results to appropriate Racket types. Likewise, query parameters are accepted as Racket values and diff --git a/collects/db/scribblings/util.scrbl b/collects/db/scribblings/util.scrbl index ca16fd9ecf..9b398c8b55 100644 --- a/collects/db/scribblings/util.scrbl +++ b/collects/db/scribblings/util.scrbl @@ -9,7 +9,7 @@ @title[#:tag "util"]{Utilities} 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]. @;{========================================}