objectbox-python/objectbox/c.py at fix-github-actions · objectbox/objectbox-python

History

449 lines (318 loc) · 14 KB

Raw

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

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

import ctypes.util

import os

import platform

from objectbox.version import Version

# This file contains C-API bindings based on lib/objectbox.h, linking to the 'objectbox' shared library.

# The bindings are implementing using ctypes, see https://docs.python.org/dev/library/ctypes.html for introduction.

# Version of the library used by the binding. This version is checked at runtime to ensure binary compatibility.

# Don't forget to update download-c-lib.py when upgrading to a newer version.

required_version = "0.14.0"

def shlib_name(library: str) -> str:

"""Returns the platform-specific name of the shared library"""

if platform.system() == 'Linux':

return 'lib' + library + '.so'

elif platform.system() == 'Windows':

return library + '.dll'

elif platform.system() == 'Darwin':

return 'lib' + library + '.dylib'

else:

assert False, 'Unsupported platform: ' + platform.system()

# initialize the C library

lib_path = os.path.dirname(os.path.realpath(__file__))

lib_path = os.path.join(lib_path, 'lib',

platform.machine() if platform.system() != 'Darwin' else 'macos-universal', shlib_name('objectbox'))

C = ctypes.CDLL(lib_path)

# load the core library version

__major = ctypes.c_int(0)

__minor = ctypes.c_int(0)

__patch = ctypes.c_int(0)

C.obx_version(ctypes.byref(__major), ctypes.byref(

__minor), ctypes.byref(__patch))

# C-api (core library) version

version_core = Version(__major.value, __minor.value, __patch.value)

assert str(version_core) == required_version, \

"Incorrect ObjectBox version loaded: %s instead of expected %s " % (

str(version_core), required_version)

# define some basic types

obx_err = ctypes.c_int

obx_schema_id = ctypes.c_uint32

obx_uid = ctypes.c_uint64

obx_id = ctypes.c_uint64

obx_qb_cond = ctypes.c_int

# enums

OBXPropertyType = ctypes.c_int

OBXPropertyFlags = ctypes.c_int

OBXDebugFlags = ctypes.c_int

OBXPutMode = ctypes.c_int

OBXOrderFlags = ctypes.c_int

class OBX_model(ctypes.Structure):

pass

OBX_model_p = ctypes.POINTER(OBX_model)

class OBX_store(ctypes.Structure):

pass

OBX_store_p = ctypes.POINTER(OBX_store)

class OBX_store_options(ctypes.Structure):

pass

OBX_store_options_p = ctypes.POINTER(OBX_store_options)

class OBX_bytes(ctypes.Structure):

_fields_ = [

('data', ctypes.c_void_p),

('size', ctypes.c_size_t),

]

OBX_bytes_p = ctypes.POINTER(OBX_bytes)

class OBX_bytes_array(ctypes.Structure):

_fields_ = [

('data', OBX_bytes_p),

('count', ctypes.c_size_t),

]

OBX_bytes_array_p = ctypes.POINTER(OBX_bytes_array)

class OBX_id_array(ctypes.Structure):

_fields_ = [

('ids', ctypes.POINTER(obx_id)),

('count', ctypes.c_size_t),

]

OBX_id_array_p = ctypes.POINTER(OBX_id_array)

class OBX_txn(ctypes.Structure):

pass

OBX_txn_p = ctypes.POINTER(OBX_txn)

class OBX_box(ctypes.Structure):

pass

OBX_box_p = ctypes.POINTER(OBX_box)

class OBX_async(ctypes.Structure):

pass

OBX_async_p = ctypes.POINTER(OBX_async)

class OBX_query_builder(ctypes.Structure):

pass

OBX_query_builder_p = ctypes.POINTER(OBX_query_builder)

class OBX_query(ctypes.Structure):

pass

OBX_query_p = ctypes.POINTER(OBX_query)

# manually configure error methods, we can't use `fn()` defined below yet due to circular dependencies

C.obx_last_error_message.restype = ctypes.c_char_p

C.obx_last_error_code.restype = obx_err

class CoreException(Exception):

