diff --git a/basis/db/db-docs.factor b/basis/db/db-docs.factor index 742322733b..dae81e5904 100644 --- a/basis/db/db-docs.factor +++ b/basis/db/db-docs.factor @@ -81,7 +81,7 @@ HELP: query-results { $values { "query" object } { "result-set" result-set } } -{ $description "Returns a " { $link result-set } " object representing the results of a SQL query. See " { $link "db-result-sets" } "." } ; +{ $description "Returns a " { $link result-set } " object representing the results of an SQL query. See " { $link "db-result-sets" } "." } ; HELP: #rows { $values { "result-set" result-set } { "n" integer } } @@ -143,13 +143,13 @@ HELP: rollback-transaction HELP: sql-command { $values { "sql" string } } -{ $description "Executes a SQL string using the database in the " { $link db-connection } " symbol." } ; +{ $description "Executes an SQL string using the database in the " { $link db-connection } " symbol." } ; HELP: sql-query { $values { "sql" string } { "rows" "an array of arrays of strings" } } -{ $description "Runs a SQL query of raw text in the database in the " { $link db-connection } " symbol. Each row is returned as an array of strings; no type-conversions are done on the resulting data." } ; +{ $description "Runs an SQL query of raw text in the database in the " { $link db-connection } " symbol. Each row is returned as an array of strings; no type-conversions are done on the resulting data." } ; { sql-command sql-query } related-words @@ -217,7 +217,7 @@ $nl } ; ARTICLE: "db-result-sets" "Result sets" -"Result sets are the encapsulated, database-specific results from a SQL query." +"Result sets are the encapsulated, database-specific results from an SQL query." $nl "Two possible protocols for iterating over result sets exist:" { $subsections @@ -266,7 +266,7 @@ ARTICLE: "db-protocol" "Low-level database protocol" ARTICLE: "db-lowlevel-tutorial" "Low-level database tutorial" "Although Factor makes integrating a database with its object system easy (see " { $vocab-link "db.tuples" } "), sometimes you may want to write SQL directly and get the results back as arrays of strings, for instance, when interfacing with a legacy database that doesn't easily map to " { $snippet "tuples" } "." $nl -"Executing a SQL command:" +"Executing an SQL command:" { $subsections sql-command } "Executing a query directly:" { $subsections sql-query } diff --git a/basis/db/tuples/tuples-docs.factor b/basis/db/tuples/tuples-docs.factor index 91a376745b..f099a4b16c 100644 --- a/basis/db/tuples/tuples-docs.factor +++ b/basis/db/tuples/tuples-docs.factor @@ -64,7 +64,7 @@ HELP: HELP: define-persistent { $values { "class" class } { "table" string } { "columns" "an array of slot specifiers" } } -{ $description "Defines a relation from a Factor " { $snippet "tuple class" } " to a SQL database table name. The format for the slot specifiers is as follows:" +{ $description "Defines a relation from a Factor " { $snippet "tuple class" } " to an SQL database table name. The format for the slot specifiers is as follows:" { $list { "a slot name from the " { $snippet "tuple class" } } { "the name of a database column that maps to the slot" } @@ -84,17 +84,17 @@ HELP: define-persistent HELP: create-table { $values { "class" class } } -{ $description "Creates a SQL table from a mapping defined by " { $link define-persistent } ". If the table already exists, the database will likely throw an error." } ; +{ $description "Creates an SQL table from a mapping defined by " { $link define-persistent } ". If the table already exists, the database will likely throw an error." } ; HELP: ensure-table { $values { "class" class } } -{ $description "Creates a SQL table from a mapping defined by " { $link define-persistent } ". If the table already exists, the error is silently ignored." } ; +{ $description "Creates an SQL table from a mapping defined by " { $link define-persistent } ". If the table already exists, the error is silently ignored." } ; HELP: ensure-tables { $values { "classes" "a sequence of classes" } } -{ $description "Creates a SQL table from a mapping defined by " { $link define-persistent } ". If a table already exists, the error is silently ignored." } ; +{ $description "Creates an SQL table from a mapping defined by " { $link define-persistent } ". If a table already exists, the error is silently ignored." } ; HELP: recreate-table { $values @@ -125,7 +125,7 @@ HELP: update-tuple HELP: delete-tuples { $values { "tuple" tuple } } -{ $description "Uses the " { $snippet "tuple" } " as an exemplar object and deletes any objects that have the same slots set. If a slot is not " { $link f } ", then it is used to generate a SQL statement that deletes tuples." } +{ $description "Uses the " { $snippet "tuple" } " as an exemplar object and deletes any objects that have the same slots set. If a slot is not " { $link f } ", then it is used to generate an SQL statement that deletes tuples." } { $warning "This word will delete your data." } ; { insert-tuple update-tuple delete-tuples } related-words diff --git a/basis/db/types/types-docs.factor b/basis/db/types/types-docs.factor index ca2fb66797..72d6c2edc2 100644 --- a/basis/db/types/types-docs.factor +++ b/basis/db/types/types-docs.factor @@ -121,24 +121,24 @@ HELP: find-primary-key HELP: no-sql-type { $values { "type" "a SQL type" } } -{ $description "Throws an error containing a SQL type that is unsupported or the result of a typo." } ; +{ $description "Throws an error containing an SQL type that is unsupported or the result of a typo." } ; HELP: normalize-spec { $values { "spec" "a SQL spec" } } -{ $description "Normalizes a SQL spec." } ; +{ $description "Normalizes an SQL spec." } ; HELP: primary-key? { $values { "spec" "a SQL spec" } { "?" boolean } } -{ $description "Returns true if a SQL spec is a primary key." } ; +{ $description "Returns true if an SQL spec is a primary key." } ; HELP: relation? { $values { "spec" "a SQL spec" } { "?" boolean } } -{ $description "Returns true if a SQL spec is a relation." } ; +{ $description "Returns true if an SQL spec is a relation." } ; HELP: unknown-modifier { $values { "modifier" string } }