forked from groonga/groonga
-
Notifications
You must be signed in to change notification settings - Fork 1
/
groonga.h
2140 lines (1875 loc) · 77.4 KB
/
groonga.h
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
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright(C) 2009 Brazil
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef GROONGA_H
#define GROONGA_H
#ifdef __cplusplus
extern "C" {
#endif
#ifndef GRN_API
#if defined(_WIN32) || defined(_WIN64)
#define GRN_API __declspec(dllimport)
#else
#define GRN_API
#endif /* defined(_WIN32) || defined(_WIN64) */
#endif /* GRN_API */
typedef unsigned grn_id;
#define GRN_ID_NIL (0x00)
#define GRN_ID_MAX (0x3fffffff)
#define GRN_TRUE (1)
#define GRN_FALSE (0)
typedef enum {
GRN_SUCCESS = 0,
GRN_END_OF_DATA = 1,
GRN_UNKNOWN_ERROR = -1,
GRN_OPERATION_NOT_PERMITTED = -2,
GRN_NO_SUCH_FILE_OR_DIRECTORY = -3,
GRN_NO_SUCH_PROCESS = -4,
GRN_INTERRUPTED_FUNCTION_CALL = -5,
GRN_INPUT_OUTPUT_ERROR = -6,
GRN_NO_SUCH_DEVICE_OR_ADDRESS = -7,
GRN_ARG_LIST_TOO_LONG = -8,
GRN_EXEC_FORMAT_ERROR = -9,
GRN_BAD_FILE_DESCRIPTOR = -10,
GRN_NO_CHILD_PROCESSES = -11,
GRN_RESOURCE_TEMPORARILY_UNAVAILABLE = -12,
GRN_NOT_ENOUGH_SPACE = -13,
GRN_PERMISSION_DENIED = -14,
GRN_BAD_ADDRESS = -15,
GRN_RESOURCE_BUSY = -16,
GRN_FILE_EXISTS = -17,
GRN_IMPROPER_LINK = -18,
GRN_NO_SUCH_DEVICE = -19,
GRN_NOT_A_DIRECTORY = -20,
GRN_IS_A_DIRECTORY = -21,
GRN_INVALID_ARGUMENT = -22,
GRN_TOO_MANY_OPEN_FILES_IN_SYSTEM = -23,
GRN_TOO_MANY_OPEN_FILES = -24,
GRN_INAPPROPRIATE_I_O_CONTROL_OPERATION = -25,
GRN_FILE_TOO_LARGE = -26,
GRN_NO_SPACE_LEFT_ON_DEVICE = -27,
GRN_INVALID_SEEK = -28,
GRN_READ_ONLY_FILE_SYSTEM = -29,
GRN_TOO_MANY_LINKS = -30,
GRN_BROKEN_PIPE = -31,
GRN_DOMAIN_ERROR = -32,
GRN_RESULT_TOO_LARGE = -33,
GRN_RESOURCE_DEADLOCK_AVOIDED = -34,
GRN_NO_MEMORY_AVAILABLE = -35,
GRN_FILENAME_TOO_LONG = -36,
GRN_NO_LOCKS_AVAILABLE = -37,
GRN_FUNCTION_NOT_IMPLEMENTED = -38,
GRN_DIRECTORY_NOT_EMPTY = -39,
GRN_ILLEGAL_BYTE_SEQUENCE = -40,
GRN_SOCKET_NOT_INITIALIZED = -41,
GRN_OPERATION_WOULD_BLOCK = -42,
GRN_ADDRESS_IS_NOT_AVAILABLE = -43,
GRN_NETWORK_IS_DOWN = -44,
GRN_NO_BUFFER = -45,
GRN_SOCKET_IS_ALREADY_CONNECTED = -46,
GRN_SOCKET_IS_NOT_CONNECTED = -47,
GRN_SOCKET_IS_ALREADY_SHUTDOWNED = -48,
GRN_OPERATION_TIMEOUT = -49,
GRN_CONNECTION_REFUSED = -50,
GRN_RANGE_ERROR = -51,
GRN_TOKENIZER_ERROR = -52,
GRN_FILE_CORRUPT = -53,
GRN_INVALID_FORMAT = -54,
GRN_OBJECT_CORRUPT = -55,
GRN_TOO_MANY_SYMBOLIC_LINKS = -56,
GRN_NOT_SOCKET = -57,
GRN_OPERATION_NOT_SUPPORTED = -58,
GRN_ADDRESS_IS_IN_USE = -59,
GRN_ZLIB_ERROR = -60,
GRN_LZO_ERROR = -61,
GRN_STACK_OVER_FLOW = -62,
GRN_SYNTAX_ERROR = -63,
} grn_rc;
GRN_API grn_rc grn_init(void);
GRN_API grn_rc grn_fin(void);
typedef enum {
GRN_ENC_DEFAULT = 0,
GRN_ENC_NONE,
GRN_ENC_EUC_JP,
GRN_ENC_UTF8,
GRN_ENC_SJIS,
GRN_ENC_LATIN1,
GRN_ENC_KOI8R
} grn_encoding;
typedef enum {
GRN_LOG_NONE = 0,
GRN_LOG_EMERG,
GRN_LOG_ALERT,
GRN_LOG_CRIT,
GRN_LOG_ERROR,
GRN_LOG_WARNING,
GRN_LOG_NOTICE,
GRN_LOG_INFO,
GRN_LOG_DEBUG,
GRN_LOG_DUMP
} grn_log_level;
typedef enum {
GRN_CONTENT_TSV,
GRN_CONTENT_JSON
} grn_content_type;
typedef struct _grn_obj grn_obj;
typedef struct _grn_ctx grn_ctx;
#define GRN_CTX_MSGSIZE (0x80)
#define GRN_CTX_FIN (0xff)
typedef union {
int int_value;
grn_id id;
void *ptr;
} grn_user_data;
typedef grn_obj *grn_proc_func(grn_ctx *ctx, int nargs, grn_obj **args,
grn_user_data *user_data);
struct _grn_ctx {
grn_rc rc;
int flags;
grn_encoding encoding;
unsigned char ntrace;
unsigned char errlvl;
unsigned char stat;
unsigned int seqno;
unsigned int subno;
unsigned int seqno2;
unsigned int errline;
grn_user_data user_data;
grn_ctx *prev;
grn_ctx *next;
const char *errfile;
const char *errfunc;
struct _grn_ctx_impl *impl;
void *trace[16];
char errbuf[GRN_CTX_MSGSIZE];
};
#define GRN_CTX_USER_DATA(ctx) (&((ctx)->user_data))
/**
* grn_ctx_init:
* @ctx: 初期化するctx構造体へのポインタを指定します。
* @flags: 初期化するctxのオプションを指定します。
* GRN_CTX_USE_QLを指定すると、groonga qlインタプリタを実行可能なctxを初期化します。
* GRN_CTX_USE_QL|GRN_CTX_BATCH_MODEを指定すると、batchmodeでインタプリタを初期化します。
*
* ctxを初期化します。
**/
#define GRN_CTX_USE_QL (0x03)
#define GRN_CTX_BATCH_MODE (0x04)
GRN_API grn_rc grn_ctx_init(grn_ctx *ctx, int flags);
/**
* grn_ctx_fin:
* @ctx: 解放するctx構造体へのポインタを指定します。
*
* ctxの管理するメモリを解放し、使用を終了します。
**/
GRN_API grn_rc grn_ctx_fin(grn_ctx *ctx);
/**
* grn_get_default_encoding:
*
* デフォルトのencodingを返します。
**/
GRN_API grn_encoding grn_get_default_encoding(void);
/**
* grn_set_default_encoding:
* @encoding: 変更後のデフォルトのencodingを指定します。
*
* デフォルトのencodingを変更します。
**/
GRN_API grn_rc grn_set_default_encoding(grn_encoding encoding);
#define GRN_CTX_GET_ENCODING(ctx) ((ctx)->encoding)
#define GRN_CTX_SET_ENCODING(ctx,enc) \
((ctx)->encoding = (enc == GRN_ENC_DEFAULT) ? grn_get_default_encoding() : enc)
/* obj */
typedef unsigned short int grn_obj_flags;
#define GRN_OBJ_TABLE_TYPE_MASK (0x07)
#define GRN_OBJ_TABLE_HASH_KEY (0x00)
#define GRN_OBJ_TABLE_PAT_KEY (0x01)
#define GRN_OBJ_TABLE_NO_KEY (0x03)
#define GRN_OBJ_TABLE_VIEW (0x04)
#define GRN_OBJ_KEY_MASK (0x07<<3)
#define GRN_OBJ_KEY_UINT (0x00<<3)
#define GRN_OBJ_KEY_INT (0x01<<3)
#define GRN_OBJ_KEY_FLOAT (0x02<<3)
#define GRN_OBJ_KEY_WITH_SIS (0x01<<6)
#define GRN_OBJ_KEY_NORMALIZE (0x01<<7)
#define GRN_OBJ_COLUMN_TYPE_MASK (0x07)
#define GRN_OBJ_COLUMN_SCALAR (0x00)
#define GRN_OBJ_COLUMN_VECTOR (0x01)
#define GRN_OBJ_COLUMN_INDEX (0x02)
#define GRN_OBJ_COMPRESS_MASK (0x07<<4)
#define GRN_OBJ_COMPRESS_NONE (0x00<<4)
#define GRN_OBJ_COMPRESS_ZLIB (0x01<<4)
#define GRN_OBJ_COMPRESS_LZO (0x02<<4)
#define GRN_OBJ_WITH_SECTION (0x01<<7)
#define GRN_OBJ_WITH_WEIGHT (0x01<<8)
#define GRN_OBJ_WITH_POSITION (0x01<<9)
#define GRN_OBJ_WITH_BUFFER (0x01<<10)
#define GRN_OBJ_UNIT_MASK (0x0f<<8)
#define GRN_OBJ_UNIT_DOCUMENT_NONE (0x00<<8)
#define GRN_OBJ_UNIT_DOCUMENT_SECTION (0x01<<8)
#define GRN_OBJ_UNIT_DOCUMENT_POSITION (0x02<<8)
#define GRN_OBJ_UNIT_SECTION_NONE (0x03<<8)
#define GRN_OBJ_UNIT_SECTION_POSITION (0x04<<8)
#define GRN_OBJ_UNIT_POSITION_NONE (0x05<<8)
#define GRN_OBJ_UNIT_USERDEF_DOCUMENT (0x06<<8)
#define GRN_OBJ_UNIT_USERDEF_SECTION (0x07<<8)
#define GRN_OBJ_UNIT_USERDEF_POSITION (0x08<<8)
#define GRN_OBJ_NO_SUBREC (0x00<<13)
#define GRN_OBJ_WITH_SUBREC (0x01<<13)
#define GRN_OBJ_KEY_VAR_SIZE (0x01<<14)
#define GRN_OBJ_TEMPORARY (0x00<<15)
#define GRN_OBJ_PERSISTENT (0x01<<15)
/* obj types */
#define GRN_VOID (0x00)
#define GRN_BULK (0x02)
#define GRN_PTR (0x03)
#define GRN_UVECTOR (0x04) /* vector of grn_id */
#define GRN_PVECTOR (0x05) /* vector of grn_obj* */
#define GRN_VECTOR (0x06) /* vector of arbitrary data */
#define GRN_MSG (0x07)
#define GRN_QUERY (0x08)
#define GRN_ACCESSOR (0x09)
#define GRN_ACCESSOR_VIEW (0x0a)
#define GRN_SNIP (0x0b)
#define GRN_PATSNIP (0x0c)
#define GRN_CURSOR_TABLE_HASH_KEY (0x10)
#define GRN_CURSOR_TABLE_PAT_KEY (0x11)
#define GRN_CURSOR_TABLE_NO_KEY (0x13)
#define GRN_CURSOR_TABLE_VIEW (0x14)
#define GRN_CURSOR_COLUMN_INDEX (0x18)
#define GRN_TYPE (0x20)
#define GRN_PROC (0x21)
#define GRN_EXPR (0x22)
#define GRN_TABLE_HASH_KEY (0x30)
#define GRN_TABLE_PAT_KEY (0x31)
#define GRN_TABLE_NO_KEY (0x33)
#define GRN_TABLE_VIEW (0x34)
#define GRN_DB (0x37)
#define GRN_COLUMN_FIX_SIZE (0x40)
#define GRN_COLUMN_VAR_SIZE (0x41)
#define GRN_COLUMN_INDEX (0x48)
typedef struct _grn_section grn_section;
typedef struct _grn_obj_header grn_obj_header;
struct _grn_section {
unsigned int offset;
unsigned int length;
unsigned int weight;
grn_id domain;
};
struct _grn_obj_header {
unsigned char type;
unsigned char impl_flags;
grn_obj_flags flags;
grn_id domain;
};
struct _grn_obj {
grn_obj_header header;
union {
struct {
char *head;
char *curr;
char *tail;
} b;
struct {
grn_obj *body;
grn_section *sections;
int n_sections;
} v;
} u;
};
#define GRN_OBJ_REFER (0x01<<0)
#define GRN_OBJ_OUTPLACE (0x01<<1)
#define GRN_OBJ_INIT(obj,obj_type,obj_flags,obj_domain) do { \
(obj)->header.type = (obj_type);\
(obj)->header.impl_flags = (obj_flags);\
(obj)->header.flags = 0;\
(obj)->header.domain = (obj_domain);\
(obj)->u.b.head = NULL;\
(obj)->u.b.curr = NULL;\
(obj)->u.b.tail = NULL;\
} while (0)
#define GRN_OBJ_FIN(ctx,obj) (grn_obj_close((ctx), (obj)))
/**
* grn_db_create:
* @path: 作成するdbを格納するファイルパス。NULLならtemporary dbとなる。
* NULL以外のパスを指定した場合はpersistent dbとなる。
* @optarg: 作成するdbの組み込み型の名前を変更する時に指定する。
* optarg.builtin_type_namesには組み込み型の名前となるnul終端文字列の配列を指定する。
* optarg.n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を
* 指定する。配列のoffsetはenum型grn_builtin_typeの値に対応する。
*
* 新たなdbを作成する。
**/
typedef struct _grn_db_create_optarg grn_db_create_optarg;
struct _grn_db_create_optarg {
char **builtin_type_names;
int n_builtin_type_names;
};
GRN_API grn_obj *grn_db_create(grn_ctx *ctx, const char *path, grn_db_create_optarg *optarg);
#define GRN_DB_OPEN_OR_CREATE(ctx,path,optarg,db) \
(((db) = grn_db_open((ctx), (path))) || (db = grn_db_create((ctx), (path), (optarg))))
/**
* grn_db_open:
* @path: 開こうとするdbを格納するファイルパス。
*
* 既存のdbを開く。
**/
GRN_API grn_obj *grn_db_open(grn_ctx *ctx, const char *path);
/**
* grn_ctx_use:
* @db: ctxが使用するdbを指定します。
*
* ctxが操作対象とするdbを指定します。NULLを指定した場合は、
* dbを操作しない状態(init直後の状態)になります。
**/
GRN_API grn_rc grn_ctx_use(grn_ctx *ctx, grn_obj *db);
/**
* grn_ctx_db:
*
* ctxが現在操作対象としているdbを返します。
* dbを使用していない場合はNULLを返します。
**/
GRN_API grn_obj *grn_ctx_db(grn_ctx *ctx);
/**
* grn_ctx_get:
* @name: 検索しようとするオブジェクトの名前。
* @name_size: @nameのbyte長。
*
* ctxが使用するdbからnameに対応するオブジェクトを検索して返す。
* nameに一致するオブジェクトが存在しなければNULLを返す。
**/
GRN_API grn_obj *grn_ctx_get(grn_ctx *ctx, const char *name, unsigned name_size);
/**
* grn_ctx_at:
* @id: 検索しようとするオブジェクトのid。
*
* ctx、またはctxが使用するdbからidに対応するオブジェクトを検索して返す。
* idに一致するオブジェクトが存在しなければNULLを返す。
**/
typedef enum {
GRN_DB_VOID = 0,
GRN_DB_DB,
GRN_DB_OBJECT,
GRN_DB_BOOL,
GRN_DB_INT8,
GRN_DB_UINT8,
GRN_DB_INT16,
GRN_DB_UINT16,
GRN_DB_INT32,
GRN_DB_UINT32,
GRN_DB_INT64,
GRN_DB_UINT64,
GRN_DB_FLOAT,
GRN_DB_TIME,
GRN_DB_SHORT_TEXT,
GRN_DB_TEXT,
GRN_DB_LONG_TEXT,
GRN_DB_TOKYO_GEO_POINT,
GRN_DB_WGS84_GEO_POINT
} grn_builtin_type;
typedef enum {
GRN_DB_MECAB = 64,
GRN_DB_DELIMIT,
GRN_DB_UNIGRAM,
GRN_DB_BIGRAM,
GRN_DB_TRIGRAM,
} grn_builtin_tokenizer;
GRN_API grn_obj *grn_ctx_at(grn_ctx *ctx, grn_id id);
/**
* grn_type_create:
* @name: 作成するtypeの名前。
* @flags: GRN_OBJ_KEY_VAR_SIZE, GRN_OBJ_KEY_FLOAT, GRN_OBJ_KEY_INT, GRN_OBJ_KEY_UINT
* のいずれかを指定
* @size: GRN_OBJ_KEY_VAR_SIZEの場合は最大長、
* それ以外の場合は長さを指定(単位:byte)
*
* nameに対応する新たなtype(型)をdbに定義する。
**/
GRN_API grn_obj *grn_type_create(grn_ctx *ctx, const char *name, unsigned name_size,
grn_obj_flags flags, unsigned int size);
GRN_API grn_rc grn_db_load(grn_ctx *ctx, const char *path);
/**
* grn_proc_create:
* @name: 作成するprocの名前。
* @type: procの種類。
* @init: 初期化関数のポインタ
* @next: 実処理関数のポインタ
* @fin: 終了関数のポインタ
* @nvars: procで使用する変数の数
* @vars: procで使用する変数の定義(grn_expr_var構造体の配列)
*
* nameに対応する新たなproc(手続き)をctxが使用するdbに定義する。
**/
typedef struct {
char *name;
unsigned name_size;
grn_obj value;
} grn_expr_var;
typedef grn_rc grn_proc_init_func(grn_ctx *ctx, const char *path);
GRN_API grn_obj *grn_proc_create(grn_ctx *ctx,
const char *name, unsigned name_size, const char *path,
grn_proc_func *init, grn_proc_func *next, grn_proc_func *fin,
unsigned nvars, grn_expr_var *vars);
/**
* grn_proc_vars:
* @user_data: grn_proc_funcに渡されたuser_data
* @nvars: 変数の数
*
* user_dataをキーとして、現在実行中のgrn_proc_func関数および
* 定義されている変数(grn_expr_var)の配列とその数を取得する。
**/
GRN_API grn_obj *grn_proc_get_info(grn_ctx *ctx, grn_user_data *user_data,
grn_expr_var **vars, unsigned *nvars, grn_obj **caller);
/*-------------------------------------------------------------
* table操作のための関数
*/
#define GRN_TABLE_MAX_KEY_SIZE (0x1000)
/**
* grn_table_create:
* @name: 作成するtableの名前。NULLなら無名tableとなる。
* persistent dbに対して名前をありのtableを作成するときには、
* flagsにGRN_OBJ_PERSISTENTが指定されていなければならない。
* @path: 作成するtableのファイルパス。
* flagsにGRN_OBJ_PERSISTENTが指定されている場合のみ有効。
* NULLなら自動的にファイルパスが付与される。
* @flags: GRN_OBJ_PERSISTENTを指定すると永続tableとなる。
* GRN_OBJ_TABLE_PAT_KEY,GRN_OBJ_TABLE_HASH_KEY,GRN_OBJ_TABLE_NO_KEY
* のいずれかを指定する。
* GRN_OBJ_KEY_NORMALIZEを指定すると正規化された文字列がkeyとなる。
* GRN_OBJ_KEY_WITH_SISを指定するとkey文字列の全suffixが自動的に登録される。
* @key_type: keyの型を指定する。GRN_OBJ_TABLE_NO_KEYが指定された場合は無効。
* 既存のtypeあるいはtableを指定できる。
* key_typeにtable Aを指定してtable Bを作成した場合、Bは必ずAのサブセットとなる。
* @value_type: keyに対応する値を格納する領域の型。tableはcolumnとは別に、
* keyに対応する値を格納する領域を一つだけ持つことができる。
*
* nameに対応する新たなtableをctxが使用するdbに定義する。
**/
GRN_API grn_obj *grn_table_create(grn_ctx *ctx,
const char *name, unsigned name_size,
const char *path, grn_obj_flags flags,
grn_obj *key_type, grn_obj *value_type);
/**
* grn_table_open:
* @name: 開こうとするtableの名前。NULLなら無名tableとなる。
* @path: 開こうとするtableのファイルパス。
*
* ctxが使用するdbの中でnameに対応付けて既存のtableを開く。
* dbに登録されている名前付きの永続テーブルを開く場合はgrn_ctx_get()を使用するのが望ましい。
**/
GRN_API grn_obj *grn_table_open(grn_ctx *ctx,
const char *name, unsigned name_size, const char *path);
#define GRN_TABLE_OPEN_OR_CREATE(ctx,name,name_size,path,flags,key_type,value_type,table) \
(((table) = grn_ctx_get((ctx), (name), (name_size))) ||\
((table) = grn_table_create((ctx), (name), (name_size), (path), (flags), (key_type), (value_type))))
/**
* grn_table_add:
* @table: 対象table
* @key: 検索key
* @added: NULL以外の値が指定された場合、
* 新たにrecordが追加された時には1が、既存recordだった時には0がセットされる。
*
* keyに対応する新しいrecordをtableに追加し、そのIDを返す。
* keyに対応するrecordがすでにtableに存在するならば、そのrecordのIDを返す。
* GRN_OBJ_TABLE_NO_KEYが指定されたtableでは、key, key_size は無視される。
**/
GRN_API grn_id grn_table_add(grn_ctx *ctx, grn_obj *table,
const void *key, unsigned key_size, int *added);
/**
* grn_table_get:
* @table: 対象table
* @key: 検索key
*
* tableからkeyに対応するrecordを検索し、対応するIDを返す。
**/
GRN_API grn_id grn_table_get(grn_ctx *ctx, grn_obj *table,
const void *key, unsigned key_size);
/**
* grn_table_lcp_search:
* @table: 対象table
* @key: 検索key
*
* tableがGRN_TABLE_PAT_KEYを指定して作ったtableなら、
* longest common prefix searchを行い、対応するIDを返す。
**/
GRN_API grn_id grn_table_lcp_search(grn_ctx *ctx, grn_obj *table,
const void *key, unsigned key_size);
/**
* grn_table_get_key:
* @table: 対象table
* @id: 対象レコードのID
* @keybuf: keyを格納するバッファ(呼出側で準備する)
* @buf_size: keybufのサイズ(byte長)
*
* tableのIDに対応するレコードのkeyを取得する。対応するレコードが存在する場合はkey長を返す。
* 見つからない場合は0を返す。
* 対応するキーの検索に成功し、またbuf_sizeの長さがkey長以上であった場合は、
* keybufに該当するkeyをコピーする。
*
**/
GRN_API int grn_table_get_key(grn_ctx *ctx, grn_obj *table,
grn_id id, void *keybuf, int buf_size);
/**
* grn_table_delete:
* @table: 対象table
* @key: 検索key
* @key_size: 検索keyのサイズ
*
* tableのkeyに対応するレコードを削除する。
* 対応するレコードが存在しない場合はGRN_INVALID_ARGUMENTを返す。
**/
GRN_API grn_rc grn_table_delete(grn_ctx *ctx, grn_obj *table,
const void *key, unsigned key_size);
/**
* grn_table_delete_by_id:
* @table: 対象table
* @id: レコードID
*
* tableのkeyに対応するレコードを削除する。
* 対応するレコードが存在しない場合はGRN_INVALID_ARGUMENTを返す。
**/
GRN_API grn_rc grn_table_delete_by_id(grn_ctx *ctx, grn_obj *table, grn_id id);
/**
* grn_table_truncate:
* @table: 対象table
*
* tableの全レコードを一括して削除する。
**/
GRN_API grn_rc grn_table_truncate(grn_ctx *ctx, grn_obj *table);
typedef grn_obj grn_table_cursor;
#define GRN_CURSOR_ASCENDING (0x00<<0)
#define GRN_CURSOR_DESCENDING (0x01<<0)
#define GRN_CURSOR_GE (0x00<<1)
#define GRN_CURSOR_GT (0x01<<1)
#define GRN_CURSOR_LE (0x00<<2)
#define GRN_CURSOR_LT (0x01<<2)
#define GRN_CURSOR_BY_KEY (0x00<<3)
#define GRN_CURSOR_BY_ID (0x01<<3)
/**
* grn_table_cursor_open:
* @table: 対象table
* @min: keyの下限 (NULLは下限なしと見なす)
* @min_size: @minのsize
* @max: keyの上限 (NULLは上限なしと見なす)
* @max_size: @maxのsize
* @flags: GRN_CURSOR_ASCENDINGを指定すると昇順にレコードを取り出す。
* GRN_CURSOR_DESCENDINGを指定すると降順にレコードを取り出す。
* GRN_CURSOR_GTを指定するとminに一致したkeyをcursorの範囲に含まない。
* GRN_CURSOR_LTを指定するとmaxに一致したkeyをcursorの範囲に含まない。
* GRN_CURSOR_BY_IDを指定するとID順にレコードを取り出す。
* GRN_OBJ_TABLE_PAT_KEYを指定したtableについては、
* GRN_CURSOR_BY_KEYを指定するとkey順にレコードを取り出す。
* (GRN_OBJ_TABLE_HASH_KEY,GRN_OBJ_TABLE_NO_KEYではGRN_CURSOR_BY_KEYは無視される)
* @offset: 該当する範囲のレコードのうち、(0ベースで)offset番目からレコードを取り出す。
* @limit: 該当する範囲のレコードのうち、limit件のみを取り出す。
* 0が指定された場合は、全件が指定されたものとみなす。
*
* tableに登録されているレコードを順番に取り出すためのカーソルを生成して返す。
**/
GRN_API grn_table_cursor *grn_table_cursor_open(grn_ctx *ctx, grn_obj *table,
const void *min, unsigned min_size,
const void *max, unsigned max_size,
unsigned offset, unsigned limit, int flags);
/**
* grn_table_cursor_close:
* @tc: 対象cursor
*
* grn_table_cursor_openで生成したcursorを解放する。
**/
GRN_API grn_rc grn_table_cursor_close(grn_ctx *ctx, grn_table_cursor *tc);
/**
* grn_table_cursor_next:
* @tc: 対象cursor
*
* cursorのカレントレコードを一件進めてそのIDを返す。
* cursorの対象範囲の末尾に達するとGRN_ID_NILを返す。
**/
GRN_API grn_id grn_table_cursor_next(grn_ctx *ctx, grn_table_cursor *tc);
/**
* grn_table_cursor_get_key:
* @tc: 対象cursor
* @key: カレントレコードのkeyへのポインタがセットされる。
* cursorのカレントレコードのkeyを@keyにセットし、その長さを返す。
**/
GRN_API int grn_table_cursor_get_key(grn_ctx *ctx, grn_table_cursor *tc, void **key);
/**
* grn_table_cursor_get_value:
* @tc: 対象cursor
* @value: カレントレコードのvalueへのポインタがセットされる。
* cursorのカレントレコードのvalueを@valueにセットし、その長さを返す。
**/
GRN_API int grn_table_cursor_get_value(grn_ctx *ctx, grn_table_cursor *tc, void **value);
/**
* grn_table_cursor_set_value:
* @tc: 対象cursor
* @value: 新しいvalueの値。
* @flags: grn_obj_set_valueのflagsと同様の値を指定できる。
*
* cursorのカレントレコードのvalueを引数の内容に置き換える。
* cursorのカレントレコードが存在しない場合はGRN_INVALID_ARGUMENTを返す。
**/
GRN_API grn_rc grn_table_cursor_set_value(grn_ctx *ctx, grn_table_cursor *tc,
void *value, int flags);
/**
* grn_table_cursor_delete:
* @tc: 対象cursor
*
* cursorのカレントレコードを削除する。
* cursorのカレントレコードが存在しない場合はGRN_INVALID_ARGUMENTを返す。
**/
GRN_API grn_rc grn_table_cursor_delete(grn_ctx *ctx, grn_table_cursor *tc);
/**
* grn_table_cursor_table:
* @tc: 対象cursor
*
* cursorが属するtableを返す。
**/
GRN_API grn_obj *grn_table_cursor_table(grn_ctx *ctx, grn_table_cursor *tc);
#define GRN_TABLE_EACH(ctx,table,head,tail,id,key,key_size,value,block) do {\
(ctx)->errlvl = GRN_LOG_NOTICE;\
(ctx)->rc = GRN_SUCCESS;\
if ((ctx)->seqno & 1) {\
(ctx)->subno++;\
} else {\
(ctx)->seqno++;\
}\
if (table) {\
switch ((table)->header.type) {\
case GRN_TABLE_PAT_KEY :\
GRN_PAT_EACH((ctx), (grn_pat *)(table), (id), (key), (key_size), (value), block);\
break;\
case GRN_TABLE_HASH_KEY :\
GRN_HASH_EACH((ctx), (grn_hash *)(table), (id), (key), (key_size), (value), block);\
break;\
case GRN_TABLE_NO_KEY :\
GRN_ARRAY_EACH((ctx), (grn_array *)(table), (head), (tail), (id), (value), block);\
break;\
}\
}\
if ((ctx)->subno) {\
(ctx)->subno--;\
} else {\
(ctx)->seqno++;\
}\
} while (0)
/**
* grn_table_sort:
* @table: 対象table
* @offset: sortされたレコードのうち、(0ベースで)offset番目から順にresにレコードを格納する
* @limit: resに格納するレコードの上限
* @result: 結果を格納するtable
* @keys: ソートキー配列へのポインタ
* @n_keys: ソートキー配列のサイズ
*
* table内のレコードをソートし、上位limit個の要素をresultに格納する。
* keys.keyには、tableのcolumn,accessor,procのいずれかが指定できる。
* keys.flagsには、GRN_TABLE_SORT_ASC/GRN_TABLE_SORT_DESCのいずれかを指定できる。
* GRN_TABLE_SORT_ASCでは昇順、GRN_TABLE_SORT_DESCでは降順でソートされる。
* keys.offsetは、内部利用のためのメンバである。
**/
typedef struct _grn_table_sort_key grn_table_sort_key;
typedef unsigned char grn_table_sort_flags;
#define GRN_TABLE_SORT_ASC (0x00<<0)
#define GRN_TABLE_SORT_DESC (0x01<<0)
struct _grn_table_sort_key {
grn_obj *key;
grn_table_sort_flags flags;
int offset;
};
GRN_API int grn_table_sort(grn_ctx *ctx, grn_obj *table, int offset, int limit,
grn_obj *result, grn_table_sort_key *keys, int n_keys);
/**
* grn_table_group:
* @table: 対象table
* @keys: group化キー構造体の配列へのポインタ
* @n_keys: group化キー構造体の配列のサイズ
* @results: group化の結果を格納する構造体の配列へのポインタ
* @n_results:group化の結果を格納する構造体の配列のサイズ
*
* tableのレコードを特定の条件でグループ化する
**/
typedef struct _grn_table_group_result grn_table_group_result;
typedef unsigned int grn_table_group_flags;
#define GRN_TABLE_GROUP_CALC_COUNT (0x01<<3)
#define GRN_TABLE_GROUP_CALC_MAX (0x01<<4)
#define GRN_TABLE_GROUP_CALC_MIN (0x01<<5)
#define GRN_TABLE_GROUP_CALC_SUM (0x01<<6)
#define GRN_TABLE_GROUP_CALC_AVG (0x01<<7)
typedef enum {
GRN_OP_PUSH = 0,
GRN_OP_POP,
GRN_OP_NOP,
GRN_OP_CALL,
GRN_OP_INTERN,
GRN_OP_GET_REF,
GRN_OP_GET_VALUE,
GRN_OP_AND,
GRN_OP_BUT,
GRN_OP_OR,
GRN_OP_ASSIGN,
GRN_OP_STAR_ASSIGN,
GRN_OP_SLASH_ASSIGN,
GRN_OP_MOD_ASSIGN,
GRN_OP_PLUS_ASSIGN,
GRN_OP_MINUS_ASSIGN,
GRN_OP_SHIFTL_ASSIGN,
GRN_OP_SHIRTR_ASSIGN,
GRN_OP_SHIFTRR_ASSIGN,
GRN_OP_AND_ASSIGN,
GRN_OP_XOR_ASSIGN,
GRN_OP_OR_ASSIGN,
GRN_OP_JUMP,
GRN_OP_CJUMP,
GRN_OP_COMMA,
GRN_OP_BITWISE_OR,
GRN_OP_BITWISE_XOR,
GRN_OP_BITWISE_AND,
GRN_OP_BITWISE_NOT,
GRN_OP_EQUAL,
GRN_OP_NOT_EQUAL,
GRN_OP_LESS,
GRN_OP_GREATER,
GRN_OP_LESS_EQUAL,
GRN_OP_GREATER_EQUAL,
GRN_OP_IN,
GRN_OP_MATCH,
GRN_OP_NEAR,
GRN_OP_NEAR2,
GRN_OP_SIMILAR,
GRN_OP_TERM_EXTRACT,
GRN_OP_SHIFTL,
GRN_OP_SHIFTR,
GRN_OP_SHIFTRR,
GRN_OP_PLUS,
GRN_OP_MINUS,
GRN_OP_STAR,
GRN_OP_SLASH,
GRN_OP_MOD,
GRN_OP_DELETE,
GRN_OP_INCR,
GRN_OP_DECR,
GRN_OP_INCR_POST,
GRN_OP_DECR_POST,
GRN_OP_NOT,
GRN_OP_ADJUST,
GRN_OP_EXACT,
GRN_OP_LCP,
GRN_OP_PARTIAL,
GRN_OP_UNSPLIT,
GRN_OP_PREFIX,
GRN_OP_SUFFIX,
GRN_OP_GEO_DISTANCE1,
GRN_OP_GEO_DISTANCE2,
GRN_OP_GEO_DISTANCE3,
GRN_OP_GEO_DISTANCE4,
GRN_OP_GEO_WITHINP5,
GRN_OP_GEO_WITHINP6,
GRN_OP_GEO_WITHINP8,
GRN_OP_OBJ_SEARCH,
GRN_OP_EXPR_GET_VAR,
GRN_OP_TABLE_CREATE,
GRN_OP_TABLE_SELECT,
GRN_OP_TABLE_SORT,
GRN_OP_TABLE_GROUP,
GRN_OP_JSON_PUT
} grn_operator;
struct _grn_table_group_result {
grn_obj *table;
unsigned char key_begin;
unsigned char key_end;
int limit;
grn_table_group_flags flags;
grn_operator op;
};
GRN_API grn_rc grn_table_group(grn_ctx *ctx, grn_obj *table,
grn_table_sort_key *keys, int n_keys,
grn_table_group_result *results, int n_results);
/**
* grn_table_setoperation:
* @table1: 対象table1
* @table2: 対象table2
* @res: 結果を格納するtable
* @op: 実行する演算の種類
*
* table1とtable2をopの指定に従って集合演算した結果をresに格納する。
* resにtable1あるいはtable2そのものを指定した場合を除けば、table1, table2は破壊されない。
**/
GRN_API grn_rc grn_table_setoperation(grn_ctx *ctx, grn_obj *table1, grn_obj *table2,
grn_obj *res, grn_operator op);
/**
* grn_table_difference:
* @table1: 対象table1
* @table2: 対象table2
* @res1: 結果を格納するtable
* @res2: 結果を格納するtable
*
* table1とtable2から重複するレコードを取り除いた結果をそれぞれres1, res2に格納する。
**/
GRN_API grn_rc grn_table_difference(grn_ctx *ctx, grn_obj *table1, grn_obj *table2,
grn_obj *res1, grn_obj *res2);
/**
* grn_table_columns:
* @table: 対象table
* @name: 取得したいカラム名のprefix
* @name_size: @nameの長さ
* @res: 結果を格納するGRN_TABLE_HASH_KEYのtable
*
* @nameから始まるtableのカラムIDを@resに格納する。
* @name_sizeが0の場合はすべてのカラムIDを格納する。格納した
* カラムIDの数を返す。
**/
GRN_API int grn_table_columns(grn_ctx *ctx, grn_obj *table,
const char *name, unsigned name_size,
grn_obj *res);
/**
* grn_obj_column:
* @table: 対象table
* @name: カラム名
*
* nameがカラム名の場合、それに対応するtableのカラムを返す。
* 対応するカラムが存在しなければNULLを返す。
* nameはアクセサ文字列の場合、それに対応するaccessorを返す。
* アクセサ文字列とは、カラム名等を'.'で連結した文字列である。
* '_id', '_key'は特殊なアクセサで、それぞれレコードID/keyを返す。
* 例) 'col1' / 'col2.col3' / 'col2._id'
**/
GRN_API grn_obj *grn_obj_column(grn_ctx *ctx, grn_obj *table,
const char *name, unsigned name_size);
/**
* grn_table_size:
* @table: 対象table
*
* tableに登録されているレコードの件数を返す。
**/
GRN_API unsigned int grn_table_size(grn_ctx *ctx, grn_obj *table);
/*-------------------------------------------------------------
* column操作のための関数
*/
/**
* grn_column_create:
* @table: 対象table
* @name: カラム名
* @name_size: @nameのsize(byte)
* @path: カラムを格納するファイルパス。
* flagsにGRN_OBJ_PERSISTENTが指定されている場合のみ有効。
* NULLなら自動的にファイルパスが付与される。
* @flags: GRN_OBJ_PERSISTENTを指定すると永続columnとなる。
* GRN_OBJ_COLUMN_INDEXを指定すると転置インデックスとなる。
* GRN_OBJ_COLUMN_SCALARを指定するとスカラ値(単独の値)を格納する。
* GRN_OBJ_COLUMN_VECTORを指定すると値の配列を格納する。
* GRN_OBJ_COMPRESS_ZLIBを指定すると値をzlib圧縮して格納する。
* GRN_OBJ_COMPRESS_LZOを指定すると値をlzo圧縮して格納する。
* GRN_OBJ_COLUMN_INDEXと共にGRN_OBJ_WITH_SECTIONを指定すると、
* 転置索引にsection(段落情報)を合わせて格納する。
* GRN_OBJ_COLUMN_INDEXと共にGRN_OBJ_WITH_WEIGHTを指定すると、
* 転置索引にweight情報を合わせて格納する。
* GRN_OBJ_COLUMN_INDEXと共にGRN_OBJ_WITH_POSITIONを指定すると、
* 転置索引に出現位置情報を合わせて格納する。
* @type: カラム値の型。定義済みのtypeあるいはtableを指定できる。
*
* tableに新たなカラムを定義する。nameは省略できない。
* 一つのtableに同一のnameのcolumnを複数定義することはできない。
**/
GRN_API grn_obj *grn_column_create(grn_ctx *ctx, grn_obj *table,
const char *name, unsigned name_size,
const char *path, grn_obj_flags flags, grn_obj *type);
#define GRN_COLUMN_OPEN_OR_CREATE(ctx,table,name,name_size,path,flags,type,column) \
(((column) = grn_obj_column((ctx), (table), (name), (name_size))) ||\
((column) = grn_column_create((ctx), (table), (name), (name_size), (path), (flags), (type))))
/**