Class: Groonga::Expression

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

Overview

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

Instance Method Summary collapse

Methods inherited from Object

#==, #[]=, #accessor?, #append, #builtin?, #close, #closed?, #column?, #corrupt?, #dirty?, #disk_usage, #domain, #function_procedure?, #id, #index_column?, #key_accessor?, #last_modified, #name, #path, #persistent?, #prepend, #procedure?, #range, #reference_column?, #remove, #scorer_procedure?, #selector_only_procedure?, #selector_procedure?, #table?, #temporary?, #touch, #unlink, #window_function_procedure?

Constructor Details

#initializeObject



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

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_context_check(context, self);
    rb_grn_object_assign(Qnil, self, rb_context, context, expression);
    rb_grn_context_register_floating_object(DATA_PTR(self));

    rb_iv_set(self, "@objects", rb_ary_new());

    return Qnil;
}

Instance Method Details

#[](name) ⇒ 変数の値 #[](offset) ⇒ 変数の値

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

Overloads:

  • #[](name) ⇒ 変数の値

    Returns:

    • (変数の値)
  • #[](offset) ⇒ 変数の値

    Returns:

    • (変数の値)


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

static VALUE
rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
{
    grn_ctx *context = NULL;
    grn_obj *expression, *variable;
    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);
        break;
    case T_FIXNUM:
        offset = NUM2INT(rb_name_or_offset);
        variable = grn_expr_get_var_by_offset(context, expression, offset);
        break;
    default:
        rb_raise(rb_eArgError, "xxx");
        break;
    }

    return GRNVARIABLE2RVAL(context, variable);
}

#append_constant(constant, operation = Groonga::Operator::PUSH, n_arguments = 1) ⇒ Self

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

Parameters:

  • constant (Object)

    追加する constant

  • operation (Groonga::Operator::XXX) (defaults to: Groonga::Operator::PUSH)

    追加する operation

  • n_arguments (Integer) (defaults to: 1)

    operation の取る引数

Returns:

  • (Self)

    self



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

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 = RVAL2GRNOPERATOR(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_unlink(context, constant);
    if (!NIL_P(exception))
        rb_exc_raise(exception);

    return self;
}

#append_object(object, operation = Groonga::Operator::PUSH, n_arguments = 1) ⇒ Self

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

Parameters:

  • object (Object)

    追加するオブジェクト

  • operation (Groonga::Operator::XXX) (defaults to: Groonga::Operator::PUSH)

    追加する operation

  • n_arguments (Integer) (defaults to: 1)

    operation の取る引数

Returns:

  • (Self)

    self



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

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 = RVAL2GRNOPERATOR(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);

    if (RB_TYPE_P(rb_object, RUBY_T_HASH)) {
        RbGrnHashFromRubyHashData data;
        data.context = context;
        data.hash = grn_hash_create(context, NULL,
                                    GRN_TABLE_MAX_KEY_SIZE,
                                    sizeof(grn_obj),
                                    GRN_OBJ_KEY_VAR_SIZE |
                                    GRN_OBJ_TEMPORARY |
                                    GRN_HASH_TINY);
        grn_expr_take_obj(context, expression, (grn_obj *)(data.hash));
        data.rb_hash = rb_object;
        rb_hash_foreach(rb_object,
                        rb_grn_hash_from_ruby_hash_body,
                        (VALUE)&data);
        grn_expr_append_obj(context, expression, (grn_obj *)(data.hash),
                            operation, n_arguments);
    } else {
        object = RVAL2GRNOBJECT(rb_object, &context);
        grn_expr_append_obj(context, expression, object,
                            operation, n_arguments);
    }
    rb_grn_context_check(context, self);
    rb_ary_push(rb_iv_get(self, "@objects"), rb_object);

    return self;
}

#append_operation(operation, n_arguments) ⇒ Object

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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
# File 'ext/groonga/rb-grn-expression.c', line 341

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 = RVAL2GRNOPERATOR(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;
}

#compileObject

expression をコンパイルする。



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
# File 'ext/groonga/rb-grn-expression.c', line 595

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 で使用可能な変数を作成する。

Parameters:

  • options (::Hash) (defaults to: {})

    The name and value pairs. Omitted names are initialized as the default value.

Options Hash (options):

  • :name (String) — default: nil

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

  • :domain (Groonga::Table) — default: nil

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

  • :reference (Bool) — default: nil

    Initializes this variable as reference hold variable if @:reference@ is true. Reference hold variable is GRN_PTR type in groonga. You can’t use @:reference@ with @:domain@.

Returns:



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

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_reference;

    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,
                        "reference", &rb_reference,
                        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);
    } else if (!NIL_P(rb_reference) && RVAL2CBOOL(rb_reference)) {
        GRN_PTR_INIT(variable, 0, GRN_DB_OBJECT);
    }

    return rb_variable;
}

