The cl4store Reference Manual

Table of Contents

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

The cl4store Reference Manual

This is the cl4store Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:45:12 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Client library for interacting with the 4store RDF server (http://4store.org/).

Building on work of Equill (https://github.com/equill)


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 cl4store

Maintainer

Mariano Montone

Author

Mariano Montone

License

BSD

Description

4store

Version

0.0.1

Dependencies
Source

cl4store.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl4store.asd

Location

cl4store.asd

Systems

cl4store (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl4store/package.lisp

Parent

cl4store (system)

Location

package.lisp

Packages

4store


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl4store/util.lisp

Dependency

package.lisp (file)

Parent

cl4store (system)

Location

util.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl4store/cl4store.lisp

Dependency

util.lisp (file)

Parent

cl4store (system)

Location

cl4store.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 4store

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *4store-server*

4store host address

Package

4store

Source

cl4store.lisp (file)

Special Variable: *graph*

Knowledge base graph

Package

4store

Source

cl4store.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: with-4store-server VALUE &body BODY
Package

4store

Source

cl4store.lisp (file)

Macro: with-graph VALUE &body BODY
Package

4store

Source

cl4store.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: delete-all-triples &optional GRAPH SERVER-URL

Deletes _all_ triples in the specified graph.

Package

4store

Source

cl4store.lisp (file)

Function: delete-graph &optional GRAPH-NAME SERVER-URL

Deletes the identified graph.
Currently known not to work; despite being semantically correct and receiving a success code from the server.

Package

4store

Source

cl4store.lisp (file)

Function: delete-triples TRIPLES &optional GRAPH SERVER-URL

Remove the supplied set of triples from the graph.
Expects the ’triples argument to be a list of three-element lists. If the Object is plain text, it’s expected to already be quoted.

Package

4store

Source

cl4store.lisp (file)

Function: get-graphs-list &optional SERVER-URL
Package

4store

Source

cl4store.lisp (file)

Function: get-triples-list &optional GRAPH SERVER-URL

Retrieves all triples in the store.
Useful for smoke-testing; use with caution in large stores, because it returns _everything_.

Package

4store

Source

cl4store.lisp (file)

Function: insert-triples TRIPLES &optional GRAPH SERVER-URL

Inserts a list of triples into the store.
The ’triples argument is expected to be a list of proper lists, each containing subject, predicate and object.

Package

4store

Source

cl4store.lisp (file)

Function: select-rdfs-classes &optional SERVER-URL

Select all the RDFS classses in the knowledgebase. Return the multiple values from the query POSTed to the knowledgebase’s sparql http end-point. The first value is the body of the response in the sparql query results XML format.

Package

4store

Source

cl4store.lisp (file)

Function: sparql-server-put-data-request FILEPATH &optional GRAPHNAME SERVER-URL

Perform an HTTP put request with the data contained in a file. Arguments:
- the base url pathname of the SPARQL server
- relative URL component (i.e, the graph name)
- the path to the file
Assumes that the input file is valid RDF/XML

Package

4store

Source

cl4store.lisp (file)

Function: sparql-server-status-request &optional SERVER-URL

Returns the numeric HTTP status code from the server. If all is well, the return code will be 200 (for OK).

Package

4store

Source

cl4store.lisp (file)

Function: sparql-update DATA &optional METHOD SERVER-URL

Send a SPARQL update request to the server, and return the result. Expects a valid SPARQL query for its second argument, in a text string. Uses POST by default, but the :method keyword argument can be used to force POST, PUT, DELETE or whatever other method tickles your fancy.

Package

4store

Source

cl4store.lisp (file)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *4store-text-content-types*
Package

4store

Source

cl4store.lisp (file)

Special Variable: *backend*
Package

4store

Source

cl4store.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: defdynvar NAME &optional VALUE DOC
Package

4store

Source

util.lisp (file)

Macro: with-backend VALUE &body BODY
Package

4store

Source

cl4store.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: 4store-request URI &key METHOD ACCEPT PARAMETERS CONTENT CONTENT-TYPE ADDITIONAL-HEADERS
Package

4store

Source

cl4store.lisp (file)

Function: call-with-4store-server VALUE FUN
Package

4store

Source

cl4store.lisp (file)

Function: call-with-backend VALUE FUN
Package

4store

Source

cl4store.lisp (file)

Function: call-with-graph VALUE FUN
Package

4store

Source

cl4store.lisp (file)

Function: make-keyword STRING
Package

4store

Source

util.lisp (file)

Function: parse-result XML-RESULT

Use cxml to parse a sparql result XML formatted string into a list structure.

Package

4store

Source

cl4store.lisp (file)

Function: tsv-to-list TSV

Convert a 4store TSV result string to a list of lisp lists

Package

4store

Source

cl4store.lisp (file)

Function: tsv-to-lists TSV

Convert a 4store TSV result string to a list of lisp lists

Package

4store

Source

cl4store.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl4store.asd: The cl4store․asd file
cl4store/cl4store.lisp: The cl4store/cl4store․lisp file
cl4store/package.lisp: The cl4store/package․lisp file
cl4store/util.lisp: The cl4store/util․lisp file

F
File, Lisp, cl4store.asd: The cl4store․asd file
File, Lisp, cl4store/cl4store.lisp: The cl4store/cl4store․lisp file
File, Lisp, cl4store/package.lisp: The cl4store/package․lisp file
File, Lisp, cl4store/util.lisp: The cl4store/util․lisp file

L
Lisp File, cl4store.asd: The cl4store․asd file
Lisp File, cl4store/cl4store.lisp: The cl4store/cl4store․lisp file
Lisp File, cl4store/package.lisp: The cl4store/package․lisp file
Lisp File, cl4store/util.lisp: The cl4store/util․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   4  
C   D   F   G   I   M   P   S   T   W  
Index Entry  Section

4
4store-request: Internal functions

C
call-with-4store-server: Internal functions
call-with-backend: Internal functions
call-with-graph: Internal functions

D
defdynvar: Internal macros
delete-all-triples: Exported functions
delete-graph: Exported functions
delete-triples: Exported functions

F
Function, 4store-request: Internal functions
Function, call-with-4store-server: Internal functions
Function, call-with-backend: Internal functions
Function, call-with-graph: Internal functions
Function, delete-all-triples: Exported functions
Function, delete-graph: Exported functions
Function, delete-triples: Exported functions
Function, get-graphs-list: Exported functions
Function, get-triples-list: Exported functions
Function, insert-triples: Exported functions
Function, make-keyword: Internal functions
Function, parse-result: Internal functions
Function, select-rdfs-classes: Exported functions
Function, sparql-server-put-data-request: Exported functions
Function, sparql-server-status-request: Exported functions
Function, sparql-update: Exported functions
Function, tsv-to-list: Internal functions
Function, tsv-to-lists: Internal functions

G
get-graphs-list: Exported functions
get-triples-list: Exported functions

I
insert-triples: Exported functions

M
Macro, defdynvar: Internal macros
Macro, with-4store-server: Exported macros
Macro, with-backend: Internal macros
Macro, with-graph: Exported macros
make-keyword: Internal functions

P
parse-result: Internal functions

S
select-rdfs-classes: Exported functions
sparql-server-put-data-request: Exported functions
sparql-server-status-request: Exported functions
sparql-update: Exported functions

T
tsv-to-list: Internal functions
tsv-to-lists: Internal functions

W
with-4store-server: Exported macros
with-backend: Internal macros
with-graph: Exported macros

Jump to:   4  
C   D   F   G   I   M   P   S   T   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*4store-server*: Exported special variables
*4store-text-content-types*: Internal special variables
*backend*: Internal special variables
*graph*: Exported special variables

S
Special Variable, *4store-server*: Exported special variables
Special Variable, *4store-text-content-types*: Internal special variables
Special Variable, *backend*: Internal special variables
Special Variable, *graph*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   4  
C   P   S  
Index Entry  Section

4
4store: The 4store package

C
cl4store: The cl4store system

P
Package, 4store: The 4store package

S
System, cl4store: The cl4store system

Jump to:   4  
C   P   S