The cl-naive-store Reference Manual

3.1.1 cl-naive-store/cl-naive-store.asd

Source

cl-naive-store.asd.

Parent Component

cl-naive-store (system).

ASDF Systems

cl-naive-store.

---

3.1.2 cl-naive-store.naive-core/cl-naive-store.naive-core.asd

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

ASDF Systems

cl-naive-store.naive-core.

---

3.1.3 cl-naive-store.document-types/cl-naive-store.document-types.asd

Source

cl-naive-store.document-types.asd.

Parent Component

cl-naive-store.document-types (system).

ASDF Systems

cl-naive-store.document-types.

---

3.1.4 cl-naive-store.definitions/cl-naive-store.definitions.asd

Source

cl-naive-store.definitions.asd.

Parent Component

cl-naive-store.definitions (system).

ASDF Systems

cl-naive-store.definitions.

---

3.1.5 cl-naive-store.naive-documents/cl-naive-store.naive-documents.asd

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

ASDF Systems

cl-naive-store.naive-documents.

---

3.1.6 cl-naive-store.naive-indexed/cl-naive-store.naive-indexed.asd

Source

cl-naive-store.naive-indexed.asd.

Parent Component

cl-naive-store.naive-indexed (system).

ASDF Systems

cl-naive-store.naive-indexed.

---

3.1.7 cl-naive-store.naive-merkle/cl-naive-store.naive-merkle.asd

Source

cl-naive-store.naive-merkle.asd.

Parent Component

cl-naive-store.naive-merkle (system).

ASDF Systems

cl-naive-store.naive-merkle.

---

3.1.8 cl-naive-store.naive-core/src/naive-store/packages.lisp

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Packages

cl-naive-store.naive-core.

---

3.1.9 cl-naive-store.naive-core/src/naive-store/naive-impl/package.lisp

Dependency

src/naive-store/packages.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Packages

naive-impl.

---

3.1.10 cl-naive-store.naive-core/src/naive-store/naive-impl/common.lisp

Dependency

src/naive-store/naive-impl/package.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• %loading-shard% (special variable).
• *disable-parallel-p* (special variable).
• *lock* (special variable).
• do-sequence (macro).
• empty-p (function).
• frmt (function).
• get-query-cache (function).
• gethash-safe (generic function).
• (setf gethash-safe) (generic function).
• make-mac (generic function).
• map-append (function).
• maphash-collect (function).
• plist-to-pairs (function).
• plist-to-values (function).
• remhash-safe (generic function).
• set-query-cache (function).
• trim-whitespace (function).

Internals

• *mac-key* (special variable).
• *query-cache* (special variable).
• call-do-sequence (function).

---

3.1.11 cl-naive-store.naive-core/src/naive-store/naive-impl/files.lisp

Dependency

src/naive-store/naive-impl/common.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• file-to-string (function).
• sexp-from-file (function).
• (setf sexp-from-file) (function).
• with-file-lock (macro).
• with-open-file-lock (macro).
• write-to-file (function).

Internals

• write-list-items-to-file (function).
• write-to-stream (function).

---

3.1.12 cl-naive-store.naive-core/src/naive-store/naive-impl/logs.lisp

Dependency

src/naive-store/naive-impl/files.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• *break-on-error-log* (special variable).
• *debug-log-p* (special variable).
• debug-log (function).
• write-log (function).

Internals

• *break-on-debug-log* (special variable).
• *now* (special variable).
• *short-months* (special variable).
• *std-lock* (special variable).
• *time-zone* (special variable).
• format-date-time (function).
• format-universal-date-time (function).
• get-temp (function).
• iso-timestamp-now (function).
• short-month-name (function).

---

3.1.13 cl-naive-store.naive-core/src/naive-store/naive-core.lisp

Dependency

src/naive-store/naive-impl/logs.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• add-collection (generic function).
• add-store (generic function).
• clear-collection (generic function).
• collection (class).
• collection-class (reader method).
• (setf collection-class) (writer method).
• collections (reader method).
• (setf collections) (writer method).
• data-loaded-p (generic function).
• document-shard-mac (function).
• documents (method).
• documents (reader method).
• (setf documents) (writer method).
• ensure-location (generic function).
• get-collection (generic function).
• get-collection-from-def (generic function).
• get-shard (generic function).
• get-store (generic function).
• get-store-from-def (function).
• keys (reader method).
• (setf keys) (writer method).
• load-data (generic function).
• location (reader method).
• location (reader method).
• location (reader method).
• location (reader method).
• (setf location) (writer method).
• (setf location) (writer method).
• (setf location) (writer method).
• (setf location) (writer method).
• lock (reader method).
• (setf lock) (writer method).
• mac (reader method).
• (setf mac) (writer method).
• make-shard (generic function).
• match-shard (function).
• name (reader method).
• name (reader method).
• (setf name) (writer method).
• (setf name) (writer method).
• persist (generic function).
• persist-collection (function).
• persist-collection-def (generic function).
• print-object (method).
• print-object (method).
• print-object (method).
• remove-collection (generic function).
• shard (class).
• shards (reader method).
• (setf shards) (writer method).
• short-mac (generic function).
• status (generic function).
• (setf status) (generic function).
• store (reader method).
• (setf store) (writer method).
• store (class).
• store-class (reader method).
• (setf store-class) (writer method).
• stores (reader method).
• (setf stores) (writer method).
• universe (reader method).
• (setf universe) (writer method).
• universe (class).

Internals

• *shards-cache-lock* (special variable).
• *shards-macs-cache-lock* (special variable).
• get-shard-cache-safe% (function).
• get-shard-mac-cache-safe% (function).
• set-shard-cache-safe% (function).
• set-shard-mac-cache-safe% (function).
• shard-elements (reader method).
• (setf shard-elements) (writer method).
• shards-cache% (reader method).
• (setf shards-cache%) (writer method).
• shards-macs-cache% (reader method).
• (setf shards-macs-cache%) (writer method).

---

3.1.14 cl-naive-store.naive-core/src/naive-store/documents.lisp

Dependency

src/naive-store/naive-core.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• add-document (generic function).
• delete-document (generic function).
• deleted-p (generic function).
• (setf deleted-p) (generic function).
• document-values (generic function).
• existing-document (generic function).
• key-values (generic function).
• persist-document (generic function).
• remove-document (generic function).

Internals

ensure-shard (function).

---

3.1.15 cl-naive-store.naive-core/src/naive-store/blob.lisp

Dependency

src/naive-store/documents.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• blob (structure).
• blob-file-ext (reader).
• (setf blob-file-ext) (writer).
• blob-file-type (reader).
• (setf blob-file-type) (writer).
• blob-location (reader).
• (setf blob-location) (writer).
• blob-p (function).
• blob-raw (reader).
• (setf blob-raw) (writer).
• blob-ref-p (function).
• blob-string-value (function).
• (setf getx) (method).
• getx (method).
• make-blob (function).
• read-blob (function).
• write-blob (function).

Internals

• blob-parent-accessor (reader).
• (setf blob-parent-accessor) (writer).
• blob-ref-values (function).
• copy-blob (function).
• reference-form (method).

---

3.1.16 cl-naive-store.naive-core/src/naive-store/naive-impl/naive-core.lisp

Dependency

src/naive-store/naive-impl/common.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Internals

• get-collection* (function).
• get-store* (function).

---

3.1.17 cl-naive-store.naive-core/src/naive-store/naive-impl/parse-document.lisp

Dependency

src/naive-store/naive-impl/files.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• compose-document (generic function).
• compose-parse (generic function).
• compose-special (generic function).
• find-document-by-hash (generic function).
• load-document-reference-collection (function).
• type-of-sexp (generic function).

---

3.1.18 cl-naive-store.naive-core/src/naive-store/naive-impl/persist-document.lisp

Dependency

src/naive-store/naive-impl/files.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• persist-delete-document (generic function).
• persist-form (generic function).
• persist-parse (generic function).
• type-of-doc-element (generic function).

---

3.1.19 cl-naive-store.naive-core/src/naive-store/load.lisp

Dependency

