[Groonga-commit] ranguba/rroonga at 5f6e9bc [bind-grn_obj_is_key_accessor] Add examples

Back to archive index

Masafumi Yokoyama null+****@clear*****
Tue Jan 5 15:19:50 JST 2016


Masafumi Yokoyama	2016-01-05 15:19:50 +0900 (Tue, 05 Jan 2016)

  New Revision: 5f6e9bc38286c8f268056ecec822c2bacf35856c
  https://github.com/ranguba/rroonga/commit/5f6e9bc38286c8f268056ecec822c2bacf35856c

  Message:
    Add examples
    
    TODO: Translate.

  Modified files:
    ext/groonga/rb-grn-object.c

  Modified: ext/groonga/rb-grn-object.c (+10 -0)
===================================================================
--- ext/groonga/rb-grn-object.c    2016-01-05 15:05:31 +0900 (3ea70bd)
+++ ext/groonga/rb-grn-object.c    2016-01-05 15:19:50 +0900 (2f20c25)
@@ -1685,6 +1685,16 @@ rb_grn_object_accessor_p (VALUE self)
 /*
  * Checks whether the object is key accessor or not.
  *
+ * @example `true` case: `column("_key")` is an accessor and it's an accessor for `_key`
+ *   Groonga::Schema.create_table("Users", :key_type => :short_text)
+ *   users = Groonga["Users"]
+ *   users.column("_key").key_accessor? # => true
+ *
+ * @example `false` case: `column("_id")` is an accessor but it's not an accessor for `_key`
+ *   Groonga::Schema.create_table("Users", :key_type => :short_text)
+ *   users = Groonga["Users"]
+ *   users.column("_id").key_accessor? # => false
+ *
  * @overload key_accessor?
  *   @return [Boolean] `true` if the object is key accessor,
  *     `false` otherwise.
-------------- next part --------------
HTML����������������������������...
下載 



More information about the Groonga-commit mailing list
Back to archive index