struct GGrnCommand

struct GGrnCommand;

A GGrnCommand is an object to create a Groonga command string. It is executable by ggrn_context_execute_command().

struct GGrnCommandClass

struct GGrnCommandClass {
    GObjectClass parent_class;
};

ggrn_command_new ()

GGrnCommand *       ggrn_command_new                    (GGrnContext *context,
                                                         const gchar *name);

Allocates a new GGrnCommand.

Since 1.0.0

ggrn_command_add_argument ()

void                ggrn_command_add_argument           (GGrnCommand *command,
                                                         const gchar *name,
                                                         const gchar *value);

Adds an argument of the command.

If you add the same name argument twice, the old argument value is overrode.

Since 1.0.0

ggrn_command_execute ()

gchar *             ggrn_command_execute                (GGrnCommand *command);

Executes the command and returns the executed result.

Since 1.0.0

ggrn_command_to_path ()

gchar *             ggrn_command_to_path                (GGrnCommand *command);

Formats the command as path format like the following:

/d/table_create?name=Logs&flags=TABLE_NO_KEY

Since 1.0.0

ggrn_command_to_command_line ()

gchar *             ggrn_command_to_command_line        (GGrnCommand *command);

Formats the command as command line format like the following:

table_create --name Logs --flags TABLE_NO_KEY

Since 1.0.0

The "context" property

  "context"                  GGrnContext*          : Read / Write / Construct Only

The context for the command.

The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

The name of the command.

Default value: NULL