src/naive-store/naive-impl/parse-document.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• find-collection-definitions (function).
• load-data (method).
• load-store (generic function).
• load-stores (generic function).

Internals

• *files* (special variable).
• find-collection-files (function).
• find-store-definitions (function).
• load-collections (generic function).
• load-shard (generic function).
• load-shards (function).

---

3.1.20 cl-naive-store.naive-core/src/naive-store/query.lisp

Dependency

src/naive-store/naive-core.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

• naive-reduce (generic function).
• query-data (generic function).
• query-document (generic function).

Internals

*query-lock* (special variable).

---

3.1.21 cl-naive-store.naive-core/src/naive-store/maintenance.lisp

Dependency

src/naive-store/naive-impl/persist-document.lisp (file).

Source

cl-naive-store.naive-core.asd.

Parent Component

cl-naive-store.naive-core (system).

Public Interface

sanitize-data-file (generic function).

Internals

sanitize-universe (generic function).

---

3.1.22 cl-naive-store.document-types/src/document-types/packages.lisp

Source

cl-naive-store.document-types.asd.

Parent Component

cl-naive-store.document-types (system).

Packages

cl-naive-store.document-types.

---

3.1.23 cl-naive-store.document-types/src/document-types/document-types.lisp

Dependency

src/document-types/packages.lisp (file).

Source

cl-naive-store.document-types.asd.

Parent Component

cl-naive-store.document-types (system).

Public Interface

• add-collection (method).
• add-document-type (generic function).
• attributes (reader method).
• (setf attributes) (writer method).
• document-of-type-p (generic function).
• document-type (reader method).
• (setf document-type) (writer method).
• document-type (class).
• document-type-class (reader method).
• (setf document-type-class) (writer method).
• document-type-collection-mixin (class).
• document-type-store-mixin (class).
• document-types (reader method).
• (setf document-types) (writer method).
• element (class).
• element-class (reader method).
• (setf element-class) (writer method).
• elements (reader method).
• (setf elements) (writer method).
• get-attribute (generic function).
• get-collection-from-def (method).
• get-document-type (generic function).
• get-document-type-from-def (generic function).
• get-element (generic function).
• (setf getx) (method).
• getx (method).
• (setf getx) (method).
• getx (method).
• key-p (reader method).
• (setf key-p) (writer method).
• key-values (method).
• label (reader method).
• (setf label) (writer method).
• load-store (method).
• name (reader method).
• name (reader method).
• (setf name) (writer method).
• (setf name) (writer method).
• persist (method).
• persist-collection-def (method).
• store (reader method).
• (setf store) (writer method).

Internals

• concrete-type (reader method).
• (setf concrete-type) (writer method).
• load-store-collections (method).
• load-store-document-types (function).
• values-from-key-elements% (function).

---

3.1.24 cl-naive-store.definitions/src/definitions/packages.lisp

Source

cl-naive-store.definitions.asd.

Parent Component

cl-naive-store.definitions (system).

Packages

cl-naive-store.definitions.

---

3.1.25 cl-naive-store.definitions/src/definitions/definitions.lisp

Dependency

src/definitions/packages.lisp (file).

Source

cl-naive-store.definitions.asd.

Parent Component

cl-naive-store.definitions (system).

Public Interface

create-multiverse (function).

Internals

• build-adjacency-list (function).
• create-collections (function).
• create-document-types (function).
• depth-first-search (function).
• get-collection-names (function).
• get-collections-dependencies (function).
• get-document-types (function).
• get-referenced-types (function).
• get-topological-order (function).
• sublist-in-order-p (function).
• topological-sort (function).
• walk-data-filter (function).

---

3.1.26 cl-naive-store.naive-documents/src/naive-documents/packages.lisp

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Packages

cl-naive-store.naive-documents.

---

3.1.27 cl-naive-store.naive-documents/src/naive-documents/documents-impl/package.lisp

Dependency

src/naive-documents/packages.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Packages

documents-impl.

---

3.1.28 cl-naive-store.naive-documents/src/naive-documents/naive-documents.lisp

Dependency

src/naive-documents/documents-impl/package.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

• document (structure).
• document-changes (reader).
• (setf document-changes) (writer).
• document-collection (reader).
• (setf document-collection) (writer).
• document-collection (class).
• document-deleted-p (reader).
• (setf document-deleted-p) (writer).
• document-document-type (reader).
• (setf document-document-type) (writer).
• document-elements (reader).
• (setf document-elements) (writer).
• document-hash (reader).
• (setf document-hash) (writer).
• document-p (function).
• document-store (reader).
• (setf document-store) (writer).
• document-store (class).
• document-values (method).
• document-versions (reader).
• (setf document-versions) (writer).
• getxn (generic function).
• getxo (generic function).
• hash (method).
• (setf hash) (method).
• key-values (method).
• make-document (function).
• murmurhash (method).
• place-exists-p (method).

Internals

• copy-document (function).
• document-list-p (function).
• document-persisted-p (reader).
• (setf document-persisted-p) (writer).
• exists-p (method).
• key-values%% (function).

---

3.1.29 cl-naive-store.naive-documents/src/naive-documents/documents-impl/parse-document.lisp

Dependency

src/naive-documents/naive-documents.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

• compose-document (method).
• compose-special (method).
• compose-special (method).
• compose-special (method).
• type-of-sexp (method).

Internals

document-values-p (function).

---

3.1.30 cl-naive-store.naive-documents/src/naive-documents/documents-impl/persist-document.lisp

Dependency

src/naive-documents/naive-documents.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

• persist-form (method).
• persist-form (method).
• persist-form (method).
• persist-form (method).
• persist-parse (method).
• type-of-doc-element (method).

---

3.1.31 cl-naive-store.naive-documents/src/naive-documents/document-types.lisp

Dependency

src/naive-documents/naive-documents.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

---

3.1.32 cl-naive-store.naive-documents/src/naive-documents/documents.lisp

Dependency

src/naive-documents/packages.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

• deleted-p (method).
• (setf deleted-p) (method).
• persist-document (method).

Internals

• check-keys-and-synq (function).
• persist-merge-document (function).
• reference-documents-equal-p (function).

---

3.1.33 cl-naive-store.naive-documents/src/naive-documents/indexed.lisp

Dependency

src/naive-documents/documents.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

index-values (method).

---

3.1.34 cl-naive-store.naive-documents/src/naive-documents/query.lisp

Dependency

src/naive-documents/indexed.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

• (setf digx) (method).
• digx (method).
• find-equalp-document (function).
• (setf getx) (method).
• getx (method).

Internals

• *change-control-p* (special variable).
• find-document-by-value (function).
• naive-dig (function).
• set-naive-dig (function).

---

3.1.35 cl-naive-store.naive-documents/src/naive-documents/export.lisp

Dependency

src/naive-documents/indexed.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

documents-to-plist (function).

Internals

• document-pair-to-plist (function).
• parse-document (function).

---

3.1.36 cl-naive-store.naive-documents/src/naive-documents/export-csv.lisp

Dependency

src/naive-documents/export.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

document-list-to-csv (function).

Internals

• treemap-csv (function).
• write-pair-csv (function).

---

3.1.37 cl-naive-store.naive-documents/src/naive-documents/export-json.lisp

Dependency

src/naive-documents/export.lisp (file).

Source

cl-naive-store.naive-documents.asd.

Parent Component

cl-naive-store.naive-documents (system).

Public Interface

document-list-to-json (function).

Internals

• lambda-p (function).
• treemap-json (function).
• write-pair-json (function).

---

3.1.38 cl-naive-store.naive-indexed/src/naive-indexed/packages.lisp

Source

cl-naive-store.naive-indexed.asd.

Parent Component

cl-naive-store.naive-indexed (system).

Packages

• cl-naive-store.naive-indexed.
• indexed-impl.

---

3.1.39 cl-naive-store.naive-indexed/src/naive-indexed/naive-indexed.lisp

Dependency

src/naive-indexed/packages.lisp (file).

Source

cl-naive-store.naive-indexed.asd.

Parent Component

cl-naive-store.naive-indexed (system).

Public Interface

