Class: Groonga::Type

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

Overview

groongaのテーブルの主キーや、カラムの値の型のためのオブジェ クト。型として使用可能なものはgroongaで予め定義済みの型、ユ ーザが定義する型、またはユーザが定義したテーブル。

Constant Summary

OBJECT =

任意のテーブルに属する全てのレコード(Object型はv1.2で サポートされます)。

INT2NUM(GRN_DB_OBJECT)
BOOLEAN =

bool型。trueとfalse。

INT2NUM(GRN_DB_BOOL)
BOOL =

bool型。trueとfalse。

INT2NUM(GRN_DB_BOOL)
INT8 =

8bit符号付き整数。

INT2NUM(GRN_DB_INT8)
UINT8 =

8bit符号なし整数。

INT2NUM(GRN_DB_UINT8)
INT16 =

16bit符号付き整数。

INT2NUM(GRN_DB_INT16)
UINT16 =

16bit符号なし整数。

INT2NUM(GRN_DB_UINT16)
INT32 =

32bit符号付き整数。

INT2NUM(GRN_DB_INT32)
UINT32 =

32bit符号なし整数。

INT2NUM(GRN_DB_UINT32)
INT64 =

64bit符号付き整数。

INT2NUM(GRN_DB_INT64)
UINT64 =

64bit符号なし整数。

INT2NUM(GRN_DB_UINT64)
FLOAT =

ieee754形式の64bit浮動小数点数。

INT2NUM(GRN_DB_FLOAT)
TIME =

1970年1月1日0時0分0秒からの経過マイクロ秒数を64bit符 号付き整数で表現した値。

INT2NUM(GRN_DB_TIME)
SHORT_TEXT =

4Kbyte以下の文字列。

INT2NUM(GRN_DB_SHORT_TEXT)
TEXT =

64Kbyte以下の文字列。

INT2NUM(GRN_DB_TEXT)
LONG_TEXT =

2Gbyte以下の文字列。

INT2NUM(GRN_DB_LONG_TEXT)
DELIMIT =
INT2NUM(GRN_DB_DELIMIT)
UNIGRAM =
INT2NUM(GRN_DB_UNIGRAM)
BIGRAM =
INT2NUM(GRN_DB_BIGRAM)
TRIGRAM =
INT2NUM(GRN_DB_TRIGRAM)
MECAB =
INT2NUM(GRN_DB_MECAB)

Instance Method Summary collapse

Methods inherited from Object

#==, #[], #[]=, #accessor?, #append, #close, #closed?, #column?, #dirty?, #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

#new(name, options = {}) ⇒ Object

名前が name の型を作成する。

Parameters:

  • name (String)

    作成する型の名前

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

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

Options Hash (options):

  • :type (Symbol) — default: :variable

    :integer(符号付き整数)、:int(:integerの省略 形)、:unsigned_integer(符号なし整 数)、:uint(:unsigned_integerの省略形)、:float(浮動小数点 数)、:variable(可変長文字列)のいずれかを指定する。省略した場 合は:variableを指定したものと扱う。 :variableを指定した場合は必ず +:size+ を指定しなければいけない。

  • :context (Context)

    型の作成時に利用するGroonga::Contextを指定する。省略すると Groonga::Context.defaultを用いる。

  • :size (Integer)

    +:option+ が:variableの場合は最大長、それ以外の場合は長さを 指定する(単位:byte)。



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

static VALUE
rb_grn_type_initialize (int argc, VALUE *argv, VALUE self)
{
    grn_ctx *context;
    grn_obj *type;
    const char *name = NULL;
    unsigned name_size, size = 0;
    grn_obj_flags flags = 0;
    VALUE rb_name, options, rb_context, rb_type, rb_size;

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

    rb_grn_scan_options(options,
                        "context", &rb_context,
                        "type", &rb_type,
                        "size", &rb_size,
                        NULL);

    name = StringValuePtr(rb_name);
    name_size = RSTRING_LEN(rb_name);

    context = rb_grn_context_ensure(&rb_context);

    if (NIL_P(rb_type) ||
        rb_grn_equal_option(rb_type, "variable")) {
        flags = GRN_OBJ_KEY_VAR_SIZE;
    } else if (rb_grn_equal_option(rb_type, "integer") ||
               rb_grn_equal_option(rb_type, "int")) {
        flags = GRN_OBJ_KEY_INT;
        size = sizeof(int);
    } else if (rb_grn_equal_option(rb_type, "unsigned_integer") ||
               rb_grn_equal_option(rb_type, "uint")) {
        flags = GRN_OBJ_KEY_UINT;
        size = sizeof(unsigned int);
    } else if (rb_grn_equal_option(rb_type, "float")) {
        flags = GRN_OBJ_KEY_FLOAT;
        size = sizeof(double);
    } else {
        rb_raise(rb_eArgError,
                 ":type should be one of "
                 "[:integer, :int, :unsigned_integer, :uint, "
                 ":float, :variable]: %s",
                 rb_grn_inspect(options));
    }

    if (NIL_P(rb_size)) {
        if (size == 0)
            rb_raise(rb_eArgError, "size is missing: %s",
                     rb_grn_inspect(options));
    } else {
        size = NUM2UINT(rb_size);
    }

    type = grn_type_create(context, name, name_size, flags, size);
    rb_grn_object_assign(Qnil, self, rb_context, context, type);
    rb_grn_context_check(context, rb_ary_new_from_values(argc, argv));

    return Qnil;
}

