Class: Groonga::Column

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

Overview

テーブルに情報を付加するためのオブジェクト。テーブルに複 数のカラムを定義することによりレコード毎に複数の情報を付 加することができる。

カラムには大きく分けて3種類ある。

Groonga::FixSizeColumn

固定長のデータを格納するカラム。

Groonga::VariableSizeColumn

可変長のデータを格納するカラム。

Groonga::IndexColumn

転置インデックスを格納するカラム。全文検索や参照元レコー ドの検索を行う場合はこのカラムを使用する。

固定長データ用カラム・可変長データ用カラムは1つのデータだ けを格納するか複数のデータを格納するかを選ぶことができる。 1つのデータの場合はスカラ値、複数のデータの場合はスカラー 値を格納するという。

カラムは名前を持ち、1つのテーブルでは同じカラム名を持つカ ラムを複数定義することはできない。

Direct Known Subclasses

FixSizeColumn, IndexColumn, VariableSizeColumn

Instance Method Summary collapse

Instance Method Details

#clear_lock ⇒ Object

call-seq:

column.clear_lock(options={})

columnのロックを強制的に解除する。

利用可能なオプションは以下の通り。

:id

:idで指定したレコードのロックを強制的に解除する。 （注: groonga側が未実装のため、現在は無視される。実装さ れるのではないかと思っているが、実装されないかもしれな い。）



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

static VALUE
rb_grn_column_clear_lock (int argc, VALUE *argv, VALUE self)
{
    grn_id id = GRN_ID_NIL;
    grn_ctx *context;
    grn_obj *column;
    VALUE options, rb_id;

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

    rb_grn_column_deconstruct(SELF(self), &column, &context,
			     NULL, NULL,
			     NULL, NULL, NULL);

    rb_grn_scan_options(options,
			"id", &rb_id,
			NULL);

    if (!NIL_P(rb_id))
	id = NUM2UINT(rb_id);

    grn_obj_clear_lock(context, column);

    return Qnil;
}

#local_name ⇒ Object

テーブル名を除いたカラム名を返す。

items = Groonga::Array.create(:name => "Items")
title = items.define_column("title", "ShortText")
title.name # => "Items.title"
title.local_name # => "title"



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'ext/rb-grn-column.c', line 145

static VALUE
rb_grn_column_get_local_name (VALUE self)
{
    RbGrnColumn *rb_grn_column;
    grn_ctx *context = NULL;
    grn_obj *column;
    int name_size;
    VALUE rb_name;

    rb_grn_column = SELF(self);
    rb_grn_object_deconstruct(RB_GRN_OBJECT(rb_grn_column), &column, &context,
			      NULL, NULL,
			      NULL, NULL);
    name_size = grn_column_name(context, column, NULL, 0);
    if (name_size == 0)
	return Qnil;

    rb_name = rb_str_buf_new(name_size);
    rb_str_set_len(rb_name, name_size);
    grn_column_name(context, column, RSTRING_PTR(rb_name), name_size);
    return rb_name;
}

#lock ⇒ Object

call-seq:

column.lock(options={})
column.lock(options={}) {...}

columnをロックする。ロックに失敗した場合は Groonga::ResourceDeadlockAvoided例外が発生する。

ブロックを指定した場合はブロックを抜けたときにunlockする。

利用可能なオプションは以下の通り。

:timeout

ロックを獲得できなかった場合は:timeout秒間ロックの獲 得を試みる。:timeout秒以内にロックを獲得できなかった 場合は例外が発生する。

:id

:idで指定したレコードをロックする。（注: groonga側が 未実装のため、現在は無視される）



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

static VALUE
rb_grn_column_lock (int argc, VALUE *argv, VALUE self)
{
    grn_id id = GRN_ID_NIL;
    grn_ctx *context;
    grn_obj *column;
    int timeout = 0;
    grn_rc rc;
    VALUE options, rb_timeout, rb_id;

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

    rb_grn_column_deconstruct(SELF(self), &column, &context,
			     NULL, NULL,
			     NULL, NULL, NULL);

    rb_grn_scan_options(options,
			"timeout", &rb_timeout,
			"id", &rb_id,
			NULL);

    if (!NIL_P(rb_timeout))
	timeout = NUM2UINT(rb_timeout);

    if (!NIL_P(rb_id))
	id = NUM2UINT(rb_id);

    rc = grn_obj_lock(context, column, id, timeout);
    rb_grn_context_check(context, self);
    rb_grn_rc_check(rc, self);

    if (rb_block_given_p()) {
	return rb_ensure(rb_yield, Qnil, rb_grn_column_unlock_ensure, self);
    } else {
	return Qnil;
    }
}