• *do-partial-indexing* (special variable).
• add-document (method).
• add-index (generic function).
• clear-documents (method).
• existing-document (method).
• get-shard (method).
• hash (generic function).
• (setf hash) (generic function).
• index-lookup-hash (generic function).
• index-lookup-values (generic function).
• indexed-collection-mixin (class).
• indexes (reader method).
• (setf indexes) (writer method).
• key-value-index (reader method).
• (setf key-value-index) (writer method).
• make-shard (method).
• remove-document (method).
• remove-index (generic function).

Internals

• hash-index (reader method).
• (setf hash-index) (writer method).
• indexed-shard (class).
• try-better-value-match (function).

---

3.1.40 cl-naive-store.naive-indexed/src/naive-indexed/indexed-impl.lisp

Dependency

src/naive-indexed/naive-indexed.lisp (file).

Source

cl-naive-store.naive-indexed.asd.

Parent Component

cl-naive-store.naive-indexed (system).

Public Interface

• index-values (generic function).
• push-value-index (generic function).
• remove-value-index (generic function).

Internals

• hash-values (function).
• populate-partial-value-index (function).
• populate-value-index (function).
• remove-index-values (function).
• remove-partial-value-index (function).

---

3.1.41 cl-naive-store.naive-indexed/src/naive-indexed/parse-document.lisp

Dependency

src/naive-indexed/naive-indexed.lisp (file).

Source

cl-naive-store.naive-indexed.asd.

Parent Component

cl-naive-store.naive-indexed (system).

Public Interface

• compose-special (method).
• find-document-by-hash (method).

---

3.1.42 cl-naive-store.naive-indexed/src/naive-indexed/query.lisp

Dependency

src/naive-indexed/naive-indexed.lisp (file).

Source

cl-naive-store.naive-indexed.asd.

Parent Component

cl-naive-store.naive-indexed (system).

Public Interface

• naive-reduce (method).
• query-data (method).

Internals

• *index-query-lock* (special variable).
• indexed-values (function).

---

3.1.43 cl-naive-store.naive-merkle/src/naive-merkle/package.lisp

Source

cl-naive-store.naive-merkle.asd.

Parent Component

cl-naive-store.naive-merkle (system).

Packages

cl-naive-merkle.

---

3.1.44 cl-naive-store.naive-merkle/src/naive-merkle/merkle.lisp

Dependency

src/naive-merkle/package.lisp (file).

Source

cl-naive-store.naive-merkle.asd.

Parent Component

cl-naive-store.naive-merkle (system).

Internals

• branch (function).
• calc (function).
• calc-branch (function).
• calc-document (function).
• children (reader method).
• (setf children) (writer method).
• leaf-p (function).
• make-document-hash (function).
• make-hash (function).
• make-node (function).
• map-tree (function).
• merkle-hash (reader method).
• (setf merkle-hash) (writer method).
• merkle-node (class).
• merkle-sum (reader method).
• (setf merkle-sum) (writer method).
• node-p (function).
• parent (reader method).
• (setf parent) (writer method).
• recalc (function).
• tree-from-reference-tree (function).
• tree-to-reference-tree (function).

---

5.1.1 Special variables

Special Variable: %loading-shard% ¶

Used during the loading of an individual shard. That way no heavy recursive locking has to be done.

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Special Variable: *break-on-error-log* ¶

Causes a break when logging errors of type :error and :warning.

Package

naive-impl.

Source

src/naive-store/naive-impl/logs.lisp.

Special Variable: *debug-log-p* ¶

Switches debug logging or off for debug-log

Package

naive-impl.

Source

src/naive-store/naive-impl/logs.lisp.

Special Variable: *disable-parallel-p* ¶

Depending on the data and how naive-store is used switching of parallel processing could produce better performance. This does not disable parallel loading of shards but it does disable all other parallel processing.

Switching off parallel processing is achieved by ignoring the parallel-p argument of do-sequence when *disable-parallel-p* is t.

So if you are customising cl-naive-store use do-sequence for simple parallel processing or make sure that your customization obeys *disable-parallel-p* where possible.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-impl/common.lisp.

Special Variable: *do-partial-indexing* ¶

When this is set to t (which is the default), indexing is done for the individual elements of the indexes as well.

Package

cl-naive-store.naive-indexed.

Source

src/naive-indexed/naive-indexed.lisp.

Special Variable: *lock* ¶

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

---

5.1.2 Macros

Macro: do-sequence ((element-var sequence &key index-var parallel-p) &body body) ¶

Iterates over the sequence applying body. In the body you can use the element-var and/or the index-var if supplied.

If you set parallel-p then the body is executed asyncronously. Asyncronous excecution places restraints on how special variables can be used within the body.

From lparallel documentation:

To establish permanent dynamic bindings inside workers (thread-local variables), use the :bindings argument to make-kernel, which is an alist of (var-name . value-form) pairs. Each value-form is evaluated inside each worker when it is created. (So if you have two workers, each value-form will be evaluated twice.)

Notes:

Uses loop or lparallel:pdotimes depending on parallel-p value.

To get the best out of do-sequence use the parallel option if the sequence is large (> 1000) or the body is excecution heavy.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-impl/common.lisp.

Macro: with-file-lock ((path &key interval) &body body) ¶

Get an exclusive lock on a file. If lock cannot be obtained, keep trying after waiting a while.

Source: Giovanni Gigante https://sourceforge.net/p/cl-cookbook/patches/8/|#

Package

naive-impl.

Source

src/naive-store/naive-impl/files.lisp.

Macro: with-open-file-lock ((stream file &key direction if-exists if-does-not-exist) &body body) ¶

Opens a file with a file lock and writes to the file.

Package

naive-impl.

Source

src/naive-store/naive-impl/files.lisp.

---

5.1.3 Ordinary functions

Reader: blob-file-ext (instance) ¶

Writer: (setf blob-file-ext) (instance) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Target Slot

file-ext.

Reader: blob-file-type (instance) ¶

Writer: (setf blob-file-type) (instance) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Target Slot

file-type.

Reader: blob-location (instance) ¶

Writer: (setf blob-location) (instance) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Target Slot

location.

Function: blob-p (object) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Reader: blob-raw (instance) ¶

Writer: (setf blob-raw) (instance) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Target Slot

raw.

Function: blob-ref-p (document) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Function: blob-string-value (blob) ¶

Returns the value of a blob as a string.

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Function: create-multiverse (universe-definitions &optional persist-p) ¶

Package

cl-naive-store.definitions.

Source

src/definitions/definitions.lisp.

Function: debug-log (format-control-string &rest arguments-and-keys) ¶

Package

naive-impl.

Source

src/naive-store/naive-impl/logs.lisp.

Reader: document-changes (instance) ¶

Writer: (setf document-changes) (instance) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Target Slot

changes.

Reader: document-collection (instance) ¶

Writer: (setf document-collection) (instance) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Target Slot

collection.

Reader: document-deleted-p (instance) ¶

Writer: (setf document-deleted-p) (instance) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Target Slot

deleted-p.

Reader: document-document-type (instance) ¶

Writer: (setf document-document-type) (instance) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Target Slot

document-type.

Reader: document-elements (instance) ¶

Writer: (setf document-elements) (instance) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Target Slot

elements.

Reader: document-hash (instance) ¶

Writer: (setf document-hash) (instance) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Target Slot

hash.

Function: document-list-to-csv (document-list) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/export-csv.lisp.

Function: document-list-to-json (document-list) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/export-json.lisp.

Function: document-p (object) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Function: document-shard-mac (collection document) ¶

Calculating a mac is expensive so caching shard value macs in a hashtable but that hashtable needs to be thread safe so using safe functions to get and set.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Reader: document-store (instance) ¶

Writer: (setf document-store) (instance) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Target Slot

store.

Reader: document-versions (instance) ¶

Writer: (setf document-versions) (instance) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Target Slot

versions.

Function: documents-to-plist (tree) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/export.lisp.

Function: empty-p (value) ¶

Checks if value is null/nil or an empty string..

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-impl/common.lisp.

Function: file-to-string (file) ¶

Reads a file and returns the contents as a string.

NOTES: You could achieve the same with with-output-to-string, but now you dont have to worry about supplying a string that can be written to.