Instance Method Details

#builtin?Boolean

Returns:

  • (Boolean)


176
177
178
179
180
181
182
183
184
185
186
# File 'ext/groonga/rb-grn-type.c', line 176

static VALUE
rb_grn_type_builtin_p (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *type;
    grn_id id;

    type = RVAL2GRNOBJECT(self, &context);
    id =  grn_obj_id(context, type);
    return CBOOL2RVAL(grn_type_id_is_builtin(context, id));
}

#fixed_size?Boolean

Returns:

  • (Boolean)


154
155
156
157
158
159
160
161
162
163
# File 'ext/groonga/rb-grn-type.c', line 154

static VALUE
rb_grn_type_fixed_size_p (VALUE self)
{
    grn_ctx *context;
    grn_obj *type;

    type = RVAL2GRNOBJECT(self, &context);

    return CBOOL2RVAL(!(type->header.flags & GRN_OBJ_KEY_VAR_SIZE));
}

#flagsObject



143
144
145
146
147
148
149
150
151
152
# File 'ext/groonga/rb-grn-type.c', line 143

static VALUE
rb_grn_type_flags (VALUE self)
{
    grn_ctx *context;
    grn_obj *type;

    type = RVAL2GRNOBJECT(self, &context);

    return UINT2NUM(type->header.flags);
}

#float?Boolean

Returns:

  • (Boolean)


210
211
212
213
214
215
216
217
218
219
# File 'ext/groonga/rb-grn-type.c', line 210

static VALUE
rb_grn_type_float_p (VALUE self)
{
    grn_obj *type;
    grn_obj_flags key_type;

    type = RVAL2GRNOBJECT(self, NULL);
    key_type = type->header.flags & GRN_OBJ_KEY_MASK;
    return CBOOL2RVAL(key_type == GRN_OBJ_KEY_FLOAT);
}

#geo_point?Boolean

Returns:

  • (Boolean)


221
222
223
224
225
226
227
228
229
230
# File 'ext/groonga/rb-grn-type.c', line 221

static VALUE
rb_grn_type_geo_point_p (VALUE self)
{
    grn_obj *type;
    grn_obj_flags key_type;

    type = RVAL2GRNOBJECT(self, NULL);
    key_type = type->header.flags & GRN_OBJ_KEY_MASK;
    return CBOOL2RVAL(key_type == GRN_OBJ_KEY_GEO_POINT);
}

#integer?Boolean Also known as: int?

Returns:

  • (Boolean)


199
200
201
202
203
204
205
206
207
208
# File 'ext/groonga/rb-grn-type.c', line 199

static VALUE
rb_grn_type_integer_p (VALUE self)
{
    grn_obj *type;
    grn_obj_flags key_type;

    type = RVAL2GRNOBJECT(self, NULL);
    key_type = type->header.flags & GRN_OBJ_KEY_MASK;
    return CBOOL2RVAL(key_type == GRN_OBJ_KEY_INT);
}

#number_family?Boolean

Returns:

  • (Boolean)


244
245
246
247
248
249
250
251
252
253
254
# File 'ext/groonga/rb-grn-type.c', line 244

static VALUE
rb_grn_type_number_family_p (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *type;
    grn_id id;

    type = RVAL2GRNOBJECT(self, &context);
    id =  grn_obj_id(context, type);
    return CBOOL2RVAL(grn_type_id_is_number_family(context, id));
}

#sizeObject



132
133
134
135
136
137
138
139
140
141
# File 'ext/groonga/rb-grn-type.c', line 132

static VALUE
rb_grn_type_size (VALUE self)
{
    grn_ctx *context;
    grn_obj *type;

    type = RVAL2GRNOBJECT(self, &context);

    return UINT2NUM(grn_obj_get_range(context, type));
}

#text_family?Boolean

Returns:

  • (Boolean)


232
233
234
235
236
237
238
239
240
241
242
# File 'ext/groonga/rb-grn-type.c', line 232

static VALUE
rb_grn_type_text_family_p (VALUE self)
{
    grn_ctx *context = NULL;
    grn_obj *type;
    grn_id id;

    type = RVAL2GRNOBJECT(self, &context);
    id =  grn_obj_id(context, type);
    return CBOOL2RVAL(grn_type_id_is_text_family(context, id));
}

#unsigned_integer?Boolean Also known as: uint?

Returns:

  • (Boolean)


188
189
190
191
192
193
194
195
196
197
# File 'ext/groonga/rb-grn-type.c', line 188

static VALUE
rb_grn_type_unsigned_integer_p (VALUE self)
{
    grn_obj *type;
    grn_obj_flags key_type;

    type = RVAL2GRNOBJECT(self, NULL);
    key_type = type->header.flags & GRN_OBJ_KEY_MASK;
    return CBOOL2RVAL(key_type == GRN_OBJ_KEY_UINT);
}

#variable_size?Boolean

Returns:

  • (Boolean)


165
166
167
168
169
170
171
172
173
174
# File 'ext/groonga/rb-grn-type.c', line 165

static VALUE
rb_grn_type_variable_size_p (VALUE self)
{
    grn_ctx *context;
    grn_obj *type;

    type = RVAL2GRNOBJECT(self, &context);

    return CBOOL2RVAL(type->header.flags & GRN_OBJ_KEY_VAR_SIZE);
}