Commands

Commands — Issuing commands to the provider

Functions

Types and Values

Object Hierarchy

    GBoxed
    ╰── GdaCommand

Description

The GdaCommand structure holds data needed to issue a command to the providers. Applications usually create a GdaCommand (via gda_command_new), set its properties (via the gda_command_set_* functions) and pass it over to the database using the GdaConnection functions.

GdaCommand commands can only be plain SQL without any variable in it, they are however very easy to use. For prepared statements and/or usage of variables in SQL statements, use a GdaQuery object.

Functions

gda_command_new ()

GdaCommand *
gda_command_new (const gchar *text,
                 GdaCommandType type,
                 GdaCommandOptions options);

Creates a new GdaCommand from the parameters that should be freed by calling gda_command_free.

If there are conflicting options, this will set options to GDA_COMMAND_OPTION_DEFAULT.

Parameters

text

the text of the command.

 

type

a GdaCommandType value.

 

options

a GdaCommandOptions value.

 

Returns

a newly allocated GdaCommand.


gda_command_free ()

void
gda_command_free (GdaCommand *cmd);

Frees the resources allocated by gda_command_new.

Parameters

cmd

a GdaCommand.

 

gda_command_copy ()

GdaCommand *
gda_command_copy (GdaCommand *cmd);

Creates a new GdaCommand from an existing one.

Parameters

cmd

command to get a copy from.

 

Returns

a newly allocated GdaCommand with a copy of the data in cmd .


gda_command_get_text ()

const gchar *
gda_command_get_text (GdaCommand *cmd);

Gets the command text held by cmd .

Parameters

cmd

a GdaCommand.

 

Returns

the command string of cmd .


gda_command_set_text ()

void
gda_command_set_text (GdaCommand *cmd,
                      const gchar *text);

Sets the command text of cmd .

Parameters

cmd

a GdaCommand

 

text

the command text.

 

gda_command_get_command_type ()

GdaCommandType
gda_command_get_command_type (GdaCommand *cmd);

Gets the command type of cmd .

Parameters

cmd

a GdaCommand.

 

Returns

the command type of cmd .


gda_command_set_command_type ()

void
gda_command_set_command_type (GdaCommand *cmd,
                              GdaCommandType type);

Sets the command type of cmd .

Parameters

cmd

a GdaCommand

 

type

the command type.

 

gda_command_get_options ()

GdaCommandOptions
gda_command_get_options (GdaCommand *cmd);

Gets the command options of cmd .

Parameters

cmd

a GdaCommand.

 

Returns

the command options of cmd .


gda_command_set_options ()

void
gda_command_set_options (GdaCommand *cmd,
                         GdaCommandOptions options);

Sets the command options of cmd .

Parameters

cmd

a GdaCommand

 

options

the command options.

 

Types and Values

enum GdaCommandOptions

And OR'ed combination of GDA_COMMAND_OPTIONS_* values.

Members

GDA_COMMAND_OPTION_IGNORE_ERRORS

   

GDA_COMMAND_OPTION_STOP_ON_ERRORS

   

GDA_COMMAND_OPTION_BAD_OPTION

   

enum GdaCommandType

Members

GDA_COMMAND_TYPE_SQL

the text of the command is composed of zero or more SQL sentences.

 

GDA_COMMAND_TYPE_XML

   

GDA_COMMAND_TYPE_PROCEDURE

   

GDA_COMMAND_TYPE_TABLE

the text of the command is composed of zero or more table names.

 

GDA_COMMAND_TYPE_SCHEMA

   

GDA_COMMAND_TYPE_INVALID

   

struct GdaCommand

struct GdaCommand {
	gchar             *text;
	GdaCommandType     type;
	GdaCommandOptions  options;
};