Class: Groonga::Expression

Inherits:
Object
  • Object
show all
Defined in:
ext/rb-grn-expression.c,
ext/rb-grn-expression.c

Overview

検索条件やデータベースへの操作を表現するオブジェクト。

Instance Method Summary collapse

Methods inherited from Object

#==, #[]=, #append, #close, #closed?, #domain, #id, #name, #path, #persistent?, #prepend, #range, #remove, #temporary?

Constructor Details

#initialize ⇒ Object 



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
 
# File 'ext/rb-grn-expression.c', line 75

static VALUE
rb_grn_expression_initialize (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    VALUE options, rb_context, rb_name;
    char *name = NULL;
    unsigned name_size = 0;

    rb_scan_args(argc, argv, "01", &options);
    rb_grn_scan_options(options,
                        "context", &rb_context,
                        "name", &rb_name,
                        NULL);

    context = rb_grn_context_ensure(&rb_context);

    if (!NIL_P(rb_name)) {
  name = StringValuePtr(rb_name);
  name_size = RSTRING_LEN(rb_name);
    }

    expression = grn_expr_create(context, name, name_size);
    rb_grn_object_assign(Qnil, self, rb_context, context, expression);
    rb_grn_context_check(context, self);

    return Qnil;
}

Instance Method Details

#[](name) ⇒ Object #[](offset) ⇒ Object

expressionで使用可能な変数のうち、名前がnameまたは offset番目にExpression#append_objectされた変数の値を返 す。



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
 
# File 'ext/rb-grn-expression.c', line 491

static VALUE
rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
{
    grn_ctx *context = NULL;
    grn_obj *expression, *variable, *value;
    char *name = NULL;
    unsigned name_size = 0;
    int offset;

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    switch (TYPE(rb_name_or_offset)) {
    case T_STRING:
        name = RSTRING_PTR(rb_name_or_offset);
        name_size = RSTRING_LEN(rb_name_or_offset);
        variable = grn_expr_get_var(context, expression, name, name_size);
        return GRNBULK2RVAL(context, variable, NULL, self);
        break;
    case T_FIXNUM:
        offset = NUM2INT(rb_name_or_offset);
        value = grn_expr_get_var_by_offset(context, expression, offset);
        return GRNBULK2RVAL(context, value, NULL, self);
        break;
    default:
        rb_raise(rb_eArgError, "xxx");
        break;
    }

    return Qnil;
}

#append_constant(constant) ⇒ Object #operation= ⇒ Object #n_arguments= ⇒ self

constantを追加し、n_arguments個の引数を取るoperationを追加する。

Overloads:

  • #n_arguments= ⇒ self

    Returns:

    • (self) 


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
 
# File 'ext/rb-grn-expression.c', line 197

static VALUE
rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
{
    VALUE rb_constant, rb_operator, rb_n_arguments;
    VALUE exception;
    grn_ctx *context = NULL;
    grn_obj *expression, *constant = NULL;
    grn_operator operator = GRN_OP_PUSH;
    int n_arguments = 1;

    rb_scan_args(argc, argv, "12", &rb_constant, &rb_operator, &rb_n_arguments);
    if (!NIL_P(rb_operator))
        operator = NUM2INT(rb_operator);
    if (!NIL_P(rb_n_arguments))
        n_arguments = NUM2INT(rb_n_arguments);

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL, NULL,
          NULL, NULL);

    RVAL2GRNOBJ(rb_constant, context, &constant);
    grn_expr_append_const(context, expression, constant, operator, n_arguments);

    exception = rb_grn_context_to_exception(context, self);
    grn_obj_close(context, constant);
    if (!NIL_P(exception))
  rb_exc_raise(exception);

    return self;
}

#append_object(object) ⇒ Object #operation= ⇒ Object #n_arguments= ⇒ self

objectを追加し、n_arguments個の引数を取るoperationを追加する。

Overloads:

  • #n_arguments= ⇒ self

    Returns:

    • (self) 


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
 
# File 'ext/rb-grn-expression.c', line 163