codes = {

0: "SUCCESS",

404: "NOT_FOUND",

10001: "ILLEGAL_STATE",

10002: "ILLEGAL_ARGUMENT",

10003: "ALLOCATION",

10097: "NO_ERROR_INFO",

10098: "GENERAL",

10099: "UNKNOWN",

10101: "DB_FULL",

10102: "MAX_READERS_EXCEEDED",

10103: "STORE_MUST_SHUTDOWN",

10199: "STORAGE_GENERAL",

10201: "UNIQUE_VIOLATED",

10202: "NON_UNIQUE_RESULT",

10203: "PROPERTY_TYPE_MISMATCH",

10299: "CONSTRAINT_VIOLATED",

10301: "STD_ILLEGAL_ARGUMENT",

10302: "STD_OUT_OF_RANGE",

10303: "STD_LENGTH",

10304: "STD_BAD_ALLOC",

10305: "STD_RANGE",

10306: "STD_OVERFLOW",

10399: "STD_OTHER",

10501: "SCHEMA",

10502: "FILE_CORRUPT"

}

def __init__(self, code):

self.code = code

self.message = py_str(C.obx_last_error_message())

name = self.codes[code] if code in self.codes else "n/a"

super(CoreException, self).__init__(

"%d (%s) - %s" % (code, name, self.message))

class NotFoundException(Exception):

pass

# assert the the returned obx_err is empty

def check_obx_err(code: obx_err, func, args) -> obx_err:

if code == 404:

raise NotFoundException()

elif code != 0:

raise CoreException(code)

return code

# assert that the returned pointer/int is non-empty

def check_result(result, func, args):

if not result:

raise CoreException(C.obx_last_error_code())

return result

# creates a global function "name" with the given restype & argtypes, calling C function with the same name

def fn(name: str, restype: type, argtypes):

func = C.__getattr__(name)

func.argtypes = argtypes

func.restype = restype

if restype is obx_err:

func.errcheck = check_obx_err

elif restype is not None:

func.errcheck = check_result

return func

def py_str(ptr: ctypes.c_char_p) -> str:

return ctypes.c_char_p(ptr).value.decode("utf-8")

def c_str(string: str) -> ctypes.c_char_p:

return string.encode('utf-8')

def c_voidp_as_bytes(voidp, size):

# TODO verify which of the following two approaches is better. Performance-wise, it seems the same.

# slice the data from the pointer

# return ctypes.cast(voidp, ctypes.POINTER(ctypes.c_char))[:size]

# create a memory view

return memoryview(ctypes.cast(voidp, ctypes.POINTER(ctypes.c_ubyte * size))[0]).tobytes()

# OBX_model* (void);

obx_model = fn('obx_model', OBX_model_p, [])

# obx_err (OBX_model* model, const char* name, obx_schema_id entity_id, obx_uid entity_uid);

obx_model_entity = fn('obx_model_entity', obx_err, [

OBX_model_p, ctypes.c_char_p, obx_schema_id, obx_uid])

# obx_err (OBX_model* model, const char* name, OBXPropertyType type, obx_schema_id property_id, obx_uid property_uid);

obx_model_property = fn('obx_model_property', obx_err,

[OBX_model_p, ctypes.c_char_p, OBXPropertyType, obx_schema_id, obx_uid])

# obx_err (OBX_model* model, OBXPropertyFlags flags);

obx_model_property_flags = fn('obx_model_property_flags', obx_err, [

OBX_model_p, OBXPropertyFlags])

# obx_err (OBX_model*, obx_schema_id entity_id, obx_uid entity_uid);

obx_model_last_entity_id = fn('obx_model_last_entity_id', None, [

OBX_model_p, obx_schema_id, obx_uid])

# obx_err (OBX_model* model, obx_schema_id index_id, obx_uid index_uid);

obx_model_last_index_id = fn('obx_model_last_index_id', None, [

OBX_model_p, obx_schema_id, obx_uid])

# obx_err (OBX_model* model, obx_schema_id relation_id, obx_uid relation_uid);

obx_model_last_relation_id = fn('obx_model_last_relation_id', None, [

OBX_model_p, obx_schema_id, obx_uid])

