A GRelation is a table of data which can be indexed on any number of fields, rather like simple database tables. A GRelation contains a number of records, called tuples. Each record contains a number of fields. Records are not ordered, so it is not possible to find the record at a particular index.

Note that GRelation tables are currently limited to 2 fields.

To create a GRelation, use [funcgLib.Relation.new].

To specify which fields should be indexed, use Relation.index(). Note that this must be called before any tuples are added to the GRelation.

To add records to a GRelation use Relation.insert().

To determine if a given record appears in a GRelation, use Relation.exists(). Note that fields are compared directly, so pointers must point to the exact same position (i.e. different copies of the same string will not match.)

To count the number of records which have a particular value in a given field, use relationCount.

To get all the records which have a particular value in a given field, use Relation.select(). To access fields of the resulting records, use tuplesIndex. To free the resulting records use tuplesDestroy.

To delete all records which have a particular value in a given field, use relationDelete.

To destroy the GRelation, use relationDestroy.

To help debug GRelation objects, use relationPrint.

GRelation has been marked as deprecated, since this API has never been fully implemented, is not very actively maintained and rarely used.

Click to display all available methods, including inherited ones