the type of statement to build
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
.
the expression ID representing the test of the CASE, or %0
the expression ID representing the ELSE expression, or %0
an array containing each WHEN expression ID, having at least args_size
elements
an array containing each THEN expression ID, having at least args_size
elements
Builds a new expression which represents a condition (or operation).
type of condition
the ID of the 1st argument (not 0)
the ID of the 2nd argument (may be %0 if op
needs only one operand)
the ID of the 3rd argument (may be %0 if op
needs only one or two operand)
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).
type of condition
an array of ID for the arguments (not %0)
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.
value to set the expression to, or %NULL or a GDA_TYPE_NULL value to represent an SQL NULL
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().
a field name
a table name, or %NULL
Valid only for: INSERT, UPDATE statements.
Specifies that the field represented by field_name
will be set to the value identified
by value
a field name
value to set the field to, or %NULL or a GDA_TYPE_NULL value to represent an SQL NULL
Valid only for: INSERT, UPDATE, SELECT statements
field_id
will be set to the value identified
by value_id
.value_id
is not %0, then use it as an
aliasfield_id
represents an SQL identifier (obtained using gda_sql_builder_add_id()): then if
value_id
is not %0 then specifies that the field represented by field_id
will be set to the
value identified by value_id,
otherwise just specifies a named field to be given a value.
If field_id
represents a sub SELECT (obtained using gda_sql_builder_add_sub_select()), then
this method call defines the sub SELECT from which values to insert are taken.
See also gda_sql_builder_add_field_value() and gda_sql_builder_add_field_value_as_gvalue().
the ID of the field's name or definition
the ID of the value to set the field to, or %0
Builds a new expression which represents a function applied to some arguments
the functions's name
an array of IDs representing the function's arguments
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:
will be rendered as SQL as:
because "date" is an SQL reserved keyword.
For fields, see gda_sql_builder_add_field_id().
a string
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:
will be rendered as SQL as:
parameter's name
parameter's type
TRUE if the parameter can be set to %NULL
Adds an expression which is a subselect.
a pointer to a #GdaSqlStatement, which has to be a SELECT or compound SELECT. This will be copied.
Creates a binding between source_property
on source
and target_property
on target
.
Whenever the source_property
is changed the target_property
is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags
contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property
on target
changes then the source_property
on source
will be updated as well.
The binding will automatically be removed when either the source
or the
target
instances are finalized. To remove the binding without affecting the
source
and the target
you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source
and target
are only used from a single thread and it
is clear that both source
and target
outlive the binding. Especially it
is not safe to rely on this if the binding, source
or target
can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
Creates a binding between source_property
on source
and target_property
on target,
allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source
to the target,
or %NULL to use the default
a #GClosure wrapping the transformation function from the target
to the source,
or %NULL to use the default
Add a sub select to a COMPOUND statement
a pointer to a #GdaSqlStatement, which has to be a SELECT or compound SELECT. This will be copied.
Add a sub select to a COMPOUND statement
a #GdaSqlBuilder, which has to be a SELECT or compound SELECT. This will be copied.
Changes the type of compound which builder
is making, for a COMPOUND statement
a type of compound
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object
. If the freeze count is
non-zero, the emission of "notify" signals on object
is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Gets a property of an object.
The value
can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
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.
Gets n_properties
properties for an object
.
Obtained properties will be set to values
. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Imports the an expression located in query
into builder
.
a #GdaSqlBuilder object to get expression from
a #GdaSqlBuilderId of the expression in query
Checks whether object
has a [floating][floating-ref] reference.
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.
the ID of the join to modify (not %0)
the name of the field to use in the join condition (not %NULL)
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object
.
Emits a "notify" signal for the property specified by pspec
on object
.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object
.
Increase the reference count of object,
and possibly remove the
[floating][floating-ref] reference, if object
has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object
will be propagated to the return type
under the same conditions as for g_object_ref().
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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().
a field name
a table name, or %NULL
an alias (eg. for the "AS" clause), or %NULL
Adds a new target to a SELECT statement
the name of the target table
the alias to give to the target, or %NULL
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.
the ID of the expression holding a table reference (not %0)
the alias to give to the target, or %NULL
Valid only for: SELECT statements
Adds the expr_id
expression to the GROUP BY clause's expressions list
the ID of the expression to set use in the GROUP BY clause, or 0 to unset any previous GROUP BY clause
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.
the ID of the left target to use (not %0)
the ID of the right target to use (not %0)
the type of join
joining expression's ID, or %0
Adds a new ORDER BY expression to a SELECT statement.
the ID of the expression to use during sorting (not %0)
%TRUE for an ascending sorting
name of the collation to use when sorting, or %NULL
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>...").
set to %TRUE to have the DISTINCT requirement
the ID of the DISTINCT ON expression, or %0 if no expression is to be used. It is ignored if distinct
is %FALSE.
Valid only for: SELECT statements
Sets the HAVING condition of the statement
the ID of the expression to set as HAVING condition, or 0 to unset any previous HAVING condition
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.
the ID of the LIMIT expression, or %0
the ID of the OFFSET expression, or %0
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key
is converted to a #GQuark using g_quark_from_string().
This means a copy of key
is kept permanently (even after object
has been
finalized) — so it is recommended to only use a small, bounded set of values
for key
in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets a property on an object.
the name of the property to set
the value
Valid only for: INSERT, UPDATE, DELETE statements
Sets the name of the table on which the built statement operates.
a table name
Valid only for: UPDATE, DELETE, SELECT statements
Sets the WHERE condition of the statement
the ID of the expression to set as WHERE condition, or 0 to unset any previous WHERE condition
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data
from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Decreases the reference count of object
. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
This function essentially limits the life time of the closure
to
the life time of the object. That is, when the object is finalized,
the closure
is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure,
to ensure that an extra
reference count is held on object
during invocation of the
closure
. Usually, this function will be called on closures that
use this object
as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init
member of
#GTypeInfo.) It must not be called after after class_init
has
been called for any object types implementing this interface.
If pspec
is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface
will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Create a new #GdaSqlBuilder object to build #GdaStatement or #GdaSqlStatement
objects of type stmt_type
the type of statement to build
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Create a new #GdaSqlBuilder object to build #GdaStatement or #GdaSqlStatement objects of type
stmt_type