# obx_err (OBX_model* model, obx_schema_id property_id, obx_uid property_uid);

obx_model_entity_last_property_id = fn('obx_model_entity_last_property_id', obx_err,

[OBX_model_p, obx_schema_id, obx_uid])

# OBX_store_options* ();

obx_opt = fn('obx_opt', OBX_store_options_p, [])

# obx_err (OBX_store_options* opt, const char* dir);

obx_opt_directory = fn('obx_opt_directory', obx_err, [

OBX_store_options_p, ctypes.c_char_p])

# void (OBX_store_options* opt, size_t size_in_kb);

obx_opt_max_db_size_in_kb = fn('obx_opt_max_db_size_in_kb', None, [

OBX_store_options_p, ctypes.c_size_t])

# void (OBX_store_options* opt, int file_mode);

obx_opt_file_mode = fn('obx_opt_file_mode', None, [

OBX_store_options_p, ctypes.c_uint])

# void (OBX_store_options* opt, int max_readers);

obx_opt_max_readers = fn('obx_opt_max_readers', None, [

OBX_store_options_p, ctypes.c_uint])

# obx_err (OBX_store_options* opt, OBX_model* model);

obx_opt_model = fn('obx_opt_model', obx_err, [

OBX_store_options_p, OBX_model_p])

# void (OBX_store_options* opt);

obx_opt_free = fn('obx_opt_free', None, [OBX_store_options_p])

# OBX_store* (const OBX_store_options* options);

obx_store_open = fn('obx_store_open', OBX_store_p, [OBX_store_options_p])

# obx_err (OBX_store* store);

obx_store_close = fn('obx_store_close', obx_err, [OBX_store_p])

# OBX_txn* (OBX_store* store);

obx_txn_write = fn('obx_txn_write', OBX_txn_p, [OBX_store_p])

# OBX_txn* (OBX_store* store);

obx_txn_read = fn('obx_txn_read', OBX_txn_p, [OBX_store_p])

# obx_err (OBX_txn* txn)

obx_txn_close = fn('obx_txn_close', obx_err, [OBX_txn_p])

# obx_err (OBX_txn* txn);

obx_txn_abort = fn('obx_txn_abort', obx_err, [OBX_txn_p])

# obx_err (OBX_txn* txn);

obx_txn_success = fn('obx_txn_success', obx_err, [OBX_txn_p])

# OBX_box* (OBX_store* store, obx_schema_id entity_id);

obx_box = fn('obx_box', OBX_box_p, [OBX_store_p, obx_schema_id])

# obx_err (OBX_box* box, obx_id id, const void** data, size_t* size);

obx_box_get = fn('obx_box_get', obx_err,

[OBX_box_p, obx_id, ctypes.POINTER(ctypes.c_void_p), ctypes.POINTER(ctypes.c_size_t)])

# OBX_bytes_array* (OBX_box* box);

obx_box_get_all = fn('obx_box_get_all', OBX_bytes_array_p, [OBX_box_p])

# obx_id (OBX_box* box, obx_id id_or_zero);

obx_box_id_for_put = fn('obx_box_id_for_put', obx_id, [OBX_box_p, obx_id])

# obx_err (OBX_box* box, uint64_t count, obx_id* out_first_id);

obx_box_ids_for_put = fn('obx_box_ids_for_put', obx_err, [

OBX_box_p, ctypes.c_uint64, ctypes.POINTER(obx_id)])

# obx_err (OBX_box* box, obx_id id, const void* data, size_t size);

obx_box_put = fn('obx_box_put', obx_err, [

OBX_box_p, obx_id, ctypes.c_void_p, ctypes.c_size_t])

# obx_err (OBX_box* box, const OBX_bytes_array* objects, const obx_id* ids, OBXPutMode mode);

obx_box_put_many = fn('obx_box_put_many', obx_err, [

OBX_box_p, OBX_bytes_array_p, ctypes.POINTER(obx_id), OBXPutMode])

# obx_err (OBX_box* box, obx_id id);

obx_box_remove = fn('obx_box_remove', obx_err, [OBX_box_p, obx_id])

# obx_err (OBX_box* box, uint64_t* out_count);