static VALUE
rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
{
    VALUE rb_object, rb_operation, rb_n_arguments;
    grn_ctx *context = NULL;
    grn_obj *expression, *object;
    grn_operator operation = GRN_OP_PUSH;
    int n_arguments = 1;

    rb_scan_args(argc, argv, "12", &rb_object, &rb_operation, &rb_n_arguments);
    if (!NIL_P(rb_operation))
        operation = NUM2INT(rb_operation);
    if (!NIL_P(rb_n_arguments))
        n_arguments = NUM2INT(rb_n_arguments);

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    object = RVAL2GRNOBJECT(rb_object, &context);
    grn_expr_append_obj(context, expression, object,
                        operation, n_arguments);
    rb_grn_context_check(context, self);
    return self;
}

#append_operation(operation, n_arguments) ⇒ Object

n_arguments個の引数を取るoperationを追加する。



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'ext/rb-grn-expression.c', line 234

static VALUE
rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
            VALUE rb_n_arguments)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    grn_operator operation;
    int n_arguments = 0;

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    operation = NUM2INT(rb_operation);
    n_arguments = NUM2INT(rb_n_arguments);
    grn_expr_append_op(context, expression, operation, n_arguments);
    rb_grn_context_check(context, self);
    return Qnil;
}

#compile ⇒ Object

expressionをコンパイルする。



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'ext/rb-grn-expression.c', line 464

static VALUE
rb_grn_expression_compile (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    grn_rc rc;

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    rc = grn_expr_compile(context, expression);
    rb_grn_context_check(context, self);
    rb_grn_rc_check(rc, self);

    return Qnil;
}

#define_variable(options = {}) ⇒ Groonga::Variable

expressionで使用可能な変数を作成する。

optionsに指定可能な値は以下の通り。

:name

変数の名前。省略した場合は名前を付けない。

:domain

テーブルを指定すると、そのテーブル用のレコードとして初期化する。

Returns:



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
 
# File 'ext/rb-grn-expression.c', line 118

static VALUE
rb_grn_expression_define_variable (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression, *variable;
    char *name = NULL;
    unsigned name_size = 0;
    VALUE options, rb_name, rb_domain, rb_variable;

    rb_scan_args(argc, argv, "01", &options);

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    rb_grn_scan_options(options,
      "name", &rb_name,
      "domain", &rb_domain,
      NULL);

    if (!NIL_P(rb_name)) {
  name = StringValuePtr(rb_name);
  name_size = RSTRING_LEN(rb_name);
    }

    variable = grn_expr_add_var(context, expression, name, name_size);
    rb_variable = GRNVARIABLE2RVAL(context, variable);

    if (RVAL2CBOOL(rb_obj_is_kind_of(rb_domain, rb_cGrnTable))) {
  grn_id domain_id;
  domain_id = NUM2UINT(rb_funcall(rb_domain, rb_intern("id"), 0));
  GRN_RECORD_INIT(variable, 0, domain_id);
    }

    return rb_variable;
}

#execute ⇒ Object

expressionを実行する。



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'ext/rb-grn-expression.c', line 440

static VALUE
rb_grn_expression_execute (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    grn_rc rc;

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    rc = grn_expr_exec(context, expression, 0);
    rb_grn_context_check(context, self);
    rb_grn_rc_check(rc, self);

    return Qnil;
}

#inspect ⇒ String

expressionの中身を人に見やすい文字列で返す。

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'ext/rb-grn-expression.c', line 533

static VALUE
rb_grn_expression_inspect (VALUE self)
{
    grn_rc rc;
    grn_ctx *context = NULL;
    grn_obj inspected;
    grn_obj *expression;
    VALUE rb_inspected;

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    GRN_TEXT_INIT(&inspected, 0);
    GRN_TEXT_PUTS(context, &inspected, "#<Groonga::Expression ");
    rc = grn_expr_inspect(context, &inspected, expression);
    GRN_TEXT_PUTS(context, &inspected, ">");
    rb_inspected = rb_str_new(GRN_TEXT_VALUE(&inspected),
            GRN_TEXT_LEN(&inspected));
    GRN_OBJ_FIN(context, &inspected);

    return rb_inspected;
}

