Tuples#

Deprecated since version 2.26: Rarely used API

class Tuples(*args, **kwargs)#

The Tuples struct is used to return records (or tuples) from the Relation by select(). It only contains one public member - the number of records that matched. To access the matched records, you must use index().

Methods#

class Tuples
destroy() → None#

Frees the records which were returned by select(). This should always be called after select() when you are finished with the records. The records are not removed from the Relation.

Deprecated since version 2.26: Rarely used API

index(index_: int, field: int) → Any | None#

Gets a field from the records returned by select(). It returns the given field of the record at the given index. The returned value should not be changed.

Deprecated since version 2.26: Rarely used API

Parameters:

  • index – the index of the record.

  • field – the field to return.

Fields#

class Tuples
len#

The number of records that matched.