The sxql-composer Reference Manual

Table of Contents

The sxql-composer Reference Manual

This is the sxql-composer Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:55:26 2021 GMT+0.

1 Introduction

SXQL-COMPOSER

Build and compose SXQL queries dynamically.

Motivation

It is not possible to dynamically build and compose SXQL queries because it uses macros for query building. For example, something like:

(defun build-query (fields &key order-by)
    (select fields
      (where (:= 'user.id 1))
      (when order-by
        (order-by order-by))))

is not possible.

SXQL-COMPOSER implements an equivalent set of functions in order to be able to either build new queries dynamically, or modify and composer already existent queries.

With SXQL-COMPOSER:

(defun build-query (fields &key order-by)
   (let ((q (select fields
               (where (:= 'user.id 1)))))
      (when order-by (order-by= q order-by))
      q))

Also, it is not possible to modify already existent queries. That is useful for filtering:

(defun all-users ()
   (select :* (from :users)))

(defun married-users ()
   (and-where (all-users)
       '(:= status "married")))

CL-ARROWS library is potentially useful for building the queries:

(defun married-users ()
   (-> (all-users)
      (and-where '(:= status "married"))))

Functions

and-where

(statement expression)

Add an AND clause to the WHERE clause of SQL STATEMENT

fields+

(statement &rest fields)

Add FIELDS to the SELECT SQL STATEMENT

fields=

(statement fields)

Set the FIELDS of the SELECT SQL STATEMENT

from+

(statement &rest tables)

Add TABLES to the FROM clause of the SQL STATEMENT

from=

(statement &rest tables)

Set the FROM clause of the SQL STATEMENT

group-by+

(statement &rest expressions)

Add expressions to the GROUP BY clause of the SQL STATEMENT

group-by=

(statement &rest expressions)

Set the GROUP BY clause of the SQL statement

limit=

(statement count1 &optional count2)

Set the LIMIT clause of the SQL STATEMENT

offset=

(statement offset)

Set the OFFSET clause of the SQL STATEMENT

or-where

(statement expression)

Add an OR clause to the WHERE clause of SQL STATEMENT

order-by+

(statement &rest expressions)

Add EXPRESSIONS ot the ORDER BY clause of the SQL STATEMENT

order-by=

(statement &rest expressions)

Set the ORDER BY clause of the SQL STATEMENT

returning=

(statement expression)

Set the RETURNING clause of SQL STATEMENT

where=

(statement expression)

Set SQL WHERE clause of the SQL STATEMENT

2 Systems

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

2.1 sxql-composer

Author

Mariano Montone <marianomontone@gmail.com>

License

MIT

Description

Build and compose SXQL queries dynamically

Version

0.1

Dependency

sxql

Source

sxql-composer.asd (file)

Components

• package.lisp (file)
• sxql-composer.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 sxql-composer.asd

Location

sxql-composer.asd

Systems

sxql-composer (system)

3.1.2 sxql-composer/package.lisp

Parent

sxql-composer (system)

Location

package.lisp

Packages

sxql-composer

3.1.3 sxql-composer/sxql-composer.lisp

Dependency

package.lisp (file)

Parent

sxql-composer (system)

Location

sxql-composer.lisp

Exported Definitions

• 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)

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 sxql-composer

Dynamic SXQL query composition

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• 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)

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: and-where STATEMENT EXPRESSION

Add an AND clause to the WHERE clause of SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: fields+ STATEMENT &rest FIELDS

Add FIELDS to the SELECT SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: fields= STATEMENT FIELDS

Set the FIELDS of the SELECT SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: from+ STATEMENT &rest TABLES

Add TABLES to the FROM clause of the SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: from= STATEMENT &rest TABLES

Set the FROM clause of the SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: group-by+ STATEMENT &rest EXPRESSIONS

Add expressions to the GROUP BY clause of the SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: group-by= STATEMENT &rest EXPRESSIONS

Set the GROUP BY clause of the SQL statement

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: limit= STATEMENT COUNT1 &optional COUNT2

Set the LIMIT clause of the SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: offset= STATEMENT OFFSET

Set the OFFSET clause of the SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: or-where STATEMENT EXPRESSION

Add an OR clause to the WHERE clause of SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: order-by+ STATEMENT &rest EXPRESSIONS

Add EXPRESSIONS ot the ORDER BY clause of the SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: order-by= STATEMENT &rest EXPRESSIONS

Set the ORDER BY clause of the SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: returning= STATEMENT EXPRESSION

Set the RETURNING clause of SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: where= STATEMENT EXPRESSION

Set SQL WHERE clause of the SQL STATEMENT

Package

sxql-composer

Source

sxql-composer.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: expand-expression EXPRESSIONS

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: expand-op OBJECT

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: fields STATEMENT FIELDS &optional ACTION

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: from* STATEMENT TABLE-OR-TABLES &optional ACTION

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: group-by* STATEMENT EXPRESSIONS &optional ACTION

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: order-by* STATEMENT EXPRESSIONS &optional ACTION

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: set-child STATEMENT CHILD

Package

sxql-composer

Source

sxql-composer.lisp (file)

Function: where* STATEMENT EXPRESSION &optional ACTION

Package

sxql-composer

Source

sxql-composer.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types