gda_sql_builder_new ()

GdaSqlBuilder *
gda_sql_builder_new (GdaSqlStatementType stmt_type);

Create a new GdaSqlBuilder object to build GdaStatement or GdaSqlStatement objects of type stmt_type

Since: 4.2

gda_sql_builder_get_statement ()

GdaStatement *
gda_sql_builder_get_statement (GdaSqlBuilder *builder,
                               GError **error);

Creates a new GdaStatement statement from builder 's contents.

Since: 4.2

gda_sql_builder_get_sql_statement ()

GdaSqlStatement *
gda_sql_builder_get_sql_statement (GdaSqlBuilder *builder);

Creates a new GdaSqlStatement structure from builder 's contents.

The returned pointer belongs to builder 's internal representation. Use gda_sql_statement_copy() if you need to keep it.

[skip]

Since: 4.2

gda_sql_builder_set_table ()

void
gda_sql_builder_set_table (GdaSqlBuilder *builder,
                           const gchar *table_name);

Valid only for: INSERT, UPDATE, DELETE statements

Sets the name of the table on which the built statement operates.

Since: 4.2

gda_sql_builder_add_field_value ()

void
gda_sql_builder_add_field_value (GdaSqlBuilder *builder,
                                 const gchar *field_name,
                                 GType type,
                                 ...);

Valid only for: INSERT, UPDATE statements.

Specifies that the field represented by field_name will be set to the value identified by @... of type type . See gda_sql_builder_add_expr() for more information.

This is a C convenience function. See also gda_sql_builder_add_field_value_as_gvalue().

Since: 4.2

gda_sql_builder_add_field_value_as_gvalue ()

void
gda_sql_builder_add_field_value_as_gvalue
                               (GdaSqlBuilder *builder,
                                const gchar *field_name,
                                const GValue *value);

Valid only for: INSERT, UPDATE statements.

Specifies that the field represented by field_name will be set to the value identified by value

Since: 4.2

gda_sql_builder_add_field_value_id ()

void
gda_sql_builder_add_field_value_id (GdaSqlBuilder *builder,
                                    GdaSqlBuilderId field_id,
                                    GdaSqlBuilderId value_id);

Valid only for: INSERT, UPDATE, SELECT statements

See also gda_sql_builder_add_field_value() and gda_sql_builder_add_field_value_as_gvalue().

Since: 4.2

gda_sql_builder_add_function ()

GdaSqlBuilderId
gda_sql_builder_add_function (GdaSqlBuilder *builder,
                              const gchar *func_name,
                              ...);

Builds a new expression which represents a function applied to some arguments

Since: 4.2

gda_sql_builder_add_function_v ()

GdaSqlBuilderId
gda_sql_builder_add_function_v (GdaSqlBuilder *builder,
                                const gchar *func_name,
                                const GdaSqlBuilderId *args,
                                gint args_size);

Builds a new expression which represents a function applied to some arguments

[rename-to gda_sql_builder_add_function]

Since: 4.2

gda_sql_builder_add_id ()

GdaSqlBuilderId
gda_sql_builder_add_id (GdaSqlBuilder *builder,
                        const gchar *str);

Defines an expression representing an identifier in builder , which may be reused to build other parts of a statement, for instance as a parameter to gda_sql_builder_add_cond() or gda_sql_builder_add_field_value_id().

The new expression will contain the str literal. For example:

gda_sql_builder_add_id (b, "name")
gda_sql_builder_add_id (b, "date")

will be rendered as SQL as:

name
"date"

because "date" is an SQL reserved keyword.

For fields, see gda_sql_builder_add_field_id().

Since: 4.2

gda_sql_builder_add_field_id ()

GdaSqlBuilderId
gda_sql_builder_add_field_id (GdaSqlBuilder *builder,
                              const gchar *field_name,
                              const gchar *table_name);

Defines an expression representing a field in builder , which may be reused to build other parts of a statement, for instance as a parameter to gda_sql_builder_add_cond() or gda_sql_builder_add_field_value_id().

Calling this with a NULL table_name is equivalent to calling gda_sql_builder_add_id().

For SELECT queries, see gda_sql_builder_select_add_field().

Since: 4.2

gda_sql_builder_add_expr ()

GdaSqlBuilderId
gda_sql_builder_add_expr (GdaSqlBuilder *builder,
                          GdaDataHandler *dh,
                          GType type,
                          ...);

Defines an expression in builder which may be reused to build other parts of a statement.

The new expression will contain the value passed as the @... argument.

If type is G_TYPE_STRING then it is possible to customize how the value has to be interpreted by passing a specific GdaDataHandler object as dh . This feature is very rarely used and the dh argument should generally be NULL.

Note that for composite types such as GdaNumeric, Gdate, GdaTime, ... pointer to these structures are expected, they should no be passed by value. For example:

GDate *date = g_date_new_dmy (27, G_DATE_MAY, 1972);
id = gda_sql_builder_add_expr (b, NULL, G_TYPE_DATE, date);
g_date_free (date);

