velr 0.2.14

Velr embedded property-graph database (Rust driver, beta)
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![allow(dead_code)]
use libloading::{Library, Symbol};
use std::os::raw::{c_char, c_int};
use crate::sys::*;
#[cfg(feature = "arrow-ipc")]
use arrow2::ffi::{ArrowArray, ArrowSchema};
pub struct Api {
    pub velr_string_free: unsafe extern "C" fn(*mut c_char),
    pub velr_open: unsafe extern "C" fn(
        *const c_char,
        *mut *mut velr_db,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_open_existing_readonly: Option<
        unsafe extern "C" fn(
            *const c_char,
            *mut *mut velr_db,
            *mut *mut c_char,
        ) -> velr_code,
    >,
    pub velr_close: unsafe extern "C" fn(*mut velr_db),
    pub velr_exec_start: unsafe extern "C" fn(
        *mut velr_db,
        *const c_char,
        *mut *mut velr_stream,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_exec_close: unsafe extern "C" fn(*mut velr_stream),
    pub velr_stream_next_table: unsafe extern "C" fn(
        *mut velr_stream,
        *mut *mut velr_table,
        *mut c_int,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_explain: unsafe extern "C" fn(
        *mut velr_db,
        *const c_char,
        *mut *mut velr_explain_trace,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_explain_analyze: unsafe extern "C" fn(
        *mut velr_db,
        *const c_char,
        *mut *mut velr_explain_trace,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_tx_explain: unsafe extern "C" fn(
        *mut velr_tx,
        *const c_char,
        *mut *mut velr_explain_trace,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_tx_explain_analyze: unsafe extern "C" fn(
        *mut velr_tx,
        *const c_char,
        *mut *mut velr_explain_trace,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_explain_trace_close: unsafe extern "C" fn(*mut velr_explain_trace),
    pub velr_explain_trace_plan_count: unsafe extern "C" fn(
        *mut velr_explain_trace,
    ) -> usize,
    pub velr_explain_trace_plan_meta: unsafe extern "C" fn(
        *mut velr_explain_trace,
        usize,
        *mut velr_explain_plan_meta,
    ) -> velr_code,
    pub velr_explain_trace_step_count: unsafe extern "C" fn(
        *mut velr_explain_trace,
        usize,
    ) -> usize,
    pub velr_explain_trace_step_meta: unsafe extern "C" fn(
        *mut velr_explain_trace,
        usize,
        usize,
        *mut velr_explain_step_meta,
    ) -> velr_code,
    pub velr_explain_trace_statement_count: unsafe extern "C" fn(
        *mut velr_explain_trace,
        usize,
        usize,
    ) -> usize,
    pub velr_explain_trace_statement_meta: unsafe extern "C" fn(
        *mut velr_explain_trace,
        usize,
        usize,
        usize,
        *mut velr_explain_stmt_meta,
    ) -> velr_code,
    pub velr_explain_trace_sqlite_plan_count: unsafe extern "C" fn(
        *mut velr_explain_trace,
        usize,
        usize,
        usize,
    ) -> usize,
    pub velr_explain_trace_sqlite_plan_detail: unsafe extern "C" fn(
        *mut velr_explain_trace,
        usize,
        usize,
        usize,
        usize,
        *mut velr_strview,
    ) -> velr_code,
    pub velr_explain_trace_compact_len: unsafe extern "C" fn(
        *mut velr_explain_trace,
        *mut usize,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_explain_trace_compact_write: unsafe extern "C" fn(
        *mut velr_explain_trace,
        *mut u8,
        usize,
        *mut usize,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_explain_trace_compact_malloc: unsafe extern "C" fn(
        *mut velr_explain_trace,
        *mut *mut u8,
        *mut usize,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_exec_one: unsafe extern "C" fn(
        *mut velr_db,
        *const c_char,
        *mut *mut velr_table,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_table_close: unsafe extern "C" fn(*mut velr_table),
    pub velr_table_column_count: unsafe extern "C" fn(*mut velr_table) -> usize,
    pub velr_table_column_name: unsafe extern "C" fn(
        *mut velr_table,
        usize,
        *mut *const u8,
        *mut usize,
    ) -> velr_code,
    pub velr_table_rows_open: unsafe extern "C" fn(
        *mut velr_table,
        *mut *mut velr_rows,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_rows_close: unsafe extern "C" fn(*mut velr_rows),
    pub velr_rows_next: unsafe extern "C" fn(
        *mut velr_rows,
        *mut velr_cell,
        usize,
        *mut usize,
        *mut *mut c_char,
    ) -> c_int,
    pub velr_tx_begin: unsafe extern "C" fn(
        *mut velr_db,
        *mut *mut velr_tx,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_tx_commit: unsafe extern "C" fn(
        *mut velr_tx,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_tx_rollback: unsafe extern "C" fn(
        *mut velr_tx,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_tx_close: unsafe extern "C" fn(*mut velr_tx),
    pub velr_tx_exec_start: unsafe extern "C" fn(
        *mut velr_tx,
        *const c_char,
        *mut *mut velr_stream_tx,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_exec_tx_close: unsafe extern "C" fn(*mut velr_stream_tx),
    pub velr_stream_tx_next_table: unsafe extern "C" fn(
        *mut velr_stream_tx,
        *mut *mut velr_table,
        *mut c_int,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_tx_savepoint: unsafe extern "C" fn(
        *mut velr_tx,
        *mut *mut velr_sp,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_sp_release: unsafe extern "C" fn(
        *mut velr_sp,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_sp_rollback: unsafe extern "C" fn(
        *mut velr_sp,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_sp_close: unsafe extern "C" fn(*mut velr_sp),
    pub velr_tx_savepoint_named: unsafe extern "C" fn(
        *mut velr_tx,
        *const c_char,
        *mut *mut velr_sp,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_tx_rollback_to: unsafe extern "C" fn(
        *mut velr_tx,
        *const c_char,
        *mut *mut c_char,
    ) -> velr_code,
    #[cfg(feature = "arrow-ipc")]
    pub velr_table_ipc_file_len: unsafe extern "C" fn(
        *mut velr_table,
        *mut usize,
        *mut *mut c_char,
    ) -> velr_code,
    #[cfg(feature = "arrow-ipc")]
    pub velr_table_ipc_file_write: unsafe extern "C" fn(
        *mut velr_table,
        *mut u8,
        usize,
        *mut usize,
        *mut *mut c_char,
    ) -> velr_code,
    pub velr_free: unsafe extern "C" fn(*mut u8, usize),
    #[cfg(feature = "arrow-ipc")]
    pub velr_table_ipc_file_malloc: unsafe extern "C" fn(
        *mut velr_table,
        *mut *mut u8,
        *mut usize,
        *mut *mut c_char,
    ) -> velr_code,
    #[cfg(feature = "arrow-ipc")]
    pub velr_bind_arrow: unsafe extern "C" fn(
        *mut velr_db,
        *const c_char,
        *const *const ArrowSchema,
        *const *const ArrowArray,
        *const velr_strview,
        usize,
        *mut *mut c_char,
    ) -> velr_code,
    #[cfg(feature = "arrow-ipc")]
    pub velr_tx_bind_arrow: unsafe extern "C" fn(
        *mut velr_tx,
        *const c_char,
        *const *const ArrowSchema,
        *const *const ArrowArray,
        *const velr_strview,
        usize,
        *mut *mut c_char,
    ) -> velr_code,
    #[cfg(feature = "arrow-ipc")]
    pub velr_bind_arrow_chunks: unsafe extern "C" fn(
        *mut velr_db,
        *const c_char,
        *const velr_arrow_chunks,
        *const velr_strview,
        usize,
        *mut *mut c_char,
    ) -> velr_code,
    #[cfg(feature = "arrow-ipc")]
    pub velr_tx_bind_arrow_chunks: unsafe extern "C" fn(
        *mut velr_tx,
        *const c_char,
        *const velr_arrow_chunks,
        *const velr_strview,
        usize,
        *mut *mut c_char,
    ) -> velr_code,
}
impl Api {
    pub unsafe fn load(lib: &Library) -> Result<Self, libloading::Error> {
        unsafe fn get<T: Copy>(
            lib: &Library,
            name: &'static [u8],
        ) -> Result<T, libloading::Error> {
            let sym: Symbol<T> = lib.get::<T>(name)?;
            Ok(*sym)
        }
        unsafe fn get_optional<T: Copy>(
            lib: &Library,
            name: &'static [u8],
        ) -> Option<T> {
            lib.get::<T>(name).ok().map(|sym| *sym)
        }
        Ok(Self {
            velr_string_free: get(
                lib,
                concat!(stringify!(velr_string_free), "\0").as_bytes(),
            )?,
            velr_open: get(lib, concat!(stringify!(velr_open), "\0").as_bytes())?,
            velr_open_existing_readonly: get_optional(
                lib,
                concat!(stringify!(velr_open_existing_readonly), "\0").as_bytes(),
            ),
            velr_close: get(lib, concat!(stringify!(velr_close), "\0").as_bytes())?,
            velr_exec_start: get(
                lib,
                concat!(stringify!(velr_exec_start), "\0").as_bytes(),
            )?,
            velr_exec_close: get(
                lib,
                concat!(stringify!(velr_exec_close), "\0").as_bytes(),
            )?,
            velr_stream_next_table: get(
                lib,
                concat!(stringify!(velr_stream_next_table), "\0").as_bytes(),
            )?,
            velr_explain: get(lib, concat!(stringify!(velr_explain), "\0").as_bytes())?,
            velr_explain_analyze: get(
                lib,
                concat!(stringify!(velr_explain_analyze), "\0").as_bytes(),
            )?,
            velr_tx_explain: get(
                lib,
                concat!(stringify!(velr_tx_explain), "\0").as_bytes(),
            )?,
            velr_tx_explain_analyze: get(
                lib,
                concat!(stringify!(velr_tx_explain_analyze), "\0").as_bytes(),
            )?,
            velr_explain_trace_close: get(
                lib,
                concat!(stringify!(velr_explain_trace_close), "\0").as_bytes(),
            )?,
            velr_explain_trace_plan_count: get(
                lib,
                concat!(stringify!(velr_explain_trace_plan_count), "\0").as_bytes(),
            )?,
            velr_explain_trace_plan_meta: get(
                lib,
                concat!(stringify!(velr_explain_trace_plan_meta), "\0").as_bytes(),
            )?,
            velr_explain_trace_step_count: get(
                lib,
                concat!(stringify!(velr_explain_trace_step_count), "\0").as_bytes(),
            )?,
            velr_explain_trace_step_meta: get(
                lib,
                concat!(stringify!(velr_explain_trace_step_meta), "\0").as_bytes(),
            )?,
            velr_explain_trace_statement_count: get(
                lib,
                concat!(stringify!(velr_explain_trace_statement_count), "\0").as_bytes(),
            )?,
            velr_explain_trace_statement_meta: get(
                lib,
                concat!(stringify!(velr_explain_trace_statement_meta), "\0").as_bytes(),
            )?,
            velr_explain_trace_sqlite_plan_count: get(
                lib,
                concat!(stringify!(velr_explain_trace_sqlite_plan_count), "\0")
                    .as_bytes(),
            )?,
            velr_explain_trace_sqlite_plan_detail: get(
                lib,
                concat!(stringify!(velr_explain_trace_sqlite_plan_detail), "\0")
                    .as_bytes(),
            )?,
            velr_explain_trace_compact_len: get(
                lib,
                concat!(stringify!(velr_explain_trace_compact_len), "\0").as_bytes(),
            )?,
            velr_explain_trace_compact_write: get(
                lib,
                concat!(stringify!(velr_explain_trace_compact_write), "\0").as_bytes(),
            )?,
            velr_explain_trace_compact_malloc: get(
                lib,
                concat!(stringify!(velr_explain_trace_compact_malloc), "\0").as_bytes(),
            )?,
            velr_exec_one: get(
                lib,
                concat!(stringify!(velr_exec_one), "\0").as_bytes(),
            )?,
            velr_table_close: get(
                lib,
                concat!(stringify!(velr_table_close), "\0").as_bytes(),
            )?,
            velr_table_column_count: get(
                lib,
                concat!(stringify!(velr_table_column_count), "\0").as_bytes(),
            )?,
            velr_table_column_name: get(
                lib,
                concat!(stringify!(velr_table_column_name), "\0").as_bytes(),
            )?,
            velr_table_rows_open: get(
                lib,
                concat!(stringify!(velr_table_rows_open), "\0").as_bytes(),
            )?,
            velr_rows_close: get(
                lib,
                concat!(stringify!(velr_rows_close), "\0").as_bytes(),
            )?,
            velr_rows_next: get(
                lib,
                concat!(stringify!(velr_rows_next), "\0").as_bytes(),
            )?,
            velr_tx_begin: get(
                lib,
                concat!(stringify!(velr_tx_begin), "\0").as_bytes(),
            )?,
            velr_tx_commit: get(
                lib,
                concat!(stringify!(velr_tx_commit), "\0").as_bytes(),
            )?,
            velr_tx_rollback: get(
                lib,
                concat!(stringify!(velr_tx_rollback), "\0").as_bytes(),
            )?,
            velr_tx_close: get(
                lib,
                concat!(stringify!(velr_tx_close), "\0").as_bytes(),
            )?,
            velr_tx_exec_start: get(
                lib,
                concat!(stringify!(velr_tx_exec_start), "\0").as_bytes(),
            )?,
            velr_exec_tx_close: get(
                lib,
                concat!(stringify!(velr_exec_tx_close), "\0").as_bytes(),
            )?,
            velr_stream_tx_next_table: get(
                lib,
                concat!(stringify!(velr_stream_tx_next_table), "\0").as_bytes(),
            )?,
            velr_tx_savepoint: get(
                lib,
                concat!(stringify!(velr_tx_savepoint), "\0").as_bytes(),
            )?,
            velr_sp_release: get(
                lib,
                concat!(stringify!(velr_sp_release), "\0").as_bytes(),
            )?,
            velr_sp_rollback: get(
                lib,
                concat!(stringify!(velr_sp_rollback), "\0").as_bytes(),
            )?,
            velr_sp_close: get(
                lib,
                concat!(stringify!(velr_sp_close), "\0").as_bytes(),
            )?,
            velr_tx_savepoint_named: get(
                lib,
                concat!(stringify!(velr_tx_savepoint_named), "\0").as_bytes(),
            )?,
            velr_tx_rollback_to: get(
                lib,
                concat!(stringify!(velr_tx_rollback_to), "\0").as_bytes(),
            )?,
            #[cfg(feature = "arrow-ipc")]
            velr_table_ipc_file_len: get(
                lib,
                concat!(stringify!(velr_table_ipc_file_len), "\0").as_bytes(),
            )?,
            #[cfg(feature = "arrow-ipc")]
            velr_table_ipc_file_write: get(
                lib,
                concat!(stringify!(velr_table_ipc_file_write), "\0").as_bytes(),
            )?,
            velr_free: get(lib, concat!(stringify!(velr_free), "\0").as_bytes())?,
            #[cfg(feature = "arrow-ipc")]
            velr_table_ipc_file_malloc: get(
                lib,
                concat!(stringify!(velr_table_ipc_file_malloc), "\0").as_bytes(),
            )?,
            #[cfg(feature = "arrow-ipc")]
            velr_bind_arrow: get(
                lib,
                concat!(stringify!(velr_bind_arrow), "\0").as_bytes(),
            )?,
            #[cfg(feature = "arrow-ipc")]
            velr_tx_bind_arrow: get(
                lib,
                concat!(stringify!(velr_tx_bind_arrow), "\0").as_bytes(),
            )?,
            #[cfg(feature = "arrow-ipc")]
            velr_bind_arrow_chunks: get(
                lib,
                concat!(stringify!(velr_bind_arrow_chunks), "\0").as_bytes(),
            )?,
            #[cfg(feature = "arrow-ipc")]
            velr_tx_bind_arrow_chunks: get(
                lib,
                concat!(stringify!(velr_tx_bind_arrow_chunks), "\0").as_bytes(),
            )?,
        })
    }
}