Back to Seed Clases

Midgard

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Midgard.QueryBuilder

Class Midgard.QueryBuilder

Import line:	Midgard = imports.gi.Midgard;
GIR File:	Midgard-10.05.gir
C documentation:	MidgardQueryBuilder
Class :	QueryBuilder
Extends:	GObject.Object
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	parent : GObject.Object read only	Midgard.QueryBuilder
	priv : Midgard.QueryBuilderPrivate read only	Midgard.QueryBuilder

Methods / Constructors
Method / Constructor		Defined By
	new Midgard.QueryBuilder (Object *properties) Create a new Midgard.QueryBuilder Create a new Midgard.QueryBuilder Parameters: Object properties*
	new Midgard.QueryBuilder.c_new (Connection *mgd, String classname) : Midgard.QueryBuilder Create a new Midgard.QueryBuilder Create a new Midgard.QueryBuilder Parameters: Midgard.Connection mgd* Required (not null) String classname Required (not null) Returns: Midgard.QueryBuilder
	add_constraint (String *name, String op, Value value) : Boolean Parameters: String name* Required (not null) String op Required (not null) GObject.Value value Required (not null) Returns: Boolean	Midgard.QueryBuilder
	add_constraint_with_property (String *property_a, String op, String property_b) : Boolean Adds named property constraint to the given query builder. Adds named property constraint to the given query builder. Unlike add_constraint method, this one accepts property name instead of scalar value. The difference is that with add_constraint method you can compare property with particular value, while using add_constraint_with_property method you can compare two different properties without any need to know their values. For example, you should use this method if you want to select only those objects which has been revised after publication time, and particular date doesn't matter. midgard_query_builder_add_constraint_with_property(builder, "metadata.revised", ">", "metadata.published"); Parameters: String property_a* Required (not null) String op Required (not null) String property_b Required (not null) Returns: Boolean	Midgard.QueryBuilder
	add_order (String *name, String dir) : Boolean Adds an ordering constraint to the query. Adds an ordering constraint to the query. An ordering constraint consists of a property name and a sort direction. The objects returned by this query will be sorted by the given property in the given direction (ascending or descending). Multiple ordering constraints are applied in the order they were added. Property name pattern is described in midgard_query_builder_add_constraint() Parameters: String name* Required (not null) String dir Required (not null) Returns: Boolean	Midgard.QueryBuilder
	begin_group (String *type) : Boolean Starts a constraint group of the given type. Starts a constraint group of the given type. A conjunctive constraint group type* (AND) requires that all component constraints match the queried objects, while a disjunctive group type (OR) requires just one of the component constraints to match. Parameters: String type Required (not null) Returns: Boolean	Midgard.QueryBuilder
	count () : Number Returns: Number	Midgard.QueryBuilder
	end_group () : Boolean Closes the most recently opened constraint group. Closes the most recently opened constraint group. The client should ensure proper nesting by closing all constraint groups before the containing query is executed. open constraint groups were found Returns: Boolean	Midgard.QueryBuilder
	execute (Object *out_values) : GObject.Object Executes the built query. Executes the built query. Objects in returned array are MidgardDBObject* derived ones, and typecasted to base GObject. You can safely typecast them to the type, which MidgardQueryBuilder has been initialized for. In case of any error, MidgardConnection error is set. Parameters: Object out_values Number n_objects Returns: GObject.Object	Midgard.QueryBuilder
	get_type_name () : String Returns type name of the type which is currently used by Query Builder. Returns type name of the type which is currently used by Query Builder. This function should be used on language binding level , when internal Query Builder's instance is already created and language binding object should be instanciated. Returned type name is a pointer and is owned by GLib system. Caller shouldn't free it. Returns: String	Midgard.QueryBuilder
	include_deleted () : none Query all objects, deleted and undeleted. Query all objects, deleted and undeleted. Returns: none	Midgard.QueryBuilder
	set_limit (Number *limit) : none Sets the maximum number of objects to return when the query is executed. Sets the maximum number of objects to return when the query is executed. A query will by default return all matching objects, but the limit* setting can be used to restrict the potentially large number of returned objects. The limit is applied only after the matching objects have been identified and sorted and after the optional start offset has been applied. Setting a limit on the number of returned objects is normally only reasonable when one or more ordering constraints and optionally an offset setting are applied to the query. Parameters: Number limit Required (not null) Returns: none	Midgard.QueryBuilder
	set_offset (Number *offset) : none Sets the start offset* of the objects to return when the query is executed. Sets the start offset of the objects to return when the query is executed. The start offset is applied after all the matching objects have been identified and sorted according to the given ordering constraints. The first offset objects are skipped and only the remaining (if any) objects are returned to the client. Setting a start offset is normally only reasonable when one or more ordering constraints are applied to the query. A start offset is usually accompanied by a limit setting. Parameters: Number offset Required (not null) Returns: none	Midgard.QueryBuilder

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	execution_end (QueryBuilder *self) : none Parameters: Midgard.QueryBuilder self* Returns: {none}	Midgard.QueryBuilder
	execution_start (QueryBuilder *self) : none Parameters: Midgard.QueryBuilder self* Returns: {none}	Midgard.QueryBuilder

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Tue Jun 22 2010 16:34:50 GMT+0800 (HKT)