GdaQueryFieldAgg

GdaQueryFieldAgg — Represents a function (selected by a GdaDictAggregate object)

Functions

Properties

GdaDictAggregate * aggregate Read / Write
gchar * aggregate-id Write
gchar * aggregate-name Write
GdaQuery * query Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GdaObject
        ╰── GdaQueryObject
            ╰── GdaQueryField
                ╰── GdaQueryFieldAgg

Implemented Interfaces

GdaQueryFieldAgg implements GdaXmlStorage, GdaEntityField, GdaRenderer and GdaReferer.

Description

Functions

gda_query_field_agg_new ()

GdaQueryField *
gda_query_field_agg_new (GdaQuery *query,
                         const gchar *agg_name);

Creates a new GdaQueryFieldAgg object which represents the agg aggregate

Parameters

query

a GdaQuery in which the new object will be

 

agg_name

the name of an aggregate to represent

 

Returns

the new object


gda_query_field_agg_get_ref_agg ()

GdaDictAggregate *
gda_query_field_agg_get_ref_agg (GdaQueryFieldAgg *agg);

Get the real GdaDictAggregate object used by agg

Parameters

agg

a GdaQueryFieldAgg object

 

Returns

the GdaDictAggregate object, or NULL if agg is not active


gda_query_field_agg_set_arg ()

gboolean
gda_query_field_agg_set_arg (GdaQueryFieldAgg *agg,
                             GdaQueryField *arg);

Sets the argument of agg . If arg is NULL, then the argument (if there was one) is removed.

If agg is not active, then no check on the provided arg is performed.

Parameters

agg

a GdaQueryFieldAgg object

 

arg

a GdaQueryField object

 

Returns

TRUE if no error occurred

Types and Values

GdaQueryFieldAgg

typedef struct _GdaQueryFieldAgg GdaQueryFieldAgg;

Property Details

The “aggregate” property

  “aggregate”                GdaDictAggregate *

Flags: Read / Write


The “aggregate-id” property

  “aggregate-id”             gchar *

Flags: Write

Default value: NULL


The “aggregate-name” property

  “aggregate-name”           gchar *

Flags: Write

Default value: NULL


The “query” property

  “query”                    GdaQuery *

Flags: Read / Write / Construct Only