#dump_planObject

Dump execution plan of the expression in string.

Since:

  • 4.0.7



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
# File 'ext/groonga/rb-grn-expression.c', line 619

static VALUE
rb_grn_expression_dump_plan (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    grn_obj dumped_plan;
    VALUE rb_dumped_plan;

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

    GRN_TEXT_INIT(&dumped_plan, 0);
    grn_expr_dump_plan(context, expression, &dumped_plan);
    rb_dumped_plan = GRNBULK2RVAL(context, &dumped_plan, NULL, self);
    grn_obj_unlink(context, &dumped_plan);

    return rb_dumped_plan;
}

#estimate_sizeInteger

Estimates the number of matched records when expression is executed.

Note that the estimated size isn’t correct value. It’s just estimated size.

Examples:

expression.parse("Ruby OR Groonga")
expression.estimate_size # => 10

Returns the estimated number of matched records when expression is executed.

Returns:

  • (Integer)

    the estimated number of matched records when expression is executed.

Since:

  • 5.0.1



885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
# File 'ext/groonga/rb-grn-expression.c', line 885

static VALUE
rb_grn_expression_estimate_size (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    unsigned int size;

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

    size = grn_expr_estimate_size(context, expression);

    return UINT2NUM(size);
}

#execute

expression を実行し、実行した結果を返す。

Returns:

  • ()


573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
# File 'ext/groonga/rb-grn-expression.c', line 573

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

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

    result = grn_expr_exec(context, expression, 0);
    rb_grn_context_check(context, self);

    return GRNOBJ2RVAL(Qnil, context, result, self);
}

#inspectObject



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

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

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

    rb_inspected = rb_str_new_cstr("");
    rb_grn_object_inspect_header(self, rb_inspected);

    GRN_TEXT_INIT(&inspected, 0);
    grn_inspect(context, &inspected, expression);
    grn_bulk_truncate(context, &inspected, GRN_TEXT_LEN(&inspected) - 2);
    {
        size_t prefix_length;
        const char *content;
        size_t content_length;

        prefix_length = strlen("#<expr");
        content = GRN_TEXT_VALUE(&inspected) + prefix_length;
        content_length = GRN_TEXT_LEN(&inspected) - prefix_length;
        rb_str_concat(rb_inspected,
                      rb_grn_context_rb_string_new(context,
                                                   content,
                                                   content_length));
    }

    GRN_OBJ_FIN(context, &inspected);

    rb_grn_object_inspect_footer(self, rb_inspected);

    return rb_inspected;
}

#keywords::Array<String>

Extracts keywords from expression. The keywords order isn’t guaranteed.

Examples:

expression.parse("Ruby OR Groonga")
expression.keywords  #=> ["Groonga", "Ruby"]

Returns the extracted keywords

Returns:

  • (::Array<String>)

    the extracted keywords

Since:

  • 4.0.6



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

static VALUE
rb_grn_expression_get_keywords (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    grn_obj keywords;
    VALUE rb_keywords = rb_ary_new();

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

    GRN_PTR_INIT(&keywords, GRN_OBJ_VECTOR, GRN_ID_NIL);
    grn_expr_get_keywords(context, expression, &keywords);
    {
        int i, n_keywords;
        n_keywords = GRN_BULK_VSIZE(&keywords) / sizeof(grn_obj *);
        for (i = 0; i < n_keywords; i++) {
            grn_obj *keyword = GRN_PTR_VALUE_AT(&keywords, i);
            rb_ary_push(rb_keywords,
                        GRNBULK2RVAL(context, keyword, NULL, self));
        }
    }
    GRN_OBJ_FIN(context, &keywords);

    return rb_keywords;
}

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

文字列 query をパースする。

Parameters:

  • query (String)

    パースする文字列

  • options (::Hash) (defaults to: {})

    The name and value pairs. Omitted names are initialized as the default value.

Options Hash (options):

  • :default_column (Object)

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

  • :default_operator (Object) — default: Groonga::Operator::AND

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

    • Groonga::Operator::OR := レコードはいずれかの条件にマッチすればいい。 =:
    • Groonga::Operator::AND := レコードは全ての条件にマッチしなければならない。 =:
    • Groonga::Operator::AND_NOT := 最初の条件にレコードはマッチし、残りの条件にレコードは マッチしてはならない。 =:
  • :default_mode (Object) — default: Groonga::Operator::MATCH

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

  • :syntax (Object) — default: :query

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

    • +:query+ := 「文字列1 OR 文字列2」で「”文字列1”あるいは”文字列2” にマッチという検索エンジンで利用できるような構文を使 う。 参考: “Groongaのクエリ構文のドキュメント”:http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html =:
    • +nil+ := +:query+と同様 =:
    • +:script+ := 「[カラム名] == [値]」というようにECMAScript風の構文を使う。 参考: “Groongaのscript構文のドキュメント”:http://groonga.org/ja/docs/reference/grn_expr/script_syntax.html =:
  • :allow_pragma (Object)

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

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

    参考: “Groongaのクエリ構文のドキュメント”:http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html

  • :allow_column (Object)

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

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

    参考: “Groongaのクエリ構文のドキュメント”:http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html

  • :allow_update (Object)

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

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

    参考: “Groongaのクエリ構文のドキュメント”:http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html

  • :no_syntax_error (Object)

    Specifies whether preventing syntax error in query syntax.

    If it’s true, special characters are treated as normal characters on syntax error.

    If it’s false, syntax error is reported on syntax error. It’s the default.

    You can’t use this option in script syntax.

    @see Query syntax document in Groonga



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