obx_box_remove_all = fn('obx_box_remove_all', obx_err, [

OBX_box_p, ctypes.POINTER(ctypes.c_uint64)])

# obx_err (OBX_box* box, bool* out_is_empty);

obx_box_is_empty = fn('obx_box_is_empty', obx_err, [

OBX_box_p, ctypes.POINTER(ctypes.c_bool)])

# obx_err obx_box_count(OBX_box* box, uint64_t limit, uint64_t* out_count);

obx_box_count = fn('obx_box_count', obx_err, [

OBX_box_p, ctypes.c_uint64, ctypes.POINTER(ctypes.c_uint64)])

# OBX_bytes_array* (size_t count);

obx_bytes_array = fn('obx_bytes_array', OBX_bytes_array_p, [ctypes.c_size_t])

# obx_err (OBX_bytes_array* array, size_t index, const void* data, size_t size);

obx_bytes_array_set = fn('obx_bytes_array_set', obx_err,

[OBX_bytes_array_p, ctypes.c_size_t, ctypes.c_void_p, ctypes.c_size_t])

# void (OBX_bytes_array * array);

obx_bytes_array_free = fn('obx_bytes_array_free', None, [OBX_bytes_array_p])

OBXPropertyType_Bool = 1

OBXPropertyType_Byte = 2

OBXPropertyType_Short = 3

OBXPropertyType_Char = 4

OBXPropertyType_Int = 5

OBXPropertyType_Long = 6

OBXPropertyType_Float = 7

OBXPropertyType_Double = 8

OBXPropertyType_String = 9

OBXPropertyType_Date = 10

OBXPropertyType_Relation = 11

OBXPropertyType_ByteVector = 23

OBXPropertyType_StringVector = 30

OBXPropertyFlags_ID = 1

OBXPropertyFlags_NON_PRIMITIVE_TYPE = 2

OBXPropertyFlags_NOT_NULL = 4

OBXPropertyFlags_INDEXED = 8

OBXPropertyFlags_RESERVED = 16

OBXPropertyFlags_UNIQUE = 32

OBXPropertyFlags_ID_MONOTONIC_SEQUENCE = 64

OBXPropertyFlags_ID_SELF_ASSIGNABLE = 128

OBXPropertyFlags_INDEX_PARTIAL_SKIP_NULL = 256

OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO = 512

OBXPropertyFlags_VIRTUAL = 1024

OBXPropertyFlags_INDEX_HASH = 2048

OBXPropertyFlags_INDEX_HASH64 = 4096

OBXPropertyFlags_UNSIGNED = 8192

OBXDebugFlags_LOG_TRANSACTIONS_READ = 1

OBXDebugFlags_LOG_TRANSACTIONS_WRITE = 2

OBXDebugFlags_LOG_QUERIES = 4

OBXDebugFlags_LOG_QUERY_PARAMETERS = 8

OBXDebugFlags_LOG_ASYNC_QUEUE = 16

# Standard put ("insert or update")

OBXPutMode_PUT = 1

# Put succeeds only if the entity does not exist yet.

OBXPutMode_INSERT = 2

# Put succeeds only if the entity already exist.

OBXPutMode_UPDATE = 3

# The given ID (non-zero) is guaranteed to be new; don't use unless you know exactly what you are doing!

# This is primarily used internally. Wrong usage leads to inconsistent data (e.g. index data not updated)!

OBXPutMode_PUT_ID_GUARANTEED_TO_BE_NEW = 4

# Reverts the order from ascending (default) to descending.

OBXOrderFlags_DESCENDING = 1

# Makes upper case letters (e.g. "Z") be sorted before lower case letters (e.g. "a").

# If not specified, the default is case insensitive for ASCII characters.

OBXOrderFlags_CASE_SENSITIVE = 2

# For scalars only: changes the comparison to unsigned (default is signed).

OBXOrderFlags_UNSIGNED = 4

# null values will be put last.

# If not specified, by default null values will be put first.

OBXOrderFlags_NULLS_LAST = 8

# null values should be treated equal to zero (scalars only).

OBXOrderFlags_NULLS_ZERO = 16

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

c.py

Latest commit

History

c.py

File metadata and controls