#locked? ⇒ Boolean

call-seq:

column.locked?(options={})

columnがロックされていればtrueを返す。

利用可能なオプションは以下の通り。

:id

:idで指定したレコードがロックされていればtrueを返す。 （注: groonga側が未実装のため、現在は無視される。実装さ れるのではないかと思っているが、実装されないかもしれな い。）

Returns:

  • (Boolean) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'ext/rb-grn-column.c', line 528

static VALUE
rb_grn_column_is_locked (int argc, VALUE *argv, VALUE self)
{
    grn_id id = GRN_ID_NIL;
    grn_ctx *context;
    grn_obj *column;
    VALUE options, rb_id;

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

    rb_grn_column_deconstruct(SELF(self), &column, &context,
			     NULL, NULL,
			     NULL, NULL, NULL);

    rb_grn_scan_options(options,
			"id", &rb_id,
			NULL);

    if (!NIL_P(rb_id))
	id = NUM2UINT(rb_id);

    return CBOOL2RVAL(grn_obj_is_locked(context, column));
}

#select(options) {|record| ... } ⇒ Groonga::Hash #select(query, options) ⇒ Groonga::Hash #select(expression, options) ⇒ Groonga::Hash

カラムが所属するテーブルからブロックまたは文字列で指定し た条件にマッチするレコードを返す。返されたテーブルには expressionという特異メソッドがあり、指定した条件を表し ているGroonga::Expressionを取得できる。 Groonga::Expression#snippetを使うことにより、指定した条件 用のスニペットを簡単に生成できる。

results = description_column.select do |column|
  column =~ "groonga"
