cabinet / cabinet.go

  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
/*

Kyoto Cabinet bindings for Go. Copyleft by William Waites in 2011

 This program is free software: you can redistribute it and/or modify it under the terms of
 the GNU General Public License as published by the Free Software Foundation, either version
 3 of the License, or any later version.

 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with this program.
 If not, see <http://www.gnu.org/licenses/>.

Source code: http://bitbucket.org/ww/cabinet/src

Documentation: http://godoc.styx.org/pkg/bitbucket.org/ww/cabinet

These bindings have been tested with Kyoto Cabinet version 1.2.46.
They are known not to work with 1.2.7 because of the absent
kcdbreplace() function call. Once Kyoto Cabinet is installed, building
the bindings should be a simple matter of running:

    goinstall -u -v bitbucket.org/ww/cabinet

Simple usage will be along the lines of,

    import (
        "bitbucket.org/ww/cabinet
    )

    ...

    kc := cabinet.New()
    err = kc.Open("some_db.kch", cabinet.KCOWRITER | cabinet.KCOCREATE)
    err = kc.Set([]byte("hello"), []byte("world"))
    world, err = kc.Get([]byte("hello"))
    err = kc.Close()
    kc.Del()

Obviously checking the relevant errors...

The API follows the Kyoto Cabinet C API closely, for some examples see
http://fallabs.com/kyotocabinet/api/

Most input and output variables are []byte and not string. This is because
Kyoto Cabinet is not particularly concerned with strings and it is possible
to use any byte array as either key or value. An example from the test 
suite to read an integer out of the database:

    var n int64
    v, err = kc.Get([]byte("numbers"))
    binary.Read(bytes.NewBuffer(v), binary.BigEndian, &n)

Some functions have been added for convenience using Go. The Keys()
Values() and Items() on the cursor object return a channel over which
their results will be sent, for example. This probably obviates the need
for implementing the visitor-callback pattern when using Kyoto Cabinet
with Go.

If you use this module please feel free to contact me, ww@styx.org
with any questions, comments or bug reports.

*/
package cabinet

// #cgo CFLAGS: -I/usr/local/include
// #cgo LDFLAGS: -L/usr/local/lib -lkyotocabinet
// #include <kclangc.h>
import "C"

import (
	"log"
	"os"
	"unsafe"
)

const KCOREADER int = C.KCOREADER
const KCOWRITER int = C.KCOWRITER
const KCOCREATE int = C.KCOCREATE
const KCOTRUNCATE int = C.KCOTRUNCATE
const KCOAUTOTRAN int = C.KCOAUTOTRAN
const KCOAUTOSYNC int = C.KCOAUTOSYNC
const KCONOLOCK int = C.KCONOLOCK
const KCOTRYLOCK int = C.KCOTRYLOCK
const KCONOREPAIR = C.KCONOREPAIR

const KCESUCCESS int = C.KCESUCCESS
const KCENOIMPL int = C.KCENOIMPL
const KCEINVALID int = C.KCEINVALID
const KCENOREPOS int = C.KCENOREPOS
const KCEBROKEN int = C.KCEBROKEN
const KCENOPERM int = C.KCENOPERM
const KCEDUPREC int = C.KCEDUPREC
const KCENOREC int = C.KCENOREC
const KCELOGIC int = C.KCELOGIC
const KCESYSTEM = C.KCESYSTEM
const KCEMISC = C.KCEMISC

const KCMADD int = C.KCMADD
const KCMSET int = C.KCMSET
const KCMAPPEND int = C.KCMAPPEND
const KCMREPLACE int = C.KCMREPLACE

type KCDB struct {
	db *C.KCDB
}

func New() *KCDB {
	db := C.kcdbnew()
	return &KCDB{db}
}

func (kc *KCDB) Ecode() int {
	return int(C.kcdbecode(kc.db))
}

func EcodeName(ecode int) string {
	return C.GoString(C.kcecodename(C.int32_t(ecode)))
}

func (kc *KCDB) error() os.Error {
	return os.NewError(EcodeName(kc.Ecode()))
}

