The cl-postgres-plus-uuid Reference Manual

Table of Contents

The cl-postgres-plus-uuid Reference Manual

This is the cl-postgres-plus-uuid Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:11:29 2021 GMT+0.

1 Introduction

cl-postgres-plus-uuid

cl-postgres-plus-uuid is a Common Lisp library that defines a cl-postgres SQL reader for the PostgreSQL UUID type.

cl-postgres-plus-uuid depends on cl-postgres and UUID.

cl-postgres-plus-uuid is being developed with SBCL, CCL, and LispWorks on OS X. cl-postgres-plus-uuid is being deployed with SBCL on FreeBSD/AMD64 and Linux/AMD64.

Installation

(ql:quickload "cl-postgres-plus-uuid")

Example

(defvar *connection* (cl-postgres:open-database *dbname* *dbuser* *dbpassword* *dbhost*))

(cl-postgres:exec-query *connection* "SELECT uuid_generate_v4();" 'cl-postgres:list-row-reader)
=> (("ce29603b-59b8-4354-9e3c-3798a10451de"))

(cl-postgres-plus-uuid:set-uuid-sql-reader)

(cl-postgres:exec-query *connection* "SELECT uuid_generate_v4();" 'cl-postgres:list-row-reader)
=> ((C526D222-9A51-4453-99D1-FCC691826020))

(type-of (caar *))
=> UUID:UUID

(cl-postgres:close-database *connection*)

License

cl-postgres-plus-uuid is distributed under the MIT license. See LICENSE.

2 Systems

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

2.1 cl-postgres-plus-uuid

Author

Michael J. Forster <mike@forsterfamily.ca>

License

MIT

Description

Common Lisp library providing a cl-postgres SQL reader for the PostgreSQL UUID type.

Version

0.0.1

Dependencies

• cl-postgres
• uuid

Source

cl-postgres-plus-uuid.asd (file)

Components

• package.lisp (file)
• cl-postgres-plus-uuid.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-postgres-plus-uuid.asd

Location

cl-postgres-plus-uuid.asd

Systems

cl-postgres-plus-uuid (system)

3.1.2 cl-postgres-plus-uuid/package.lisp

Parent

cl-postgres-plus-uuid (system)

Location

package.lisp

Packages

cl-postgres-plus-uuid

3.1.3 cl-postgres-plus-uuid/cl-postgres-plus-uuid.lisp

Dependency

package.lisp (file)

Parent

cl-postgres-plus-uuid (system)

Location

cl-postgres-plus-uuid.lisp

Exported Definitions

set-uuid-sql-reader (function)

Internal Definitions

+uuid-oid+ (constant)

4 Packages

Packages are listed by definition order.

4.1 cl-postgres-plus-uuid

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

set-uuid-sql-reader (function)

Internal Definitions

+uuid-oid+ (constant)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: set-uuid-sql-reader &optional TABLE

Package

cl-postgres-plus-uuid

Source

cl-postgres-plus-uuid.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +uuid-oid+

The value of the PostgreSQL Object Identifier (OID) for the UUID data type.

Obtained from the PostgreSQL pg_type system catalogue via the
following query:

SELECT oid FROM pg_type WHERE typname = ’uuid’;

See https://www.postgresql.org/docs/current/static/datatype-oid.html, https://www.postgresql.org/docs/current/static/datatype-uuid.html, and https://www.postgresql.org/docs/current/static/catalog-pg-type.html.

Package

cl-postgres-plus-uuid

Source

cl-postgres-plus-uuid.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types