static VALUE
rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression, *default_column;
    grn_bool default_column_is_created = GRN_FALSE;
    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, rb_allow_leading_not;
    VALUE rb_no_syntax_error;
    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,
                        "allow_leading_not", &rb_allow_leading_not,
                        "no_syntax_error", &rb_no_syntax_error,
                        NULL);

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

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

    if (NIL_P(rb_default_column)) {
        default_column = NULL;
    } else if (RVAL2CBOOL(rb_obj_is_kind_of(rb_default_column, rb_cGrnObject))) {
        default_column = RVAL2GRNOBJECT(rb_default_column, &context);
    } else {
        default_column = RVAL2GRNBULK(rb_default_column, context, NULL);
        default_column_is_created = GRN_TRUE;
    }

    if (!NIL_P(rb_default_mode))
        default_mode = RVAL2GRNOPERATOR(rb_default_mode);
    if (!NIL_P(rb_default_operator))
        default_operator = RVAL2GRNSETOPERATOR(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_SCRIPT))
            flags |= GRN_EXPR_ALLOW_PRAGMA;
    } else {
        if ((flags & 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_SCRIPT))
            flags |= GRN_EXPR_ALLOW_COLUMN;
    } else {
        if ((flags & 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)) {
        flags |= GRN_EXPR_ALLOW_UPDATE;
    } else {
        if (RVAL2CBOOL(rb_allow_update))
            flags |= GRN_EXPR_ALLOW_UPDATE;
    }

    if (!NIL_P(rb_allow_leading_not)) {
        if (RVAL2CBOOL(rb_allow_leading_not))
            flags |= GRN_EXPR_ALLOW_LEADING_NOT;
    }

    if (!NIL_P(rb_no_syntax_error)) {
        if ((flags & GRN_EXPR_SYNTAX_SCRIPT))
            rb_raise(rb_eArgError,
                     ":no_syntax_error isn't allowed in script syntax");
        if (RVAL2CBOOL(rb_no_syntax_error))
            flags |= GRN_EXPR_QUERY_NO_SYNTAX_ERROR;
    }

    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_new_from_args(2,
                                 self,
                                 rb_ary_new_from_values(argc, argv));
        exception = rb_grn_context_to_exception(context, related_object);
    }
    if (default_column_is_created)
        grn_obj_unlink(context, default_column);

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

    return Qnil;
}

#rewriteGroonga::Expression?

Rewrites expression.

Examples:

expression.parse("age >= 10 AND age < 20",
                 :syntax => :script)
expression.rewrite # => New rewritten expression.
                   #    It'll use between(age, 10, "include", 20, "exclude")

Returns new rewritten expression when the expression is rewritten, nil otherwise.

Returns:

  • (Groonga::Expression, nil)

    new rewritten expression when the expression is rewritten, nil otherwise.

Since:

  • 5.1.0



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
# File 'ext/groonga/rb-grn-expression.c', line 916

static VALUE
rb_grn_expression_rewrite (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    grn_obj *rewritten_expression;

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

    rewritten_expression = grn_expr_rewrite(context, expression);

    return GRNOBJECT2RVAL(Qnil, context, rewritten_expression, GRN_TRUE);
}

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

expression から 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>。"]

Parameters:

  • tags (Array<string>)

    キーワードの前後に挿入するタグの配列 (詳細は上記を参照)

  • options (::Hash)

    The name and value pairs. Omitted names are initialized as the default value.

Options Hash (options):

  • :normalize (Object) — default: false

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

  • :skip_leading_spaces (Object) — default: false

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

  • :width (Object) — default: 100

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

  • :max_results (Object) — default: 3

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

  • :html_escape (Object) — default: false

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

Returns:



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

static VALUE
rb_grn_expression_snippet (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *expression;
    grn_obj *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;
    VALUE related_object;
    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_new_from_args(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);
    related_object =
        rb_ary_new_from_args(2, self, rb_ary_new_from_values(argc, argv));
    rb_grn_context_check(context, related_object);

    return GRNOBJECT2RVAL(Qnil, context, snippet, GRN_TRUE);
}