index_column.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct grn_index_column_diff_options	grn_index_column_diff_options
	Options for grn_index_column_diff().

Functions
GRN_API grn_rc	grn_index_column_diff (grn_ctx *ctx, grn_obj *index_column, grn_obj **diff)
	Compute differences between expected index content and actual index content.
GRN_API grn_index_column_diff_options *	grn_index_column_diff_options_open (grn_ctx *ctx)
	Create a new options.
GRN_API grn_rc	grn_index_column_diff_options_close (grn_ctx *ctx, grn_index_column_diff_options *options)
	Free the options.
GRN_API grn_log_level	grn_index_column_diff_options_get_progress_log_level (grn_ctx *ctx, grn_index_column_diff_options *options)
	Get the log level that is used for progress logs.
GRN_API grn_rc	grn_index_column_diff_options_set_progress_log_level (grn_ctx *ctx, grn_index_column_diff_options *options, grn_log_level level)
	Set the log level that is used for progress logs.
GRN_API grn_rc	grn_index_column_diff_full (grn_ctx *ctx, grn_obj *index_column, grn_index_column_diff_options *options, grn_obj **diff)
	Compute differences between expected index content and actual index content with options.
GRN_API bool	grn_index_column_is_usable (grn_ctx *ctx, grn_obj *index_column, grn_operator op)

Typedef Documentation

grn_index_column_diff_options

typedef struct grn_index_column_diff_options grn_index_column_diff_options

Options for grn_index_column_diff().

Since

14.1.3

Function Documentation

grn_index_column_diff()

GRN_API grn_rc grn_index_column_diff	(	grn_ctx *	ctx,
		grn_obj *	index_column,
		grn_obj **	diff
	)

Compute differences between expected index content and actual index content.

See grn_index_column_diff_full() for details. This uses the default options.

Parameters

ctx	The context object.
index_column	The target index column.
diff	The result. This is an output parameter.

Returns

GRN_SUCCESS on success, the appropriate grn_rc on error.

grn_index_column_diff_full()

GRN_API grn_rc grn_index_column_diff_full	(	grn_ctx *	ctx,
		grn_obj *	index_column,
		grn_index_column_diff_options *	options,
		grn_obj **	diff
	)

Compute differences between expected index content and actual index content with options.

You can use this to check whether the target index column is broken or not.

Expected index content is computed from the sources. So you can't update the sources while this is executing. If you update the sources, the result of this may be incorrect.

Parameters

ctx	The context object.
index_column	The target index column.
options	The target options.
diff	The result. This is an output parameter.

Returns

GRN_SUCCESS on success, the appropriate grn_rc on error.

Since

14.1.3

grn_index_column_diff_options_close()

GRN_API grn_rc grn_index_column_diff_options_close	(	grn_ctx *	ctx,
		grn_index_column_diff_options *	options
	)

Free the options.

Parameters

ctx	The context object.
options	The options to be freed.

Returns

GRN_SUCCESS on success, the appropriate grn_rc on error.

Since

14.1.3

grn_index_column_diff_options_get_progress_log_level()

GRN_API grn_log_level grn_index_column_diff_options_get_progress_log_level	(	grn_ctx *	ctx,
		grn_index_column_diff_options *	options
	)

Get the log level that is used for progress logs.

Parameters

ctx	The context object.
options	The target options.

Returns

The log level to be used for progress logs. If options is NULL, the default log level is returned.

Since

14.1.3

grn_index_column_diff_options_open()

GRN_API grn_index_column_diff_options * grn_index_column_diff_options_open

(

grn_ctx *

ctx

)

Create a new options.

Parameters

ctx	The context object.

Returns

The newly created options on success, NULL on error.

    See `ctx->rc` for error details.

Since

14.1.3

grn_index_column_diff_options_set_progress_log_level()

GRN_API grn_rc grn_index_column_diff_options_set_progress_log_level	(	grn_ctx *	ctx,
		grn_index_column_diff_options *	options,
		grn_log_level	level
	)

Set the log level that is used for progress logs.

Parameters

ctx	The context object.
options	The target options. Must not NULL.
level	The log level for progress logs.

Returns

GRN_SUCCESS on success, the appropriate grn_rc on error.

Since

14.1.3

grn_index_column_is_usable()

GRN_API bool grn_index_column_is_usable	(	grn_ctx *	ctx,
		grn_obj *	index_column,
		grn_operator	op
	)