diff --git a/basis/db/db-docs.factor b/basis/db/db-docs.factor index 08544b3367..c392ec6b85 100644 --- a/basis/db/db-docs.factor +++ b/basis/db/db-docs.factor @@ -173,7 +173,7 @@ HELP: with-db HELP: with-transaction { $values { "quot" quotation } } -{ $description "" } ; +{ $description "Calls the quotation inside a database transaction and commits the result to the database after the quotation finishes. If the quotation throws an error, the transaction is aborted." } ; ARTICLE: "db" "Database library" "Accessing a database:" diff --git a/basis/db/types/types-docs.factor b/basis/db/types/types-docs.factor index b8ccbd976f..4d3be1d592 100644 --- a/basis/db/types/types-docs.factor +++ b/basis/db/types/types-docs.factor @@ -1,7 +1,7 @@ ! Copyright (C) 2008 Doug Coleman. ! See http://factorcode.org/license.txt for BSD license. USING: classes hashtables help.markup help.syntax io.streams.string -kernel sequences strings math ; +kernel sequences strings math db.tuples db.tuples.private ; IN: db.types HELP: +db-assigned-id+ @@ -27,15 +27,11 @@ HELP: +user-assigned-id+ HELP: <generator-bind> { $values { "slot-name" object } { "key" object } { "generator-singleton" object } { "type" object } { "generator-bind" generator-bind } } -{ $description "" } ; +{ $description "An internal constructor for creating objects containing parameters used for binding generated values to a tuple query." } ; HELP: <literal-bind> { $values { "key" object } { "type" object } { "value" object } { "literal-bind" literal-bind } } -{ $description "" } ; - -HELP: <low-level-binding> -{ $values { "value" object } { "low-level-binding" low-level-binding } } -{ $description "" } ; +{ $description "An internal constructor for creating objects containing parameters used for binding literal values to a tuple query." } ; HELP: BIG-INTEGER { $description "A 64-bit integer. Whether this number is signed or unsigned depends on the database backend." } ; @@ -100,18 +96,12 @@ HELP: user-assigned-id-spec? HELP: bind# { $values { "spec" "a sql spec" } { "obj" object } } -{ $description "" } ; +{ $description "A generic word that lets a database construct a literal binding." } ; HELP: bind% { $values { "spec" "a sql spec" } } -{ $description "" } ; - -HELP: compound -{ $values - { "string" string } { "obj" object } - { "hash" hashtable } } -{ $description "" } ; +{ $description "A generic word that lets a database output a binding." } ; HELP: db-assigned-id-spec? { $values @@ -126,45 +116,12 @@ HELP: find-primary-key { $description "Returns the rows from the sql-specs array that are part of the primary key. Composite primary keys are supported, so this word must return a sequence." } { $notes "This is a low-level word." } ; -HELP: generator-bind -{ $description "" } ; - HELP: get-slot-named { $values { "name" "a slot name" } { "tuple" tuple } { "value" "the value stored in the slot" } } { $description "Returns the value stored in a tuple slot, where the tuple slot is a string." } ; -HELP: literal-bind -{ $description "" } ; - -HELP: lookup-create-type -{ $values - { "obj" object } - { "string" string } } -{ $description "" } ; - -HELP: lookup-modifier -{ $values - { "obj" object } - { "string" string } } -{ $description "" } ; - -HELP: lookup-type -{ $values - { "obj" object } - { "string" string } } -{ $description "" } ; - -HELP: low-level-binding -{ $description "" } ; - -HELP: modifiers -{ $values - { "spec" "a sql spec" } - { "string" string } } -{ $description "" } ; - HELP: no-sql-type { $values { "type" "a sql type" } } @@ -173,7 +130,7 @@ HELP: no-sql-type HELP: normalize-spec { $values { "spec" "a sql spec" } } -{ $description "" } ; +{ $description "Normalizes a sql spec." } ; HELP: offset-of-slot { $values @@ -181,52 +138,20 @@ HELP: offset-of-slot { "n" integer } } { $description "Returns the offset of a tuple slot accessed by name." } ; -HELP: persistent-table -{ $values - - { "hash" hashtable } } -{ $description "" } ; - HELP: primary-key? { $values { "spec" "a sql spec" } { "?" "a boolean" } } -{ $description "" } ; +{ $description "Returns true if a sql spec is a primary key." } ; HELP: random-id-generator -{ $description "" } ; +{ $description "Used to tell " { $link eval-generator } " to generate a random number for use as a key." } ; HELP: relation? { $values { "spec" "a sql spec" } { "?" "a boolean" } } -{ $description "" } ; - -HELP: remove-db-assigned-id -{ $values - { "specs" "a sequence of sql specs" } - { "obj" object } } -{ $description "" } ; - -HELP: remove-id -{ $values - { "specs" "a sequence of sql specs" } - { "obj" object } } -{ $description "" } ; - -HELP: set-slot-named -{ $values - { "value" object } { "name" string } { "obj" object } } -{ $description "" } ; - -HELP: spec>tuple -{ $values - { "class" class } { "spec" "a sql spec" } - { "tuple" tuple } } -{ $description "" } ; - -HELP: sql-spec -{ $description "" } ; +{ $description "Returns true if a sql spec is a relation." } ; HELP: unknown-modifier { $values { "modifier" string } }