Package

naive-impl.

Source

src/naive-store/naive-impl/files.lisp.

Function: find-collection-definitions (store) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/load.lisp.

Function: find-equalp-document (document document-list) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/query.lisp.

Function: frmt (control-string &rest args) ¶

Short hand for (format nil ..).

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-impl/common.lisp.

Function: get-query-cache (key) ¶

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Function: get-store-from-def (universe store-name) ¶

Tries to find a store definition file on disk and if it does it loads the store into the universe, but it does not load the collections!.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Function: load-document-reference-collection (universe document-ref) ¶

When documents are persisted to file any document values that are referencing an document in a different collection is first sanitized (just enough info to retrieve the document later from where it is stored).

When documents are read from a file the references need to be converted to documents but for that to happen the collection containing the referenced documents need to be loaded first.

Package

naive-impl.

Source

src/naive-store/naive-impl/parse-document.lisp.

Function: make-blob (&key file-type file-ext location raw parent-accessor) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Function: make-document (&key store collection document-type hash elements changes versions deleted-p persisted-p) ¶

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Function: map-append (fn &rest lists) ¶

Non distructive version of mapcan. Source: On Lisp

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Function: maphash-collect (fn hash-table &key append-p) ¶

Collects the results of a maphash. Pushes to a list by default, use append-p to append instead. NIL results are not collected.

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Function: match-shard (filename shards) ¶

Check filename against a list of shards to find the matching shard.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Function: persist-collection (collection) ¶

Persists the documents in a collection in the order that they where added.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Function: plist-to-pairs (values) ¶

Returns a list of key value pairs of a plist.

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Function: plist-to-values (values) ¶

Returns the values of a plist.

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Function: read-blob (blob-ref-values) ¶

Reads the raw blob contents from file.

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Function: set-query-cache (key value) ¶

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Function: sexp-from-file (pathname) ¶

Read sexp from file.

Package

naive-impl.

Source

src/naive-store/naive-impl/files.lisp.

Function: (setf sexp-from-file) (pathname) ¶

Package

naive-impl.

Source

src/naive-store/naive-impl/files.lisp.

Function: trim-whitespace (string) ¶

Removes white spaces from a string.

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Function: write-blob (file value) ¶

Wrties the raw blob contents to file.

Package

cl-naive-store.naive-core.

Source

src/naive-store/blob.lisp.

Function: write-log (location type message) ¶

Writes errors to location.

Different Types are written to different files,
:error => error.err
:warning => warning.wrn
:debug => debug.dbl
:log => log.lg

Note:

Not writing stuf to .log files because that is what persist uses!!!.

Package

naive-impl.

Source

src/naive-store/naive-impl/logs.lisp.

Function: write-to-file (file object &key if-exists) ¶

Writes to file using with-open-file-lock.

Package

naive-impl.

Source

src/naive-store/naive-impl/files.lisp.

---

5.1.4 Generic functions

Generic Function: add-collection (store collection) ¶

Adds a collection to a store.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: add-collection :after ((store store) (collection document-type-collection-mixin)) ¶

Uses document type to figure out what the keys of the collection are.

Source

src/document-types/document-types.lisp.

Method: add-collection ((store store) (collection collection)) ¶

Generic Function: add-document (collection document &key shard replace-existing-p update-index-p handle-duplicates-p &allow-other-keys) ¶

Adds a document to the collection, it DOES NOT PERSIST the change, if you want adding with persistance use persist-document or persist the collection as a whole after you have done your adding.

Supply the shard the document should belong to if you can, especially if you have a lot of documents to add to a specific shard. If not supplied the (shard-elements collection) will be used to calculate which shard to use for the document.

add-document returns multiple values:

The first returned value is the actual document supplied.
The second returned value indicates what action was taken ie. was it added newly or was an exiting document replaced.
The third returned value is the replaced document.

NOTES:

In general you should not be calling add-document directly, you should use persist-document. Calling add-document directly is allowed so you can create temporary collections that can be thrown away.

cl-naive-store does not have a update-document function, add-document does both and its behaviour can be complex depending on the key parameters supplied. Also the behaviour can differ for different types of collections. Check the appropriate collection documentation for more details.

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: add-document ((collection indexed-collection-mixin) document &key shard replace-existing-p update-index-p &allow-other-keys) ¶

Duplicates are not allowed for indexed collections!

If the document has no hash and a document with the same keys exists in the collection the supplied document’s hash will be set to that of the existing document. The existing document will then be replaced with the supplied document. This is done to maintain hash consistancy of the store.

If you set replace-existing-p to nil then an existing document wont be replaced by the supplied document. Basically nothing will be done.

Indexes will be updated by default, if you want to stop index updates set update-index-p to nil. Just remember that if the document is really "new" to the collection the indexes will be updated in any case.

Source

src/naive-indexed/naive-indexed.lisp.

Method: add-document ((collection collection) document &key shard handle-duplicates-p replace-existing-p &allow-other-keys) ¶

None of the following will have an effect if handle-duplicates = nil.

If a document with the same keys exists in the collection the supplied the existing document will be replaced with the supplied document.

If you set replace-existing-p to nil then an existing document wont be replaced by the supplied document. Basically nothing will be done.

Generic Function: add-document-type (store document-type &key persist-p) ¶

Adds a document-type to a store.

Package

cl-naive-store.naive-core.

Source

src/document-types/document-types.lisp.

Methods

Method: add-document-type ((store document-type-store-mixin) (document-type document-type) &key persist-p) ¶

Generic Function: add-index (collection shard document &key key-values &allow-other-keys) ¶

Adds a document to two indexes. The first uses a UUID that will stay with the document for its life time. The UUID is used when persisting the document and is never changed once created. This allows us to change key values without loosing the identify of the original document.

The second is a key value hash index to be used when looking for duplicate documents during persist. If you are not using document-types the order of the keys in the plist matter. To make sure that you dont muck with the order of values/keys in your plists initialize all the possible value pairs with nil so that way the order is set.

A shard must be supplied.

Package

cl-naive-store.naive-indexed.

Source

src/naive-indexed/naive-indexed.lisp.

Methods

Method: add-index ((collection indexed-collection-mixin) shard document &key key-values &allow-other-keys) ¶

Generic Function: add-store (universe store) ¶

Adds a store document to a universe.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: add-store ((universe universe) (store store)) ¶

Generic Reader: attributes (object) ¶

Generic Writer: (setf attributes) (object) ¶

Package

cl-naive-store.document-types.

Methods

Reader Method: attributes ((element element)) ¶

Writer Method: (setf attributes) ((element element)) ¶

A property list of additional element attributes.

Source

src/document-types/document-types.lisp.

Target Slot

attributes.

Generic Function: clear-collection (collection) ¶

Clears documents indexes etc from collection.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: clear-collection (collection) ¶

Generic Function: clear-documents (shard) ¶

Package

cl-naive-store.naive-core.

Methods

Method: clear-documents ((shard indexed-shard)) ¶

Source

src/naive-indexed/naive-indexed.lisp.

Generic Reader: collection-class (object) ¶

Generic Writer: (setf collection-class) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: collection-class ((store store)) ¶

Writer Method: (setf collection-class) ((store store)) ¶

The class that should be used to make collections.

Source

src/naive-store/naive-core.lisp.

Target Slot

collection-class.

Generic Reader: collections (object) ¶

Generic Writer: (setf collections) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: collections ((store store)) ¶

Writer Method: (setf collections) ((store store)) ¶

List of collections represented by this store.

Source

src/naive-store/naive-core.lisp.

Target Slot

collections.

Generic Function: compose-document (collection shard document-form &key &allow-other-keys) ¶

The loading of documents happens in a two step process. First documents are read with (*read-eval* nil). Then the sexp representing a raw document is processed to compose the required in memory representation.

Package

naive-impl.

Source

src/naive-store/naive-impl/parse-document.lisp.

Methods

Method: compose-document ((collection document-collection) shard document-form &key &allow-other-keys) ¶

Source

src/naive-documents/documents-impl/parse-document.lisp.

