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

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 Nov 06 15:00:30 2023 GMT+0.

Next: Systems, Previous: The sxql-composer Reference Manual, Up: The sxql-composer Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The sxql-composer Reference Manual [Contents][Index]

2 Systems

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

sxql-composer

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

2.1 `sxql-composer`

Build and compose SXQL queries dynamically

Author

Mariano Montone <marianomontone@gmail.com>

License

MIT

Version

0.1

Dependency

sxql (system).

Source

sxql-composer.asd.

Child Components

package.lisp (file).
sxql-composer.lisp (file).

Next: Packages, Previous: Systems, Up: The sxql-composer Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: sxql-composer/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `sxql-composer/sxql-composer.asd`

Source: sxql-composer.asd.
Parent Component: sxql-composer (system).
ASDF Systems: sxql-composer.

Next: sxql-composer/sxql-composer.lisp, Previous: sxql-composer/sxql-composer.asd, Up: Lisp [Contents][Index]

3.1.2 `sxql-composer/package.lisp`

Source: sxql-composer.asd.
Parent Component: sxql-composer (system).
Packages: sxql-composer.

Previous: sxql-composer/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `sxql-composer/sxql-composer.lisp`

Dependency

package.lisp (file).

Source

sxql-composer.asd.

Parent Component

sxql-composer (system).

Public Interface

and-where (function).
fields+ (function).
fields= (function).
from+ (function).
from= (function).
group-by+ (function).
group-by= (function).
limit= (function).
offset= (function).
or-where (function).
order-by+ (function).
order-by= (function).
returning= (function).
where= (function).

Internals

expand-expression (function).
expand-op (function).
fields (function).
from* (function).
group-by* (function).
order-by* (function).
set-child (function).
where* (function).

Next: Definitions, Previous: Files, Up: The sxql-composer Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

sxql-composer

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

4.1 `sxql-composer`

Dynamic SXQL query composition

Source

package.lisp.

Use List

common-lisp.

Public Interface

and-where (function).
fields+ (function).
fields= (function).
from+ (function).
from= (function).
group-by+ (function).
group-by= (function).
limit= (function).
offset= (function).
or-where (function).
order-by+ (function).
order-by= (function).
returning= (function).
where= (function).

Internals

expand-expression (function).
expand-op (function).
fields (function).
from* (function).
group-by* (function).
order-by* (function).
set-child (function).
where* (function).

Next: Indexes, Previous: Packages, Up: The sxql-composer Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

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

5.2 Internals

Ordinary functions

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

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.

Previous: Definitions, Up: The sxql-composer Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

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

A.4 Data types

Jump to:	F P S

	Index Entry	Section

F
	`File, package.lisp`:	The sxql-composer/package․lisp file
	`File, sxql-composer.asd`:	The sxql-composer/sxql-composer․asd file
	`File, sxql-composer.lisp`:	The sxql-composer/sxql-composer․lisp file

P
	`Package, sxql-composer`:	The sxql-composer package
	`package.lisp`:	The sxql-composer/package․lisp file

S
	`sxql-composer`:	The sxql-composer system
	`sxql-composer`:	The sxql-composer package
	`sxql-composer.asd`:	The sxql-composer/sxql-composer․asd file
	`sxql-composer.lisp`:	The sxql-composer/sxql-composer․lisp file
	`System, sxql-composer`:	The sxql-composer system

The sxql-composer Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 sxql-composer

3 Files

3.1 Lisp

3.1.1 sxql-composer/sxql-composer.asd

3.1.2 sxql-composer/package.lisp

3.1.3 sxql-composer/sxql-composer.lisp

4 Packages

4.1 sxql-composer

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `sxql-composer`

3.1.1 `sxql-composer/sxql-composer.asd`

3.1.2 `sxql-composer/package.lisp`

3.1.3 `sxql-composer/sxql-composer.lisp`

4.1 `sxql-composer`