The clsql-fluid Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The clsql-fluid Reference Manual

This is the clsql-fluid Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:35:22 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

This is a snapshot branch for users who wish to fetch the Fluid
backend separately from CLSQL.  It does not include unit tests.

If you are interested in hacking this, please branch from repository 
https://github.com/html/clsql-fluid.git

Originally code copied from branch `fluid-pools' in git://repo.or.cz/clsql/s11.git .  

More
information about this branch at

http://repo.or.cz/w/clsql/s11.git?a=shortlog;h=refs/heads/fluid-pools

Please do not submit Darcs patches.

Thanks for clsql-sys:*error-on-print-object-p* option code to Jocelyn Fr├ęchot 


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 clsql-fluid

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Stephen Compall <scompall@nocandysw.com>

License

Lessor Lisp General Public License

Description

Common Lisp SQL Fluid Connection Pools

Long Description

A full database type based on fluids, or per-thread connections.

Dependencies
Source

clsql-fluid.asd (file)

Component

sql (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 clsql-fluid/sql

Parent

clsql-fluid (system)

Location

sql/

Component

base (module)


Previous: , Up: Modules   [Contents][Index]

3.2 clsql-fluid/sql/base

Parent

sql (module)

Location

sql/

Component

fluid.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 clsql-fluid.asd

Location

clsql-fluid.asd

Systems

clsql-fluid (system)

Packages

clsql-fluid-system


Previous: , Up: Lisp files   [Contents][Index]

4.1.2 clsql-fluid/sql/base/fluid.lisp

Parent

base (module)

Location

sql/fluid.lisp

Packages

clsql-fluid-bt

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 clsql-fluid-system

Source

clsql-fluid.asd

Use List

Previous: , Up: Packages   [Contents][Index]

5.2 clsql-fluid-bt

Fluids implemented around Bordeaux-Threads.

Source

fluid.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: fluid-lock INSTANCE
Function: (setf fluid-lock) VALUE INSTANCE
Package

clsql-fluid-bt

Source

fluid.lisp (file)

Function: fluid-value FLUID &optional THREAD

Answer two values: the value of FLUID for THREAD, and whether a value is present.

Package

clsql-fluid-bt

Source

fluid.lisp (file)

Writer

(setf fluid-value) (function)

Function: (setf fluid-value) NEW-VALUE FLUID &optional THREAD

Alter the value of FLUID for THREAD to NEW-VALUE, answering NEW-VALUE.

Package

clsql-fluid-bt

Source

fluid.lisp (file)

Reader

fluid-value (function)

Function: make-fluid &key (LOCK LOCK) (TABLE TABLE) (GC-FUNCTION GC-FUNCTION) (GC-COUNT GC-COUNT) (GC-FREQUENCY GC-FREQUENCY)
Package

clsql-fluid-bt

Source

fluid.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: copy-fluid INSTANCE
Package

clsql-fluid-bt

Source

fluid.lisp (file)

Function: fluid-gc FLUID

Clean up FLUID. *Assume it is locked in this thread.*

Package

clsql-fluid-bt

Source

fluid.lisp (file)

Function: fluid-gc-count INSTANCE
Function: (setf fluid-gc-count) VALUE INSTANCE
Package

clsql-fluid-bt

Source

fluid.lisp (file)

Function: fluid-gc-frequency INSTANCE
Package

clsql-fluid-bt

Source

fluid.lisp (file)

Function: fluid-gc-function INSTANCE
Package

clsql-fluid-bt

Source

fluid.lisp (file)

Function: fluid-p OBJECT
Package

clsql-fluid-bt

Source

fluid.lisp (file)

Function: fluid-table INSTANCE
Package

clsql-fluid-bt

Source

fluid.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Structures

Structure: fluid ()

A container for a different value in each thread. Values are not inherited.

Package

clsql-fluid-bt

Source

fluid.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: lock
Initform

(bordeaux-threads:make-lock)

Readers

fluid-lock (function)

Writers

(setf fluid-lock) (function)

Slot: table
Type

hash-table

Initform

(make-hash-table :test (function eql))

Readers

fluid-table (function)

Writers

(setf fluid-table) (function)

Slot: gc-function
Type

(or symbol cons function)

Initform

(function identity)

Readers

fluid-gc-function (function)

Writers

(setf fluid-gc-function) (function)

Slot: gc-count
Type

(and (integer 0) fixnum)

Initform

0

Readers

fluid-gc-count (function)

Writers

(setf fluid-gc-count) (function)

Slot: gc-frequency
Type

(and (integer 1) fixnum)

Initform

30

Readers

fluid-gc-frequency (function)

Writers

(setf fluid-gc-frequency) (function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
clsql-fluid.asd: The clsql-fluid<dot>asd file
clsql-fluid/sql: The clsql-fluid/sql module
clsql-fluid/sql/base: The clsql-fluid/sql/base module
clsql-fluid/sql/base/fluid.lisp: The clsql-fluid/sql/base/fluid<dot>lisp file

F
File, Lisp, clsql-fluid.asd: The clsql-fluid<dot>asd file
File, Lisp, clsql-fluid/sql/base/fluid.lisp: The clsql-fluid/sql/base/fluid<dot>lisp file

L
Lisp File, clsql-fluid.asd: The clsql-fluid<dot>asd file
Lisp File, clsql-fluid/sql/base/fluid.lisp: The clsql-fluid/sql/base/fluid<dot>lisp file

M
Module, clsql-fluid/sql: The clsql-fluid/sql module
Module, clsql-fluid/sql/base: The clsql-fluid/sql/base module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
C   F   M  
Index Entry  Section

(
(setf fluid-gc-count): Internal functions
(setf fluid-lock): Exported functions
(setf fluid-value): Exported functions

C
copy-fluid: Internal functions

F
fluid-gc: Internal functions
fluid-gc-count: Internal functions
fluid-gc-frequency: Internal functions
fluid-gc-function: Internal functions
fluid-lock: Exported functions
fluid-p: Internal functions
fluid-table: Internal functions
fluid-value: Exported functions
Function, (setf fluid-gc-count): Internal functions
Function, (setf fluid-lock): Exported functions
Function, (setf fluid-value): Exported functions
Function, copy-fluid: Internal functions
Function, fluid-gc: Internal functions
Function, fluid-gc-count: Internal functions
Function, fluid-gc-frequency: Internal functions
Function, fluid-gc-function: Internal functions
Function, fluid-lock: Exported functions
Function, fluid-p: Internal functions
Function, fluid-table: Internal functions
Function, fluid-value: Exported functions
Function, make-fluid: Exported functions

M
make-fluid: Exported functions

Jump to:   (  
C   F   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   G   L   S   T  
Index Entry  Section

G
gc-count: Internal structures
gc-frequency: Internal structures
gc-function: Internal structures

L
lock: Internal structures

S
Slot, gc-count: Internal structures
Slot, gc-frequency: Internal structures
Slot, gc-function: Internal structures
Slot, lock: Internal structures
Slot, table: Internal structures

T
table: Internal structures

Jump to:   G   L   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   F   P   S  
Index Entry  Section

C
clsql-fluid: The clsql-fluid system
clsql-fluid-bt: The clsql-fluid-bt package
clsql-fluid-system: The clsql-fluid-system package

F
fluid: Internal structures

P
Package, clsql-fluid-bt: The clsql-fluid-bt package
Package, clsql-fluid-system: The clsql-fluid-system package

S
Structure, fluid: Internal structures
System, clsql-fluid: The clsql-fluid system

Jump to:   C   F   P   S