Method: compose-document (collection shard document-form &key &allow-other-keys) ¶

Generic Function: compose-parse (collection shard sexp doc) ¶

Processes document form for compose-document.

Package

naive-impl.

Source

src/naive-store/naive-impl/parse-document.lisp.

Methods

Method: compose-parse (collection shard sexp doc) ¶

Generic Function: compose-special (collection shard sexp type) ¶

Does special processing to compose a specific type of document or element.

Package

naive-impl.

Source

src/naive-store/naive-impl/parse-document.lisp.

Methods

Method: compose-special ((collection document-collection) shard sexp (type (eql :blob))) ¶

Source

src/naive-documents/documents-impl/parse-document.lisp.

Method: compose-special ((collection document-collection) shard sexp (type (eql :child-document))) ¶

Source

src/naive-documents/documents-impl/parse-document.lisp.

Method: compose-special ((collection document-collection) shard sexp (type (eql :document))) ¶

Source

src/naive-documents/documents-impl/parse-document.lisp.

Method: compose-special ((collection indexed-collection-mixin) shard sexp (type (eql :document))) ¶

Source

src/naive-indexed/parse-document.lisp.

Method: compose-special (collection shard sexp (type (eql :reference))) ¶

Method: compose-special (collection shard sexp (type (eql :hash-table))) ¶

Method: compose-special (collection shard sexp (type (eql :blob))) ¶

Method: compose-special (collection shard sexp (type (eql :document))) ¶

Generic Function: data-loaded-p (container &key *allow-other-keys shard-macs &allow-other-keys) ¶

Checks if the data is loaded for the container, be it universe , store or collection.

NOTES:

This physically checks each collection’s underlying concrete data structure for data. This is done because a collection can be empty and still loaded, thus setting a status when loaded became confusing and could be missed by an over loading method.

If you change the underlying container for (shards collection) or the container for (docutments shard) you have to implement data-loaded-p. Your implementation is expected to physically check for document count > 0 and not some status set. Be smart about it you are not expected to return a count so dont waist time counting just check if there is at least one document in the container.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: data-loaded-p ((universe universe) &key &allow-other-keys) ¶

Method: data-loaded-p ((store store) &key &allow-other-keys) ¶

Method: data-loaded-p ((collection collection) &key shard-macs &allow-other-keys) ¶

Generic Function: delete-document (collection document &key shard &allow-other-keys) ¶

Removes a document from the collection, marks the document as deleted and persists the deleted document to disk.

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: delete-document ((collection collection) document &key shard &allow-other-keys) ¶

Generic Function: deleted-p (document) ¶

Indicates if a data document has been marked as deleted.

naive-store writes data to file sequentially and when deleting data documents it does not remove a data document from the underlying file it just marks it as deleted.

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: deleted-p ((document document)) ¶

Source

src/naive-documents/documents.lisp.

Method: deleted-p (document) ¶

Generic Function: (setf deleted-p) (document &key &allow-other-keys) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: (setf deleted-p) ((document document) &key &allow-other-keys) ¶

Source

src/naive-documents/documents.lisp.

Method: (setf deleted-p) (document &key &allow-other-keys) ¶

Generic Function: document-of-type-p (document document-type) ¶

Package

cl-naive-store.document-types.

Source

src/document-types/document-types.lisp.

Generic Reader: document-type (object) ¶

Generic Writer: (setf document-type) (object) ¶

Package

cl-naive-store.document-types.

Methods

Reader Method: document-type ((document-type-collection-mixin document-type-collection-mixin)) ¶

Writer Method: (setf document-type) ((document-type-collection-mixin document-type-collection-mixin)) ¶

The document-type that this collection contains documents of.

Source

src/document-types/document-types.lisp.

Target Slot

document-type.

Generic Reader: document-type-class (object) ¶

Generic Writer: (setf document-type-class) (object) ¶

Package

cl-naive-store.document-types.

Methods

Reader Method: document-type-class ((document-type-store-mixin document-type-store-mixin)) ¶

Writer Method: (setf document-type-class) ((document-type-store-mixin document-type-store-mixin)) ¶

The class that should be used to make document-type documents. IMPL NOTES: To deal with customization of document-type.

Source

src/document-types/document-types.lisp.

Target Slot

document-type-class.

Generic Reader: document-types (object) ¶

Generic Writer: (setf document-types) (object) ¶

Package

cl-naive-store.document-types.

Methods

Reader Method: document-types ((document-type-store-mixin document-type-store-mixin)) ¶

Writer Method: (setf document-types) ((document-type-store-mixin document-type-store-mixin)) ¶

List of document-types represented by this store’s collections.

Source

src/document-types/document-types.lisp.

Target Slot

document-types.

Generic Function: document-values (document) ¶

Returns a plist of document values.

NOTES:

Exists to ease the compatibility of various implementation functions. Basically it blurs the line between plists and more complex documents like cl-naive-store.naive-documents document struct.

This helps keep the amount of specializations needed down considerably.

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: document-values ((document document)) ¶

Source

src/naive-documents/naive-documents.lisp.

Method: document-values (document) ¶

Generic Function: documents (object) ¶

Package

cl-naive-store.naive-core.

Methods

Method: documents ((collection collection)) ¶

Source

src/naive-store/naive-core.lisp.

Reader Method: documents ((shard shard)) ¶

Documents belonging to shard.

Source

src/naive-store/naive-core.lisp.

Target Slot

documents.

Generic Writer: (setf documents) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Writer Method: (setf documents) ((shard shard)) ¶

Documents belonging to shard.

Source

src/naive-store/naive-core.lisp.

Target Slot

documents.

Generic Reader: element-class (object) ¶

Generic Writer: (setf element-class) (object) ¶

Package

cl-naive-store.document-types.

Methods

Reader Method: element-class ((document-type document-type)) ¶

Writer Method: (setf element-class) ((document-type document-type)) ¶

The class that should be used to make element documents.
NOTES:

element-class is declaratively specified here so that elements can be dynamicly created when definition type definitions are read from file. See naive-store-documents for usage examples.

Source

src/document-types/document-types.lisp.

Target Slot

element-class.

Generic Reader: elements (object) ¶

Generic Writer: (setf elements) (object) ¶

Package

cl-naive-store.document-types.

Methods

Reader Method: elements ((document-type document-type)) ¶

Writer Method: (setf elements) ((document-type document-type)) ¶

Field definitions that represents a data unit.

Source

src/document-types/document-types.lisp.

Target Slot

elements.

Generic Function: ensure-location (object) ¶

Tries to find or build path to cl-naive-store files.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: ensure-location ((object collection)) ¶

Method: ensure-location ((object store)) ¶

Method: ensure-location ((object universe)) ¶

Generic Function: existing-document (collection document &key shard key-values &allow-other-keys) ¶

Finds any documents with the same key values. This could return the exact same document or a similar document.

If a shard is passed in then the search is limited to that shard.

IMPL NOTES:

This is an essential part of loading and persisting documents, take care when implementing.

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: existing-document ((collection indexed-collection-mixin) document &key shard key-values &allow-other-keys) ¶

Source

src/naive-indexed/naive-indexed.lisp.

Method: existing-document (collection document &key shard &allow-other-keys) ¶

Generic Function: find-document-by-hash (collection hash &key shards &allow-other-keys) ¶

Finds the document that matches the hash.

Package

naive-impl.

Source

src/naive-store/naive-impl/parse-document.lisp.

Methods

Method: find-document-by-hash ((collection indexed-collection-mixin) hash &key shards &allow-other-keys) ¶

Source

src/naive-indexed/parse-document.lisp.

Method: find-document-by-hash (collection hash &key shards &allow-other-keys) ¶

Generic Function: get-attribute (element attribute) ¶

Package

cl-naive-store.document-types.

Source

src/document-types/document-types.lisp.

Methods

Method: get-attribute ((element element) attribute) ¶

Generic Function: get-collection (store collection-name) ¶

Returns a collection document if found in the store.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: get-collection ((store store) collection-name) ¶

Generic Function: get-collection-from-def (store collection-name) ¶

Tries to find the collection definition file on disk and loads it into the store, but it does not load the collection’s data.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: get-collection-from-def ((store document-type-store-mixin) collection-name) ¶

