/*
* _database_ をロックする。ロックに失敗した場合は
* {Groonga::ResourceDeadlockAvoided} 例外が発生する。
*
* @overload lock(options={})
* @!macro [new] database.lock.arguments
* @param [::Hash] options 利用可能なオプションは以下の通り。
* @option options :timeout
* ロックを獲得できなかった場合は _:timeout_ 秒間ロックの獲
* 得を試みる。 _:timeout_ 秒以内にロックを獲得できなかった
* 場合は例外が発生する。
* @!macro database.lock.arguments
* @overload lock(options={})
* @yield ブロックを指定した場合はブロックを抜けたときにunlockする。
* @!macro database.lock.arguments
*/
static VALUE
rb_grn_database_lock (int argc, VALUE *argv, VALUE self)
{
grn_ctx *context;
grn_obj *database;
int timeout = 0;
grn_rc rc;
VALUE options, rb_timeout;
rb_scan_args(argc, argv, "01", &options);
rb_grn_database_deconstruct(SELF(self), &database, &context,
NULL, NULL, NULL, NULL);
rb_grn_scan_options(options,
"timeout", &rb_timeout,
NULL);
if (!NIL_P(rb_timeout))
timeout = NUM2UINT(rb_timeout);
rc = grn_obj_lock(context, database, GRN_ID_NIL, 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_database_unlock, self);
} else {
return Qnil;
}
}
/*
* データベース内のオブジェクトを順番にブロックに渡す。
*
* @example すべてのオブジェクトの名前を表示する:
* database.each do |object|
* p object.name
* end
*
* @example すべてのオブジェクトの名前をID順で表示する:
* database.each(:order_by => :id) do |object|
* p object.name
* end
*
* @example すべてのオブジェクトの名前をキー名の降順で表示する:
* database.each(:order_by => :key, :order => :desc) do |object|
* p object.name
* end
*
* @overload each(options=nil)
* @macro [new] database.each.options
* @param options [::Hash]
* @yield [object]
* @option options :order
* +:asc+ または +:ascending+ を指定すると昇順にレコードを取
* り出す。（デフォルト）
* +:desc+ または +:descending+ を指定すると降順にレコードを
* 取り出す。
* @option options :order_by (:key)
* +:id+ を指定するとID順にレコードを取り出す。
* +:key+ 指定するとキー順にレコードを取り出す。（デフォル
* ト）
* @macro database.each.options
*
* @overload each(options=nil)
* @macro database.each.options
* @option options :ignore_missing_object (false)
* Specify +true+ to ignore missing object. Otherwise, an exception is
* raised for missing object.
*
* @since 2.0.5
*/
static VALUE
rb_grn_database_each (int argc, VALUE *argv, VALUE self)
{
grn_ctx *context = NULL;
grn_obj *database;
grn_table_cursor *cursor;
VALUE rb_cursor, rb_options, rb_order, rb_order_by;
VALUE rb_ignore_missing_object;
int flags = 0;
grn_id id;
VALUE exception;
RETURN_ENUMERATOR(self, argc, argv);
rb_grn_database_deconstruct(SELF(self), &database, &context,
NULL, NULL, NULL, NULL);
rb_scan_args(argc, argv, "01", &rb_options);
rb_grn_scan_options(rb_options,
"order", &rb_order,
"order_by", &rb_order_by,
"ignore_missing_object", &rb_ignore_missing_object,
NULL);
flags |= rb_grn_table_cursor_order_to_flag(rb_order);
flags |= rb_grn_table_cursor_order_by_to_flag(GRN_TABLE_PAT_KEY,
self,
rb_order_by);
cursor = grn_table_cursor_open(context, database, NULL, 0, NULL, 0,
0, -1,
flags);
rb_cursor = GRNTABLECURSOR2RVAL(Qnil, context, cursor);
rb_iv_set(self, "cursor", rb_cursor);
while ((id = grn_table_cursor_next(context, cursor)) != GRN_ID_NIL) {
grn_obj *object;
object = grn_ctx_at(context, id);
if (!object && RTEST(rb_ignore_missing_object)) {
context->rc = GRN_SUCCESS;
continue;
}
exception = rb_grn_context_to_exception(context, self);
if (!NIL_P(exception)) {
rb_grn_object_close(rb_cursor);
rb_iv_set(self, "cursor", Qnil);
rb_exc_raise(exception);
}
if (object) {
rb_yield(GRNOBJECT2RVAL(Qnil, context, object, GRN_FALSE));
}
}
rb_grn_object_close(rb_cursor);
rb_iv_set(self, "cursor", Qnil);
return Qnil;
}
/*
* _database_ がロックされていれば +true+ を返す。
*
* @overload locked?
*/
static VALUE
rb_grn_database_is_locked (VALUE self)
{
grn_ctx *context;
grn_obj *database;
rb_grn_database_deconstruct(SELF(self), &database, &context,
NULL, NULL, NULL, NULL);
return CBOOL2RVAL(grn_obj_is_locked(context, database));
}
/*
* _database_ の最終更新時刻を現在時刻にする。
*
* @overload touch
*/
static VALUE
rb_grn_database_touch (VALUE self)
{
grn_ctx *context;
grn_obj *database;
rb_grn_database_deconstruct(SELF(self), &database, &context,
NULL, NULL, NULL, NULL);
grn_db_touch(context, database);
return Qnil;
}
/*
* @overload unmap()
*
* Unmaps all mapped tables and columns in database.
*
* It frees resources for them.
*
* Normally, you don't need to unmap explicitly. Because OS manages
* resourced for mapped tables and columns cleverly.
*
* @return [void]
*
* @since 5.0.5
*/
static VALUE
rb_grn_database_unmap (VALUE self)
{
grn_rc rc;
grn_ctx *context;
grn_obj *database;
rb_grn_database_deconstruct(SELF(self), &database, &context,
NULL, NULL, NULL, NULL);
rc = grn_db_unmap(context, database);
rb_grn_context_check(context, self);
rb_grn_rc_check(rc, self);
return Qnil;
}
/*
* call-seq:
* database.each {|object| ...}
* database.each(options=nil) {|object| ...}
*
* データベース内のオブジェクトを順番にブロックに渡す。
*
* @example すべてのオブジェクトの名前を表示する:
* database.each do |object|
* p object.name
* end
*
* @example すべてのオブジェクトの名前をID順で表示する:
* database.each(:order_by => :id) do |object|
* p object.name
* end
*
* @example すべてのオブジェクトの名前をキー名の降順で表示する:
* database.each(:order_by => :key, :order => :desc) do |object|
* p object.name
* end
*
* @param options [::Hash]
* @option options :order The order
* +:asc+ または +:ascending+ を指定すると昇順にレコードを取
* り出す。（デフォルト）
*
* +:desc+ または +:descending+ を指定すると降順にレコードを
* 取り出す。
*
* @option options :order_by (:key) The ordef by
* +:id+ を指定するとID順にレコードを取り出す。
*
* +:key+ 指定するとキー順にレコードを取り出す。（デフォル
* ト）
*
*/
static VALUE
rb_grn_database_each (int argc, VALUE *argv, VALUE self)
{
grn_ctx *context = NULL;
grn_obj *database;
grn_table_cursor *cursor;
VALUE rb_cursor, rb_options, rb_order, rb_order_by;
int flags = 0;
grn_id id;
rb_grn_database_deconstruct(SELF(self), &database, &context,
NULL, NULL, NULL, NULL);
rb_scan_args(argc, argv, "01", &rb_options);
rb_grn_scan_options(rb_options,
"order", &rb_order,
"order_by", &rb_order_by,
NULL);
flags |= rb_grn_table_cursor_order_to_flag(rb_order);
flags |= rb_grn_table_cursor_order_by_to_flag(GRN_TABLE_PAT_KEY,
self,
rb_order_by);
cursor = grn_table_cursor_open(context, database, NULL, 0, NULL, 0,
0, -1,
flags);
rb_cursor = GRNTABLECURSOR2RVAL(Qnil, context, cursor);
rb_iv_set(self, "cursor", rb_cursor);
while ((id = grn_table_cursor_next(context, cursor)) != GRN_ID_NIL) {
grn_obj *object;
object = grn_ctx_at(context, id);
if (object)
rb_yield(GRNOBJECT2RVAL(Qnil, context, object, GRN_FALSE));
}
rb_grn_object_close(rb_cursor);
rb_iv_set(self, "cursor", Qnil);
return Qnil;
}
/*
* Removes an object forcibly.
*
* Normally, you should use {Groonga::Object#remove}.
*
* @overload remove_force(name)
*
* @param [String] name The target object name.
*
* @since 6.0.9
*/
static VALUE
rb_grn_database_remove_force (VALUE self, VALUE rb_name)
{
grn_rc rc;
grn_ctx *context;
char *name;
int name_size;
rb_grn_database_deconstruct(SELF(self), NULL, &context,
NULL, NULL, NULL, NULL);
name = StringValueCStr(rb_name);
name_size = RSTRING_LEN(rb_name);
rc = grn_obj_remove_force(context, name, name_size);
rb_grn_context_check(context, self);
rb_grn_rc_check(rc, self);
return Qnil;
}
/*
* Defrags all variable size columns in the database.
*
* @return [Integer] the number of defraged segments
* @overload defrag(options={})
* @param [::Hash] options option for defrag
* @option options [Integer] :threshold (0) the threshold to
* determine whether a segment is defraged. Available
* values are -4..22. -4 means all segments are defraged.
* 22 means no segment is defraged.
* @since 1.2.6
*/
static VALUE
rb_grn_database_defrag (int argc, VALUE *argv, VALUE self)
{
grn_ctx *context;
grn_obj *database;
int n_segments;
VALUE options, rb_threshold;
int threshold = 0;
rb_scan_args(argc, argv, "01", &options);
rb_grn_scan_options(options,
"threshold", &rb_threshold,
NULL);
if (!NIL_P(rb_threshold)) {
threshold = NUM2INT(rb_threshold);
}
rb_grn_database_deconstruct(SELF(self), &database, &context,
NULL, NULL, NULL, NULL);
n_segments = grn_obj_defrag(context, database, threshold);
rb_grn_context_check(context, self);
return INT2NUM(n_segments);
}