Class: Groonga::Array

Inherits:
Table show all
Defined in:
ext/groonga/rb-grn-array.c,
ext/groonga/rb-grn-array.c

Overview

各レコードがキーに関連付けられていないテーブル。レコードは IDで識別する。

Class Method Summary collapse

  • .create ⇒ Object

    キーのないテーブルを生成する。ブロックを指定すると、そのブ ロックに生成したテーブルが渡され、ブロックを抜けると自動的 にテーブルが破棄される。.

Instance Method Summary collapse

Methods inherited from Table

#[], #clear_lock, #column, #column_value, #columns, #define_column, #define_index_column, #defrag, #delete, #difference!, #dump_arrow, #each, #each_sub_record, #empty?, #exist?, #geo_sort, #group, #have_column?, #have_n_sub_records_space?, #initialize, #inspect, #intersection!, #load_arrow, #lock, #locked?, #merge!, #open_cursor, #paginate, #records, #rename, #select, #set_column_value, #set_value, #size, #sort, #support_key?, #support_sub_records?, #support_value?, #truncate, #union!, #unlock, #value

Methods included from Flushable

#flush

Methods inherited from Object

#==, #[], #[]=, #accessor?, #append, #builtin?, #close, #closed?, #column?, #corrupt?, #dirty?, #disk_usage, #domain, #function_procedure?, #id, #index_column?, #inspect, #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

This class inherits a constructor from Groonga::Table

Class Method Details

.create(options = {}) ⇒ Groonga::Array .create(options = {}) {|table| ... } ⇒ Object

キーのないテーブルを生成する。ブロックを指定すると、そのブ ロックに生成したテーブルが渡され、ブロックを抜けると自動的 にテーブルが破棄される。

Examples:

#無名一時テーブルを生成する。
Groonga::Array.create

#無名永続テーブルを生成する。
Groonga::Array.create(:path => "/tmp/array.grn")

#名前付き永続テーブルを生成する。ただし、ファイル名は気にしない。
Groonga::Array.create(:name => "Bookmarks",
                      :persistent => true)

#それぞれのレコードに512バイトの値を格納できる無名一時テーブルを生成する。
Groonga::Array.create(:value => 512)