Source

src/document-types/document-types.lisp.

Method: get-collection-from-def ((store store) collection-name) ¶

Generic Function: get-document-type (store type-name) ¶

Returns a document-type document if found in the store.

Package

cl-naive-store.naive-core.

Source

src/document-types/document-types.lisp.

Methods

Method: get-document-type ((store document-type-store-mixin) type-name) ¶

Generic Function: get-document-type-from-def (store document-type-name) ¶

Tries to find the document definition on disk.

Package

cl-naive-store.document-types.

Source

src/document-types/document-types.lisp.

Methods

Method: get-document-type-from-def ((store store) document-type-name) ¶

Generic Function: get-element (document-type element) ¶

Package

cl-naive-store.document-types.

Source

src/document-types/document-types.lisp.

Methods

Method: get-element (document-type element) ¶

Generic Function: get-shard (collection shard-mac &key &allow-other-keys) ¶

Get the shard object by its mac. Shard lookups are done so much that there is no choice but to cache them in a hashtable, but that hashtable needs to be thread safe so using safe functions to get and set.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: get-shard ((collection indexed-collection-mixin) shard-mac &key &allow-other-keys) ¶

Source

src/naive-indexed/naive-indexed.lisp.

Method: get-shard (collection shard-mac &key &allow-other-keys) ¶

Method: get-shard :around (collection shard-mac &key &allow-other-keys) ¶

Generic Function: get-store (universe store-name) ¶

Returns a store if found in the universe.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: get-store ((universe universe) store-name) ¶

Generic Function: gethash-safe (key hash &key lock recursive-p) ¶

Puts lock around hash get access for those cl implementations that dont have a thread safe hashtable.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-impl/common.lisp.

Methods

Method: gethash-safe (key hash &key lock recursive-p) ¶

Generic Function: (setf gethash-safe) (key hash &key lock recursive-p) ¶

Puts lock around hash set access.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-impl/common.lisp.

Methods

Method: (setf gethash-safe) (key hash &key lock recursive-p) ¶

Generic Function: getxn (document element-name) ¶

Gets changed value made to the document. IE new value.

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Methods

Method: getxn ((document document) element-name) ¶

Generic Function: getxo (document element-name) ¶

Gets value ignoring any changes made to the document. IE old value.

Package

cl-naive-store.naive-documents.

Source

src/naive-documents/naive-documents.lisp.

Methods

Method: getxo ((document document) element-name) ¶

Generic Function: hash (document) ¶

Returns the hash identifier for a data document. Data documents need a hash identifier to work with naive-store-indexed. naive-store-indexed will edit the document to add a hash identifier when adding documents to a collection. naive-store-indexed uses a UUID in its default implementation.

Package

cl-naive-store.naive-indexed.

Source

src/naive-indexed/naive-indexed.lisp.

Methods

Method: hash ((document document)) ¶

Source

src/naive-documents/naive-documents.lisp.

Method: hash (document) ¶

Generic Function: (setf hash) (document) ¶

Package

cl-naive-store.naive-indexed.

Source

src/naive-indexed/naive-indexed.lisp.

Methods

Method: (setf hash) ((document document)) ¶

Source

src/naive-documents/naive-documents.lisp.

Method: (setf hash) (document) ¶

Generic Function: index-lookup-hash (collection hash &key shards &allow-other-keys) ¶

Looks up document in UUID hash index. If sharsd is not supplied all loaded shards will be searched.

Will use shards to limit the lookup to specific shards.

Package

cl-naive-store.naive-indexed.

Source

src/naive-indexed/naive-indexed.lisp.

Methods

Method: index-lookup-hash ((collection indexed-collection-mixin) hash &key shards &allow-other-keys) ¶

Generic Function: index-lookup-values (collection values &key shards &allow-other-keys) ¶

Looks up document in key value hash index. If you are not using document-types then the order of values matter.

Will use shards to limit the lookup to specific shards.

Package

cl-naive-store.naive-indexed.

Source

src/naive-indexed/naive-indexed.lisp.

Methods

Method: index-lookup-values ((collection indexed-collection-mixin) values &key shards &allow-other-keys) ¶

Method: index-lookup-values ((collection collection) values &key shards &allow-other-keys) ¶

Generic Function: index-values (collection values &key &allow-other-keys) ¶

Returns a set of index values from the values of a data document.

Package

indexed-impl.

Source

src/naive-indexed/indexed-impl.lisp.

Methods

Method: index-values ((collection document-collection) (values document) &key &allow-other-keys) ¶

Source

src/naive-documents/indexed.lisp.

Method: index-values (collection values &key &allow-other-keys) ¶

Generic Reader: indexes (object) ¶

Generic Writer: (setf indexes) (object) ¶

Package

cl-naive-store.naive-indexed.

Methods

Reader Method: indexes ((indexed-collection-mixin indexed-collection-mixin)) ¶

Writer Method: (setf indexes) ((indexed-collection-mixin indexed-collection-mixin)) ¶

List of index combinations. Also indexes members partially if *partial-indexing* is t, for example ’((:emp-no :surname gender)) is indexed as (:emp-no :surname :gender), (:emp-no :surname), :emp-no, :surname and :gender

Source

src/naive-indexed/naive-indexed.lisp.

Target Slot

indexes.

Generic Reader: key-p (object) ¶

Generic Writer: (setf key-p) (object) ¶

Package

cl-naive-store.document-types.

Methods

Reader Method: key-p ((element element)) ¶

Writer Method: (setf key-p) ((element element)) ¶

Indicates that the element is part of the primary key.

Can be used for indexing and document comparison. For example when a new document is persisted naive-store-documents checks for documents with the same index value and then updates the existing document.

Source

src/document-types/document-types.lisp.

Target Slot

key-p.

Generic Reader: key-value-index (object) ¶

Generic Writer: (setf key-value-index) (object) ¶

Package

cl-naive-store.naive-indexed.

Methods

Reader Method: key-value-index ((indexed-shard indexed-shard)) ¶

Writer Method: (setf key-value-index) ((indexed-shard indexed-shard)) ¶

Hash table keyed on document key values for quick retrieval of an document. Used when doing key value equality comparisons.

Source

src/naive-indexed/naive-indexed.lisp.

Target Slot

key-value-index.

Generic Function: key-values (collection values &key &allow-other-keys) ¶

Returns a set of key values from the values of a data document. Checks the collection keys or uses hash.

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: key-values ((collection document-collection) document &key &allow-other-keys) ¶

Source

src/naive-documents/naive-documents.lisp.

Method: key-values ((collection document-type-collection-mixin) document &key &allow-other-keys) ¶

Source

src/document-types/document-types.lisp.

Method: key-values ((collection collection) values &key &allow-other-keys) ¶

Generic Reader: keys (object) ¶

Generic Writer: (setf keys) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: keys ((collection collection)) ¶

Writer Method: (setf keys) ((collection collection)) ¶

Keys need to be set to handle duplicates, the default is :key if :key is not found in the document then duplicates will occur.

NOTES:

For collections that use cl-naive-document-type there is a fallback the document-type is checked for keys as well and the collection’s keys will be set to the keys set in the document-type elements.

Source

src/naive-store/naive-core.lisp.

Target Slot

keys.

Generic Reader: label (object) ¶

Generic Writer: (setf label) (object) ¶

Package

cl-naive-store.document-types.

Methods

Reader Method: label ((document-type document-type)) ¶

Writer Method: (setf label) ((document-type document-type)) ¶

Human readable/formated short description.

Source

src/document-types/document-types.lisp.

Target Slot

label.

Generic Function: load-data (collection &key force-reload-p shard-macs parallel-p &allow-other-keys) ¶

Loads the data documents of a collection from file or files if sharding is used. If the data is already loaded it wont reload it, if you want the data to be reloaded use force-reload-p.

shard-macs is a list of shard macs to indicate which shards should be used. If no shards are specified all shards will be loaded.

NOTES:

