rdbpython 0.2.4__tar.gz → 0.2.7__tar.gz
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.
- rdbpython-0.2.7/LICENSE.md +201 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/PKG-INFO +15 -10
- rdbpython-0.2.7/README.md +61 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/pyproject.toml +12 -9
- {rdbpython-0.2.4 → rdbpython-0.2.7}/scripts/build-rocksdb-linux.sh +2 -1
- {rdbpython-0.2.4 → rdbpython-0.2.7}/setup.py +3 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/db.pxd +1 -1
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/lib_rocksdb.pxd +16 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/lib_rocksdb.pyx +348 -108
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpython.egg-info/PKG-INFO +15 -10
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpython.egg-info/SOURCES.txt +1 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/tests/functional/test_db.py +26 -0
- rdbpython-0.2.7/tests/functional/test_lifetime.py +483 -0
- rdbpython-0.2.4/LICENSE.md +0 -21
- rdbpython-0.2.4/README.md +0 -57
- {rdbpython-0.2.4 → rdbpython-0.2.7}/MANIFEST.in +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/scripts/build-rocksdb-macos.sh +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/scripts/rocksdb-cstdint.patch +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/setup.cfg +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/__init__.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/backup.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/cache.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/comparator.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/env.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/errors.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/filter_policy.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/include/rdb_include/comparator_wrapper.hpp +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/include/rdb_include/filter_policy_wrapper.hpp +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/include/rdb_include/memtable_factories.hpp +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/include/rdb_include/merge_operator_wrapper.hpp +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/include/rdb_include/slice_transform_wrapper.hpp +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/include/rdb_include/utils.hpp +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/include/rdb_include/write_batch_iter_helper.hpp +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/interfaces.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/iterator.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/lib_rocksdb.pyi +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/lib_utils.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/logger.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/memtablerep.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/merge_operator.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/merge_operators.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/options.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/slice_.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/slice_transform.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/snapshot.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/status.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/std_memory.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/table_factory.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/transaction.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpy/universal_compaction.pxd +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpython.egg-info/dependency_links.txt +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpython.egg-info/not-zip-safe +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpython.egg-info/requires.txt +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/src/rdbpython.egg-info/top_level.txt +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/tests/conftest.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/tests/functional/__init__.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/tests/functional/test_memtable.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/tests/functional/test_options.py +0 -0
- {rdbpython-0.2.4 → rdbpython-0.2.7}/tests/functional/test_transaction.py +0 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for describing the origin of the Work and
|
|
141
|
+
reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Support. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or support.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Gor Arakelyan
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: rdbpython
|
|
3
|
-
Version: 0.2.
|
|
3
|
+
Version: 0.2.7
|
|
4
4
|
Summary: Python bindings for RocksDB with Cython
|
|
5
5
|
Author-email: Gor Arakelyan <gorarkln@gmail.com>
|
|
6
6
|
Maintainer-email: Gor Arakelyan <gorarkln@gmail.com>
|
|
7
|
-
License-Expression:
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
8
|
Project-URL: Homepage, https://github.com/nustackdev/rdbpy
|
|
9
9
|
Project-URL: Documentation, https://github.com/nustackdev/rdbpy#readme
|
|
10
10
|
Project-URL: Repository, https://github.com/nustackdev/rdbpy
|
|
11
11
|
Project-URL: Issues, https://github.com/nustackdev/rdbpy/issues
|
|
12
12
|
Project-URL: PyPI, https://pypi.org/project/rdbpython/
|
|
13
|
-
Keywords: rocksdb,
|
|
13
|
+
Keywords: nustack,python,rocksdb,key-value-store,embedded-database,transactions,bindings,storage
|
|
14
14
|
Classifier: Development Status :: 3 - Alpha
|
|
15
15
|
Classifier: Intended Audience :: Developers
|
|
16
16
|
Classifier: Operating System :: OS Independent
|
|
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.10
|
|
|
20
20
|
Classifier: Programming Language :: Python :: 3.11
|
|
21
21
|
Classifier: Programming Language :: Python :: 3.12
|
|
22
22
|
Classifier: Programming Language :: Python :: 3.13
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
23
24
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
24
25
|
Classifier: Programming Language :: Cython
|
|
25
26
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
@@ -46,12 +47,6 @@ Dynamic: license-file
|
|
|
46
47
|
|
|
47
48
|
# rdbpy
|
|
48
49
|
|
|
49
|
-
[](https://github.com/nustackdev/rdbpy/actions/workflows/build.yml)
|
|
50
|
-
[](https://github.com/nustackdev/rdbpy/actions/workflows/test.yml)
|
|
51
|
-
[](https://pypi.org/project/rdbpython/)
|
|
52
|
-
[](https://pypi.org/project/rdbpython/)
|
|
53
|
-
[](https://opensource.org/licenses/MIT)
|
|
54
|
-
|
|
55
50
|
Python bindings for RocksDB with Cython - **batteries included!**
|
|
56
51
|
|
|
57
52
|
**No RocksDB installation required** - everything is bundled in the wheel for Linux and macOS (Intel + Apple Silicon).
|
|
@@ -85,6 +80,16 @@ while it.valid():
|
|
|
85
80
|
it.next()
|
|
86
81
|
```
|
|
87
82
|
|
|
83
|
+
## Lifetimes and threads
|
|
84
|
+
|
|
85
|
+
Iterators, snapshots and transactions point into native state owned by their parent:
|
|
86
|
+
|
|
87
|
+
- `Transaction.commit()`, `rollback()`, `close()` and a successful `rollback_to_save_point()` invalidate every iterator created from that transaction. So does `TransactionDB.begin_transaction(reuse=txn)`.
|
|
88
|
+
- `DB.close()` / `TransactionDB.close()` invalidate every iterator and snapshot of the DB and roll back any transaction that is still open.
|
|
89
|
+
- Using an invalidated iterator, or a DB after `close()`, raises `RuntimeError`. Dropping an invalidated object is safe, in any order, including when gc frees it.
|
|
90
|
+
|
|
91
|
+
Threads: a transaction and its iterators belong to one thread and must not be shared between threads. rdbpy does no locking of its own and releases the GIL inside RocksDB calls, so ending a transaction, or closing a DB, while another thread is still inside a call on it or on its iterators is undefined behaviour and can crash. Close a DB only after every thread is done with it. A finalizer (a generator's `finally`, `__del__`) that ends a transaction runs on whichever thread triggers gc, so it counts as using the transaction from that thread. gc merely freeing objects on another thread is safe.
|
|
92
|
+
|
|
88
93
|
## Development
|
|
89
94
|
|
|
90
95
|
```bash
|
|
@@ -100,4 +105,4 @@ make test
|
|
|
100
105
|
|
|
101
106
|
## License
|
|
102
107
|
|
|
103
|
-
|
|
108
|
+
Apache-2.0
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# rdbpy
|
|
2
|
+
|
|
3
|
+
Python bindings for RocksDB with Cython - **batteries included!**
|
|
4
|
+
|
|
5
|
+
**No RocksDB installation required** - everything is bundled in the wheel for Linux and macOS (Intel + Apple Silicon).
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install rdbpython
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
That's it! No need to install RocksDB or any compression libraries manually.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```python
|
|
18
|
+
import rdbpy
|
|
19
|
+
|
|
20
|
+
# Open database
|
|
21
|
+
options = rdbpy.Options(create_if_missing=True)
|
|
22
|
+
db = rdbpy.DB('/path/to/db', options)
|
|
23
|
+
|
|
24
|
+
# Put/Get
|
|
25
|
+
db.put(b'key', b'value')
|
|
26
|
+
value = db.get(b'key')
|
|
27
|
+
|
|
28
|
+
# Iterate
|
|
29
|
+
it = db.iterkeys()
|
|
30
|
+
it.seek_to_first()
|
|
31
|
+
while it.valid():
|
|
32
|
+
print(it.key())
|
|
33
|
+
it.next()
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Lifetimes and threads
|
|
37
|
+
|
|
38
|
+
Iterators, snapshots and transactions point into native state owned by their parent:
|
|
39
|
+
|
|
40
|
+
- `Transaction.commit()`, `rollback()`, `close()` and a successful `rollback_to_save_point()` invalidate every iterator created from that transaction. So does `TransactionDB.begin_transaction(reuse=txn)`.
|
|
41
|
+
- `DB.close()` / `TransactionDB.close()` invalidate every iterator and snapshot of the DB and roll back any transaction that is still open.
|
|
42
|
+
- Using an invalidated iterator, or a DB after `close()`, raises `RuntimeError`. Dropping an invalidated object is safe, in any order, including when gc frees it.
|
|
43
|
+
|
|
44
|
+
Threads: a transaction and its iterators belong to one thread and must not be shared between threads. rdbpy does no locking of its own and releases the GIL inside RocksDB calls, so ending a transaction, or closing a DB, while another thread is still inside a call on it or on its iterators is undefined behaviour and can crash. Close a DB only after every thread is done with it. A finalizer (a generator's `finally`, `__del__`) that ends a transaction runs on whichever thread triggers gc, so it counts as using the transaction from that thread. gc merely freeing objects on another thread is safe.
|
|
45
|
+
|
|
46
|
+
## Development
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# Setup
|
|
50
|
+
make install
|
|
51
|
+
|
|
52
|
+
# Build
|
|
53
|
+
make build
|
|
54
|
+
|
|
55
|
+
# Test
|
|
56
|
+
make test
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
Apache-2.0
|
|
@@ -10,10 +10,10 @@ build-backend = "setuptools.build_meta"
|
|
|
10
10
|
# ============================================================================
|
|
11
11
|
[project]
|
|
12
12
|
name = "rdbpython"
|
|
13
|
-
version = "0.2.
|
|
13
|
+
version = "0.2.7"
|
|
14
14
|
description = "Python bindings for RocksDB with Cython"
|
|
15
15
|
readme = "README.md"
|
|
16
|
-
license = "
|
|
16
|
+
license = "Apache-2.0"
|
|
17
17
|
authors = [
|
|
18
18
|
{name = "Gor Arakelyan", email = "gorarkln@gmail.com"}
|
|
19
19
|
]
|
|
@@ -21,12 +21,14 @@ maintainers = [
|
|
|
21
21
|
{name = "Gor Arakelyan", email = "gorarkln@gmail.com"}
|
|
22
22
|
]
|
|
23
23
|
keywords = [
|
|
24
|
+
"nustack",
|
|
25
|
+
"python",
|
|
24
26
|
"rocksdb",
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
+
"key-value-store",
|
|
28
|
+
"embedded-database",
|
|
29
|
+
"transactions",
|
|
30
|
+
"bindings",
|
|
27
31
|
"storage",
|
|
28
|
-
"embedded",
|
|
29
|
-
"cython"
|
|
30
32
|
]
|
|
31
33
|
classifiers = [
|
|
32
34
|
"Development Status :: 3 - Alpha",
|
|
@@ -38,6 +40,7 @@ classifiers = [
|
|
|
38
40
|
"Programming Language :: Python :: 3.11",
|
|
39
41
|
"Programming Language :: Python :: 3.12",
|
|
40
42
|
"Programming Language :: Python :: 3.13",
|
|
43
|
+
"Programming Language :: Python :: 3.14",
|
|
41
44
|
"Programming Language :: Python :: Implementation :: CPython",
|
|
42
45
|
"Programming Language :: Cython",
|
|
43
46
|
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
@@ -107,7 +110,7 @@ rdbpy = [
|
|
|
107
110
|
# CI/CD - cibuildwheel configuration
|
|
108
111
|
# ============================================================================
|
|
109
112
|
[tool.cibuildwheel]
|
|
110
|
-
build = ["cp39-*", "cp310-*", "cp311-*", "cp312-*", "cp313-*"]
|
|
113
|
+
build = ["cp39-*", "cp310-*", "cp311-*", "cp312-*", "cp313-*", "cp314-*"]
|
|
111
114
|
|
|
112
115
|
skip = [
|
|
113
116
|
"*-musllinux_*",
|
|
@@ -240,7 +243,7 @@ directory = "tests/reports/coverage"
|
|
|
240
243
|
# ============================================================================
|
|
241
244
|
[tool.ruff]
|
|
242
245
|
line-length = 100
|
|
243
|
-
target-version = "
|
|
246
|
+
target-version = "py39"
|
|
244
247
|
src = ["src", "tests"]
|
|
245
248
|
extend-exclude = [
|
|
246
249
|
".venv",
|
|
@@ -316,7 +319,7 @@ docstring-code-line-length = 80
|
|
|
316
319
|
# Type Checking - mypy
|
|
317
320
|
# ============================================================================
|
|
318
321
|
[tool.mypy]
|
|
319
|
-
python_version = "3.
|
|
322
|
+
python_version = "3.9"
|
|
320
323
|
warn_return_any = true
|
|
321
324
|
warn_unused_configs = true
|
|
322
325
|
disallow_untyped_defs = false
|
|
@@ -142,6 +142,7 @@ tar xzf "rocksdb-${ROCKSDB_VERSION}.tar.gz"
|
|
|
142
142
|
cd "rocksdb-${ROCKSDB_VERSION}"
|
|
143
143
|
|
|
144
144
|
# Apply patch to fix missing <cstdint> include for newer GCC versions
|
|
145
|
+
# (GCC 13+ needs it in more headers; the build also force-includes it below)
|
|
145
146
|
echo "Applying cstdint patch..."
|
|
146
147
|
SCRIPT_DIR="$(dirname "$(readlink -f "${BASH_SOURCE[0]}" 2>/dev/null || realpath "${BASH_SOURCE[0]}" 2>/dev/null || echo "${BASH_SOURCE[0]}")")"
|
|
147
148
|
if [ -f "$SCRIPT_DIR/rocksdb-cstdint.patch" ]; then
|
|
@@ -160,7 +161,7 @@ make static_lib shared_lib -j$(nproc) \
|
|
|
160
161
|
USE_RTTI=1 \
|
|
161
162
|
DISABLE_WARNING_AS_ERROR=1 \
|
|
162
163
|
DEBUG_LEVEL=0 \
|
|
163
|
-
EXTRA_CXXFLAGS="$CXXFLAGS" \
|
|
164
|
+
EXTRA_CXXFLAGS="$CXXFLAGS -include cstdint" \
|
|
164
165
|
EXTRA_LDFLAGS="$LDFLAGS"
|
|
165
166
|
|
|
166
167
|
# Install
|
|
@@ -194,6 +194,9 @@ def get_link_args() -> list[str]:
|
|
|
194
194
|
[
|
|
195
195
|
"-stdlib=libc++",
|
|
196
196
|
f"-mmacosx-version-min={os.environ.get('MACOSX_DEPLOYMENT_TARGET', '10.14')}",
|
|
197
|
+
# Reserve Mach-O header pad so delocate can rewrite @rpath -> @loader_path/.dylibs
|
|
198
|
+
# without hitting install_name_tool's "load commands don't fit" error on cp314.
|
|
199
|
+
"-Wl,-headerpad_max_install_names",
|
|
197
200
|
]
|
|
198
201
|
)
|
|
199
202
|
|
|
@@ -113,7 +113,7 @@ cdef extern from "rocksdb/db.h" namespace "rocksdb":
|
|
|
113
113
|
const options.ReadOptions&,
|
|
114
114
|
ColumnFamilyHandle*) nogil except+
|
|
115
115
|
|
|
116
|
-
|
|
116
|
+
Status NewIterators(
|
|
117
117
|
const options.ReadOptions&,
|
|
118
118
|
vector[ColumnFamilyHandle*]&,
|
|
119
119
|
vector[Iterator*]*) nogil except+
|
|
@@ -622,6 +622,13 @@ cdef class DB(IDB):
|
|
|
622
622
|
cdef db.DB* db
|
|
623
623
|
cdef list cf_handles
|
|
624
624
|
cdef list cf_options
|
|
625
|
+
cdef set _iterators
|
|
626
|
+
cdef set _snapshots
|
|
627
|
+
# Used by TransactionDB, declared here so it is still set when
|
|
628
|
+
# DB.__dealloc__ calls TransactionDB.close() after TransactionDB's own
|
|
629
|
+
# fields were cleared.
|
|
630
|
+
cdef set _transactions
|
|
631
|
+
cdef int _check_open(self) except -1
|
|
625
632
|
# def __cinit__(self, db_name, Options opts, dict column_families = *, read_only=False)
|
|
626
633
|
# def __dealloc__(self)
|
|
627
634
|
cpdef void close(self)
|
|
@@ -668,10 +675,14 @@ cdef class TransactionDB(DB):
|
|
|
668
675
|
cpdef void close(self)
|
|
669
676
|
|
|
670
677
|
|
|
678
|
+
@cython.no_gc_clear
|
|
671
679
|
cdef class Transaction(object):
|
|
672
680
|
cdef transaction.Transaction* txn
|
|
673
681
|
cdef TransactionDB db
|
|
674
682
|
cdef bint closed
|
|
683
|
+
cdef set _iterators
|
|
684
|
+
|
|
685
|
+
cdef void _release(self)
|
|
675
686
|
|
|
676
687
|
cdef void _ensure_open(self)
|
|
677
688
|
cpdef void close(self)
|
|
@@ -714,14 +725,19 @@ cdef class Iterator:
|
|
|
714
725
|
cpdef object next(self)
|
|
715
726
|
cpdef object get(self)
|
|
716
727
|
cpdef void skip(self)
|
|
728
|
+
cpdef void skip_back(self)
|
|
717
729
|
|
|
718
730
|
|
|
731
|
+
@cython.no_gc_clear
|
|
719
732
|
cdef class BaseIterator(Iterator):
|
|
720
733
|
cdef iterator.Iterator* ptr
|
|
721
734
|
cdef DB db
|
|
722
735
|
cdef ColumnFamilyHandle handle
|
|
723
736
|
cdef object owner
|
|
724
737
|
|
|
738
|
+
cdef int _check_valid(self) except -1
|
|
739
|
+
cdef void _invalidate(self)
|
|
740
|
+
|
|
725
741
|
# def __cinit__(self, DB db, ColumnFamilyHandle handle = None)
|
|
726
742
|
# def __dealloc__(self)
|
|
727
743
|
# def __iter__(self)
|