This is the piggyback-parameters Reference Manual, version 0.1.7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:21:36 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
piggyback-parametersThis is a configuration system that supports local file and database based parameter storage.
Eric Diethelm <ediethelm@yahoo.com>
MIT
0.1.7
trivial-pooled-database (system).
trivial-hashtable-serialize (system).
trivial-json-codec (system).
package.lisp (file).
piggyback-parameters.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
piggyback-parameters/piggyback-parameters.asdpiggyback-parameters/package.lisppiggyback-parameters/piggyback-parameters.lisppiggyback-parameters/piggyback-parameters.asdpiggyback-parameters (system).
piggyback-parameters/package.lisppiggyback-parameters (system).
piggyback-parameters/piggyback-parameters.lisppiggyback-parameters (system).
clear-parameter (function).
delete-parameter (function).
file-not-found-error (condition).
get-value (function).
(setf get-value) (function).
reset (function).
set-configuration-file (function).
*config-file* (special variable).
*parameters* (special variable).
config-parameter (class).
find-parameter (function).
get-key (reader method).
load-file (function).
load-value (generic function).
path (reader method).
save-file (function).
save-value (generic function).
strategy (reader method).
try-merge (function).
Packages are listed by definition order.
piggyback-parameterspiggyback-parameters is a parameter system that supports local file and database parameter storage.
common-lisp.
clear-parameter (function).
delete-parameter (function).
file-not-found-error (condition).
get-value (function).
(setf get-value) (function).
reset (function).
set-configuration-file (function).
*config-file* (special variable).
*parameters* (special variable).
config-parameter (class).
find-parameter (function).
get-key (generic reader).
load-file (function).
load-value (generic function).
path (generic reader).
save-file (function).
save-value (generic function).
strategy (generic reader).
try-merge (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Remove the parameter from memory (aka unload).
Delete the *parameter* *from* the indicated source. Also removes it from memory.
**:file** - Delete the *parameter* from the configuration file;
**:database** - Delete the *parameter* from the database;
**:everywhere** - Delete the *parameter* from both file and database
Read the value of paramter *PARAM*. The source of the value can be defined by *STRATEGY*, which accepts following values
**nil** Reuse the same strategy as in the previous get/set of this parameter;
**:file-first** Load the value first from the local configuration and, if it does not exist, from the database;
**:db-first** Load the value first from the database and, if it does not exist, from the local configuration;
**:try-append** Load the values both from database and from local configuration and try to append them (valid types are only *list* and *string*);
**:file-only** Load the value only from the local configuration file;
**:db-only** Load the value only from the database.
Save the parameter *PARAMETER* with value *VALUE* into storage. The storage destination is defined by the parameter *STRATEGY* with possible values being
**nil** Reuse the same strategy as in the previous get/set of this parameter;
**:local-only** Save the parameter/value pair only in the local configuration file;
**:database-only** Save the parameter/value pair only in the database.
Define the path of the configuration file to be used in combination with the :file-only and :file-first strategies.
config-parameter)) ¶automatically generated reader method
key.
(eql :database-first))) ¶(eql :file-first))) ¶(eql :memory-only))) ¶(eql :file-only))) ¶(eql :database-only))) ¶file-not-found-error)) ¶path.
(eql :database-first)) value) ¶(eql :file-first)) value) ¶(eql :memory-only)) value) ¶(eql :file-only)) value) ¶(eql :database-only)) value) ¶config-parameter)) ¶automatically generated reader method
| Jump to: | (
C D F G L M P R S T |
|---|
| Jump to: | (
C D F G L M P R S T |
|---|
| Jump to: | *
K P R S V |
|---|
| Jump to: | *
K P R S V |
|---|
| Jump to: | C F P S |
|---|
| Jump to: | C F P S |
|---|