The cl-sparql Reference Manual

Table of Contents

The cl-sparql Reference Manual

This is the cl-sparql Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:21:10 2021 GMT+0.

1 Introduction

CL-SPARQL

SPARQL query builder for Common Lisp.

Syntax

(sparql (:select * :where (?x ?y ?z)))

 (sparql 
    (:select *
        :where (?x ?y ?z)
        :limit 20
        :offset 10))

Subqueries

(sparql 
    (:select *
        :where (?x ?y ?z)
            (:select *
                :where (?x ?y ?z)
                :limit 20
                :offset 10)
        :limit 20
        :offset 10))

URI syntax

Enable special URI syntax with (sparql:enable-uri-syntax).

After that, you can write uris like:

#u<rdf:type>

and you get the expanded uri:

#<PURI:URI http://www.w3.org/1999/02/22-rdf-syntax-ns#type>.

Use define-uri-prefix to define new uri prefixes expansions, like:

(define-uri-prefix rdf "http://www.w3.org/1999/02/22-rdf-syntax-ns#")
(define-uri-prefix xsd "http://www.w3.org/2001/XMLSchema#")
(define-uri-prefix ex "http://www.franz.com/things#")  
(define-uri-prefix rdfs "http://www.w3.org/2000/01/rdf-schema#")  
(define-uri-prefix fn "http://www.w3.org/2005/xpath-functions#") 
(define-uri-prefix err "http://www.w3.org/2005/xqt-errors#")  
(define-uri-prefix owl "http://www.w3.org/2002/07/owl#")  
(define-uri-prefix xs "http://www.w3.org/2001/XMLSchema#")

Those are already defined.

Implementation technique

I think the embedded domain specific language technique used is interesting. parser-combinators library is used, but, instead of using for parsing strings, it is used for parsing already read Lisp lists.

License

MIT

2 Systems

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

2.1 cl-sparql

Author

Mariano Montone <marianomontone@gmail.com>

License

MIT

Description

SPARQL query builder for Common Lisp

Version

0.0.1

Dependencies

• puri
• parser-combinators
• cl-ppcre
• split-sequence

Source

cl-sparql.asd (file)

Components

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

Location

cl-sparql.asd

Systems

cl-sparql (system)

3.1.2 cl-sparql/package.lisp

Parent

cl-sparql (system)

Location

package.lisp

Packages

sparql

3.1.3 cl-sparql/sparql.lisp

Dependency

package.lisp (file)

Parent

cl-sparql (system)

Location

sparql.lisp

Exported Definitions

• sparql (macro)
• sparql-compile (function)
• sparql-eval (function)

Internal Definitions

• *eval* (special variable)
• expand (function)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• in-list (function)
• reduce-strings (function)
• render-sparql (function)
• sparql-delete-data (function)
• sparql-filter-exists (function)
• sparql-filter-not-exists (function)
• sparql-insert-data (function)
• sparql-limit (function)
• sparql-minus (function)
• sparql-offset (function)
• sparql-optional (function)
• sparql-order-arg (function)
• sparql-order-by (function)
• sparql-order-term (function)
• sparql-parser (function)
• sparql-select (function)
• sparql-subselect (function)
• sparql-triple (function)
• sparql-union (function)
• sparql-var (function)
• sparql-where (function)
• sparql-where-graph (function)
• strcat (function)
• transform (function)
• triple-object (function)
• triple-predicate (function)
• triple-subject (function)
• triples-block (function)
• where-body (function)
• where-triple (function)

3.1.4 cl-sparql/uri.lisp

Dependency

sparql.lisp (file)

Parent

cl-sparql (system)

Location

uri.lisp

Exported Definitions

• define-uri-prefix (macro)
• enable-uri-syntax (function)
• get-uri-prefix (function)
• make-uri (function)
• parse-literal (function)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• render-literal (method)

Internal Definitions

• *uri-prefixes* (special variable)
• clean-literal (function)
• display-uri-prefixes (function)
• parse-boolean-literal (function)
• parse-typed-literal (function)
• parse-uri (function)
• uri-reader (function)

4 Packages

Packages are listed by definition order.

4.1 sparql

Source

package.lisp (file)

Use List

• parser-combinators
• common-lisp

Exported Definitions

• define-uri-prefix (macro)
• enable-uri-syntax (function)
• get-uri-prefix (function)
• make-uri (function)
• parse-literal (function)
• render-literal (generic function)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• render-literal (method)
• sparql (macro)
• sparql-compile (function)
• sparql-eval (function)

Internal Definitions

