The cl-fbclient Reference Manual

Table of Contents

The cl-fbclient Reference Manual

This is the cl-fbclient Reference Manual, version 0.7, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:04:58 2018 GMT+0.

1 Introduction

cl-fbclient

Common Lisp library for working with firebird databases

Library is a set of classes and methods for working with firebird databases. Basic classes:

• fb-database
• fb-transaction
• fb-statement
• fb-error

Supported SQL-vars types:

• float
• double
• integer
• decimal(numeric)
• varchar
• timestamp
• BLOB

Examples:

First

(require 'cl-fbclient)

;; create an instance of the database and automatically connect to the database
(defparameter *db* (make-instance 'cl-fbclient:fb-database
  				   :path "/path-to-db/db-file.fdb"))
             
;; query that returns no value
;; (transaction will be created, started and commited automatically)
(cl-fbclient:fb-noresult-query *db* "INSERT INTO T1(A1,A2) VALUES(121, 42)")

;; to query and write results to the list
;; (transaction will be created, started and commited automatically)
(cl-fbclient:fb-query-fetch-all *db* "SELECT * FROM t1")

;; disconnecting from DB
(cl-fbclient:fb-disconnect *db*)

Second(easier)

(require 'cl-fbclient)

(cl-fbclient:fb-with-database (DB :path "/path-to-db/db-file.fdb")
    (cl-fbclient:fb-with-transaction (DB TR)
     	(cl-fbclient:fb-query "SELECT * FROM T1" :tr TR)
        (cl-fbclient:fb-query "INSERT INTO T1(A1,A2) VALUES(121, 42)" :tr TR)
        (cl-fbclient:fb-query "SELECT * FROM T1" :tr TR)))

Third(even easier)

(require 'cl-fbclient)

(cl-fbclient:fb-with-database (DB :path "/path-to-db/db-file.fdb")
     (cl-fbclient:fb-query "SELECT * FROM T1" :db DB)
     (cl-fbclient:fb-query "INSERT INTO T1(A1,A2) VALUES(121, 42)" :db DB)
     (cl-fbclient:fb-query "SELECT * FROM T1" :db DB))

Tested on:

• SBCL(ubuntu)
• CLISP(ubuntu)
• SBCL-win32-threads (by akovalenko). (WindowsXP)

Documentation: cl-fbclient/wiki

Please report me about BUGs and ask your questions by e-mail: klimenko.serj@gmail.com

TODO:

• Add 'get metainfo' functions
• Create support types: date, time, array
• Add docstrings
• support WIKI.
• ...

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-fbclient

Author

Klimenko Serj <klimenko.serj@gmail.com>

License

MIT

Description

Common Lisp library for working with firebird databases(using fbclient)

Version

0.7

Dependency

cffi

Source

cl-fbclient.asd (file)

Components

• package.lisp (file)
• cl-fbclient-cffi.lisp (file)
• cl-fbclient-error.lisp (file)
• cl-fbclient-database.lisp (file)
• cl-fbclient-transaction.lisp (file)
• cl-fbclient-statement.lisp (file)
• cl-fbclient.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-fbclient.asd

Location

cl-fbclient.asd

Systems

cl-fbclient (system)

3.1.2 cl-fbclient/package.lisp

Parent

cl-fbclient (system)

Location

package.lisp

Packages

cl-fbclient

3.1.3 cl-fbclient/cl-fbclient-cffi.lisp

Dependency

package.lisp (file)

Parent

cl-fbclient (system)

Location

cl-fbclient-cffi.lisp

Internal Definitions

• isc-attach-database (function)
• isc-close-blob (function)
• isc-commit-transaction (function)
• isc-decode-timestamp (function)
• isc-detach-database (function)
• isc-dsql-allocate-statement (function)
• isc-dsql-describe (function)
• isc-dsql-execute (function)
• isc-dsql-execute2 (function)
• isc-dsql-fetch (function)
• isc-dsql-free-statement (function)
• isc-dsql-prepare (function)
• isc-dsql-set-cursor-name (function)
• isc-dsql-sql-info (function)
• isc-get-segment (function)
• isc-interprete (function)
• isc-open-blob2 (function)
• isc-print-status (function)
• isc-rollback-transaction (function)
• isc-sql-interprete (function)
• isc-sqlcode (function)
• isc-start-transaction (function)
• isc_quad-tclass (class)
• isc_timestamp-tclass (class)
• tm-tclass (class)
• xsqlda-tclass (class)
• xsqlvar-tclass (class)

3.1.4 cl-fbclient/cl-fbclient-error.lisp

Dependency

cl-fbclient-cffi.lisp (file)

Parent

cl-fbclient (system)

Location

cl-fbclient-error.lisp

Exported Definitions

• fb-error (condition)
• fb-error-code (method)
• fb-error-text (method)
• fb-verbalize-error (function)
• fbclient-msg (method)

Internal Definitions

• get-status-vector-msg (function)
• get-status-vector-sql-msg (function)
• make-status-vector (function)
• process-status-vector (macro)
• status-vector-error-p (function)
• with-status-vector (macro)

3.1.5 cl-fbclient/cl-fbclient-database.lisp

Dependency

cl-fbclient-error.lisp (file)

Parent

cl-fbclient (system)

Location

cl-fbclient-database.lisp

Exported Definitions

• fb-connect (function)
• fb-database (class)
• fb-disconnect (function)

Internal Definitions

• calc-dpb-size (function)
• connect-to-db (function)
• db-handle* (method)
• (setf db-handle*) (method)
• encoding (method)
• (setf encoding) (method)
• host (method)
• (setf host) (method)
• make-db-handler (function)
• make-dpb (function)
• password (method)
• (setf password) (method)
• path (method)
• (setf path) (method)
• setf-dpb-buff (macro)
• user-name (method)
• (setf user-name) (method)

3.1.6 cl-fbclient/cl-fbclient-transaction.lisp

Dependency

cl-fbclient-database.lisp (file)

Parent

cl-fbclient (system)

Location

cl-fbclient-transaction.lisp

Exported Definitions

• fb-commit-transaction (function)
• fb-rollback-transaction (function)
• fb-start-transaction (function)
• fb-transaction (class)

Internal Definitions

• fb-db (method)
• (setf fb-db) (method)
• make-default-tpb (function)
• make-tr-handler (function)
• start-transaction (function)
• transaction-handle* (method)
• (setf transaction-handle*) (method)

3.1.7 cl-fbclient/cl-fbclient-statement.lisp

Dependency

cl-fbclient-transaction.lisp (file)

Parent

cl-fbclient (system)

Location

cl-fbclient-statement.lisp

Exported Definitions

• *fb-blob-read-block-size* (special variable)
• *timestamp-alist-converter* (special variable)
• fb-allocate-statement (function)
• fb-blob-close (function)
• fb-blob-load (function)
• fb-blob-open (function)
• fb-blob-read (function)
• fb-execute-statement (function)
• fb-get-sql-type (method)
• fb-prepare-statement (function)
• fb-statement (class)
• fb-statement-fetch (function)
• fb-statement-free (function)
• fb-statement-get-var-info (function)
• fb-statement-get-var-val (function)
• fb-statement-get-var-val+name (function)
• fb-statement-get-vars-info (function)
• fb-statement-get-vars-names-list (function)
• fb-statement-get-vars-vals+names-list (function)
• fb-statement-get-vars-vals-list (function)
• timestamp-alist-to-string (function)

Internal Definitions

• %var (macro)
• %var-slot (macro)
• %vars-count-1 (macro)
• *blob-convertor* (special variable)
• +mulp-vector+ (special variable)
• alloc-var-data-default (function)
• alloc-vars-data (function)
• convert-timestamp-alist (function)
• fb-blob (class)
• fb-blob-handle (method)
• (setf fb-blob-handle) (method)
• fb-blob-id (method)
• (setf fb-blob-id) (method)
• fb-blob-to-string-convertor (function)
• fb-timestamp2datetime-list (function)
• fb-tr (method)
• (setf fb-tr) (method)
• fb-tr (method)
• (setf fb-tr) (method)
• free-vars-data (function)
• get-sql-type (function)
• get-var-info (function)
• get-var-name (function)
• get-var-sqlln (function)
• get-var-type (function)
• get-var-type-by-fbtype-num (function)
• get-var-val (function)
• get-var-val+name (function)
• get-var-val-by-type (function)
• get-vars-count (function)
• get-vars-info (function)
• get-vars-names (function)
• get-vars-vals+names-list (function)
• get-vars-vals-list (function)
• is-var-nil (function)
• make-blob-handler (function)
• make-stmt-handler (function)
• make-xsqlda (function)
• need-remake-xsqlda (function)
• pow-10 (function)
• remake-xsqlda (function)
• request-str (method)
• (setf request-str) (method)
• (setf st-type) (method)
• statement-handle* (method)
• (setf statement-handle*) (method)
• xsqlda-get-var-sqlscale (function)
• xsqlda-get-var-val (function)
• xsqlda-length (function)
• xsqlda-output* (method)
• (setf xsqlda-output*) (method)

3.1.8 cl-fbclient/cl-fbclient.lisp

Dependency

cl-fbclient-statement.lisp (file)

Parent

cl-fbclient (system)

Location

cl-fbclient.lisp

Exported Definitions

• *database-toplevel* (special variable)
• fb-connect-toplevel (function)
• fb-connected-p (function)
• fb-disconnect-toplevel (function)
• fb-loop-query-fetch (macro)
• fb-loop-statement-fetch (macro)
• fb-noresult-query (function)
• fb-query (macro)
• fb-query-fetch-all (function)
• fb-query-fetch-all+names (function)
• fb-query-fetch-all+names-header (function)
• fb-with-database (macro)
• fb-with-statement (macro)
• fb-with-statement-db (macro)
• fb-with-toplevel-connection (macro)
• fb-with-transaction (macro)

4 Packages

Packages are listed by definition order.

4.1 cl-fbclient

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• *database-toplevel* (special variable)
• *fb-blob-read-block-size* (special variable)
• *timestamp-alist-converter* (special variable)
• fb-allocate-statement (function)
• fb-blob-close (function)
• fb-blob-load (function)
• fb-blob-open (function)
• fb-blob-read (function)
• fb-commit-transaction (function)
• fb-connect (function)
• fb-connect-toplevel (function)
• fb-connected-p (function)
• fb-database (class)
• fb-disconnect (function)
• fb-disconnect-toplevel (function)
• fb-error (condition)
• fb-error-code (generic function)
• fb-error-code (method)
• fb-error-text (generic function)
• fb-error-text (method)
• fb-execute-statement (function)
• fb-get-sql-type (generic function)
• fb-get-sql-type (method)
• fb-loop-query-fetch (macro)
• fb-loop-statement-fetch (macro)
• fb-noresult-query (function)
• fb-prepare-statement (function)
• fb-query (macro)
• fb-query-fetch-all (function)
• fb-query-fetch-all+names (function)
• fb-query-fetch-all+names-header (function)
• fb-rollback-transaction (function)
• fb-start-transaction (function)
• fb-statement (class)
• fb-statement-fetch (function)
• fb-statement-free (function)
• fb-statement-get-var-info (function)
• fb-statement-get-var-val (function)
• fb-statement-get-var-val+name (function)
• fb-statement-get-vars-info (function)
• fb-statement-get-vars-names-list (function)
• fb-statement-get-vars-vals+names-list (function)
• fb-statement-get-vars-vals-list (function)
• fb-transaction (class)
• fb-verbalize-error (function)
• fb-with-database (macro)
• fb-with-statement (macro)
• fb-with-statement-db (macro)
• fb-with-toplevel-connection (macro)
• fb-with-transaction (macro)
• fbclient-msg (generic function)
• fbclient-msg (method)
• timestamp-alist-to-string (function)

Internal Definitions

• %var (macro)
• %var-slot (macro)
• %vars-count-1 (macro)
• *blob-convertor* (special variable)
• +mulp-vector+ (special variable)
• alloc-var-data-default (function)
• alloc-vars-data (function)
• calc-dpb-size (function)
• connect-to-db (function)
• convert-timestamp-alist (function)
• db-handle* (generic function)
• db-handle* (method)
• (setf db-handle*) (method)
• (setf db-handle*) (generic function)
• encoding (generic function)
• encoding (method)
• (setf encoding) (method)
• (setf encoding) (generic function)
• fb-blob (class)
• fb-blob-handle (generic function)
• fb-blob-handle (method)
• (setf fb-blob-handle) (method)
• (setf fb-blob-handle) (generic function)
• fb-blob-id (generic function)
• fb-blob-id (method)
• (setf fb-blob-id) (method)
• (setf fb-blob-id) (generic function)
• fb-blob-to-string-convertor (function)
• fb-db (generic function)
• fb-db (method)
• (setf fb-db) (method)
• (setf fb-db) (generic function)
• fb-timestamp2datetime-list (function)
• fb-tr (generic function)
• fb-tr (method)
• (setf fb-tr) (method)
• fb-tr (method)
• (setf fb-tr) (method)
• (setf fb-tr) (generic function)
• free-vars-data (function)
• get-sql-type (function)
• get-status-vector-msg (function)
• get-status-vector-sql-msg (function)
• get-var-info (function)
• get-var-name (function)
• get-var-sqlln (function)
• get-var-type (function)
• get-var-type-by-fbtype-num (function)
• get-var-val (function)
• get-var-val+name (function)
• get-var-val-by-type (function)
• get-vars-count (function)
• get-vars-info (function)
• get-vars-names (function)
• get-vars-vals+names-list (function)
• get-vars-vals-list (function)
• host (generic function)
• host (method)
• (setf host) (method)
• (setf host) (generic function)
• is-var-nil (function)
• isc-attach-database (function)
• isc-close-blob (function)
• isc-commit-transaction (function)
• isc-decode-timestamp (function)
• isc-detach-database (function)
• isc-dsql-allocate-statement (function)
• isc-dsql-describe (function)
• isc-dsql-execute (function)
• isc-dsql-execute2 (function)
• isc-dsql-fetch (function)
• isc-dsql-free-statement (function)
• isc-dsql-prepare (function)
• isc-dsql-set-cursor-name (function)
• isc-dsql-sql-info (function)
• isc-get-segment (function)
• isc-interprete (function)
• isc-open-blob2 (function)
• isc-print-status (function)
• isc-rollback-transaction (function)
• isc-sql-interprete (function)
• isc-sqlcode (function)
• isc-start-transaction (function)
• isc_quad-tclass (class)
• isc_timestamp-tclass (class)
• make-blob-handler (function)
• make-db-handler (function)
• make-default-tpb (function)
• make-dpb (function)
• make-status-vector (function)
• make-stmt-handler (function)
• make-tr-handler (function)
• make-xsqlda (function)
• need-remake-xsqlda (function)
• password (generic function)
• password (method)
• (setf password) (method)
• (setf password) (generic function)
• path (generic function)
• path (method)
• (setf path) (method)
• (setf path) (generic function)
• pow-10 (function)
• process-status-vector (macro)
• remake-xsqlda (function)
• request-str (generic function)
• request-str (method)
• (setf request-str) (method)
• (setf request-str) (generic function)
• setf-dpb-buff (macro)
• (setf st-type) (generic function)
• (setf st-type) (method)
• start-transaction (function)
• statement-handle* (generic function)
• statement-handle* (method)
• (setf statement-handle*) (method)
• (setf statement-handle*) (generic function)
• status-vector-error-p (function)
• tm-tclass (class)
• transaction-handle* (generic function)
• transaction-handle* (method)
• (setf transaction-handle*) (method)
• (setf transaction-handle*) (generic function)
• user-name (generic function)
• user-name (method)
• (setf user-name) (method)
• (setf user-name) (generic function)
• with-status-vector (macro)
• xsqlda-get-var-sqlscale (function)
• xsqlda-get-var-val (function)
• xsqlda-length (function)
• xsqlda-output* (generic function)
• xsqlda-output* (method)
• (setf xsqlda-output*) (method)
• (setf xsqlda-output*) (generic function)
• xsqlda-tclass (class)
• xsqlvar-tclass (class)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *database-toplevel*

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Special Variable: *fb-blob-read-block-size*

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Special Variable: *timestamp-alist-converter*

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

5.1.2 Macros

Macro: fb-loop-query-fetch (FB-DB REQUEST-STR VARLIST) &body BODY

Macro to loop reading and processing the query results by DB. (transaction will be created, started and commited automatically)

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Macro: fb-loop-statement-fetch (FB-STMT) &body BODY

Macro to loop reading and processing the query results

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Macro: fb-query REQUEST-STR &rest KPAR

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Macro: fb-with-database (DATABASE-NAME &rest PARAMS) &body BODY

Macro to automatic connect and disconnect database.

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Macro: fb-with-statement (FB-TR STATEMENT-NAME REQUEST-STR) &body BODY

Macro to create, automatic allocate and free statements.

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Macro: fb-with-statement-db (FB-DB STATEMENT-NAME REQUEST-STR) &body BODY

Macro to create, automatic allocate and free statements. (transaction will be created, started and commited automatically)

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Macro: fb-with-toplevel-connection (&rest PARAMS) &body BODY

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Macro: fb-with-transaction (FB-DB TRANSACTION-NAME) &body BODY

Macro to create, automatic start and commit transactions.

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

5.1.3 Functions

Function: fb-allocate-statement FB-STMT

Method to allocate statement.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-blob-close BLOB

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-blob-load BLOB

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-blob-open BLOB

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-blob-read BLOB &key BUFFER-SIZE BUFFER

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-commit-transaction TR

Method to commit transaction.

Package

cl-fbclient

Source

cl-fbclient-transaction.lisp (file)

Function: fb-connect FB-DB

Method to connect to the database.

Package

cl-fbclient

Source

cl-fbclient-database.lisp (file)

Function: fb-connect-toplevel &key HOST PATH USER-NAME PASSWORD

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Function: fb-connected-p &optional FB-DB

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Function: fb-disconnect DB

Method to disconnect from the database.

Package

cl-fbclient

Source

cl-fbclient-database.lisp (file)

Function: fb-disconnect-toplevel ()

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Function: fb-execute-statement FB-STMT

Method to execute statement.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-noresult-query FB-DB REQUEST-STR

A method for performing queries that do not require answers.(insert,delete,update, etc.) (transaction will be created, started and commited automatically)

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Function: fb-prepare-statement FB-STMT

Method to prepare statement.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-query-fetch-all FB-DB REQUEST-STR

The method, which executes the query and returns all its results in a list. (transaction will be created, started and commited automatically)

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Function: fb-query-fetch-all+names FB-DB REQUEST-STR

The method, which executes the query and returns all its results(+names) in a list. (transaction will be created, started and commited automatically)

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Function: fb-query-fetch-all+names-header FB-DB REQUEST-STR

The method, which executes the query and returns all its results(+names header) in a list. (transaction will be created, started and commited automatically)

Package

cl-fbclient

Source

cl-fbclient.lisp (file)

Function: fb-rollback-transaction TR

Method to rollback transaction.

Package

cl-fbclient

Source

cl-fbclient-transaction.lisp (file)

Function: fb-start-transaction TR

Method to start transaction.

Package

cl-fbclient

Source

cl-fbclient-transaction.lisp (file)

Function: fb-statement-fetch STMT

Method to fetch results from executed statement.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-statement-free STMT

Method to free statement.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-statement-get-var-info STMT INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-statement-get-var-val STMT INDEX

A method for obtaining the values of result variables. Used after Fetch.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-statement-get-var-val+name STMT INDEX

A method for obtaining the values and names of result variables. Used after Fetch.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-statement-get-vars-info STMT

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-statement-get-vars-names-list STMT

A method for obtaining names of result variables. Used after Fetch.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-statement-get-vars-vals+names-list STMT &optional NAMES

A method for obtaining the list of values and names of result variables. Used after Fetch.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-statement-get-vars-vals-list STMT

A method for obtaining the list of values ​​of result variables. Used after Fetch.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-verbalize-error ERR

Package

cl-fbclient

Source

cl-fbclient-error.lisp (file)

Function: timestamp-alist-to-string TIMESTAMP-ALIST

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

5.1.4 Generic functions

Generic Function: fb-error-code CONDITION

Package

cl-fbclient

Methods

Method: fb-error-code (CONDITION fb-error)

Source

cl-fbclient-error.lisp (file)

Generic Function: fb-error-text CONDITION

Package

cl-fbclient

Methods

Method: fb-error-text (CONDITION fb-error)

Source

cl-fbclient-error.lisp (file)

Generic Function: fb-get-sql-type OBJECT

Package

cl-fbclient

Methods

Method: fb-get-sql-type (FB-STATEMENT fb-statement)

automatically generated reader method

Source

cl-fbclient-statement.lisp (file)

Generic Function: fbclient-msg CONDITION

Package

cl-fbclient

Methods

Method: fbclient-msg (CONDITION fb-error)

Source

cl-fbclient-error.lisp (file)

5.1.5 Conditions

Condition: fb-error ()

Condition for processing fbclient errors.

Package

cl-fbclient

Source

cl-fbclient-error.lisp (file)

Direct superclasses

error (condition)

Direct methods

• print-object (method)
• fbclient-msg (method)
• fb-error-text (method)
• fb-error-code (method)

Direct slots

Slot: fb-error-code

Initargs

:fb-error-code

Readers

fb-error-code (generic function)

Slot: fb-error-text

Initargs

:fb-error-text

Readers

fb-error-text (generic function)

Slot: fbclient-msg

Initargs

:fbclient-msg

Readers

fbclient-msg (generic function)

5.1.6 Classes

Class: fb-database ()

Class that handles database connection

Package

cl-fbclient

Source

cl-fbclient-database.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• encoding (method)
• encoding (method)
• password (method)
• password (method)
• user-name (method)
• user-name (method)
• path (method)
• path (method)
• host (method)
• host (method)
• db-handle* (method)
• db-handle* (method)

Direct slots

Slot: db-handle*

Readers

db-handle* (generic function)

Writers

(setf db-handle*) (generic function)

Slot: host

Initargs

:host

Initform

"localhost"

Readers

host (generic function)

Writers

(setf host) (generic function)

Slot: path

Initargs

:path

Readers

path (generic function)

Writers

(setf path) (generic function)

Slot: user-name

Initargs

:user-name

Initform

"sysdba"

Readers

user-name (generic function)

Writers

(setf user-name) (generic function)

Slot: password

Initargs

:password

Initform

"masterkey"

Readers

password (generic function)

Writers

(setf password) (generic function)

Slot: encoding

Initargs

:encoding

Initform

:utf-8

Readers

encoding (generic function)

Writers

(setf encoding) (generic function)

Class: fb-statement ()

Class that handles SQL statements.

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• (setf st-type) (method)
• fb-get-sql-type (method)
• xsqlda-output* (method)
• xsqlda-output* (method)
• statement-handle* (method)
• statement-handle* (method)
• request-str (method)
• request-str (method)
• fb-tr (method)
• fb-tr (method)

Direct slots

Slot: fb-tr

Initargs

:fb-tr

Readers

fb-tr (generic function)

Writers

(setf fb-tr) (generic function)

Slot: request-str

Initargs

:request-str

Readers

request-str (generic function)

Writers

(setf request-str) (generic function)

Slot: statement-handle*

Initform

(cl-fbclient::make-stmt-handler)

Readers

statement-handle* (generic function)

Writers

(setf statement-handle*) (generic function)

Slot: xsqlda-output*

Readers

xsqlda-output* (generic function)

Writers

(setf xsqlda-output*) (generic function)

Slot: st-type

Readers

fb-get-sql-type (generic function)

Writers

(setf st-type) (generic function)

Class: fb-transaction ()

Class that handles transaction.

Package

cl-fbclient

Source

cl-fbclient-transaction.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• transaction-handle* (method)
• transaction-handle* (method)
• fb-db (method)
• fb-db (method)

Direct slots

Slot: fb-db

Initargs

:fb-db

Readers

fb-db (generic function)

Writers

(setf fb-db) (generic function)

Slot: transaction-handle*

Initform

(cl-fbclient::make-tr-handler)

Readers

transaction-handle* (generic function)

Writers

(setf transaction-handle*) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *blob-convertor*

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Special Variable: +mulp-vector+

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

5.2.2 Macros

Macro: %var %XSQLDA %INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Macro: %var-slot %XSQLDA %INDEX %SLOT-NAME

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Macro: %vars-count-1 %XSQLDA

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Macro: process-status-vector STATUS-VECTOR* ERR-CODE ERR-TEXT

Package

cl-fbclient

Source

cl-fbclient-error.lisp (file)

Macro: setf-dpb-buff DPB-BUFF-VAR DPB-BUFF-SIZE-VAR DB-USER-NAME DB-PASSWORD

Package

cl-fbclient

Source

cl-fbclient-database.lisp (file)

Macro: with-status-vector STATUS-VECTOR* &body BODY

Package

cl-fbclient

Source

cl-fbclient-error.lisp (file)

5.2.3 Functions

Function: alloc-var-data-default XSQLDA* INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: alloc-vars-data XSQLDA*

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: calc-dpb-size USERNAME PASSWORD

Package

cl-fbclient

Source

cl-fbclient-database.lisp (file)

Function: connect-to-db DB-HANDLE-POINTER STATUS-VECTOR-POINTER HOST+PATH LOGIN PASS

Package

cl-fbclient

Source

cl-fbclient-database.lisp (file)

Function: convert-timestamp-alist TIMESTAMP-ALIST

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-blob-to-string-convertor BLOB

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: fb-timestamp2datetime-list FB-TIMESTAMP

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: free-vars-data XSQLDA*

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-sql-type STMT-HANDLE-POINTER

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-status-vector-msg STATUS-VECTOR*

Package

cl-fbclient

Source

cl-fbclient-error.lisp (file)

Function: get-status-vector-sql-msg STATUS-VECTOR*

Package

cl-fbclient

Source

cl-fbclient-error.lisp (file)

Function: get-var-info XSQLDA* INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-var-name XSQLDA* INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-var-sqlln XSQLDA* INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-var-type XSQLDA* INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-var-type-by-fbtype-num TYPE-NUM

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-var-val STMT INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-var-val+name STMT INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-var-val-by-type STMT INDEX TYPE

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-vars-count XSQLDA*

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-vars-info XSQLDA*

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-vars-names XSQLDA*

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-vars-vals+names-list STMT &optional NAMES

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: get-vars-vals-list STMT

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: is-var-nil XSQLDA* INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: isc-attach-database ISC_STATUS_VECT ISC_PATH_LEN ISC_PATH ISC_DB_H ISC_DPB_BUF_LEN ISC_DPB_BUF

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-close-blob ISC_STATUS_VECT ISC_BLOB_HANDLE

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-commit-transaction ISC_STATUS_VECT ISC_TR_H

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-decode-timestamp _TIMESTAMP _STRUCT_TM

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-detach-database ISC_STATUS_VECT ISC_DB_H

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-allocate-statement ISC_STATUS_VECT ISC_DB_H ISC_STMP_H

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-describe ISC_STATUS_VECT ISC_STMT_H ISC_ONE ISC_XSQLDA

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-execute ISC_STATUS_VECT ISC_TR_H ISC_STMP_H ISC_ONE ISC_XSQLDA

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-execute2 ISC_STATUS_VECT ISC_TR_H ISC_STMP_H ISC_ONE ISC_XSQLDA_IN ISC_XSQLDA_OUT

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-fetch ISC_STATUS_VECT ISC_STMP_H ISC_ONE ISC_XSQLDA

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-free-statement ISC_STATUS_VECT ISC_STMT_H ISC_CODE_ONE

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-prepare ISC_STATUS_VECT ISC_TR_H ISC_STMP_H ISC_ZERO ISC_DSQL_STR ISC_ONE ISC_XSQLDA

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-set-cursor-name ISC_STATUS_VECT ISC_STMT_H ISC_NAME ISC_NULL

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-dsql-sql-info ISC_STATUS_VECT ISC_STMP_H ISC_ONE ISC_REQ ISC_SIZE ISC_RES

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-get-segment ISC_STATUS_VECT ISC_BLOB_HANDLE ACTUAL_SEG_LEN BUFF_SIZE BUFFER

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-interprete ISC_MSG ISC_STATUS_VECT

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-open-blob2 ISC_STATUS_VECT ISC_DB_HANDLE ISC_TR_HANDLE ISC_BLOB_HANDLE ISC_QUAD_BLOB_ID ISC_USHORT BPB

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-print-status ISC_STATUS_VECT

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-rollback-transaction ISC_STATUS_VECT ISC_TR_H

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-sql-interprete ISC_SQL_CODE ISC_MSG ISC_MSG_SIZE

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-sqlcode ISC_STATUS_VECT

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: isc-start-transaction ISC_STATUS_VECT ISC_TR_H ISC_DB_COUNT ISC_DB_H ISC_TPB_LENGTH ISC_TPB

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Function: make-blob-handler ()

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: make-db-handler ()

Package

cl-fbclient

Source

cl-fbclient-database.lisp (file)

Function: make-default-tpb ()

Package

cl-fbclient

Source

cl-fbclient-transaction.lisp (file)

Function: make-dpb USERNAME PASSWORD

Package

cl-fbclient

Source

cl-fbclient-database.lisp (file)

Function: make-status-vector ()

Package

cl-fbclient

Source

cl-fbclient-error.lisp (file)

Function: make-stmt-handler ()

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: make-tr-handler ()

Package

cl-fbclient

Source

cl-fbclient-transaction.lisp (file)

Function: make-xsqlda N

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: need-remake-xsqlda TMP-XSQLDA

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: pow-10 N

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: remake-xsqlda TMP-XSQLDA

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: start-transaction DB-HANDLE-POINTER TRANSACTION-POINTER STATUS-VECTOR-POINTER

Package

cl-fbclient

Source

cl-fbclient-transaction.lisp (file)

Function: status-vector-error-p STATUS-VECTOR*

Package

cl-fbclient

Source

cl-fbclient-error.lisp (file)

Function: xsqlda-get-var-sqlscale XSQLDA* INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: xsqlda-get-var-val XSQLDA* INDEX

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Function: xsqlda-length N

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

5.2.4 Generic functions

Generic Function: db-handle* OBJECT

Generic Function: (setf db-handle*) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: db-handle* (FB-DATABASE fb-database)

automatically generated reader method

Source

cl-fbclient-database.lisp (file)

Method: (setf db-handle*) NEW-VALUE (FB-DATABASE fb-database)

automatically generated writer method

Source

cl-fbclient-database.lisp (file)

Generic Function: encoding OBJECT

Generic Function: (setf encoding) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: encoding (FB-DATABASE fb-database)

automatically generated reader method

Source

cl-fbclient-database.lisp (file)

Method: (setf encoding) NEW-VALUE (FB-DATABASE fb-database)

automatically generated writer method

Source

cl-fbclient-database.lisp (file)

Generic Function: fb-blob-handle OBJECT

Generic Function: (setf fb-blob-handle) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: fb-blob-handle (FB-BLOB fb-blob)

automatically generated reader method

Source

cl-fbclient-statement.lisp (file)

Method: (setf fb-blob-handle) NEW-VALUE (FB-BLOB fb-blob)

automatically generated writer method

Source

cl-fbclient-statement.lisp (file)

Generic Function: fb-blob-id OBJECT

Generic Function: (setf fb-blob-id) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: fb-blob-id (FB-BLOB fb-blob)

automatically generated reader method

Source

cl-fbclient-statement.lisp (file)

Method: (setf fb-blob-id) NEW-VALUE (FB-BLOB fb-blob)

automatically generated writer method

Source

cl-fbclient-statement.lisp (file)

Generic Function: fb-db OBJECT

Generic Function: (setf fb-db) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: fb-db (FB-TRANSACTION fb-transaction)

automatically generated reader method

Source

cl-fbclient-transaction.lisp (file)

Method: (setf fb-db) NEW-VALUE (FB-TRANSACTION fb-transaction)

automatically generated writer method

Source

cl-fbclient-transaction.lisp (file)

Generic Function: fb-tr OBJECT

Generic Function: (setf fb-tr) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: fb-tr (FB-STATEMENT fb-statement)

automatically generated reader method

Source

cl-fbclient-statement.lisp (file)

Method: (setf fb-tr) NEW-VALUE (FB-STATEMENT fb-statement)

automatically generated writer method

Source

cl-fbclient-statement.lisp (file)

Method: fb-tr (FB-BLOB fb-blob)

automatically generated reader method

Source

cl-fbclient-statement.lisp (file)

Method: (setf fb-tr) NEW-VALUE (FB-BLOB fb-blob)

automatically generated writer method

Source

cl-fbclient-statement.lisp (file)

Generic Function: host OBJECT

Generic Function: (setf host) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: host (FB-DATABASE fb-database)

automatically generated reader method

Source

cl-fbclient-database.lisp (file)

Method: (setf host) NEW-VALUE (FB-DATABASE fb-database)

automatically generated writer method

Source

cl-fbclient-database.lisp (file)

Generic Function: password OBJECT

Generic Function: (setf password) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: password (FB-DATABASE fb-database)

automatically generated reader method

Source

cl-fbclient-database.lisp (file)

Method: (setf password) NEW-VALUE (FB-DATABASE fb-database)

automatically generated writer method

Source

cl-fbclient-database.lisp (file)

Generic Function: path OBJECT

Generic Function: (setf path) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: path (FB-DATABASE fb-database)

automatically generated reader method

Source

cl-fbclient-database.lisp (file)

Method: (setf path) NEW-VALUE (FB-DATABASE fb-database)

automatically generated writer method

Source

cl-fbclient-database.lisp (file)

Generic Function: request-str OBJECT

Generic Function: (setf request-str) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: request-str (FB-STATEMENT fb-statement)

automatically generated reader method

Source

cl-fbclient-statement.lisp (file)

Method: (setf request-str) NEW-VALUE (FB-STATEMENT fb-statement)

automatically generated writer method

Source

cl-fbclient-statement.lisp (file)

Generic Function: (setf st-type) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: (setf st-type) NEW-VALUE (FB-STATEMENT fb-statement)

automatically generated writer method

Source

cl-fbclient-statement.lisp (file)

Generic Function: statement-handle* OBJECT

Generic Function: (setf statement-handle*) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: statement-handle* (FB-STATEMENT fb-statement)

automatically generated reader method

Source

cl-fbclient-statement.lisp (file)

Method: (setf statement-handle*) NEW-VALUE (FB-STATEMENT fb-statement)

automatically generated writer method

Source

cl-fbclient-statement.lisp (file)

Generic Function: transaction-handle* OBJECT

Generic Function: (setf transaction-handle*) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: transaction-handle* (FB-TRANSACTION fb-transaction)

automatically generated reader method

Source

cl-fbclient-transaction.lisp (file)

Method: (setf transaction-handle*) NEW-VALUE (FB-TRANSACTION fb-transaction)

automatically generated writer method

Source

cl-fbclient-transaction.lisp (file)

Generic Function: user-name OBJECT

Generic Function: (setf user-name) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: user-name (FB-DATABASE fb-database)

automatically generated reader method

Source

cl-fbclient-database.lisp (file)

Method: (setf user-name) NEW-VALUE (FB-DATABASE fb-database)

automatically generated writer method

Source

cl-fbclient-database.lisp (file)

Generic Function: xsqlda-output* OBJECT

Generic Function: (setf xsqlda-output*) NEW-VALUE OBJECT

Package

cl-fbclient

Methods

Method: xsqlda-output* (FB-STATEMENT fb-statement)

automatically generated reader method

Source

cl-fbclient-statement.lisp (file)

Method: (setf xsqlda-output*) NEW-VALUE (FB-STATEMENT fb-statement)

automatically generated writer method

Source

cl-fbclient-statement.lisp (file)

5.2.5 Classes

Class: fb-blob ()

Package

cl-fbclient

Source

cl-fbclient-statement.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• fb-blob-handle (method)
• fb-blob-handle (method)
• fb-blob-id (method)
• fb-blob-id (method)
• fb-tr (method)
• fb-tr (method)

Direct slots

Slot: fb-tr

Initargs

:fb-tr

Readers

fb-tr (generic function)

Writers

(setf fb-tr) (generic function)

Slot: blob-id

Initargs

:id

Readers

fb-blob-id (generic function)

Writers

(setf fb-blob-id) (generic function)

Slot: blob-handle

Readers

fb-blob-handle (generic function)

Writers

(setf fb-blob-handle) (generic function)

Class: isc_quad-tclass ()

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: isc_timestamp-tclass ()

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: tm-tclass ()

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: xsqlda-tclass ()

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: xsqlvar-tclass ()

Package

cl-fbclient

Source

cl-fbclient-cffi.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions