From 2ced7ad44092ec62e450279206bbcb42560e2ac1 Mon Sep 17 00:00:00 2001
From: smeghead <smeghead7@gmail.com>
Date: Mon, 13 May 2024 21:41:34 +0900
Subject: [PATCH] doc: add reference to README.

---
 README.md    | 172 +++++++++++++++++++++++++++++++++++++++++++++++++++
 src/pdo.phel |   3 -
 2 files changed, 172 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index b75e993..7388248 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,15 @@
 
 phel-lang pdo wrapper library.
 
+## Description
+
+With phel, it is very easy to call functions of originally PHP classes.
+Therefore, it is not difficult to use PDO directly.
+
+However, if you have to think about PHP classes while writing phel code, there is a concern that a context switch will occur between the phel world and the PHP world, and you will not be able to concentrate on writing the phel code.
+
+Therefore, I created a wrapper library that can handle PDO just by calling functions in the phel world.
+
 ## Install
 
 Install from composer. https://packagist.org/packages/smeghead/phel-pdo
@@ -39,6 +48,169 @@ phel:10> (statement/fetch stmt)
 {:id 1 :name phel}
 ```
 
+## Reference
+
+### pdo
+
+Represents a connection between PHP and a database server.
+
+####  begin
+
+Initiates a transaction
+
+```clojure
+(begin conn)
+```
+
+####  commit
+
+Commits a transaction
+
+```clojure
+(commit conn)
+```
+
+####  connect
+
+Connect database and return connection object.
+Throws a PDOException if the attempt to connect to the requested database fails
+
+```clojure
+(connect dns & [username password options])
+```
+
+####  error-code
+
+Fetch the SQLSTATE associated with the last operation on the database handle
+
+```clojure
+(error-code conn)
+```
+
+####  error-info
+
+Fetch extended error information associated with the last operation on the database handle
+
+```clojure
+(error-info conn)
+```
+
+####  exec
+
+Execute an SQL statement and return the number of affected rows
+
+```clojure
+(exec conn stmt & [fetch-mode])
+```
+
+####  get-attribute
+
+Retrieve a database connection attribute
+
+```clojure
+(get-attribute conn attribute)
+```
+
+####  get-available-drivers
+
+Return an array of available PDO drivers
+
+```clojure
+(get-available-drivers conn)
+```
+
+####  in-transaction
+
+Checks if inside a transaction
+
+```clojure
+(in-transaction conn)
+```
+
+####  last-insert-id
+
+Returns the ID of the last inserted row or sequence value
+
+```clojure
+(last-insert-id conn)
+```
+
+####  prepare
+
+Prepares a statement for execution and returns a statement object
+
+```clojure
+(prepare conn stmt & [fetch-mode])
+```
+
+####  query
+
+Prepares and executes an SQL statement without placeholders
+
+```clojure
+(query conn stmt & [fetch-mode])
+```
+
+####  quote
+
+Quotes a string for use in a query
+
+```clojure
+(query conn string & [type])
+```
+
+####  rollback
+
+Rolls back a transaction
+
+```clojure
+(rollback conn)
+```
+
+####  set-attribute
+
+Set an attribute
+
+```clojure
+(set-attribute conn attribute value)
+```
+
+### statement
+
+Represents a prepared statement and, after the statement is executed, an associated result set.
+
+#### execute
+
+Executes a prepared statement
+
+```clojure
+(execute statement)
+```
+
+#### fetch
+
+Fetches the next row from a result set
+
+```clojure
+(fetch statement)
+```
+
+#### fetch-all
+
+Fetches the remaining rows from a result set
+
+```clojure
+(fetch-all statement)
+```
+
+#### fetch-column
+
+Returns a single column from the next row of a result set
+
+```clojure
+(fetch-column statement & [column])
+```
+
 
 ## Development
 
diff --git a/src/pdo.phel b/src/pdo.phel
index 78d15d4..12af111 100644
--- a/src/pdo.phel
+++ b/src/pdo.phel
@@ -82,6 +82,3 @@
   [conn]
   (values (php-array-to-map (php/-> (conn :pdo) (getAvailableDrivers)))))
 
-# not implement yet.
-
-#PDO::getAvailableDrivers — Return an array of available PDO drivers