• *eval* (special variable)
• *uri-prefixes* (special variable)
• clean-literal (function)
• display-uri-prefixes (function)
• expand (function)
• expand-term (generic function)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• expand-term (method)
• in-list (function)
• parse-boolean-literal (function)
• parse-typed-literal (function)
• parse-uri (function)
• reduce-strings (function)
• render-sparql (function)
• sparql-delete-data (function)
• sparql-filter-exists (function)
• sparql-filter-not-exists (function)
• sparql-insert-data (function)
• sparql-limit (function)
• sparql-minus (function)
• sparql-offset (function)
• sparql-optional (function)
• sparql-order-arg (function)
• sparql-order-by (function)
• sparql-order-term (function)
• sparql-parser (function)
• sparql-select (function)
• sparql-subselect (function)
• sparql-triple (function)
• sparql-union (function)
• sparql-var (function)
• sparql-where (function)
• sparql-where-graph (function)
• strcat (function)
• transform (function)
• triple-object (function)
• triple-predicate (function)
• triple-subject (function)
• triples-block (function)
• uri-reader (function)
• where-body (function)
• where-triple (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: define-uri-prefix URI-PREFIX VALUE &optional DOCUMENTATION

Package

sparql

Source

uri.lisp (file)

Macro: sparql SPARQL

Package

sparql

Source

sparql.lisp (file)

5.1.2 Functions

Function: enable-uri-syntax ()

Package

sparql

Source

uri.lisp (file)

Function: get-uri-prefix URI-PREFIX

Package

sparql

Source

uri.lisp (file)

Function: make-uri PREFIX URI &rest ARGS

Package

sparql

Source

uri.lisp (file)

Function: parse-literal LITERAL

Package

sparql

Source

uri.lisp (file)

Function: sparql-compile SPARQL

Package

sparql

Source

sparql.lisp (file)

Function: sparql-eval SPARQL

Package

sparql

Source

sparql.lisp (file)

5.1.3 Generic functions

Generic Function: render-literal VALUE

Package

sparql

Methods

Method: render-literal (X symbol)

Source

uri.lisp (file)

Method: render-literal (X (eql nil))

Source

uri.lisp (file)

Method: render-literal (X (eql t))

Source

uri.lisp (file)

Method: render-literal (URI uri)

Source

uri.lisp (file)

Method: render-literal (VALUE string)

Source

uri.lisp (file)

Method: render-literal (VALUE integer)

Source

uri.lisp (file)

Method: render-literal VALUE

Source

uri.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *eval*

Package

sparql

Source

sparql.lisp (file)

Special Variable: *uri-prefixes*

Package

sparql

Source

uri.lisp (file)

5.2.2 Functions

Function: clean-literal LITERAL

Package

sparql

Source

uri.lisp (file)

Function: display-uri-prefixes ()

Package

sparql

Source

uri.lisp (file)

Function: expand TERM

Package

sparql

Source

sparql.lisp (file)

Function: in-list PARSER

Package

sparql

Source

sparql.lisp (file)

Function: parse-boolean-literal LITERAL

Package

sparql

Source

uri.lisp (file)

Function: parse-typed-literal LITERAL

Package

sparql

Source

uri.lisp (file)

Function: parse-uri URI

Package

sparql

Source

uri.lisp (file)

Function: reduce-strings LIST

Join adjacent strings in a list, leave other values intact.

Package

sparql

Source

sparql.lisp (file)

Function: render-sparql SPARQL

Package

sparql

Source

sparql.lisp (file)

Function: sparql-delete-data ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-filter-exists ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-filter-not-exists ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-insert-data ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-limit ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-minus ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-offset ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-optional ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-order-arg ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-order-by ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-order-term ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-parser ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-select ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-subselect ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-triple ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-union ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-var ()

Parser: parse a SPARQL variable.

Package

sparql

Source

sparql.lisp (file)

Function: sparql-where ()

Package

sparql

Source

sparql.lisp (file)

Function: sparql-where-graph ()

Package

sparql

Source

sparql.lisp (file)

Function: strcat ARGS

Concatenate a list of strings into a single one.

Package

sparql

Source

sparql.lisp (file)

Function: transform TRANSFORM

Parser: transform and return the result, when the transformation applies (not null)

Package

sparql

Source

sparql.lisp (file)

Function: triple-object ()

Package

sparql

Source

sparql.lisp (file)

Function: triple-predicate ()

Package

sparql

Source

sparql.lisp (file)

Function: triple-subject ()

Package

sparql

Source

sparql.lisp (file)

Function: triples-block ()

Package

sparql

Source

sparql.lisp (file)

Function: uri-reader STREAM SUB-CHAR NUMARG

Package

sparql

Source

uri.lisp (file)

Function: where-body ()

Package

sparql

Source

sparql.lisp (file)

Function: where-triple ()

Package

sparql

Source

sparql.lisp (file)

5.2.3 Generic functions

Generic Function: expand-term TYPE TERM

Package

sparql

Methods

Method: expand-term (TYPE (eql offset)) OFFSET

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql limit)) LIMIT

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql desc)) ASC

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql asc)) ASC

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql order-by)) ORDER-BY

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql options)) OPTIONS

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql minus)) MINUS

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql filter-not-exists)) FILTER-NOT-EXISTS

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql filter-exists)) FILTER-EXISTS

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql optional)) OPTIONAL

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql union)) UNION

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql triple)) TRIPLE

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql graph)) GRAPH

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql where)) WHERE

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql eval)) FORM

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql var)) VAR

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql vars)) VARS

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql subselect)) TERM

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql delete-data)) TERM

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql insert-data)) TERM

Source

sparql.lisp (file)

Method: expand-term (TYPE (eql select)) TERM

Source

sparql.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types