The sxql-composer Reference Manual

This is the sxql-composer Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:59:54 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 sxql-composer

Build and compose SXQL queries dynamically

Author

Mariano Montone <>

License

MIT

Version

0.1

Dependency

sxql (system).

Source

sxql-composer.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 sxql-composer/sxql-composer.asd

Source

sxql-composer.asd.

Parent Component

sxql-composer (system).

ASDF Systems

sxql-composer.


3.1.2 sxql-composer/package.lisp

Source

sxql-composer.asd.

Parent Component

sxql-composer (system).

Packages

sxql-composer.


3.1.3 sxql-composer/sxql-composer.lisp

Dependency

package.lisp (file).

Source

sxql-composer.asd.

Parent Component

sxql-composer (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 sxql-composer

Dynamic SXQL query composition

Source

package.lisp.

Use List

common-lisp.

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: and-where (statement expression)

Add an AND clause to the WHERE clause of SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: fields+ (statement &rest fields)

Add FIELDS to the SELECT SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: fields= (statement fields)

Set the FIELDS of the SELECT SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: from+ (statement &rest tables)

Add TABLES to the FROM clause of the SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: from= (statement &rest tables)

Set the FROM clause of the SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: group-by+ (statement &rest expressions)

Add expressions to the GROUP BY clause of the SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: group-by= (statement &rest expressions)

Set the GROUP BY clause of the SQL statement

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: limit= (statement count1 &optional count2)

Set the LIMIT clause of the SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: offset= (statement offset)

Set the OFFSET clause of the SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: or-where (statement expression)

Add an OR clause to the WHERE clause of SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: order-by+ (statement &rest expressions)

Add EXPRESSIONS ot the ORDER BY clause of the SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: order-by= (statement &rest expressions)

Set the ORDER BY clause of the SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: returning= (statement expression)

Set the RETURNING clause of SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.

Function: where= (statement expression)

Set SQL WHERE clause of the SQL STATEMENT

Package

sxql-composer.

Source

sxql-composer.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: expand-expression (expressions)
Package

sxql-composer.

Source

sxql-composer.lisp.

Function: expand-op (object)
Package

sxql-composer.

Source

sxql-composer.lisp.

Function: fields (statement fields &optional action)
Package

sxql-composer.

Source

sxql-composer.lisp.

Function: from* (statement table-or-tables &optional action)
Package

sxql-composer.

Source

sxql-composer.lisp.

Function: group-by* (statement expressions &optional action)
Package

sxql-composer.

Source

sxql-composer.lisp.

Function: order-by* (statement expressions &optional action)
Package

sxql-composer.

Source

sxql-composer.lisp.

Function: set-child (statement child)
Package

sxql-composer.

Source

sxql-composer.lisp.

Function: where* (statement expression &optional action)
Package

sxql-composer.

Source

sxql-composer.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   E   F   G   L   O   R   S   W  
Index Entry  Section

A
and-where: Public ordinary functions

E
expand-expression: Private ordinary functions
expand-op: Private ordinary functions

F
fields: Private ordinary functions
fields+: Public ordinary functions
fields=: Public ordinary functions
from*: Private ordinary functions
from+: Public ordinary functions
from=: Public ordinary functions
Function, and-where: Public ordinary functions
Function, expand-expression: Private ordinary functions
Function, expand-op: Private ordinary functions
Function, fields: Private ordinary functions
Function, fields+: Public ordinary functions
Function, fields=: Public ordinary functions
Function, from*: Private ordinary functions
Function, from+: Public ordinary functions
Function, from=: Public ordinary functions
Function, group-by*: Private ordinary functions
Function, group-by+: Public ordinary functions
Function, group-by=: Public ordinary functions
Function, limit=: Public ordinary functions
Function, offset=: Public ordinary functions
Function, or-where: Public ordinary functions
Function, order-by*: Private ordinary functions
Function, order-by+: Public ordinary functions
Function, order-by=: Public ordinary functions
Function, returning=: Public ordinary functions
Function, set-child: Private ordinary functions
Function, where*: Private ordinary functions
Function, where=: Public ordinary functions

G
group-by*: Private ordinary functions
group-by+: Public ordinary functions
group-by=: Public ordinary functions

L
limit=: Public ordinary functions

O
offset=: Public ordinary functions
or-where: Public ordinary functions
order-by*: Private ordinary functions
order-by+: Public ordinary functions
order-by=: Public ordinary functions

R
returning=: Public ordinary functions

S
set-child: Private ordinary functions

W
where*: Private ordinary functions
where=: Public ordinary functions


A.3 Variables