load-data could have been used to load universe or store as well but those have a wealth of other key word parameters to control exactly what to do that makes the load-data signature a nightmare to understand. So separate methods load-stores (for universe) and load-collections (for a store) exists for that.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: load-data ((collection collection) &key shard-macs parallel-p &allow-other-keys) ¶

Source

src/naive-store/load.lisp.

Generic Function: load-store (store &key with-data-p &allow-other-keys) ¶

Loads the document-types and collections, with or without the actual data documents.

Package

cl-naive-store.naive-core.

Source

src/naive-store/load.lisp.

Methods

Method: load-store ((store document-type-store-mixin) &key with-data-p &allow-other-keys) ¶

Source

src/document-types/document-types.lisp.

Method: load-store ((store store) &key with-data-p &allow-other-keys) ¶

Generic Function: load-stores (universe &key with-collections-p with-data-p &allow-other-keys) ¶

Finds and loads collections a store, with or without data documents.

Package

cl-naive-store.naive-core.

Source

src/naive-store/load.lisp.

Methods

Method: load-stores (universe &key with-collections-p with-data-p &allow-other-keys) ¶

Loads a whole universe, with or without collections and data documents.

Generic Reader: location (object) ¶

Generic Writer: (setf location) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: location ((universe universe)) ¶

Writer Method: (setf location) ((universe universe)) ¶

Directory path to stores.

Source

src/naive-store/naive-core.lisp.

Target Slot

location.

Reader Method: location ((store store)) ¶

Writer Method: (setf location) ((store store)) ¶

The directory path to the document-type files and collection files for this store.

Source

src/naive-store/naive-core.lisp.

Target Slot

location.

Reader Method: location ((collection collection)) ¶

Writer Method: (setf location) ((collection collection)) ¶

The directory path to where files for this collection are stored.

Source

src/naive-store/naive-core.lisp.

Target Slot

location.

Reader Method: location ((shard shard)) ¶

Writer Method: (setf location) ((shard shard)) ¶

The file path to this shard is stored.

Source

src/naive-store/naive-core.lisp.

Target Slot

location.

Generic Reader: lock (object) ¶

Generic Writer: (setf lock) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: lock ((shard shard)) ¶

Writer Method: (setf lock) ((shard shard)) ¶

Used internally to do shard specific locking.

Source

src/naive-store/naive-core.lisp.

Target Slot

lock.

Generic Reader: mac (object) ¶

Generic Writer: (setf mac) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: mac ((shard shard)) ¶

Writer Method: (setf mac) ((shard shard)) ¶

Mac to identify shard.

Source

src/naive-store/naive-core.lisp.

Target Slot

mac.

Generic Function: make-mac (value &key key) ¶

Produces a mac from the value. Mac’s should differ for different values.

NOTES:

This is used to create shard filenames.

Package

naive-impl.

Source

src/naive-store/naive-impl/common.lisp.

Methods

Method: make-mac (value &key key) ¶

Generic Function: make-shard (collection shard-mac) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: make-shard ((collection indexed-collection-mixin) shard-mac) ¶

Source

src/naive-indexed/naive-indexed.lisp.

Method: make-shard (collection shard-mac) ¶

Creates an instance of a shard using the supplied mac.

Generic Function: naive-reduce (collection &key query function initial-value index-values shards &allow-other-keys) ¶

Uses query to select data documents from a collection and applies the function to those documents returning the result.

NOTES:

Does lazy loading.

Package

cl-naive-store.naive-core.

Source

src/naive-store/query.lisp.

Methods

Method: naive-reduce ((collection indexed-collection-mixin) &key index-values query function initial-value shards) ¶

Extends naive-reduce to be able to take advantage of indexing. Reduce is done on values retrieved by the supplier index.

Source

src/naive-indexed/query.lisp.

Method: naive-reduce ((sequence sequence) &key query function initial-value &allow-other-keys) ¶

Method: naive-reduce ((hash-table hash-table) &key query function initial-value &allow-other-keys) ¶

Method: naive-reduce ((collection collection) &key query function initial-value shards &allow-other-keys) ¶

Method: naive-reduce :before ((collection collection) &key shards &allow-other-keys) ¶

Lazy loading data.

Generic Reader: name (object) ¶

Generic Writer: (setf name) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: name ((document-type document-type)) ¶

Writer Method: (setf name) ((document-type document-type)) ¶

String representing a document-type name.

Source

src/document-types/document-types.lisp.

Target Slot

name.

Reader Method: name ((element element)) ¶

Writer Method: (setf name) ((element element)) ¶

Name of the element. This should be a KEYWORD if you want data portability and some internals might expect a keyword.

Source

src/document-types/document-types.lisp.

Target Slot

name.

Reader Method: name ((store store)) ¶

Writer Method: (setf name) ((store store)) ¶

Store name.

Source

src/naive-store/naive-core.lisp.

Target Slot

name.

Reader Method: name ((collection collection)) ¶

Writer Method: (setf name) ((collection collection)) ¶

The collection name.

Source

src/naive-store/naive-core.lisp.

Target Slot

name.

Generic Function: persist (object &key &allow-other-keys) ¶

Writes various store structural objects to

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: persist ((document-type document-type) &key &allow-other-keys) ¶

Persists a document-type definition. Path to file is of this general format /universe/store-name/document-type-name.type.

Source

src/document-types/document-types.lisp.

Method: persist ((collection collection) &key &allow-other-keys) ¶

Persists a collection definition and the documents in a collection. Path to file for data is this general format /universe/store-name/collection-name/collection-name.log.

Method: persist ((store store) &key &allow-other-keys) ¶

Persists a store definition and not what it contains! Path to file is of this general format /universe/store-name/store-name.store.

Generic Function: persist-collection-def (colleciton) ¶

Persists a collection definition. Path to file is of this general format /universe/store-name/collection-name.col.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: persist-collection-def ((collection document-type-collection-mixin)) ¶

Source

src/document-types/document-types.lisp.

Method: persist-collection-def ((collection collection)) ¶

Generic Function: persist-delete-document (collection shard document file &key &allow-other-keys) ¶

Marks document as deleted.

Package

naive-impl.

Source

src/naive-store/naive-impl/persist-document.lisp.

Methods

Method: persist-delete-document (collection shard document file &key &allow-other-keys) ¶

Generic Function: persist-document (collection document-form &key shard allow-key-change-p delete-p file-name file-stream handle-duplicates-p &allow-other-keys) ¶

Traverses the document and composes a list representation that is written to file. If the document is new it is added to the collection.

The shard the document should belong to can be passed in as well.

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: persist-document ((collection document-collection) document &key shard allow-key-change-p delete-p file-name file-stream &allow-other-keys) ¶

persist-document for document-collection is leniant in what it takes as a document, it can be of type document or a plist.

Source

src/naive-documents/documents.lisp.

Method: persist-document ((collection collection) document &key shard handle-duplicates-p delete-p file-name file-stream &allow-other-keys) ¶

Method: persist-document :before (collection document &key shard &allow-other-keys) ¶

Generic Function: persist-form (collection shard element element-type &key root parent &allow-other-keys) ¶

Convert a document element to its list representation.

IMPL NOTES:

specialize element type like this (element-type (eql :blob)). DONT specialize on object type directly because that will break type-of-doc-element. If you specialize element you need to supply your own implementation of type-of-doc-element as well.

Package

naive-impl.

Source

src/naive-store/naive-impl/persist-document.lisp.

Methods

Method: persist-form ((collection document-collection) shard document (element-type (eql :document)) &key root parent &allow-other-keys) ¶

Source

src/naive-documents/documents-impl/persist-document.lisp.

Method: persist-form ((collection document-collection) shard document (element-type (eql :child-document)) &key root parent &allow-other-keys) ¶

Source

src/naive-documents/documents-impl/persist-document.lisp.

Method: persist-form ((collection document-collection) shard document (element-type (eql :reference)) &key root parent &allow-other-keys) ¶

Source

src/naive-documents/documents-impl/persist-document.lisp.

Method: persist-form ((collection document-collection) shard blob (element-type (eql :blob)) &key root parent &allow-other-keys) ¶

Source

src/naive-documents/documents-impl/persist-document.lisp.