func (kc *KCDB) Open(filename string, mode int) (err os.Error) {
	name := C.CString(filename)
	defer C.free(unsafe.Pointer(name))
	if C.kcdbopen(kc.db, name, C.uint32_t(mode)) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Close() (err os.Error) {
	if C.kcdbclose(kc.db) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Del() {
	C.kcdbdel(kc.db)
}

func (kc *KCDB) Path() (path string, err os.Error) {
	cpath := C.kcdbpath(kc.db)
	defer C.kcfree(unsafe.Pointer(cpath))
	path = C.GoString(cpath)
	if path == "" {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Status() (status string, err os.Error) {
	cstatus := C.kcdbstatus(kc.db)
	if cstatus == nil {
		err = kc.error()
	}
	status = C.GoString(cstatus)
	C.kcfree(unsafe.Pointer(cstatus))
	return
}

func (kc *KCDB) Count() (count uint64, err os.Error) {
	ccount := C.kcdbcount(kc.db)
	if ccount == -1 {
		err = kc.error()
	} else {
		count = uint64(ccount)
	}
	return
}

func (kc *KCDB) Size() (size uint64, err os.Error) {
	csize := C.kcdbsize(kc.db)
	if csize == -1 {
		err = kc.error()
	} else {
		size = uint64(csize)
	}
	return
}

func (kc *KCDB) Clear() (err os.Error) {
	if C.kcdbclear(kc.db) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Sync(hard bool) (err os.Error) {
	var chard C.int32_t
	if hard {
		chard = 1
	} else {
		chard = 0
	}
	if C.kcdbsync(kc.db, chard, nil, nil) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Copy(filename string) (err os.Error) {
	name := C.CString(filename)
	defer C.free(unsafe.Pointer(name))
	if C.kcdbcopy(kc.db, name) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Merge(sdbs []*KCDB, mode int) (err os.Error) {
	count := len(sdbs)
	csdbs := make([]*C.KCDB, count)
	for i, db := range sdbs {
		csdbs[i] = db.db
	}
	if C.kcdbmerge(kc.db, &csdbs[0], C.size_t(count), C.uint32_t(mode)) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Dump(filename string) (err os.Error) {
	name := C.CString(filename)
	defer C.free(unsafe.Pointer(name))
	if C.kcdbdumpsnap(kc.db, name) == 0 {
		err = kc.error()
	}
	return
}
func (kc *KCDB) Load(filename string) (err os.Error) {
	name := C.CString(filename)
	defer C.free(unsafe.Pointer(name))
	if C.kcdbcopy(kc.db, name) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) BeginTran(hard bool) (err os.Error) {
	var chard C.int32_t
	if hard {
		chard = 1
	} else {
		chard = 0
	}
	if C.kcdbbegintran(kc.db, chard) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) BeginTranTry(hard bool) (err os.Error) {
	var chard C.int32_t
	if hard {
		chard = 1
	} else {
		chard = 0
	}
	if C.kcdbbegintrantry(kc.db, chard) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) EndTran(commit bool) (err os.Error) {
	var ccommit C.int32_t
	if commit {
		ccommit = 1
	} else {
		ccommit = 0
	}
	if C.kcdbendtran(kc.db, ccommit) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Set(key, value []byte) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	cvalue := (*C.char)(unsafe.Pointer(&value[0]))
	if C.kcdbset(kc.db, ckey, C.size_t(len(key)), cvalue, C.size_t(len(value))) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Add(key, value []byte) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	cvalue := (*C.char)(unsafe.Pointer(&value[0]))
	if C.kcdbadd(kc.db, ckey, C.size_t(len(key)), cvalue, C.size_t(len(value))) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Replace(key, value []byte) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	cvalue := (*C.char)(unsafe.Pointer(&value[0]))
	if C.kcdbreplace(kc.db, ckey, C.size_t(len(key)), cvalue, C.size_t(len(value))) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Append(key, value []byte) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	cvalue := (*C.char)(unsafe.Pointer(&value[0]))
	if C.kcdbappend(kc.db, ckey, C.size_t(len(key)), cvalue, C.size_t(len(value))) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Remove(key []byte) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	if C.kcdbremove(kc.db, ckey, C.size_t(len(key))) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Cas(key, oval, nval []byte) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	var coval, cnval *C.char
	loval, lnval := len(oval), len(nval)
	if loval > 0 {
		coval = (*C.char)(unsafe.Pointer(&nval[0]))
	}
	if lnval > 0 {
		cnval = (*C.char)(unsafe.Pointer(&nval[0]))
	}
	if C.kcdbcas(kc.db, ckey, C.size_t(len(key)), coval, C.size_t(loval), cnval, C.size_t(lnval)) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) IncrInt(key []byte, amount int64) (result int64, err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	cresult := C.kcdbincrint(kc.db, ckey, C.size_t(len(key)), C.int64_t(amount))
	if cresult == C.INT64_MIN {
		err = kc.error()
	} else {
		result = int64(cresult)
	}
	return
}

func (kc *KCDB) IncrDouble(key []byte, amount float64) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	if C.kcdbincrdouble(kc.db, ckey, C.size_t(len(key)), C.double(amount)) == 0 {
		err = kc.error()
	}
	return
}

func (kc *KCDB) Get(key []byte) (value []byte, err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	var vlen C.size_t
	cval := C.kcdbget(kc.db, ckey, C.size_t(len(key)), &vlen)
	if cval == nil {
		err = kc.error()
	} else {
		value = make([]byte, int(vlen))
		C.memcpy(unsafe.Pointer(&value[0]), unsafe.Pointer(cval), vlen)
		C.kcfree(unsafe.Pointer(cval))
	}
	return
}

type KCCUR struct {
	cur *C.KCCUR
}

func (kc *KCDB) Cursor() (kcc *KCCUR) {
	cur := C.kcdbcursor(kc.db)
	if cur == nil {
		return nil
	}
	kcc = &KCCUR{cur}
	kcc.Jump()
	return
}

func (kcc *KCCUR) Ecode() int {
	return int(C.kccurecode(kcc.cur))
}

func (kcc *KCCUR) Emsg() string {
	err := C.kccuremsg(kcc.cur)
	return C.GoString(err)
}

func (kcc *KCCUR) error() os.Error {
	return os.NewError(kcc.Emsg())
}

func (kcc *KCCUR) Del() {
	C.kccurdel(kcc.cur)
}

func (kcc *KCCUR) Db() (kc *KCDB) {
	kc = new(KCDB)
	kc.db = C.kccurdb(kcc.cur)
	return
}

func (kcc *KCCUR) Jump() (err os.Error) {
	if C.kccurjump(kcc.cur) == 0 {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) JumpKey(key []byte) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	if C.kccurjumpkey(kcc.cur, ckey, C.size_t(len(key))) == 0 {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) JumpBack() (err os.Error) {
	if C.kccurjumpback(kcc.cur) == 0 {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) JumpBackKey(key []byte) (err os.Error) {
	ckey := (*C.char)(unsafe.Pointer(&key[0]))
	if C.kccurjumpbackkey(kcc.cur, ckey, C.size_t(len(key))) == 0 {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) Step() (err os.Error) {
	if C.kccurstep(kcc.cur) == 0 {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) StepBack() (err os.Error) {
	if C.kccurstepback(kcc.cur) == 0 {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) Remove() (err os.Error) {
	if C.kccurremove(kcc.cur) == 0 {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) SetValue(value []byte, advance bool) (err os.Error) {
	cvalue := (*C.char)(unsafe.Pointer(&value[0]))
	var cadvance C.int32_t
	if advance {
		cadvance = 1
	} else {
		cadvance = 0
	}
	if C.kccursetvalue(kcc.cur, cvalue, C.size_t(len(value)), cadvance) == 0 {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) GetKey(advance bool) (k []byte, err os.Error) {
	var ksiz C.size_t
	var cadvance C.int32_t
	if advance {
		cadvance = 1
	} else {
		cadvance = 0
	}
	kp := C.kccurgetkey(kcc.cur, &ksiz, cadvance)
	if kp != nil {
		k = make([]byte, ksiz)
		C.memcpy(unsafe.Pointer(&k[0]), unsafe.Pointer(kp), ksiz)
		C.kcfree(unsafe.Pointer(kp))
	} else {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) GetValue(advance bool) (v []byte, err os.Error) {
	var vsiz C.size_t
	var cadvance C.int32_t
	if advance {
		cadvance = 1
	} else {
		cadvance = 0
	}
	vp := C.kccurgetvalue(kcc.cur, &vsiz, cadvance)
	if vp != nil {
		v = make([]byte, vsiz)
		C.memcpy(unsafe.Pointer(&v[0]), unsafe.Pointer(vp), vsiz)
		C.kcfree(unsafe.Pointer(vp))
	} else {
		err = kcc.error()
	}
	return
}

func (kcc *KCCUR) Get(advance bool) (k, v []byte, err os.Error) {
	var ksiz, vsiz C.size_t
	var vp *C.char
	var cadvance C.int32_t
	if advance {
		cadvance = 1
	} else {
		cadvance = 0
	}
	kp := C.kccurget(kcc.cur, &ksiz, &vp, &vsiz, cadvance)
	if kp != nil {
		k = make([]byte, ksiz)
		C.memcpy(unsafe.Pointer(&k[0]), unsafe.Pointer(kp), ksiz)
		v = make([]byte, vsiz)
		C.memcpy(unsafe.Pointer(&v[0]), unsafe.Pointer(vp), vsiz)
		C.kcfree(unsafe.Pointer(kp))
	} else {
		err = kcc.error()
	}
	return
}

func (kc *KCDB) Keys() (out chan []byte) {
	out = make(chan []byte)
	go func() {
		cur := kc.Cursor()
		for {
			k, err := cur.GetKey(true)
			if err != nil {
				if cur.Ecode() != KCENOREC {
					log.Printf("GetKey(true): %s", err)
				}
				break
			}
			out <- k
		}
		cur.Del()
		close(out)
	}()
	return
}

func (kc *KCDB) Values() (out chan []byte) {
	out = make(chan []byte)
	go func() {
		cur := kc.Cursor()
		for {
			v, err := cur.GetValue(true)
			if err != nil {
				if cur.Ecode() != KCENOREC {
					log.Printf("GetValue(true): %s", err)
				}
				break
			}
			out <- v
		}
		cur.Del()
		close(out)
	}()
	return
}

type Item struct {
	Key   []byte
	Value []byte
}

func (kc *KCDB) Items() (out chan *Item) {
	out = make(chan *Item)
	go func() {
		cur := kc.Cursor()
		for {
			k, v, err := cur.Get(true)
			if err != nil {
				if cur.Ecode() != KCENOREC {
					log.Printf("Get(true): %s", err)
				}
				break
			}
			out <- &Item{k, v}
		}
		cur.Del()
		close(out)
	}()
	return
}

func (kc *KCDB) MatchPrefix(prefix string, max int) (matches [][]byte, err os.Error) {
	cprefix := C.CString(prefix)
	strarray := make([]*C.char, max)
	count := C.kcdbmatchprefix(kc.db, cprefix, &strarray[0], C.size_t(max))
	if count == -1 {
		matches = nil
		err = kc.error()
	} else {
		matches = make([][]byte, int(count))
		for i := int64(0); i < int64(count); i++ {
			matches[i] = []byte(C.GoString(strarray[i]))
			C.kcfree(unsafe.Pointer(strarray[i]))
		}
	}
	C.free(unsafe.Pointer(cprefix))
	return
}

func (kc *KCDB) MatchRegex(regex string, max int) (matches [][]byte, err os.Error) {
	cregex := C.CString(regex)
	strarray := make([]*C.char, max)
	count := C.kcdbmatchregex(kc.db, cregex, &strarray[0], C.size_t(max))
	if count == -1 {
		matches = nil
		err = kc.error()
	} else {
		matches = make([][]byte, count)
		for i := int64(0); i < int64(count); i++ {
			matches[i] = []byte(C.GoString(strarray[i]))
			C.kcfree(unsafe.Pointer(strarray[i]))
		}
	}
	C.free(unsafe.Pointer(cregex))
	return
}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.