This is the cl-dbi-connection-pool Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 03:47:01 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-dbi-connection-pooltamura shingo
LLGPL
0.1
dbi-cp (system).
dbi-cpconnection pool for CL-DBI
tamura shingo
LLGPL
# CL-DBI-Connection-Pool - connection pool for CL-DBI
This library provides connection pool for CL-DBI.
## Usage
### Create connection pool
make connection pool.
“‘common-lisp
(dbi-cp:make-db-connection-pool driver-name &key database-name username password (initial-size 10) (max-size 10)) ;; => dbi-cp:<dbi-connection-pool>
“‘
- driver-name
- ‘:sqlite‘, ‘:mysql‘, ‘:postgresql‘ (same as ‘CL-DBI‘)
- database-name
- database name (same as ‘CL-DBI‘)
- username
- username (same as ‘CL-DBI‘)
- password
- password (same as ‘CL-DBI‘)
- initial-size
- initial number of connections that are created when the pool is started
- max-size
- maximum number of connections
Additionally, it accepts parameters used in cl-dbi.
“‘common-lisp
(defparameter *CONNECTION-POOL*
(dbi-cp:make-dbi-connection-pool :mysql :database-name "dbi-cp" :username "root" :password "password"))
“‘
### Get connection
get database connection from connection pool.
“‘common-lisp
(dbi-cp:get-connection connection-pool) ;; => dbi-cp.proxy:<dbi-connection-proxy>
“‘
- connection-pool (dbi-cp:<dbi-connection-pool>)
- connection pool
“‘common-lisp
(setf conn (dbi-cp:get-connection *CONNECTION-POOL*))
“‘
### prepare, execute, fetch ...
#### Prepare
prepare SQL statement.
“‘common-lisp
(dbi-cp:prepare connection sql) ;; => dbi.driver:<dbi-query>
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
- sql
- SQL statement
this function is based on ‘CL-DBI‘
#### Execute
execute SQL.
“‘common-lisp
(dbi-cp:execute query &optional params) ;; => dbi.driver:<dbi-query>
“‘
- query (dbi.driver:<dbi-query>)
- precompiled query (returned by ‘prepare‘)
- params
- SQL parameters
this function is based on ‘CL-DBI‘
#### Fetch
fetch first row from ‘query‘ which is returned by ‘execute‘.
“‘common-lisp
(dbi-cp:fetch query) ;; => result
“‘
- query (dbi.driver:<dbi-query>)
- returned by ‘execute‘
this function is based on ‘CL-DBI‘
### Fetch all
fetch all ret row from ‘query‘.
“‘common-lisp
(dbi-cp:fetch-all query) ;; => result
“‘
- query (dbi.driver:<dbi-query>)
- returned by ‘execute‘
this function is based on ‘CL-DBI‘
#### row count
return the number of counts modified by last execute INSERT/UPDATE/DELETE query.
“‘common-lisp
(dbi-cp:row-count connection) ;; => number
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
this function is based on ‘CL-DBI‘
#### do sql
do preparation and execution at once for INSERT, UPDATE, DELETE or DDL.
“‘common-lisp
(dbi-cp:do-sql connection sql &optional params)
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
- sql
- SQL statement
- params
- SQL parameters
this function is based on ‘CL-DBI‘
### Transaction
#### create transaction block
start a transaction and commit at the end of this block.
if the evaluation ‘body‘ is interrupted, the transaction is rolled back automatically.
“‘common-lisp
(dbi-cp:with-transaction connection &body body)
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
- body
- body
this function is based on ‘CL-DBI‘
#### commit
Within ‘with-transaction‘, you can use ‘commit‘.
Outside of ‘with-transaction‘, ‘commit‘ does nothing.
“‘common-lisp
(dbi-cp:commit connection)
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
this function is based on ‘CL-DBI‘
#### rollback
Like ‘commit‘, ‘rollback‘ is also executed within ‘with-transaction‘.
“‘common-lisp
(dbi-cp:rollback connection)
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
this function is based on ‘CL-DBI‘
#### savepoint
set a named transaction savepoint with a name of ‘identifier‘.
“‘common-lisp
(dbi-cp:savepoint connection identifier)
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
- identifier
- name of transaction savepoint
this function is based on ‘CL-DBI‘
#### rollback savepoint
rollback a transaction to the named savepoint.
“‘common-lisp
(dbi-cp:rollback-savepoint connection &optional identifier)
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
- identifier
- name of transaction savepoint
this function is based on ‘CL-DBI‘
#### release savepoint
remove the named savepoint. no commit or rollback occurs.
“‘common-lisp
(dbi-cp:release-savepoint connection &optional identifier)
“‘
- connection (dbi-cp.proxy:<dbi-connection-proxy>)
- database connection
- identifier
- name of transaction savepoint
this function is based on ‘CL-DBI‘
## Example
“‘common-lisp
;;;
;;; create connection pool
;;;
CL-USER> (defparameter *pool*
(dbi-cp:make-dbi-connection-pool :mysql
:database-name "test"
:username "root"
:password "password"))
*POOL*
;;;
;;; get database connection
;;;
CL-USER> (defparameter connection (dbi-cp:get-connection *pool*))
CONNECTION
CL-USER> connection
#<DBI-CP.PROXY:<DBI-CONNECTION-PROXY> {1002E23973}>
;;;
;;; execute DDL
;;;
CL-USER> (dbi-cp:do-sql connection "create table person (id integer primary key, name varchar(24) not null)")
; No value
;;;
;;; select
;;;
CL-USER> (let* ((query (dbi-cp:prepare connection "select count(*) from person"))
(result (dbi-cp:execute query)))
(format T "~A" (dbi-cp:fetch result)))
(count(*) 0)
NIL
;;;
;;; insert
;;;
CL-USER> (dbi-cp:with-transaction connection
(let* ((query (dbi-cp:prepare connection "insert into person (id, name) values (?, ?)")))
(dbi-cp:execute query (list 1 "user1"))
(dbi-cp:execute query (list 2 "user2"))
(dbi-cp:execute query (list 3 "user3"))))
#<DBD.MYSQL:<DBD-MYSQL-QUERY> {1004B671F3}>
;;;
;;; select
;;;
CL-USER> (let* ((query (dbi-cp:prepare connection "select * from person"))
(result (dbi-cp:execute query)))
(dbi-cp:fetch-all result))
((:|id| 1 :|name| "user1") (:|id| 2 :|name| "user2") (:|id| 3 :|name| "user3"))
;;;
;;; rollback
;;;
CL-USER> (dbi-cp:with-transaction connection
(dbi-cp:execute (dbi-cp:prepare connection "delete from person"))
(rollback connection))
0
CL-USER> (dbi-cp:rollback connection)
; No value
CL-USER> (let* ((query (dbi-cp:prepare connection "select count(*) from person"))
(result (dbi-cp:execute query)))
(format T "~A" (dbi-cp:fetch result)))
(count(*) 3)
NIL
;;;
;;; release connection
;;;
CL-USER> (dbi-cp:disconnect connection)
NIL
;;;
;;; shutdown connection pool
;;;
CL-USER> (dbi-cp:shutdown *pool*)
NIL
“‘
## Installation
This library is available on Quicklisp.
“‘commonlisp
(ql:quickload :cl-dbi-connection-pool)
“‘
## how to develop
require
- make
- docker
### test
#### prepare
To prepare, create a docker image for testing.
“‘sh
make setup
“‘
#### run test
“‘sh
make test
“‘
#### swank server
Start the swank server.
“‘sh
make test.swank
“‘
connect with SLIME.
“‘
M-x slime-connect 127.0.0.1 4005
“‘
create connection pool
“‘common-lisp
(ql:quickload :cl-dbi-connection-pool)
(defvar *pool-sqlite3* (dbi-cp:make-dbi-connection-pool :sqlite3
:database-name "/app/volumes/sqlite3-test.db"))
(defvar *pool-mysql* (dbi-cp:make-dbi-connection-pool :mysql
:database-name "test"
:username "root"
:password "password"
:host "mysql-test"
:port 3306))
(defvar *pool-postgres* (dbi-cp:make-dbi-connection-pool :postgres
:database-name "test"
:username "dbicp"
:password "password"
:host "postgresql-test"
:port 5432))
“‘
#### stop test containers
“‘sh
make test.down
“‘
## Author
* tamura shingo (tamura.shingo@gmail.com)
## Copyright
Copyright (c) 2017 tamura shingo (tamura.shingo@gmail.com)
## License
Licensed under the LLGPL License.
0.1
cl-syntax (system).
cl-syntax-annot (system).
cl-dbi (system).
bt-semaphore (system).
src (module).
Modules are listed depth-first from the system components tree.
dbi-cp/srcdbi-cp (system).
dbi-cp.lisp (file).
connectionpool.lisp (file).
proxy.lisp (file).
error.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-dbi-connection-pool/cl-dbi-connection-pool.asddbi-cp/dbi-cp.asddbi-cp/src/dbi-cp.lispdbi-cp/src/connectionpool.lispdbi-cp/src/proxy.lispdbi-cp/src/error.lispcl-dbi-connection-pool/cl-dbi-connection-pool.asdcl-dbi-connection-pool (system).
dbi-cp/src/dbi-cp.lispconnectionpool.lisp (file).
src (module).
show-connection-pool (function).
dbi-cp/src/connectionpool.lispproxy.lisp (file).
error.lisp (file).
src (module).
<dbi-connection-pool> (class).
get-connection (method).
make-dbi-connection-pool (function).
shutdown (method).
%make-connection! (function).
%make-connection-array! (function).
%make-pooledconnection-array! (function).
<pooled-connection> (class).
connect-p (reader method).
(setf connect-p) (writer method).
dbi-connection-proxy (reader method).
(setf dbi-connection-proxy) (writer method).
semaphore (reader method).
(setf semaphore) (writer method).
dbi-cp/src/proxy.lispsrc (module).
<dbi-connection-proxy> (class).
begin-transaction (method).
commit (method).
dbi-connection (reader method).
(setf dbi-connection) (writer method).
disconnect (method).
disconnect-fn (reader method).
(setf disconnect-fn) (writer method).
do-sql (method).
prepare (method).
rollback (method).
row-count (method).
with-transaction (macro).
proxy (macro).
dbi-cp/src/error.lispsrc (module).
<dbi-cp-no-connection> (condition).
Packages are listed by definition order.
dbi-cp.connectionpoolcommon-lisp.
<dbi-connection-pool> (class).
get-connection (generic function).
make-dbi-connection-pool (function).
shutdown (generic function).
%make-connection! (function).
%make-connection-array! (function).
%make-pooledconnection-array! (function).
<pooled-connection> (class).
connect-p (generic reader).
(setf connect-p) (generic writer).
dbi-connection-proxy (generic reader).
(setf dbi-connection-proxy) (generic writer).
semaphore (generic reader).
(setf semaphore) (generic writer).
dbi-cpcl-dbi-connection-pool
common-lisp.
show-connection-pool (function).
dbi-cp.proxycl-annot.
cl-annot.class.
common-lisp.
<dbi-connection-proxy> (class).
dbi-connection (generic reader).
(setf dbi-connection) (generic writer).
disconnect-fn (generic reader).
(setf disconnect-fn) (generic writer).
with-transaction (macro).
proxy (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
make connection pool
Example
(make-dbi-connection-pool :mysql :database-name "dbicp" :username "root" :password "password")
<dbi-connection-proxy>)) ¶automatically generated reader method
<dbi-connection-proxy>)) ¶automatically generated writer method
<dbi-connection-proxy>)) ¶automatically generated reader method
<dbi-connection-proxy>)) ¶automatically generated writer method
<dbi-connection-pool>)) ¶get <dbi-connection-proxy> from connection pool
<dbi-connection-pool>)) ¶disconnect all connections
<dbi-connection-proxy>)) ¶dbi.driver.
<dbi-connection-proxy>)) ¶dbi.driver.
<dbi-connection-proxy>)) ¶dbi.driver.
<dbi-connection-proxy>) (sql string) &optional params) ¶dbi.driver.
<dbi-connection-proxy>) (sql string) &rest rest &key &allow-other-keys) ¶dbi.driver.
<dbi-connection-proxy>)) ¶dbi.driver.
<dbi-connection-proxy>)) ¶dbi.driver.
Exception raised when no connection found on connection pool
simple-error.
connect database and set parameters
create connection array
create <pooled-connection> instance
for debug
<pooled-connection>)) ¶<pooled-connection>)) ¶T when already connected database
<pooled-connection>)) ¶automatically generated reader method
<pooled-connection>)) ¶automatically generated writer method
<pooled-connection>)) ¶automatically generated reader method
<pooled-connection>)) ¶automatically generated writer method
T when already connected database
boolean
(bt-semaphore:make-semaphore :count 1)
(or null dbi-cp.proxy:<dbi-connection-proxy>)
:dbi-connection-proxy
| Jump to: | %
(
B C D F G M P R S W |
|---|
| Jump to: | %
(
B C D F G M P R S W |
|---|
| Jump to: | C D I P S |
|---|
| Jump to: | C D I P S |
|---|
| Jump to: | <
C D E F M P S |
|---|
| Jump to: | <
C D E F M P S |
|---|