Overloads:

  • .create(options = {}) ⇒ Groonga::Array

    Parameters:

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

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

    Options Hash (options):

    • :context (Groonga::Context) — default: Groonga::Context.default

      テーブルが利用する Context

    • :name (Object)

      The name テーブルの名前。名前をつけると、 Context#[] に名 前を指定してテーブルを取得することができる。省略すると 無名テーブルになり、テーブルIDでのみ取得できる。

    • :path (Object)

      テーブルを保存するパス。パスを指定すると永続テーブルとな り、プロセス終了後もレコードは保持される。次回起動時に Context#[] で保存されたレコードを利用することが できる。省略すると一時テーブルになり、プロセスが終了する とレコードは破棄される。

    • :persistent (Object)

      +true+ を指定すると永続テーブルとなる。 +path+ を省略した 場合は自動的にパスが付加される。 +:context+ で指定した Context に結びついているデータベースが一時デー タベースの場合は例外が発生する。

    • :value_type (Object) — default: nil

      値の型を指定する。省略すると値のための領域を確保しない。 値を保存したい場合は必ず指定すること。 参考: Type.new

    • :sub_records (Groonga::Record#n_sub_records)

      +true+ を指定すると Table#group でグループ化したときに、 Record#n_sub_records でグループに含まれるレコー ドの件数を取得できる。

    Returns:

  • .create(options = {}) {|table| ... } ⇒ Object

    Parameters:

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

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

    Options Hash (options):

    • :context (Groonga::Context) — default: Groonga::Context.default

      テーブルが利用する Context

    • :name (Object)

      The name テーブルの名前。名前をつけると、 Context#[] に名 前を指定してテーブルを取得することができる。省略すると 無名テーブルになり、テーブルIDでのみ取得できる。

    • :path (Object)

      テーブルを保存するパス。パスを指定すると永続テーブルとな り、プロセス終了後もレコードは保持される。次回起動時に Context#[] で保存されたレコードを利用することが できる。省略すると一時テーブルになり、プロセスが終了する とレコードは破棄される。

    • :persistent (Object)

      +true+ を指定すると永続テーブルとなる。 +path+ を省略した 場合は自動的にパスが付加される。 +:context+ で指定した Context に結びついているデータベースが一時デー タベースの場合は例外が発生する。

    • :value_type (Object) — default: nil

      値の型を指定する。省略すると値のための領域を確保しない。 値を保存したい場合は必ず指定すること。 参考: Type.new

    • :sub_records (Groonga::Record#n_sub_records)

      +true+ を指定すると Table#group でグループ化したときに、 Record#n_sub_records でグループに含まれるレコー ドの件数を取得できる。

    Yields:

    • (table)

      生成されたテーブル。ブロックを抜けると破棄される。



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

static VALUE
rb_grn_array_s_create (int argc, VALUE *argv, VALUE klass)
{
    grn_ctx *context = NULL;
    grn_obj *value_type = NULL, *table;
    const char *name = NULL, *path = NULL;
    unsigned name_size = 0;
    grn_table_flags flags = GRN_OBJ_TABLE_NO_KEY;
    VALUE rb_table;
    VALUE options, rb_context, rb_name, rb_path, rb_persistent;
    VALUE rb_value_type, rb_sub_records;

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

    rb_grn_scan_options(options,
                        "context", &rb_context,
                        "name", &rb_name,
                        "path", &rb_path,
                        "persistent", &rb_persistent,
                        "value_type", &rb_value_type,
                        "sub_records", &rb_sub_records,
                        NULL);

    context = rb_grn_context_ensure(&rb_context);

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

    if (!NIL_P(rb_path)) {
        path = StringValueCStr(rb_path);
        flags |= GRN_OBJ_PERSISTENT;
    }

    if (RVAL2CBOOL(rb_persistent))
        flags |= GRN_OBJ_PERSISTENT;

    if (!NIL_P(rb_value_type))
        value_type = RVAL2GRNOBJECT(rb_value_type, &context);

    if (RVAL2CBOOL(rb_sub_records))
        flags |= GRN_OBJ_WITH_SUBREC;

    table = grn_table_create(context, name, name_size, path,
                             flags, NULL, value_type);
    if (!table)
        rb_grn_context_check(context, rb_ary_new_from_values(argc, argv));
    rb_table = GRNOBJECT2RVAL(klass, context, table, GRN_TRUE);
    rb_grn_context_check(context, rb_table);
    rb_iv_set(rb_table, "@context", rb_context);

    if (rb_block_given_p())
        return rb_ensure(rb_yield, rb_table, rb_grn_object_close, rb_table);
    else
        return rb_table;
}

Instance Method Details

#add(values = nil) ⇒ Groonga::Recordまたはnil

レコード追加し、追加したレコードを返す。レコードの追加に失 敗した場合は +nil+ を返す。

values にはレコードのカラムに設定する値を指定する。省略 した場合または +nil+ を指定した場合はカラムは設定しない。カ ラムの値は @=> 値1, :カラム名2 => 値2, …@ と指定する。

Examples:

#以下のようなユーザを格納するGroonga::Arrayが
#定義されているものとする。
users = Groonga::Array.create(:name => "Users")
users.define_column("name", "ShortText")
users.define_column("uri", "ShortText")
#ユーザを追加する。
user = users.add

#daijiroユーザを追加する。
daijiro = users.add(:name => "daijiro")

#gunyara-kunユーザを追加する。
gunyara_kun = users.add(:name => "gunyara-kun",
                        :uri => "http://d.hatena.ne.jp/tasukuchan/")

Returns:



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'ext/groonga/rb-grn-array.c', line 173

static VALUE
rb_grn_array_add (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *table;
    grn_id id;
    VALUE values;

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

    table = SELF(self, &context);

    id = grn_table_add(context, table, NULL, 0, NULL);
    rb_grn_context_check(context, self);

    if (GRN_ID_NIL == id) {
        return Qnil;
    } else {
        return rb_grn_record_new_added(self, id, values);
    }
}