end
snippet = results.expression.snippet([["<em>", "</em>"]])
results.each do |record|
  puts "#{record['name']}の説明文の中で「groonga」が含まれる部分"
  snippet.execute(record["description"].each do |snippet|
    puts "---"
    puts "#{snippet}..."
    puts "---"
  end
end

出力例

Ruby/groongaの説明文の中で「groonga」が含まれる部分
---
Ruby/<em>groonga</em>は<em>groonga</em>のいわゆるDB-APIの層の...
---

queryには「:[演算子]」という書式で条件を 指定する。演算子は以下の通り。

なし
カラム値

[値]

!
カラム値

!= [値]

<
カラム値

< [値]

>
カラム値

> [値]

<=
カラム値

<= [値]

>=
カラム値

>= [値]

@

[カラム値]がを含んでいるかどうか

例:

"groonga" # _column_カラムの値が"groonga"のレコードにマッチ
"name:daijiro" # _column_カラムが属しているテーブルの
               # "name"カラムの値が"daijiro"のレコードにマッチ
"description:@groonga" # _column_カラムが属しているテーブルの
                       # "description"カラムが
                       # "groonga"を含んでいるレコードにマッチ

expressionには既に作成済みのGroonga::Expressionを渡す

ブロックで条件を指定する場合は Groonga::ColumnExpressionBuilderを参照。

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

:operator

マッチしたレコードをどのように扱うか。指定可能な値は以 下の通り。省略した場合はGroonga::Operation::OR。

Groonga::Operation::OR

マッチしたレコードを追加。すでにレコードが追加され ている場合は何もしない。

Groonga::Operation::AND

マッチしたレコードのスコアを増加。マッチしなかった レコードを削除。

Groonga::Operation::BUT

マッチしたレコードを削除。

Groonga::Operation::ADJUST

マッチしたレコードのスコアを増加。

:result

検索結果を格納するテーブル。マッチしたレコードが追加さ れていく。省略した場合は新しくテーブルを作成して返す。

:name

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

:syntax

queryの構文。省略した場合は:query。

参考: Groonga::Expression#parse.

:allow_pragma

query構文時にプラグマを利用するかどうか。省略した場合は 利用する。

参考: Groonga::Expression#parse.

:allow_column

query構文時にカラム指定を利用するかどうか。省略した場合 は利用する。

参考: Groonga::Expression#parse.

:allow_update

script構文時に更新操作を利用するかどうか。省略した場合 は利用する。

参考: Groonga::Expression#parse.

Overloads:



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

static VALUE
rb_grn_column_select (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context;
    grn_obj *table, *column, *result, *expression;
    grn_operator operator = GRN_OP_OR;
    VALUE options;
    VALUE rb_query, condition_or_options;
    VALUE rb_name, rb_operator, rb_result, rb_syntax;
    VALUE rb_allow_pragma, rb_allow_column, rb_allow_update;
    VALUE builder;
    VALUE rb_expression = Qnil;

    rb_query = Qnil;

    rb_scan_args(argc, argv, "02", &condition_or_options, &options);

    rb_grn_column_deconstruct(SELF(self), &column, &context,
			      NULL, NULL,
			      NULL, NULL, NULL);
    table = grn_column_table(context, column);

    if (RVAL2CBOOL(rb_obj_is_kind_of(condition_or_options, rb_cString))) {
        rb_query = condition_or_options;
    } else if (RVAL2CBOOL(rb_obj_is_kind_of(condition_or_options,
                                            rb_cGrnExpression))) {
        rb_expression = condition_or_options;
    } else {
        if (!NIL_P(options))
            rb_raise(rb_eArgError,
		     "should be [query_string, option_hash], "
		     "[expression, opion_hash] "
		     "or [option_hash]: %s",
		     rb_grn_inspect(rb_ary_new4(argc, argv)));
        options = condition_or_options;
    }

    rb_grn_scan_options(options,
			"operator", &rb_operator,
			"result", &rb_result,
			"name", &rb_name,
			"syntax", &rb_syntax,
			"allow_pragma", &rb_allow_pragma,
			"allow_column", &rb_allow_column,
			"allow_update", &rb_allow_update,
			NULL);

    if (!NIL_P(rb_operator))
	operator = NUM2INT(rb_operator);

    if (NIL_P(rb_result)) {
	result = grn_table_create(context, NULL, 0, NULL,
				  GRN_TABLE_HASH_KEY | GRN_OBJ_WITH_SUBREC,
				  table,
				  0);
	rb_result = GRNTABLE2RVAL(context, result, RB_GRN_TRUE);
    } else {
	result = RVAL2GRNTABLE(rb_result, &context);
    }

    if (NIL_P(rb_expression)) {
      builder = rb_grn_column_expression_builder_new(self, rb_name, rb_query);
      rb_funcall(builder, rb_intern("syntax="), 1, rb_syntax);
      rb_funcall(builder, rb_intern("allow_pragma="), 1, rb_allow_pragma);
      rb_funcall(builder, rb_intern("allow_column="), 1, rb_allow_column);
      rb_funcall(builder, rb_intern("allow_update="), 1, rb_allow_update);
      rb_expression = rb_grn_column_expression_builder_build(builder);
    }
    rb_grn_object_deconstruct(RB_GRN_OBJECT(DATA_PTR(rb_expression)),
                              &expression, NULL,
                              NULL, NULL, NULL, NULL);

    grn_table_select(context, table, expression, result, operator);
    rb_grn_context_check(context, self);

    rb_attr(rb_singleton_class(rb_result),
	    rb_intern("expression"),
	    RB_GRN_TRUE, RB_GRN_FALSE, RB_GRN_FALSE);
    rb_iv_set(rb_result, "@expression", rb_expression);

    return rb_result;
}

#table ⇒ Groonga::Table

カラムが所属するテーブルを返す。

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'ext/rb-grn-column.c', line 118

static VALUE
rb_grn_column_get_table (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *column;
    grn_obj *table;

    rb_grn_object_deconstruct((RbGrnObject *)(SELF(self)), &column, &context,
			      NULL, NULL,
			      NULL, NULL);
    table = grn_column_table(context, column);
    rb_grn_context_check(context, self);

    return GRNOBJECT2RVAL(Qnil, context, table, RB_GRN_FALSE);
}

#unlock ⇒ Object

call-seq:

column.unlock(options={})

columnのロックを解除する。

利用可能なオプションは以下の通り。

:id

:idで指定したレコードのロックを解除する。（注: groonga側が未実装のため、現在は無視される）



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

static VALUE
rb_grn_column_unlock (int argc, VALUE *argv, VALUE self)
{
    grn_id id = GRN_ID_NIL;
    grn_ctx *context;
    grn_obj *column;
    grn_rc rc;
    VALUE options, rb_id;

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

    rb_grn_column_deconstruct(SELF(self), &column, &context,
			     NULL, NULL,
			     NULL, NULL, NULL);

    rb_grn_scan_options(options,
			"id", &rb_id,
			NULL);

    if (!NIL_P(rb_id))
	id = NUM2UINT(rb_id);

    rc = grn_obj_unlock(context, column, id);
    rb_grn_context_check(context, self);
    rb_grn_rc_check(rc, self);

    return Qnil;
}