id = gda_sql_builder_add_expr (b, NULL, G_TYPE_STRING, "my string");
id = gda_sql_builder_add_expr (b, NULL, G_TYPE_INT, 25);

will correspond in SQL to:

'05-27-1972'
'my string'
25

[skip]

Since: 4.2

gda_sql_builder_add_expr_value ()

GdaSqlBuilderId
gda_sql_builder_add_expr_value (GdaSqlBuilder *builder,
                                GdaDataHandler *dh,
                                const GValue *value);

Defines an expression in builder which may be reused to build other parts of a statement.

The new expression will contain the value passed as the value argument.

If value 's type is a string then it is possible to customize how the value has to be interpreted by passing a specific GdaDataHandler object as dh . This feature is very rarely used and the dh argument should generally be NULL.

Since: 4.2

gda_sql_builder_add_param ()

GdaSqlBuilderId
gda_sql_builder_add_param (GdaSqlBuilder *builder,
                           const gchar *param_name,
                           GType type,
                           gboolean nullok);

Defines a parameter in builder which may be reused to build other parts of a statement.

The new expression will contain the string literal. For example:

gda_sql_builder_add_param (b, "age", G_TYPE_INT, FALSE)

will be rendered as SQL as:

##age::int

Since: 4.2

gda_sql_builder_add_case ()

GdaSqlBuilderId
gda_sql_builder_add_case (GdaSqlBuilder *builder,
                          GdaSqlBuilderId test_expr,
                          GdaSqlBuilderId else_expr,
                          ...);

Creates a new CASE ... WHEN ... THEN ... ELSE ... END expression.

Since: 4.2

gda_sql_builder_add_case_v ()

GdaSqlBuilderId
gda_sql_builder_add_case_v (GdaSqlBuilder *builder,
                            GdaSqlBuilderId test_expr,
                            GdaSqlBuilderId else_expr,
                            const GdaSqlBuilderId *when_array,
                            const GdaSqlBuilderId *then_array,
                            gint args_size);

Creates a new CASE ... WHEN ... THEN ... ELSE ... END expression. The WHEN expression and the THEN expression IDs are taken from the when_array and then_array at the same index, for each index inferior to args_size .

[rename-to gda_sql_builder_add_case]

Since: 4.2

gda_sql_builder_add_sub_select ()

GdaSqlBuilderId
gda_sql_builder_add_sub_select (GdaSqlBuilder *builder,
                                GdaSqlStatement *sqlst);

Adds an expression which is a subselect.

[skip]

Since: 4.2

gda_sql_builder_add_cond ()

GdaSqlBuilderId
gda_sql_builder_add_cond (GdaSqlBuilder *builder,
                          GdaSqlOperatorType op,
                          GdaSqlBuilderId op1,
                          GdaSqlBuilderId op2,
                          GdaSqlBuilderId op3);

Builds a new expression which represents a condition (or operation).

Since: 4.2

gda_sql_builder_add_cond_v ()

GdaSqlBuilderId
gda_sql_builder_add_cond_v (GdaSqlBuilder *builder,
                            GdaSqlOperatorType op,
                            const GdaSqlBuilderId *op_ids,
                            gint op_ids_size);

Builds a new expression which represents a condition (or operation).

As a side case, if ops_ids_size is 1, then op is ignored, and the returned ID represents op_ids [0] (this avoids any problem for example when op is GDA_SQL_OPERATOR_TYPE_AND and there is in fact only one operand).

Since: 4.2

gda_sql_builder_set_where ()

void
gda_sql_builder_set_where (GdaSqlBuilder *builder,
                           GdaSqlBuilderId cond_id);

Valid only for: UPDATE, DELETE, SELECT statements

Sets the WHERE condition of the statement

Since: 4.2

gda_sql_builder_select_add_target ()

GdaSqlBuilderId
gda_sql_builder_select_add_target (GdaSqlBuilder *builder,
                                   const gchar *table_name,
                                   const gchar *alias);

Adds a new target to a SELECT statement

Since: 4.2

gda_sql_builder_select_add_target_id ()

GdaSqlBuilderId
gda_sql_builder_select_add_target_id (GdaSqlBuilder *builder,
                                      GdaSqlBuilderId table_id,
                                      const gchar *alias);

Adds a new target to a SELECT statement. If there already exists a target representing the same table and the same alias (or with the same absence of alias) then the same target ID is returned instead of the ID of a new target.

Since: 4.2

gda_sql_builder_select_add_field ()

GdaSqlBuilderId
gda_sql_builder_select_add_field (GdaSqlBuilder *builder,
                                  const gchar *field_name,
                                  const gchar *table_name,
                                  const gchar *alias);

Valid only for: SELECT statements.

Add a selected selected item to the SELECT statement.

For non-SELECT statements, see gda_sql_builder_add_field_id().

Since: 4.2

