The query-fs Reference Manual

Table of Contents

The query-fs Reference Manual

This is the query-fs Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:48:40 2020 GMT+0.

1 Introduction

Query-FS is a virtual filesystem implemented using FUSE in Common Lisp.
Its current main usecase is providing a POSIX FS API to access and modify some
data in SQL databases.

One can write:

mkdir "all" do
  for x in "select name, content from test_table"
    with-file $name do
      on-read $x[1]
      on-write data "update test_table set content = ${data} where name = ${name}"
      on-remove "delete from test_table where name = ${name}"
    done
  on-create-file name "insert into test_table (name) values (${name})"
done

and browse and modify a DB table as a directory.

One can also write some queries in Common Lisp:

(mk-pair-generator x
  (let ((xn (ignore-errors (parse-integer (first x)))))
    (if xn `((,(first x) ,(1+ xn)))
      (loop for k from 1 to 10 collect `(,(format nil "~a" k) ,(1+ k)))))
  (mk-file (first x) (format nil "~a" (second x))))

Installation and use:

$ cd ~/quicklisp/local-projects
$ git clone https://gitlab.common-lisp.net/cl-fuse/query-fs
$ mkdir -p query-fs-test/queries
$ $EDITOR query-fs-test/queries/…
* (ql:quickload :query-fs)
* (query-fs:run-fs :target "query-fs-test")

See example queries in example-queries and clsql-queries

2 Systems

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

2.1 query-fs

Maintainer

Michael Raskin <fb08af68@rambler.ru>

Author

Michael Raskin <fb08af68@rambler.ru>

License

LLGPL

Description

High-level virtual FS using CL-Fuse-Meta-FS to represent results of queries

Dependencies

• cl-fuse
• cl-fuse-meta-fs
• iterate
• cl-ppcre
• bordeaux-threads
• trivial-backtrace
• command-line-arguments

Source

query-fs.asd (file)

Components

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

Location

query-fs.asd

Systems

query-fs (system)

3.1.2 query-fs/package.lisp

Parent

query-fs (system)

Location

package.lisp

Packages

query-fs

3.1.3 query-fs/query-fs.lisp

Dependency

package.lisp (file)

Parent

query-fs (system)

Location

query-fs.lisp

Exported Definitions

• *plugin-path* (special variable)
• *query-parser* (special variable)
• *query-path* (special variable)
• *result-path* (special variable)
• *target* (special variable)
• backtrace-error (function)
• collect-entries (function)
• def-linear-query-parser (macro)
• def-query-parser (macro)
• load-demo (function)
• load-plugin (function)
• load-query (function)
• reload-files (function)
• run-fs (function)
• run-fs-with-cmdline-args (function)
• update-description (function)

Internal Definitions

• *description* (special variable)
• *home* (special variable)
• *plugins-loaded* (special variable)
• *queries-loaded* (special variable)
• *query-loader-types* (special variable)
• *query-loaders* (special variable)
• compile-time-value (macro)
• getenv (function)
• load-new-files (function)
• prepare-description (function)
• reload-plugins (function)
• reload-queries (function)
• remove-query (function)
• setenv (function)

4 Packages

Packages are listed by definition order.

4.1 query-fs

Source

package.lisp (file)

Use List

• command-line-arguments
• common-lisp
• iterate
• cl-fuse-meta-fs

Exported Definitions

• *plugin-path* (special variable)
• *query-parser* (special variable)
• *query-path* (special variable)
• *result-path* (special variable)
• *target* (special variable)
• backtrace-error (function)
• collect-entries (function)
• def-linear-query-parser (macro)
• def-query-parser (macro)
• load-demo (function)
• load-plugin (function)
• load-query (function)
• reload-files (function)
• run-fs (function)
• run-fs-with-cmdline-args (function)
• update-description (function)

Internal Definitions

• *description* (special variable)
• *home* (special variable)
• *plugins-loaded* (special variable)
• *queries-loaded* (special variable)
• *query-loader-types* (special variable)
• *query-loaders* (special variable)
• compile-time-value (macro)
• getenv (function)
• load-new-files (function)
• prepare-description (function)
• reload-plugins (function)
• reload-queries (function)
• remove-query (function)
• setenv (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *plugin-path*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *query-parser*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *query-path*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *result-path*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *target*

Package

query-fs

Source

query-fs.lisp (file)

5.1.2 Macros

Macro: def-linear-query-parser QUERY-TYPE &rest BODY

Package

query-fs

Source

query-fs.lisp (file)

Macro: def-query-parser QUERY-TYPE &rest BODY

Package

query-fs

Source

query-fs.lisp (file)

5.1.3 Functions

Function: backtrace-error E &optional EXTRA-TEXT

Package

query-fs

Source

query-fs.lisp (file)

Function: collect-entries FILE FUNC

Package

query-fs

Source

query-fs.lisp (file)

Function: load-demo NAME

Package

query-fs

Source

query-fs.lisp (file)

Function: load-plugin FILE-PATH

Package

query-fs

Source

query-fs.lisp (file)

Function: load-query FILE-NAME

Package

query-fs

Source

query-fs.lisp (file)

Function: reload-files ()

Package

query-fs

Source

query-fs.lisp (file)

Function: run-fs &key TARGET QUERY-PATH PLUGIN-PATH RESULT-PATH BREAK-ON-ERRORS OBJECT-CACHE-DURATION CALL-MANAGER THREAD-POOL-SIZE EXTRA-FUSE-ARGS

Package

query-fs

Source

query-fs.lisp (file)

Function: run-fs-with-cmdline-args &optional PREPENDED-ARGUMENTS

Package

query-fs

Source

query-fs.lisp (file)

Function: update-description ()

Package

query-fs

Source

query-fs.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *description*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *home*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *plugins-loaded*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *queries-loaded*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *query-loader-types*

Package

query-fs

Source

query-fs.lisp (file)

Special Variable: *query-loaders*

Package

query-fs

Source

query-fs.lisp (file)

5.2.2 Macros

Macro: compile-time-value X

Package

query-fs

Source

query-fs.lisp (file)

5.2.3 Functions

Function: getenv VAR-NAME

Package

query-fs

Source

query-fs.lisp (file)

Function: load-new-files ()

Package

query-fs

Source

query-fs.lisp (file)

Function: prepare-description DESC

Package

query-fs

Source

query-fs.lisp (file)

Function: reload-plugins ()

Package

query-fs

Source

query-fs.lisp (file)

Function: reload-queries ()

Package

query-fs

Source

query-fs.lisp (file)

Function: remove-query NAME

Package

query-fs

Source

query-fs.lisp (file)

Function: setenv VAR-NAME VAL OVERWRITE

Package

query-fs

Source

query-fs.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types