#parse(query, options = {}) ⇒ Object

文字列queryをパースする。

optionsに指定可能な値は以下の通り。

:default_column

“column_name:hoge”ではなく“hoge”のようにcolumn_nameが指 定されない条件の検索対象となるカラムを指定する。

:default_operator

“+”や“OR”で繋がれず、ただ列挙された複数の条件があった時、 expression全体として各レコードをヒットとみなすかの論理 条件を指定する。省略した場合はGroonga::Operation::AND。

Groonga::Operation::OR

レコードはいずれかの条件にマッチすればいい。

Groonga::Operation::AND

レコードは全ての条件にマッチしなければならない。

Groonga::Operation::BUT

最初の条件にレコードはマッチし、残りの条件にレコードは マッチしてはならない。

:default_mode

検索時のモードを指定する。省略した場合は Groonga::Operation::MATCH。（FIXME: モードによってどう いう動作になるかを書く。）

:syntax

queryの構文を指定する。指定可能な値は以下の通り。省略 した場合は:query。

nil

:queryと同様。

:query

「文字列1 OR 文字列2」で「“文字列1”あるいは“文字列2” にマッチという検索エンジンで利用できるような構文を使 う。

参考: grn式のquery形式（text/expression_rdoc.html）

:script

「[カラム名] == [値]」というようにECMAScript風の構文 を使う。

参考: grn式のscript形式（text/expression_rdoc.html）

:allow_pragma

queryの構文にqueryを用いているとき（:syntaxオプショ ン参照）、「*E-1」というようにクエリの先頭でpragmaを利 用できるようにする。script構文を用いているときはこのオ プションを利用できない。

デフォルトではプラグマを利用できる。

参考: grn式のquery形式（text/expression_rdoc.html）

:allow_column

queryの構文にqueryを用いているとき（:syntaxオプショ ン参照）、「カラム名:値」というようにカラム名を指定した 条件式を利用できるようにする。script構文を用いていると きはこのオプションを利用できない。

デフォルトではカラム名を指定した条件式を利用できる。

参考: grn式のquery形式（text/expression_rdoc.html）

:allow_update

queryの構文にscriptを用いているとき（:syntaxオプショ ン参照）、「カラム名 = 値」というように更新操作を利用で きるようにする。query構文を用いているときはこのオプショ ンを利用できない。

デフォルトでは更新操作を利用できる。

参考: grn式のscript形式（text/expression_rdoc.html）



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
 
# File 'ext/rb-grn-expression.c', line 332