Method: persist-form (collection shard hash-table (element-type (eql :hash-table)) &key &allow-other-keys) ¶

Method: persist-form (collection shard reference (element-type (eql :reference)) &key &allow-other-keys) ¶

Method: persist-form (collection shard blob (element-type (eql :blob)) &key &allow-other-keys) ¶

Method: persist-form (collection shard document (element-type (eql :document)) &key &allow-other-keys) ¶

Generic Function: persist-parse (collection shard sexp doc &key root parent &allow-other-keys) ¶

Transcribes document to list form for peristance.

Package

naive-impl.

Source

src/naive-store/naive-impl/persist-document.lisp.

Methods

Method: persist-parse ((collection document-collection) shard element doc &key root parent &allow-other-keys) ¶

Source

src/naive-documents/documents-impl/persist-document.lisp.

Method: persist-parse (collection shard sexp doc &key &allow-other-keys) ¶

Generic Function: push-value-index (collection index-values document &key shard &allow-other-keys) ¶

Uses lists within the key-value-index hash-table to store/group documents that match a key value combination.

On updates of documents could end up with duplicate documents returned by the index lookup. The speed more than makes up for the occasional duplicate for now!

TODO: Implement index-lookup-value that strips out duplicates??

Package

indexed-impl.

Source

src/naive-indexed/indexed-impl.lisp.

Methods

Method: push-value-index (collection index-values document &key shard &allow-other-keys) ¶

Generic Function: query-data (collection &key query index-values shards collection-name &allow-other-keys) ¶

Returns the data that satisfies the query.

NOTES:

Does lazy loading.

Package

cl-naive-store.naive-core.

Source

src/naive-store/query.lisp.

Methods

Method: query-data ((collection indexed-collection-mixin) &key index-values query shards &allow-other-keys) ¶

Extends query-data to be able to take advantage of indexing. Query is done on values retrieved by the supplied index.

Source

src/naive-indexed/query.lisp.

Method: query-data ((hash-table hash-table) &key query &allow-other-keys) ¶

Method: query-data ((sequence sequence) &key query &allow-other-keys) ¶

Method: query-data ((store store) &key collection-name query shards &allow-other-keys) ¶

Method: query-data ((collection collection) &key query shards &allow-other-keys) ¶

Method: query-data :before ((collection collection) &key shards &allow-other-keys) ¶

Lazy loading data.

Generic Function: query-document (collection &key query collection-name shards &allow-other-keys) ¶

Returns the first last document found, and any others that satisfies the query

NOTES:

Does lazy loading.

Package

cl-naive-store.naive-core.

Source

src/naive-store/query.lisp.

Methods

Method: query-document ((hash-table hash-table) &key query &allow-other-keys) ¶

Method: query-document ((list list) &key query &allow-other-keys) ¶

Method: query-document ((store store) &key collection-name query &allow-other-keys) ¶

Method: query-document ((collection collection) &key query shards &allow-other-keys) ¶

Method: query-document :before ((collection collection) &key shards &allow-other-keys) ¶

Lazy loading data.

Generic Function: remhash-safe (key hash &key lock recursive-p) ¶

Puts lock around hash remove access for those cl implementations that dont have a thread safe hashtable.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-impl/common.lisp.

Methods

Method: remhash-safe (key hash &key lock recursive-p) ¶

Generic Function: remove-collection (store collection) ¶

Removes a collection to a store.

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: remove-collection ((store store) (collection collection)) ¶

Generic Function: remove-document (collection document &key shard &allow-other-keys) ¶

Removes an document from the collection and its indexes. See add-document.

Package

cl-naive-store.naive-core.

Source

src/naive-store/documents.lisp.

Methods

Method: remove-document ((collection indexed-collection-mixin) document &key shard &allow-other-keys) ¶

Source

src/naive-indexed/naive-indexed.lisp.

Method: remove-document ((collection collection) document &key shard &allow-other-keys) ¶

Method: remove-document :around ((collection collection) document &rest other-keys &key shard &allow-other-keys) ¶

Generic Function: remove-index (collection shard document &key &allow-other-keys) ¶

Removes a data document from the UUID and key value indexes. A shard must be supplied.

Package

cl-naive-store.naive-indexed.

Source

src/naive-indexed/naive-indexed.lisp.

Methods

Method: remove-index ((collection indexed-collection-mixin) shard document &key &allow-other-keys) ¶

Generic Function: remove-value-index (collection shard index-values document &key &allow-other-keys) ¶

Removes a value index.

Package

indexed-impl.

Source

src/naive-indexed/indexed-impl.lisp.

Methods

Method: remove-value-index (collection shard index-values document &key &allow-other-keys) ¶

Generic Function: sanitize-data-file (collection &key &allow-other-keys) ¶

This removes all the deleted data documents from a collection. When a collection is loaded only the active documents are loaded. Does this by simply writing those active documents out to a new file and then replacing the old file.

Package

cl-naive-store.naive-core.

Source

src/naive-store/maintenance.lisp.

Methods

Method: sanitize-data-file ((collection collection) &key &allow-other-keys) ¶

Generic Reader: shards (object) ¶

Generic Writer: (setf shards) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: shards ((collection collection)) ¶

Writer Method: (setf shards) ((collection collection)) ¶

A vector of shards.

NOTES:

Originally naive-store used lists but with the re-introduction of sharding, we chose to also introduce the use of lparrallel to speed up many functions and lparrallel has a preference for arrays.

Source

src/naive-store/naive-core.lisp.

Target Slot

shards.

Generic Function: short-mac (shard) ¶

Return a short string containing a prefix of the MAC

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: short-mac ((shard shard)) ¶

Generic Function: status (shard) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: status ((shard shard)) ¶

Generic Function: (setf status) (shard) ¶

Package

cl-naive-store.naive-core.

Source

src/naive-store/naive-core.lisp.

Methods

Method: (setf status) ((shard shard)) ¶

Generic Reader: store (object) ¶

Generic Writer: (setf store) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: store ((document-type document-type)) ¶

Writer Method: (setf store) ((document-type document-type)) ¶

The store that this document-type belongs to.

Source

src/document-types/document-types.lisp.

Target Slot

store.

Reader Method: store ((collection collection)) ¶

Writer Method: (setf store) ((collection collection)) ¶

The store that this collection belongs to.

Source

src/naive-store/naive-core.lisp.

Target Slot

store.

Generic Reader: store-class (object) ¶

Generic Writer: (setf store-class) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: store-class ((universe universe)) ¶

Writer Method: (setf store-class) ((universe universe)) ¶

The class that should be used to make stores.

NOTES:

store-class is delcaritively specied here because stores are dynamicly created when definition files are loaded. (see store notes for more about this.).

Source

src/naive-store/naive-core.lisp.

Target Slot

store-class.

Generic Reader: stores (object) ¶

Generic Writer: (setf stores) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: stores ((universe universe)) ¶

Writer Method: (setf stores) ((universe universe)) ¶

List of stores contained by this universe.

Source

src/naive-store/naive-core.lisp.

Target Slot

stores.

Generic Function: type-of-doc-element (collection sexp) ¶

Reports if the sexp represents a special form.

Package

naive-impl.

Source

src/naive-store/naive-impl/persist-document.lisp.

Methods

Method: type-of-doc-element ((collection document-collection) element) ¶

Source

src/naive-documents/documents-impl/persist-document.lisp.

Method: type-of-doc-element (collection element) ¶

Generic Function: type-of-sexp (collection sexp) ¶

Reports if the sexp represents a special form, like a blob or reference.

Package

naive-impl.

Source

src/naive-store/naive-impl/parse-document.lisp.

Methods

Method: type-of-sexp ((collection document-collection) document-form) ¶

Source

src/naive-documents/documents-impl/parse-document.lisp.

Method: type-of-sexp (collection sexp) ¶

Generic Reader: universe (object) ¶

Generic Writer: (setf universe) (object) ¶

Package

cl-naive-store.naive-core.

Methods

Reader Method: universe ((store store)) ¶

Writer Method: (setf universe) ((store store)) ¶

The universe this store belongs to.

Source

src/naive-store/naive-core.lisp.

Target Slot

universe.

---