gda_sql_builder_select_join_targets ()

GdaSqlBuilderId
gda_sql_builder_select_join_targets (GdaSqlBuilder *builder,
                                     GdaSqlBuilderId left_target_id,
                                     GdaSqlBuilderId right_target_id,
                                     GdaSqlSelectJoinType join_type,
                                     GdaSqlBuilderId join_expr);

Joins two targets in a SELECT statement, using the join_type type of join.

Note: if the target represented by left_target_id is actually situated after (on the right) of the target represented by right_target_id , then the actual type of join may be switched from GDA_SQL_SELECT_JOIN_LEFT to GDA_SQL_SELECT_JOIN_RIGHT or from GDA_SQL_SELECT_JOIN_RIGHT to GDA_SQL_SELECT_JOIN_LEFT.

[skip]

Since: 4.2

gda_sql_builder_join_add_field ()

void
gda_sql_builder_join_add_field (GdaSqlBuilder *builder,
                                GdaSqlBuilderId join_id,
                                const gchar *field_name);

Alter a join in a SELECT statement to make its condition use equal field values in the fields named field_name in both tables, via the USING keyword.

Since: 4.2

gda_sql_builder_select_order_by ()

void
gda_sql_builder_select_order_by (GdaSqlBuilder *builder,
                                 GdaSqlBuilderId expr_id,
                                 gboolean asc,
                                 const gchar *collation_name);

Adds a new ORDER BY expression to a SELECT statement.

Since: 4.2

gda_sql_builder_select_set_distinct ()

void
gda_sql_builder_select_set_distinct (GdaSqlBuilder *builder,
                                     gboolean distinct,
                                     GdaSqlBuilderId expr_id);

Defines (if distinct is TRUE) or removes (if distinct is FALSE) a DISTINCT clause for a SELECT statement.

If distinct is TRUE, then the ID of an expression can be specified as the expr_id argument: if not 0, this is the expression used to apply the DISTINCT clause on (the resuting SQL will then usually be "... DISTINCT ON <expression>...").

Since: 4.2

gda_sql_builder_select_set_limit ()

void
gda_sql_builder_select_set_limit (GdaSqlBuilder *builder,
                                  GdaSqlBuilderId limit_count_expr_id,
                                  GdaSqlBuilderId limit_offset_expr_id);

If limit_count_expr_id is not 0, defines the maximum number of rows in the GdaDataModel resulting from the execution of the built statement. In this case, the offset from which the rows must be collected can be defined by the limit_offset_expr_id expression if not 0 (note that this feature may not be supported by all the database providers).

If limit_count_expr_id is 0, then removes any LIMIT which may have been imposed by a previous call to this method.

Since: 4.2

gda_sql_builder_select_set_having ()

void
gda_sql_builder_select_set_having (GdaSqlBuilder *builder,
                                   GdaSqlBuilderId cond_id);

Valid only for: SELECT statements

Sets the HAVING condition of the statement

Since: 4.2

gda_sql_builder_select_group_by ()

void
gda_sql_builder_select_group_by (GdaSqlBuilder *builder,
                                 GdaSqlBuilderId expr_id);

Valid only for: SELECT statements

Adds the expr_id expression to the GROUP BY clause's expressions list

Since: 4.2

gda_sql_builder_compound_add_sub_select ()

void
gda_sql_builder_compound_add_sub_select
                               (GdaSqlBuilder *builder,
                                GdaSqlStatement *sqlst);

Add a sub select to a COMPOUND statement

[skip]

Since: 4.2

gda_sql_builder_compound_set_type ()

void
gda_sql_builder_compound_set_type (GdaSqlBuilder *builder,
                                   GdaSqlStatementCompoundType compound_type);

Changes the type of compound which builder is making, for a COMPOUND statement

Since: 4.2

gda_sql_builder_export_expression ()

GdaSqlExpr *
gda_sql_builder_export_expression (GdaSqlBuilder *builder,
                                   GdaSqlBuilderId id);

Exports a part managed by builder as a new GdaSqlExpr, which can represent any expression in a statement.

[skip]

Since: 4.2

gda_sql_builder_import_expression ()

GdaSqlBuilderId
gda_sql_builder_import_expression (GdaSqlBuilder *builder,
                                   GdaSqlExpr *expr);

Imports the expr into builder .

[skip]

Since: 4.2

struct GdaSqlBuilder

struct GdaSqlBuilder;

GdaSqlBuilderId

typedef guint GdaSqlBuilderId;

The “stmt-type” property

  “stmt-type”                GdaSqlStatementType

Specifies the type of statement to be built, can only be GDA_SQL_STATEMENT_SELECT, GDA_SQL_STATEMENT_INSERT, GDA_SQL_STATEMENT_UPDATE or GDA_SQL_STATEMENT_DELETE

Owner: GdaSqlBuilder

Flags: Write / Construct Only

Default value: GDA_SQL_STATEMENT_UNKNOWN