rroonga 3.0.1-x86-mingw32 → 3.0.2-x86-mingw32

data/ext/groonga/rb-grn-table.c

@@ -18,6 +18,16 @@
 
 #include "rb-grn.h"
 
+/* GRN_TABLE_* should be defined in groonga.h. If they are defined in
+ * groonga.h, the following defines are removed. */
+#ifndef GRN_TABLE_GROUPED
+#  define GRN_TABLE_GROUPED (0x01<<0)
+#endif
+#ifndef GRN_TABLE_IS_GROUPED
+#  define GRN_TABLE_IS_GROUPED(table) \
+    ((table)->header.impl_flags & GRN_TABLE_GROUPED)
+#endif
+
 grn_obj *grn_table_open(grn_ctx *ctx,
                         const char *name, unsigned name_size, const char *path);
 grn_obj *grn_column_open(grn_ctx *ctx, grn_obj *table,
@@ -2242,6 +2252,42 @@ rb_grn_table_support_sub_records_p (VALUE self)
 {
     grn_obj *table;
 
+    rb_grn_table_deconstruct(SELF(self), &table, NULL,
+                             NULL, NULL,
+                             NULL, NULL, NULL,
+                             NULL);
+    return CBOOL2RVAL(GRN_TABLE_IS_GROUPED(table));
+}
+
+/*
+ * {Groonga::Table#group} returns a table that contains grouped
+ * records. If grouped table has a space to store the number of
+ * records for each group, the number of records is stored to
+ * it. Records for each group are called as "sub records".
+ *
+ * Normally, you don't need to care about the space because rroonga
+ * creates a table with the space automatically. Normal tables
+ * (persistent tables) don't have the space because they don't need
+ * it.
+ *
+ * @eample A normal table don't have the space
+ *    users = Groonga["Users"] # A normal table
+ *    users.have_n_sub_records_space? # => false
+ *
+ * @eample A grouped table has the space
+ *    users = Groonga["Users"]                # A normal table
+ *    grouped_users = users.group("_key")     # A grouped table
+ *    grouped_users.have_n_sub_records_space? # => true
+ *
+ * @overload have_n_sub_records_space?
+ * @return [Boolean] @true@ if the table has a space for storing
+ *    the number of sub records, @false@ otherwise.
+ */
+static VALUE
+rb_grn_table_have_n_sub_records_space_p (VALUE self)
+{
+    grn_obj *table;
+
     rb_grn_table_deconstruct(SELF(self), &table, NULL,
                              NULL, NULL,
                              NULL, NULL, NULL,
@@ -2413,6 +2459,8 @@ rb_grn_init_table (VALUE mGrn)
                      rb_grn_table_support_key_p, 0);
     rb_define_method(rb_cGrnTable, "support_sub_records?",
                      rb_grn_table_support_sub_records_p, 0);
+    rb_define_method(rb_cGrnTable, "have_n_sub_records_space?",
+                     rb_grn_table_have_n_sub_records_space_p, 0);
 
     rb_define_method(rb_cGrnTable, "exist?", rb_grn_table_exist_p, 1);