The vellum-postmodern Reference Manual

This is the vellum-postmodern Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 07:03:49 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 vellum-postmodern

Postgres support for Vellum Data Frames (via postmodern).

Author

Marek Kochanowicz

License

BSD simplified

Version

1.0.0

Dependencies
  • iterate (system).
  • serapeum (system).
  • vellum (system)., at least version ((>= "1.2.0"))
  • alexandria (system).
  • cl-postgres (system).
  • s-sql (system).
  • documentation-utils-extensions (system).
  • postmodern (system).
Source

vellum-postmodern.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 vellum-postmodern/vellum-postmodern.asd

Source

vellum-postmodern.asd.

Parent Component

vellum-postmodern (system).

ASDF Systems

vellum-postmodern.


3.1.2 vellum-postmodern/package.lisp

Source

vellum-postmodern.asd.

Parent Component

vellum-postmodern (system).

Packages

vellum-postmodern.


3.1.3 vellum-postmodern/code.lisp

Dependency

package.lisp (file).

Source

vellum-postmodern.asd.

Parent Component

vellum-postmodern (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 vellum-postmodern

Source

package.lisp.

Use List
  • common-lisp.
  • vellum.aux-package.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: postgres-query (query header &key parameters prepared)
Package

vellum-postmodern.

Source

code.lisp.


5.1.2 Standalone methods

Method: across ((object postgres-query) function)
Package

cl-data-structures.

Source

code.lisp.

Method: across-aggregate ((object postgres-query) function)
Package

cl-data-structures.algorithms.meta.

Source

code.lisp.

Method: clone ((object postgres-query))
Package

cl-data-structures.

Source

code.lisp.

Method: reset! ((object postgres-query))
Package

cl-data-structures.

Source

code.lisp.

Method: traverse ((object postgres-query) function)
Package

cl-data-structures.

Source

code.lisp.


5.1.3 Classes

Class: postgres-query
Package

vellum-postmodern.

Source

code.lisp.

Direct superclasses
  • frame-range-mixin.
  • traversable.
Direct methods
Direct slots
Slot: %query
Initargs

:query

Readers

read-query.

Writers

This slot is read-only.

Slot: %parameters
Initargs

:parameters

Readers

read-parameters.

Writers

This slot is read-only.

Slot: %prepared
Initargs

:prepared

Readers

read-prepared.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Generic functions

Generic Reader: read-parameters (object)
Package

vellum-postmodern.

Methods
Reader Method: read-parameters ((postgres-query postgres-query))

automatically generated reader method

Source

code.lisp.

Target Slot

%parameters.

Generic Reader: read-prepared (object)
Package

vellum-postmodern.

Methods
Reader Method: read-prepared ((postgres-query postgres-query))

automatically generated reader method

Source

code.lisp.

Target Slot

%prepared.

Generic Reader: read-query (object)
Package

vellum-postmodern.

Methods
Reader Method: read-query ((postgres-query postgres-query))

automatically generated reader method

Source

code.lisp.

Target Slot

%query.


Appendix A Indexes


A.1 Concepts


A.3 Variables