static VALUE
rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression, *default_column = NULL;
    grn_operator default_operator = GRN_OP_AND;
    grn_operator default_mode = GRN_OP_MATCH;
    grn_rc rc;
    char *query = NULL;
    unsigned query_size = 0;
    grn_expr_flags flags = 0;
    VALUE options, rb_query, rb_default_column, rb_default_operator;
    VALUE rb_default_mode, rb_syntax;
    VALUE rb_allow_pragma, rb_allow_column, rb_allow_update;
    VALUE exception = Qnil;

    rb_scan_args(argc, argv, "11", &rb_query, &options);
    rb_grn_scan_options(options,
                        "default_column", &rb_default_column,
                        "default_operator", &rb_default_operator,
                        "default_mode", &rb_default_mode,
      "syntax", &rb_syntax,
      "allow_pragma", &rb_allow_pragma,
      "allow_column", &rb_allow_column,
      "allow_update", &rb_allow_update,
                        NULL);

    query = StringValuePtr(rb_query);
    query_size = RSTRING_LEN(rb_query);

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    default_column = RVAL2GRNBULK(rb_default_column, context, default_column);
    if (!NIL_P(rb_default_mode))
  default_mode = RVAL2GRNOPERATOR(rb_default_mode);
    if (!NIL_P(rb_default_operator))
  default_operator = RVAL2GRNOPERATOR(rb_default_operator);

    if (NIL_P(rb_syntax) ||
  rb_grn_equal_option(rb_syntax, "query")) {
  flags = GRN_EXPR_SYNTAX_QUERY;
    } else if (rb_grn_equal_option(rb_syntax, "script")) {
  flags = GRN_EXPR_SYNTAX_SCRIPT;
    } else {
  rb_raise(rb_eArgError,
     "syntax should be one of "
     "[nil, :query, :script]: %s",
     rb_grn_inspect(rb_syntax));
    }

    if (NIL_P(rb_allow_pragma)) {
  if ((flags & GRN_EXPR_SYNTAX_QUERY) == GRN_EXPR_SYNTAX_QUERY)
      flags |= GRN_EXPR_ALLOW_PRAGMA;
    } else {
  if ((flags & GRN_EXPR_SYNTAX_SCRIPT) == GRN_EXPR_SYNTAX_SCRIPT)
      rb_raise(rb_eArgError,
     ":allow_pragma isn't allowed in script syntax");
  if (RVAL2CBOOL(rb_allow_pragma))
      flags |= GRN_EXPR_ALLOW_PRAGMA;
    }

    if (NIL_P(rb_allow_column)) {
  if ((flags & GRN_EXPR_SYNTAX_QUERY) == GRN_EXPR_SYNTAX_QUERY)
      flags |= GRN_EXPR_ALLOW_COLUMN;
    } else {
  if ((flags & GRN_EXPR_SYNTAX_SCRIPT) == GRN_EXPR_SYNTAX_SCRIPT)
      rb_raise(rb_eArgError,
         ":allow_column isn't allowed in script syntax");
  if (RVAL2CBOOL(rb_allow_column))
      flags |= GRN_EXPR_ALLOW_COLUMN;
    }

    if (NIL_P(rb_allow_update)) {
  if ((flags & GRN_EXPR_SYNTAX_SCRIPT) == GRN_EXPR_SYNTAX_SCRIPT)
      flags |= GRN_EXPR_ALLOW_UPDATE;
    } else {
  if ((flags & GRN_EXPR_SYNTAX_QUERY) == GRN_EXPR_SYNTAX_QUERY)
      rb_raise(rb_eArgError,
         ":allow_update isn't allowed in query syntax");
  if (RVAL2CBOOL(rb_allow_update))
      flags |= GRN_EXPR_ALLOW_UPDATE;
    }

    rc = grn_expr_parse(context, expression, query, query_size,
      default_column, default_mode, default_operator,
      flags);
    if (rc != GRN_SUCCESS) {
  VALUE related_object;

  related_object = rb_ary_new3(2, self, rb_ary_new4(argc, argv));
  exception = rb_grn_context_to_exception(context, related_object);
    }
    grn_obj_close(context, default_column);

    if (!NIL_P(exception))
  rb_exc_raise(exception);

    return Qnil;
}

#snippet(tags, options) ⇒ Groonga::Snippet

expressionからGroonga::Snippetを生成する。tagsにはキー ワードの前後に挿入するタグの配列を以下のような形式で指定 する。

[
 ["キーワード前に挿入する文字列1", "キーワード後に挿入する文字列1"],
 ["キーワード前に挿入する文字列2", "キーワード後に挿入する文字列2"],
 ...,
]

もし、1つのスニペットの中にtagsで指定したタグより多くの キーワードが含まれている場合は、以下のように、また、先頭 のタグから順番に使われる。

expression.parse("Ruby groonga 検索")
tags = [["<tag1>", "</tag1>"], ["<tag2>", "</tag2>"]]
snippet = expression.snippet(tags)
p snippet.execute("Rubyでgroonga使って全文検索、高速検索。")
  # => ["<tag1>Ruby</tag1>で<tag2>groonga</tag2>"
  #     "使って全文<tag1>検索</tag1>、高速<tag2>検索</tag2>。"]

optionsに指定可能な値は以下の通り。

:normalize

キーワード文字列・スニペット元の文字列を正規化するかど うか。省略した場合はfalseで正規化しない。

:skip_leading_spaces

先頭の空白を無視するかどうか。省略した場合はfalseで無 視しない。

:width

スニペット文字列の長さ。省略した場合は100文字。

:max_results

生成するスニペットの最大数。省略した場合は3。

:html_escape

