373
|
1
|
;;; lib/obj/db/proto.lisp --- Database Protocol |
|
2
|
|
|
3
|
;; |
|
4
|
|
387
|
5
|
;;; Commentary: |
|
6
|
|
|
7
|
;; This set of |
|
8
|
|
373
|
9
|
;;; Code: |
|
10
|
(in-package :obj/db) |
|
11
|
|
387
|
12
|
;;; Vars |
|
13
|
(declaim (sb-kernel:type-specifier *default-database-type* *default-database-collection-type*)) |
|
14
|
(defparameter *default-database-type* 'vector) |
|
15
|
(defparameter *default-database-collection-type* 'list) |
|
16
|
|
373
|
17
|
;;; Database |
|
18
|
(defgeneric db (self) |
|
19
|
(:documentation "Return the Database associated with SELF.")) |
|
20
|
|
|
21
|
(defclass database () |
|
22
|
((db :initarg :db :accessor db))) |
|
23
|
|
387
|
24
|
(defclass database-collection () ()) |
373
|
25
|
|
387
|
26
|
;; TODO 2024-05-30: maybe make into a macro? |
|
27
|
(defgeneric make-db (engine &rest initargs &key &allow-other-keys) |
|
28
|
(:documentation "'make-instance' for databases. An ENGINE must be supplied, which is usually a key such as :ROCKSDB or :SQLITE.")) |
373
|
29
|
|
387
|
30
|
(defgeneric connect-db (db &key &allow-other-keys) |
|
31
|
(:documentation "Connect the database DB.")) |
373
|
32
|
|
479
|
33
|
(defgeneric query-db (db query &key &allow-other-keys) |
387
|
34
|
(:documentation "Execute QUERY against DB.")) |
|
35
|
|
|
36
|
(defgeneric db-get (db key &key &allow-other-keys) |
|
37
|
(:documentation "Return the value associated with KEY from DB.")) |
373
|
38
|
|
|
39
|
(defgeneric (setf db-get) (db key val &key &allow-other-keys)) |
|
40
|
|
387
|
41
|
(defgeneric close-db (db &key &allow-other-keys) |
|
42
|
(:documentation "Close the database DB.")) |
373
|
43
|
|
|
44
|
(defgeneric open-db (self)) |
|
45
|
|
387
|
46
|
(defgeneric destroy-db (self) |
|
47
|
(:documentation "Destroy all traces of a database, deleting any on-disk data and shutting down |
|
48
|
in-memory objects.")) |
373
|
49
|
|
387
|
50
|
(defgeneric find-db (dbs name &key &allow-other-keys) |
|
51
|
(:documentation "Return the db by NAME, from a collection of databases DBS.")) |
|
52
|
|
|
53
|
(defgeneric insert-db (dbs name &key &allow-other-keys) |
|
54
|
(:documentation "Inserts a database by NAME into the database-collection DBS.")) |
373
|
55
|
|
|
56
|
;;; Common |
|
57
|
(defun slot-val (instance slot-name) |
|
58
|
(if (and instance |
|
59
|
(slot-boundp instance slot-name)) |
|
60
|
(slot-value instance slot-name))) |
|
61
|
|
|
62
|
(defgeneric get-val (object element &optional data-type) |
|
63
|
(:documentation "Returns the value in a object based on the supplied element name and possible |
387
|
64
|
type hints.") |
|
65
|
(:method (object element &optional data-type) |
373
|
66
|
(when object |
|
67
|
(typecase (or data-type object) |
|
68
|
(hash-table |
|
69
|
(gethash element object)) |
|
70
|
(standard-object |
|
71
|
(slot-val object element)) |
|
72
|
(t |
|
73
|
(if data-type |
|
74
|
(cond |
|
75
|
((equal 'alist data-type) |
|
76
|
(second (assoc element object :test #'equal))) |
|
77
|
((equal 'plist data-type) |
|
78
|
(get object element)) |
|
79
|
(t |
|
80
|
(error "Does not handle this type of object. Implement your own get-val method."))) |
|
81
|
(if (listp object) |
|
82
|
(second (assoc element object :test #'equal)) |
387
|
83
|
(error "Does not handle this type of object. Implement your own get-val method.")))))))) |
|
84
|
|
373
|
85
|
|
387
|
86
|
(defgeneric (setf get-val) (new-value object element &optional data-type) |
|
87
|
(:documentation "Set the value in a object based on the supplied element name and possible type |
|
88
|
hints.") |
|
89
|
(:method (new-value object element &optional data-type) |
|
90
|
(typecase (or data-type object) |
|
91
|
(hash-table (setf (gethash element object) new-value)) |
|
92
|
(standard-object (setf (slot-value object element) new-value)) |
|
93
|
(t |
|
94
|
(if data-type |
|
95
|
(cond ((equal 'alist data-type) |
|
96
|
(replace object (list (list element new-value)))) |
|
97
|
((equal 'plist data-type) |
|
98
|
;;TODO: Implement this properly. |
|
99
|
(get object element )) |
|
100
|
(t |
|
101
|
(error "Does not handle this type of object. Implement your own get-val method."))) |
|
102
|
(if (listp object) |
|
103
|
(replace object (list (list element new-value))) |
|
104
|
(error "Does not handle this type of object. Implement your own get-val method."))))))) |