lora-ruby 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +27 -3
- data/lib/lora_ruby/version.rb +1 -1
- data/src/lib.rs +87 -25
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9f225172245d7983494a2d5d498edc749e31629b811453667be8517d7624fde0
|
|
4
|
+
data.tar.gz: 36e8d24e24003755b36abcf34354df4c7af42125d969c27c2e76de551d2cb06d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 48356ff0802ae5949f2d000580779c865b793dc562d8068deb92e72eefc7a2409fa9890b7a69ff336ef8c0ba2d67c27da57f253e6db2674920715b71320f7c07
|
|
7
|
+
data.tar.gz: 4446b8aac9ac26302ccb688784c6bd20f3e6f4ca80d6fb66525505c7022964f672cf9272876584672ce8b34a183708a50f9cc54e785ae75420394b365ecc43f2
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# lora-ruby
|
|
2
2
|
|
|
3
|
-
Ruby bindings for the [Lora](../../README.md)
|
|
3
|
+
Ruby bindings for the [Lora](../../README.md) graph engine.
|
|
4
4
|
Ships a native extension built with [Magnus](https://github.com/matsadler/magnus)
|
|
5
5
|
on top of [`rb-sys`](https://github.com/oxidize-rb/rb-sys) so the Rust
|
|
6
6
|
engine runs in-process — no separate server, no socket hop.
|
|
@@ -39,6 +39,16 @@ result["rows"].each do |row|
|
|
|
39
39
|
end
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
+
Initialization rule:
|
|
43
|
+
|
|
44
|
+
```ruby
|
|
45
|
+
scratch = LoraRuby::Database.create # in-memory
|
|
46
|
+
persistent = LoraRuby::Database.create("./app") # persistent: directory string
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
If you want persistence, pass a directory string to
|
|
50
|
+
`LoraRuby::Database.create(...)` or `LoraRuby::Database.new(...)`.
|
|
51
|
+
|
|
42
52
|
### Params
|
|
43
53
|
|
|
44
54
|
`execute` accepts a second argument — either `nil` or a `Hash` keyed by
|
|
@@ -66,8 +76,8 @@ binding's `lora_python.Database` and because it mirrors the
|
|
|
66
76
|
## Public API
|
|
67
77
|
|
|
68
78
|
```ruby
|
|
69
|
-
LoraRuby::Database.create
|
|
70
|
-
LoraRuby::Database.new
|
|
79
|
+
LoraRuby::Database.create(wal_dir = nil) # -> Database
|
|
80
|
+
LoraRuby::Database.new(wal_dir = nil) # -> Database (alias of .create)
|
|
71
81
|
|
|
72
82
|
db.execute(query, params = nil) # -> { "columns" => [...], "rows" => [...] }
|
|
73
83
|
db.clear # -> nil
|
|
@@ -136,6 +146,20 @@ db.execute(
|
|
|
136
146
|
- `LoraRuby::QueryError` — parse / analyze / execute failure.
|
|
137
147
|
- `LoraRuby::InvalidParamsError` — a parameter value couldn't be mapped.
|
|
138
148
|
|
|
149
|
+
## Persistence
|
|
150
|
+
|
|
151
|
+
`LoraRuby::Database.create("./app")` and
|
|
152
|
+
`LoraRuby::Database.new("./app")` open or create a WAL-backed
|
|
153
|
+
persistent database rooted at that directory. Reopening the same path
|
|
154
|
+
replays committed writes before returning the handle.
|
|
155
|
+
|
|
156
|
+
Call `db.close` before reopening the same WAL directory inside one
|
|
157
|
+
process.
|
|
158
|
+
|
|
159
|
+
This first Ruby persistence slice intentionally stays small: the
|
|
160
|
+
binding exposes WAL-backed initialization plus the existing snapshot
|
|
161
|
+
APIs, but not checkpoint, truncate, status, or sync-mode controls.
|
|
162
|
+
|
|
139
163
|
## Concurrency (GVL release)
|
|
140
164
|
|
|
141
165
|
`Database#execute` calls `rb_thread_call_without_gvl`, so other Ruby
|
data/lib/lora_ruby/version.rb
CHANGED
|
@@ -10,5 +10,5 @@ module LoraRuby
|
|
|
10
10
|
# Guard against redefinition so re-requiring this file (or loading
|
|
11
11
|
# both paths) doesn't emit a "warning: already initialized constant"
|
|
12
12
|
# when the native extension loads second with the identical value.
|
|
13
|
-
VERSION = "0.
|
|
13
|
+
VERSION = "0.4.0" unless const_defined?(:VERSION)
|
|
14
14
|
end
|
data/src/lib.rs
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
use std::collections::BTreeMap;
|
|
17
17
|
use std::ffi::c_void;
|
|
18
18
|
use std::mem::MaybeUninit;
|
|
19
|
-
use std::sync::Arc;
|
|
19
|
+
use std::sync::{Arc, Mutex};
|
|
20
20
|
|
|
21
21
|
use magnus::{
|
|
22
22
|
function, method, prelude::*, r_hash::ForEach, value::ReprValue, Error as MagnusError,
|
|
@@ -25,6 +25,7 @@ use magnus::{
|
|
|
25
25
|
|
|
26
26
|
use lora_database::{
|
|
27
27
|
Database as InnerDatabase, ExecuteOptions, InMemoryGraph, LoraValue, QueryResult, ResultFormat,
|
|
28
|
+
WalConfig,
|
|
28
29
|
};
|
|
29
30
|
use lora_store::{
|
|
30
31
|
LoraDate, LoraDateTime, LoraDuration, LoraLocalDateTime, LoraLocalTime, LoraPoint, LoraTime,
|
|
@@ -60,10 +61,11 @@ fn init(ruby: &Ruby) -> Result<(), MagnusError> {
|
|
|
60
61
|
lora_ruby.define_class("InvalidParamsError", error)?;
|
|
61
62
|
|
|
62
63
|
let database = lora_ruby.define_class("Database", ruby.class_object())?;
|
|
63
|
-
database.define_singleton_method("create", function!(database_create,
|
|
64
|
-
database.define_singleton_method("new", function!(database_new,
|
|
64
|
+
database.define_singleton_method("create", function!(database_create, -1))?;
|
|
65
|
+
database.define_singleton_method("new", function!(database_new, -1))?;
|
|
65
66
|
database.define_method("execute", method!(database_execute, -1))?;
|
|
66
67
|
database.define_method("clear", method!(database_clear, 0))?;
|
|
68
|
+
database.define_method("close", method!(database_close, 0))?;
|
|
67
69
|
database.define_method("node_count", method!(database_node_count, 0))?;
|
|
68
70
|
database.define_method(
|
|
69
71
|
"relationship_count",
|
|
@@ -114,20 +116,20 @@ fn invalid_params(ruby: &Ruby, msg: impl Into<String>) -> MagnusError {
|
|
|
114
116
|
// Database
|
|
115
117
|
// ============================================================================
|
|
116
118
|
|
|
117
|
-
///
|
|
119
|
+
/// Lora graph database handle exposed to Ruby.
|
|
118
120
|
///
|
|
119
121
|
/// Wraps an `Arc<Database<InMemoryGraph>>`; the same handle is cloned
|
|
120
122
|
/// across the GVL-release boundary for query execution without borrowing
|
|
121
123
|
/// any Ruby state.
|
|
122
124
|
#[magnus::wrap(class = "LoraRuby::Database", free_immediately, size)]
|
|
123
125
|
struct Database {
|
|
124
|
-
db: Arc<InnerDatabase<InMemoryGraph
|
|
126
|
+
db: Mutex<Option<Arc<InnerDatabase<InMemoryGraph>>>>,
|
|
125
127
|
}
|
|
126
128
|
|
|
127
129
|
impl Database {
|
|
128
|
-
fn
|
|
130
|
+
fn from_db(db: Arc<InnerDatabase<InMemoryGraph>>) -> Self {
|
|
129
131
|
Self {
|
|
130
|
-
db:
|
|
132
|
+
db: Mutex::new(Some(db)),
|
|
131
133
|
}
|
|
132
134
|
}
|
|
133
135
|
}
|
|
@@ -135,32 +137,52 @@ impl Database {
|
|
|
135
137
|
// Constructors — we expose `Database.create` and `Database.new` as
|
|
136
138
|
// singletons so callers can use whichever idiom they prefer; both are
|
|
137
139
|
// cost-equivalent.
|
|
138
|
-
fn database_new() -> Database {
|
|
139
|
-
|
|
140
|
+
fn database_new(ruby: &Ruby, args: &[Value]) -> Result<Database, MagnusError> {
|
|
141
|
+
let wal_dir = optional_wal_dir_arg(ruby, args)?;
|
|
142
|
+
let db = without_gvl(move || open_database(wal_dir)).map_err(|e| query_error(ruby, e))?;
|
|
143
|
+
Ok(Database::from_db(db))
|
|
140
144
|
}
|
|
141
145
|
|
|
142
|
-
fn database_create() -> Database {
|
|
143
|
-
|
|
146
|
+
fn database_create(ruby: &Ruby, args: &[Value]) -> Result<Database, MagnusError> {
|
|
147
|
+
database_new(ruby, args)
|
|
144
148
|
}
|
|
145
149
|
|
|
146
|
-
fn database_clear(rb_self: &Database) {
|
|
147
|
-
rb_self
|
|
150
|
+
fn database_clear(ruby: &Ruby, rb_self: &Database) -> Result<(), MagnusError> {
|
|
151
|
+
database_inner(ruby, rb_self)?.clear();
|
|
152
|
+
Ok(())
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
fn database_close(ruby: &Ruby, rb_self: &Database) -> Result<(), MagnusError> {
|
|
156
|
+
let mut slot = rb_self
|
|
157
|
+
.db
|
|
158
|
+
.lock()
|
|
159
|
+
.map_err(|_| query_error(ruby, "database lock poisoned"))?;
|
|
160
|
+
slot.take();
|
|
161
|
+
Ok(())
|
|
148
162
|
}
|
|
149
163
|
|
|
150
|
-
fn database_node_count(rb_self: &Database) -> u64 {
|
|
151
|
-
rb_self
|
|
164
|
+
fn database_node_count(ruby: &Ruby, rb_self: &Database) -> Result<u64, MagnusError> {
|
|
165
|
+
Ok(database_inner(ruby, rb_self)?.node_count() as u64)
|
|
152
166
|
}
|
|
153
167
|
|
|
154
|
-
fn database_relationship_count(rb_self: &Database) -> u64 {
|
|
155
|
-
rb_self
|
|
168
|
+
fn database_relationship_count(ruby: &Ruby, rb_self: &Database) -> Result<u64, MagnusError> {
|
|
169
|
+
Ok(database_inner(ruby, rb_self)?.relationship_count() as u64)
|
|
156
170
|
}
|
|
157
171
|
|
|
158
172
|
fn database_inspect(rb_self: &Database) -> String {
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
173
|
+
match rb_self
|
|
174
|
+
.db
|
|
175
|
+
.lock()
|
|
176
|
+
.ok()
|
|
177
|
+
.and_then(|slot| slot.as_ref().cloned())
|
|
178
|
+
{
|
|
179
|
+
Some(db) => format!(
|
|
180
|
+
"#<LoraRuby::Database nodes={} relationships={}>",
|
|
181
|
+
db.node_count(),
|
|
182
|
+
db.relationship_count(),
|
|
183
|
+
),
|
|
184
|
+
None => "#<LoraRuby::Database closed>".to_string(),
|
|
185
|
+
}
|
|
164
186
|
}
|
|
165
187
|
|
|
166
188
|
fn database_save_snapshot(
|
|
@@ -169,7 +191,7 @@ fn database_save_snapshot(
|
|
|
169
191
|
path: RString,
|
|
170
192
|
) -> Result<RHash, MagnusError> {
|
|
171
193
|
let path = path.to_string()?;
|
|
172
|
-
let db =
|
|
194
|
+
let db = database_inner(ruby, rb_self)?;
|
|
173
195
|
let meta = without_gvl(move || db.save_snapshot_to(&path))
|
|
174
196
|
.map_err(|e| query_error(ruby, format!("{e}")))?;
|
|
175
197
|
snapshot_meta_to_rhash(ruby, meta)
|
|
@@ -181,7 +203,7 @@ fn database_load_snapshot(
|
|
|
181
203
|
path: RString,
|
|
182
204
|
) -> Result<RHash, MagnusError> {
|
|
183
205
|
let path = path.to_string()?;
|
|
184
|
-
let db =
|
|
206
|
+
let db = database_inner(ruby, rb_self)?;
|
|
185
207
|
let meta = without_gvl(move || db.load_snapshot_from(&path))
|
|
186
208
|
.map_err(|e| query_error(ruby, format!("{e}")))?;
|
|
187
209
|
snapshot_meta_to_rhash(ruby, meta)
|
|
@@ -211,6 +233,46 @@ fn snapshot_meta_to_rhash(
|
|
|
211
233
|
Ok(h)
|
|
212
234
|
}
|
|
213
235
|
|
|
236
|
+
fn optional_wal_dir_arg(ruby: &Ruby, args: &[Value]) -> Result<Option<String>, MagnusError> {
|
|
237
|
+
match args.len() {
|
|
238
|
+
0 => Ok(None),
|
|
239
|
+
1 => {
|
|
240
|
+
if args[0].is_nil() {
|
|
241
|
+
Ok(None)
|
|
242
|
+
} else {
|
|
243
|
+
Ok(Some(RString::try_convert(args[0])?.to_string()?))
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
n => Err(MagnusError::new(
|
|
247
|
+
ruby.exception_arg_error(),
|
|
248
|
+
format!("wrong number of arguments (given {n}, expected 0..1)"),
|
|
249
|
+
)),
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
fn open_database(wal_dir: Option<String>) -> Result<Arc<InnerDatabase<InMemoryGraph>>, String> {
|
|
254
|
+
let db = match wal_dir {
|
|
255
|
+
Some(dir) => {
|
|
256
|
+
InnerDatabase::open_with_wal(WalConfig::enabled(dir)).map_err(|e| e.to_string())?
|
|
257
|
+
}
|
|
258
|
+
None => InnerDatabase::in_memory(),
|
|
259
|
+
};
|
|
260
|
+
Ok(Arc::new(db))
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
fn database_inner(
|
|
264
|
+
ruby: &Ruby,
|
|
265
|
+
rb_self: &Database,
|
|
266
|
+
) -> Result<Arc<InnerDatabase<InMemoryGraph>>, MagnusError> {
|
|
267
|
+
let slot = rb_self
|
|
268
|
+
.db
|
|
269
|
+
.lock()
|
|
270
|
+
.map_err(|_| query_error(ruby, "database lock poisoned"))?;
|
|
271
|
+
slot.as_ref()
|
|
272
|
+
.cloned()
|
|
273
|
+
.ok_or_else(|| query_error(ruby, "database is closed"))
|
|
274
|
+
}
|
|
275
|
+
|
|
214
276
|
/// `execute(query, params = nil)` — `-1` arity so `params` is optional and
|
|
215
277
|
/// we can distinguish "not passed" from `nil`/`{}` (both map to empty
|
|
216
278
|
/// params). Everything that touches Ruby values happens under the GVL;
|
|
@@ -248,7 +310,7 @@ fn database_execute(ruby: &Ruby, rb_self: &Database, args: &[Value]) -> Result<R
|
|
|
248
310
|
// Run the engine with the GVL released. Everything inside the closure
|
|
249
311
|
// is pure Rust — no Ruby values cross the boundary — which keeps this
|
|
250
312
|
// sound.
|
|
251
|
-
let db =
|
|
313
|
+
let db = database_inner(ruby, rb_self)?;
|
|
252
314
|
let exec_result = without_gvl(move || {
|
|
253
315
|
let options = ExecuteOptions {
|
|
254
316
|
format: ResultFormat::RowArrays,
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: lora-ruby
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- LoraDB, Inc.
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-04-
|
|
11
|
+
date: 2026-04-25 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rb_sys
|