スニペット内の+<+, >, &, “をHTMLエスケープするか どうか。省略した場合はfalseで、HTMLエスケープしない。

Returns:



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
 
# File 'ext/rb-grn-expression.c', line 602

static VALUE
rb_grn_expression_snippet (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    grn_snip *snippet;
    VALUE options;
    VALUE rb_normalize, rb_skip_leading_spaces;
    VALUE rb_width, rb_max_results, rb_tags;
    VALUE rb_html_escape;
    VALUE *rb_tag_values;
    unsigned int i;
    int flags = GRN_SNIP_COPY_TAG;
    unsigned int width = 100;
    unsigned int max_results = 3;
    unsigned int n_tags = 0;
    char **open_tags = NULL;
    unsigned int *open_tag_lengths = NULL;
    char **close_tags = NULL;
    unsigned int *close_tag_lengths = NULL;
    grn_snip_mapping *mapping = NULL;

    rb_grn_expression_deconstruct(SELF(self), &expression, &context,
                                  NULL, NULL,
                                  NULL, NULL, NULL);

    rb_scan_args(argc, argv, "11", &rb_tags, &options);

    rb_grn_scan_options(options,
                        "normalize", &rb_normalize,
                        "skip_leading_spaces", &rb_skip_leading_spaces,
                        "width", &rb_width,
                        "max_results", &rb_max_results,
                        "html_escape", &rb_html_escape,
                        NULL);

    if (TYPE(rb_tags) != T_ARRAY) {
  rb_raise(rb_eArgError,
     "tags should be "
     "[\"open_tag\", \"close_tag\"] or"
     "[[\"open_tag1\", \"close_tag1\"], ...]: %s",
     rb_grn_inspect(rb_tags));
    }

    if (TYPE(RARRAY_PTR(rb_tags)[0]) == T_STRING) {
  rb_tags = rb_ary_new3(1, rb_tags);
    }

    rb_tag_values = RARRAY_PTR(rb_tags);
    n_tags = RARRAY_LEN(rb_tags);
    open_tags = ALLOCA_N(char *, n_tags);
    open_tag_lengths = ALLOCA_N(unsigned int, n_tags);
    close_tags = ALLOCA_N(char *, n_tags);
    close_tag_lengths = ALLOCA_N(unsigned int, n_tags);
    for (i = 0; i < n_tags; i++) {
  VALUE *tag_pair;

  if (TYPE(rb_tag_values[i]) != T_ARRAY ||
      RARRAY_LEN(rb_tag_values[i]) != 2) {
      rb_raise(rb_eArgError,
         "tags should be "
         "[\"open_tag\", \"close_tag\"] or"
         "[[\"open_tag1\", \"close_tag1\"], ...]: %s",
         rb_grn_inspect(rb_tags));
  }
  tag_pair = RARRAY_PTR(rb_tag_values[i]);
  open_tags[i] = StringValuePtr(tag_pair[0]);
  open_tag_lengths[i] = RSTRING_LEN(tag_pair[0]);
  close_tags[i] = StringValuePtr(tag_pair[1]);
  close_tag_lengths[i] = RSTRING_LEN(tag_pair[1]);
    }

    if (RVAL2CBOOL(rb_normalize))
        flags |= GRN_SNIP_NORMALIZE;
    if (RVAL2CBOOL(rb_skip_leading_spaces))
        flags |= GRN_SNIP_SKIP_LEADING_SPACES;

    if (!NIL_P(rb_width))
        width = NUM2UINT(rb_width);

    if (!NIL_P(rb_max_results))
        max_results = NUM2UINT(rb_max_results);

    if (RVAL2CBOOL(rb_html_escape))
        mapping = (grn_snip_mapping *)-1;

    snippet = grn_expr_snip(context, expression, flags, width, max_results,
          n_tags,
                            (const char **)open_tags, open_tag_lengths,
                            (const char **)close_tags, close_tag_lengths,
                            mapping);
    rb_grn_context_check(context,
       rb_ary_new3(2, self, rb_ary_new4(argc, argv)));

    return GRNSNIPPET2RVAL(context, snippet, RB_GRN_TRUE);
}