You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
1.4 KiB
74 lines
1.4 KiB
--- db.md_original 2020-11-15 22:37:01.041227106 -0500 |
|
+++ db.md 2020-11-15 22:49:31.107770676 -0500 |
|
@@ -11,20 +11,20 @@ |
|
### connection? |
|
::: tip usage |
|
``` |
|
-(connection? ...) |
|
+(connection? obj) -> boolean |
|
``` |
|
::: |
|
|
|
-Please document me! |
|
+Returns #t if the arguemnt is an sql connection object. |
|
|
|
### statement? |
|
::: tip usage |
|
``` |
|
-(statement? ...) |
|
+(statement? obj) -> boolean |
|
``` |
|
::: |
|
|
|
-Please document me! |
|
+Returns #t if the argument is an sql statement object. |
|
|
|
### sql-error? |
|
::: tip usage |
|
@@ -56,11 +56,13 @@ |
|
### sql-prepare |
|
::: tip usage |
|
``` |
|
-(sql-prepare ...) |
|
+(sql-prepare str) -> statement |
|
+ str := string that is a valid sql statement |
|
``` |
|
::: |
|
|
|
-Please document me! |
|
+Converts an sql statement in string form to a statement object to be used with |
|
+connections established via `sql-connect`. |
|
|
|
### sql-bind |
|
::: tip usage |
|
@@ -128,11 +130,13 @@ |
|
### sql-exec |
|
::: tip usage |
|
``` |
|
-(sql-exec ...) |
|
+(sql-exec obj) |
|
+ obj := sql statement object |
|
``` |
|
::: |
|
|
|
-Please document me! |
|
+Accepts an sql statement object as an argument. Defaults to currently open |
|
+connection made via `(sql-connect sqlite-open ...)`. |
|
|
|
### sql-query |
|
::: tip usage |
|
@@ -199,11 +203,12 @@ |
|
### sqlite-open |
|
::: tip usage |
|
``` |
|
-(sql-connect sqlite-open ...) |
|
+(sql-connect sqlite-open str) |
|
+ str := a relative filepath or sqlite connection string |
|
``` |
|
::: |
|
|
|
-Please document me! |
|
+Opens an sql connection to the database located at the provided path/address. |
|
|
|
|
|
## PostgreSQL driver
|
|
|