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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
|
%global _empty_manifest_terminate_build 0
Name: python-yedb
Version: 0.2.25
Release: 1
Summary: Rugged embedded and client/server key/value database
License: Apache License 2.0
URL: https://github.com/alttch/yedb
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f6/6a/85ee2d9149f5f6dc54557b31527cf15e658a893520f6307f37d219c43352/yedb-0.2.25.tar.gz
BuildArch: noarch
%description
# yedb - rugged embedded and client/server key-value database (Python implementation)
<img src="https://img.shields.io/pypi/v/yedb.svg" /> <img src="https://img.shields.io/badge/license-Apache%202.0-green" /> <img src="https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue.svg" />
## Why YEDB?
- Is it fast?
- Fast to read, slow to write
- Is it smart?
- No
- So what is YEDB for?
- YEDB is ultra-reliable, thread-safe and very easy to use.
- I don't like Python
- There are other [implementations](https://yedb.bma.ai)
[](https://www.youtube.com/watch?v=i3hSWjrNqLo)
https://www.youtube.com/watch?v=i3hSWjrNqLo
YEDB is absolutely reliable rugged key-value database, which can survive in any
power loss, unless the OS file system die. Keys data is saved in the very
reliable way and immediately flushed to disk (this can be disabled to speed
up the engine but is not recommended - why then YEDB is used for).
* YEDB database objects are absolutely thread-safe.
* YEDB has built-in tools to automatically repair itself if any keys are broken.
* If the tools failed to help, YEDB can be easily repaired by a system
administrator, using standard Linux tools.
* YEDB can automatically validate keys with JSON Schema
(https://json-schema.org/)
* YEDB has a cool CLI
Practical usage:
* Create a database and start writing continuously
* Turn the power switch off
* Boot the machine again. The typical result: the latest saved key isn't
survived, but the database is still valid and working. In 99% of cases, the
latest key can be automatically restored with built-in repair tools.
We created YEDB to use in our embedded products as config registry trees and
rugged key-value data storage. We use it a lot and hope you'll like it too.
Note: YEDB is good on SSDs and SD cards. As it immediately syncs all the data
written, it can work on classic HDDs really slowly.
## Performance
Modern SSDs give about 200-300 keys/sec written with auto-flush enabled. The
write speed can be 10-15 times faster without it, but we would not recommend
turning auto-flush off, as it is the key feature of YEDB.
Reading speed varies:
* for embedded: 30-40k keys/second (70-100k keys/second when cached).
* for UNIX/TCP socket: 7-15k keys/second
* for HTTP: 700-800 keys/second. Transport via HTTP is mostly slow because YEDB
client uses synchronous "requests" library (while the default server is
async). To get better results, consider tuning the server manually and use
a custom async client.
## Quick start
```shell
# install YEDB
pip3 install yedb
# to use as embedded or client/server - go on. to use CLI - install additional
# required libraries
pip3 install "yedb[cli]"
# create a new database and go interactive
yedb /path/to/my/database
# set a key
yedb set key1 value1
# get the key value
yedb get key1
```
## Quick client-server setup
```
# Install required system packages
# Debian/Ubuntu: apt-get install -y --no-install-recommends python3 python3-dev gcc
# RedHat/Fedora/CenOS: yum install -y python3 python3-devel gcc
sudo mkdir /opt/yedbd
cd /opt/yedbd && curl https://raw.githubusercontent.com/alttch/yedb-py/main/setup-server.sh | sudo sh
```
Use env to specify extra options:
* YEDBD\_BIND - override bind to (tcp://host:port, http://host:port or path to
UNIX socket)
* YEDBD\_SERVICE - system service name
* YEDB\_PS - CLI prompt
* PIP\_EXTRA\_OPTIONS - specify pip extra options
* PYTHON - override Python path
* PIP - override pip path
## Embedding
```python
from yedb import YEDB
with YEDB('/path/to/db', auto_repair=True) as db:
# do some stuff
# OR
db = YEDB('/path/to/db')
db.open()
try:
# do some stuff
finally:
db.close()
```
## Client/server
* If socket transport requested, the built-in in server requires "msgpack"
Python module
* If HTTP transport requested, the built-in server requires "aiohttp" Python
module
```shell
# listen to tcp://localhost:8870 (default), to bind UNIX socket, specify the
# full socket path, to use http transport, specify http://host:port to bind to
python3 -m yedb.server /path/to/db
```
### Connect a client
* If socket transport requested, the built-in in client requires "msgpack"
Python module
* If HTTP transport requested, the built-in client requires "requests" Python
module
```python
from yedb import YEDB
with YEDB('tcp://localhost:8870') as db:
# do some stuff, remember to send all parameters as kwargs
```
YEDB creates thread-local objects. If the software is using permanent threads
or a thread pool, it is recommended to use sessions to correctly drop these
objects at the end of the statement:
```python
from yedb import YEDB
with YEDB('tcp://localhost:8870') as db:
with db.session() as session:
# do some stuff, remember to send all parameters as kwargs
session.key_set(key='key1', value='val1')
print(session.key_get(key='key1'))
```
### Building own client
YEDB uses JSON RPC (https://www.jsonrpc.org/) as the API protocol. Any method,
listed in yedb.server.METHODS can be called. Payloads can be packed either with
JSON or with MessagePack.
If working via UNIX or TCP socket:
* only MessagePack payload encoding is supported
* Request/response format: PROTO\_VER + DATA\_FMT + FRAME\_LEN(32-bit
little-endian) + frame
Where PROTO\_VER = protocol version (0x01) and DATA\_FMT = data encoding format
(0x02 for MessagePack, which is the only protocol supported by the
built-in server).
### Working with complicated data structures (embedded only)
```python
from yedb import YEDB
with YEDB('/path/to/db') as db:
with db.key_as_dict('path/to/keydict) as key:
key.set('field', 'value')
# If modified, the key is automatically saved at the end of the statement.
```
## Data formats
The default engine data format is JSON
(https://github.com/python-rapidjson/python-rapidjson is detected and imported
automatically if present)
Other possible formats and their benefits:
* YAML - (requires manually installing "pyyaml" Python module) slow, but key
files are more human-readable and editable
* msgpack - (requires manually installing "msgpack" Python module). Fast,
reliable binary serialization format. If used, keys can hold binary values as
well.
* cbor - similar to msgpack (requires manually installing "cbor" Python module)
* pickle - native Python pickle binary data serialization format. Is slower
than msgpack/cbor, but keys can hold Python objects and functions as-is.
Databases can be easily converted between formats using "yedb" CLI tool or
"convert\_fmt" method, unless format-specific features are used (e.g. if keys
have binary data, they can't be converted to JSON properly).
## YEDB Specifications and Data formats
See https://github.com/alttch/yedb
## Schema validation
As all keys are serialized values, they can be automatically schema-validated
with JSON Schema (https://json-schema.org/).
To create the validation schema for the chosen key, or key group, create a
special key ".schema/path/to", which has to contain the valid JSON Schema.
E.g. the schema, stored in the key ".schema/groups/group1" will be used for
validating all keys in "groups/group1", including the group primary key. And
the schema, stored in ".schema/groups/group1/key1" will be used for validating
"groups/group1/key1" only (if key or subgroup schema is present, the parent
schemas are omitted).
YEDB also supports a non-standard scheme:
```json
{ "type" : "code.python" }
```
which requires the key to have valid Python code, without syntax errors.
If schema validation fails on set or structure "with" statement exit, an
exception yedb.SchemaValidationError is raised.
## Backup/restore
Full backup: simply backup the database directory with any preferred method.
Partial/server backup:
Use "dump\_keys" / "load\_keys" methods. If dump is created with CLI (requires
"msgpack" Python module for that), it has the format:
DUMP\_VER + DUMP\_FMT
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
....
KEY_LEN(32-bit little-endian) + KEY
## Debugging
Start client/server with DEBUG=1 env variable:
```shell
DEBUG=1 yedb /path/to/db
```
to debug when embedded, enable debug logging
```python
import yedb
yedb.debug = True
```
After, lower the default logging level.
## Module documentation
https://yedb-py.readthedocs.io/
%package -n python3-yedb
Summary: Rugged embedded and client/server key/value database
Provides: python-yedb
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-yedb
# yedb - rugged embedded and client/server key-value database (Python implementation)
<img src="https://img.shields.io/pypi/v/yedb.svg" /> <img src="https://img.shields.io/badge/license-Apache%202.0-green" /> <img src="https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue.svg" />
## Why YEDB?
- Is it fast?
- Fast to read, slow to write
- Is it smart?
- No
- So what is YEDB for?
- YEDB is ultra-reliable, thread-safe and very easy to use.
- I don't like Python
- There are other [implementations](https://yedb.bma.ai)
[](https://www.youtube.com/watch?v=i3hSWjrNqLo)
https://www.youtube.com/watch?v=i3hSWjrNqLo
YEDB is absolutely reliable rugged key-value database, which can survive in any
power loss, unless the OS file system die. Keys data is saved in the very
reliable way and immediately flushed to disk (this can be disabled to speed
up the engine but is not recommended - why then YEDB is used for).
* YEDB database objects are absolutely thread-safe.
* YEDB has built-in tools to automatically repair itself if any keys are broken.
* If the tools failed to help, YEDB can be easily repaired by a system
administrator, using standard Linux tools.
* YEDB can automatically validate keys with JSON Schema
(https://json-schema.org/)
* YEDB has a cool CLI
Practical usage:
* Create a database and start writing continuously
* Turn the power switch off
* Boot the machine again. The typical result: the latest saved key isn't
survived, but the database is still valid and working. In 99% of cases, the
latest key can be automatically restored with built-in repair tools.
We created YEDB to use in our embedded products as config registry trees and
rugged key-value data storage. We use it a lot and hope you'll like it too.
Note: YEDB is good on SSDs and SD cards. As it immediately syncs all the data
written, it can work on classic HDDs really slowly.
## Performance
Modern SSDs give about 200-300 keys/sec written with auto-flush enabled. The
write speed can be 10-15 times faster without it, but we would not recommend
turning auto-flush off, as it is the key feature of YEDB.
Reading speed varies:
* for embedded: 30-40k keys/second (70-100k keys/second when cached).
* for UNIX/TCP socket: 7-15k keys/second
* for HTTP: 700-800 keys/second. Transport via HTTP is mostly slow because YEDB
client uses synchronous "requests" library (while the default server is
async). To get better results, consider tuning the server manually and use
a custom async client.
## Quick start
```shell
# install YEDB
pip3 install yedb
# to use as embedded or client/server - go on. to use CLI - install additional
# required libraries
pip3 install "yedb[cli]"
# create a new database and go interactive
yedb /path/to/my/database
# set a key
yedb set key1 value1
# get the key value
yedb get key1
```
## Quick client-server setup
```
# Install required system packages
# Debian/Ubuntu: apt-get install -y --no-install-recommends python3 python3-dev gcc
# RedHat/Fedora/CenOS: yum install -y python3 python3-devel gcc
sudo mkdir /opt/yedbd
cd /opt/yedbd && curl https://raw.githubusercontent.com/alttch/yedb-py/main/setup-server.sh | sudo sh
```
Use env to specify extra options:
* YEDBD\_BIND - override bind to (tcp://host:port, http://host:port or path to
UNIX socket)
* YEDBD\_SERVICE - system service name
* YEDB\_PS - CLI prompt
* PIP\_EXTRA\_OPTIONS - specify pip extra options
* PYTHON - override Python path
* PIP - override pip path
## Embedding
```python
from yedb import YEDB
with YEDB('/path/to/db', auto_repair=True) as db:
# do some stuff
# OR
db = YEDB('/path/to/db')
db.open()
try:
# do some stuff
finally:
db.close()
```
## Client/server
* If socket transport requested, the built-in in server requires "msgpack"
Python module
* If HTTP transport requested, the built-in server requires "aiohttp" Python
module
```shell
# listen to tcp://localhost:8870 (default), to bind UNIX socket, specify the
# full socket path, to use http transport, specify http://host:port to bind to
python3 -m yedb.server /path/to/db
```
### Connect a client
* If socket transport requested, the built-in in client requires "msgpack"
Python module
* If HTTP transport requested, the built-in client requires "requests" Python
module
```python
from yedb import YEDB
with YEDB('tcp://localhost:8870') as db:
# do some stuff, remember to send all parameters as kwargs
```
YEDB creates thread-local objects. If the software is using permanent threads
or a thread pool, it is recommended to use sessions to correctly drop these
objects at the end of the statement:
```python
from yedb import YEDB
with YEDB('tcp://localhost:8870') as db:
with db.session() as session:
# do some stuff, remember to send all parameters as kwargs
session.key_set(key='key1', value='val1')
print(session.key_get(key='key1'))
```
### Building own client
YEDB uses JSON RPC (https://www.jsonrpc.org/) as the API protocol. Any method,
listed in yedb.server.METHODS can be called. Payloads can be packed either with
JSON or with MessagePack.
If working via UNIX or TCP socket:
* only MessagePack payload encoding is supported
* Request/response format: PROTO\_VER + DATA\_FMT + FRAME\_LEN(32-bit
little-endian) + frame
Where PROTO\_VER = protocol version (0x01) and DATA\_FMT = data encoding format
(0x02 for MessagePack, which is the only protocol supported by the
built-in server).
### Working with complicated data structures (embedded only)
```python
from yedb import YEDB
with YEDB('/path/to/db') as db:
with db.key_as_dict('path/to/keydict) as key:
key.set('field', 'value')
# If modified, the key is automatically saved at the end of the statement.
```
## Data formats
The default engine data format is JSON
(https://github.com/python-rapidjson/python-rapidjson is detected and imported
automatically if present)
Other possible formats and their benefits:
* YAML - (requires manually installing "pyyaml" Python module) slow, but key
files are more human-readable and editable
* msgpack - (requires manually installing "msgpack" Python module). Fast,
reliable binary serialization format. If used, keys can hold binary values as
well.
* cbor - similar to msgpack (requires manually installing "cbor" Python module)
* pickle - native Python pickle binary data serialization format. Is slower
than msgpack/cbor, but keys can hold Python objects and functions as-is.
Databases can be easily converted between formats using "yedb" CLI tool or
"convert\_fmt" method, unless format-specific features are used (e.g. if keys
have binary data, they can't be converted to JSON properly).
## YEDB Specifications and Data formats
See https://github.com/alttch/yedb
## Schema validation
As all keys are serialized values, they can be automatically schema-validated
with JSON Schema (https://json-schema.org/).
To create the validation schema for the chosen key, or key group, create a
special key ".schema/path/to", which has to contain the valid JSON Schema.
E.g. the schema, stored in the key ".schema/groups/group1" will be used for
validating all keys in "groups/group1", including the group primary key. And
the schema, stored in ".schema/groups/group1/key1" will be used for validating
"groups/group1/key1" only (if key or subgroup schema is present, the parent
schemas are omitted).
YEDB also supports a non-standard scheme:
```json
{ "type" : "code.python" }
```
which requires the key to have valid Python code, without syntax errors.
If schema validation fails on set or structure "with" statement exit, an
exception yedb.SchemaValidationError is raised.
## Backup/restore
Full backup: simply backup the database directory with any preferred method.
Partial/server backup:
Use "dump\_keys" / "load\_keys" methods. If dump is created with CLI (requires
"msgpack" Python module for that), it has the format:
DUMP\_VER + DUMP\_FMT
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
....
KEY_LEN(32-bit little-endian) + KEY
## Debugging
Start client/server with DEBUG=1 env variable:
```shell
DEBUG=1 yedb /path/to/db
```
to debug when embedded, enable debug logging
```python
import yedb
yedb.debug = True
```
After, lower the default logging level.
## Module documentation
https://yedb-py.readthedocs.io/
%package help
Summary: Development documents and examples for yedb
Provides: python3-yedb-doc
%description help
# yedb - rugged embedded and client/server key-value database (Python implementation)
<img src="https://img.shields.io/pypi/v/yedb.svg" /> <img src="https://img.shields.io/badge/license-Apache%202.0-green" /> <img src="https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue.svg" />
## Why YEDB?
- Is it fast?
- Fast to read, slow to write
- Is it smart?
- No
- So what is YEDB for?
- YEDB is ultra-reliable, thread-safe and very easy to use.
- I don't like Python
- There are other [implementations](https://yedb.bma.ai)
[](https://www.youtube.com/watch?v=i3hSWjrNqLo)
https://www.youtube.com/watch?v=i3hSWjrNqLo
YEDB is absolutely reliable rugged key-value database, which can survive in any
power loss, unless the OS file system die. Keys data is saved in the very
reliable way and immediately flushed to disk (this can be disabled to speed
up the engine but is not recommended - why then YEDB is used for).
* YEDB database objects are absolutely thread-safe.
* YEDB has built-in tools to automatically repair itself if any keys are broken.
* If the tools failed to help, YEDB can be easily repaired by a system
administrator, using standard Linux tools.
* YEDB can automatically validate keys with JSON Schema
(https://json-schema.org/)
* YEDB has a cool CLI
Practical usage:
* Create a database and start writing continuously
* Turn the power switch off
* Boot the machine again. The typical result: the latest saved key isn't
survived, but the database is still valid and working. In 99% of cases, the
latest key can be automatically restored with built-in repair tools.
We created YEDB to use in our embedded products as config registry trees and
rugged key-value data storage. We use it a lot and hope you'll like it too.
Note: YEDB is good on SSDs and SD cards. As it immediately syncs all the data
written, it can work on classic HDDs really slowly.
## Performance
Modern SSDs give about 200-300 keys/sec written with auto-flush enabled. The
write speed can be 10-15 times faster without it, but we would not recommend
turning auto-flush off, as it is the key feature of YEDB.
Reading speed varies:
* for embedded: 30-40k keys/second (70-100k keys/second when cached).
* for UNIX/TCP socket: 7-15k keys/second
* for HTTP: 700-800 keys/second. Transport via HTTP is mostly slow because YEDB
client uses synchronous "requests" library (while the default server is
async). To get better results, consider tuning the server manually and use
a custom async client.
## Quick start
```shell
# install YEDB
pip3 install yedb
# to use as embedded or client/server - go on. to use CLI - install additional
# required libraries
pip3 install "yedb[cli]"
# create a new database and go interactive
yedb /path/to/my/database
# set a key
yedb set key1 value1
# get the key value
yedb get key1
```
## Quick client-server setup
```
# Install required system packages
# Debian/Ubuntu: apt-get install -y --no-install-recommends python3 python3-dev gcc
# RedHat/Fedora/CenOS: yum install -y python3 python3-devel gcc
sudo mkdir /opt/yedbd
cd /opt/yedbd && curl https://raw.githubusercontent.com/alttch/yedb-py/main/setup-server.sh | sudo sh
```
Use env to specify extra options:
* YEDBD\_BIND - override bind to (tcp://host:port, http://host:port or path to
UNIX socket)
* YEDBD\_SERVICE - system service name
* YEDB\_PS - CLI prompt
* PIP\_EXTRA\_OPTIONS - specify pip extra options
* PYTHON - override Python path
* PIP - override pip path
## Embedding
```python
from yedb import YEDB
with YEDB('/path/to/db', auto_repair=True) as db:
# do some stuff
# OR
db = YEDB('/path/to/db')
db.open()
try:
# do some stuff
finally:
db.close()
```
## Client/server
* If socket transport requested, the built-in in server requires "msgpack"
Python module
* If HTTP transport requested, the built-in server requires "aiohttp" Python
module
```shell
# listen to tcp://localhost:8870 (default), to bind UNIX socket, specify the
# full socket path, to use http transport, specify http://host:port to bind to
python3 -m yedb.server /path/to/db
```
### Connect a client
* If socket transport requested, the built-in in client requires "msgpack"
Python module
* If HTTP transport requested, the built-in client requires "requests" Python
module
```python
from yedb import YEDB
with YEDB('tcp://localhost:8870') as db:
# do some stuff, remember to send all parameters as kwargs
```
YEDB creates thread-local objects. If the software is using permanent threads
or a thread pool, it is recommended to use sessions to correctly drop these
objects at the end of the statement:
```python
from yedb import YEDB
with YEDB('tcp://localhost:8870') as db:
with db.session() as session:
# do some stuff, remember to send all parameters as kwargs
session.key_set(key='key1', value='val1')
print(session.key_get(key='key1'))
```
### Building own client
YEDB uses JSON RPC (https://www.jsonrpc.org/) as the API protocol. Any method,
listed in yedb.server.METHODS can be called. Payloads can be packed either with
JSON or with MessagePack.
If working via UNIX or TCP socket:
* only MessagePack payload encoding is supported
* Request/response format: PROTO\_VER + DATA\_FMT + FRAME\_LEN(32-bit
little-endian) + frame
Where PROTO\_VER = protocol version (0x01) and DATA\_FMT = data encoding format
(0x02 for MessagePack, which is the only protocol supported by the
built-in server).
### Working with complicated data structures (embedded only)
```python
from yedb import YEDB
with YEDB('/path/to/db') as db:
with db.key_as_dict('path/to/keydict) as key:
key.set('field', 'value')
# If modified, the key is automatically saved at the end of the statement.
```
## Data formats
The default engine data format is JSON
(https://github.com/python-rapidjson/python-rapidjson is detected and imported
automatically if present)
Other possible formats and their benefits:
* YAML - (requires manually installing "pyyaml" Python module) slow, but key
files are more human-readable and editable
* msgpack - (requires manually installing "msgpack" Python module). Fast,
reliable binary serialization format. If used, keys can hold binary values as
well.
* cbor - similar to msgpack (requires manually installing "cbor" Python module)
* pickle - native Python pickle binary data serialization format. Is slower
than msgpack/cbor, but keys can hold Python objects and functions as-is.
Databases can be easily converted between formats using "yedb" CLI tool or
"convert\_fmt" method, unless format-specific features are used (e.g. if keys
have binary data, they can't be converted to JSON properly).
## YEDB Specifications and Data formats
See https://github.com/alttch/yedb
## Schema validation
As all keys are serialized values, they can be automatically schema-validated
with JSON Schema (https://json-schema.org/).
To create the validation schema for the chosen key, or key group, create a
special key ".schema/path/to", which has to contain the valid JSON Schema.
E.g. the schema, stored in the key ".schema/groups/group1" will be used for
validating all keys in "groups/group1", including the group primary key. And
the schema, stored in ".schema/groups/group1/key1" will be used for validating
"groups/group1/key1" only (if key or subgroup schema is present, the parent
schemas are omitted).
YEDB also supports a non-standard scheme:
```json
{ "type" : "code.python" }
```
which requires the key to have valid Python code, without syntax errors.
If schema validation fails on set or structure "with" statement exit, an
exception yedb.SchemaValidationError is raised.
## Backup/restore
Full backup: simply backup the database directory with any preferred method.
Partial/server backup:
Use "dump\_keys" / "load\_keys" methods. If dump is created with CLI (requires
"msgpack" Python module for that), it has the format:
DUMP\_VER + DUMP\_FMT
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
KEY_LEN(32-bit little-endian) + KEY
....
KEY_LEN(32-bit little-endian) + KEY
## Debugging
Start client/server with DEBUG=1 env variable:
```shell
DEBUG=1 yedb /path/to/db
```
to debug when embedded, enable debug logging
```python
import yedb
yedb.debug = True
```
After, lower the default logging level.
## Module documentation
https://yedb-py.readthedocs.io/
%prep
%autosetup -n yedb-0.2.25
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-yedb -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Wed May 31 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.25-1
- Package Spec generated
|