5.2.6. xgt.RowID

class xgt.RowID(container_map, row_id_list)

RowID represents a row ID returned from a server. The user shouldn’t manually construct these.

Parameters:

  • container_map (_ContainerMap) – Map of container ids to frames.

  • row_id_list (list) – List in the form: [X, Y] where X is the row id and Y is the commit id when this value was valid.

Methods

__init__(container_map, row_id_list)

Constructor for RowID.

get_data([include_row_labels])

Returns row data.

Attributes

frame

The frame the RowID points into.

position

The row position the RowID points to.
__init__(container_map, row_id_list)

Constructor for RowID. Should never be called directly by a user.

property frame: TableFrame | VertexFrame | EdgeFrame

The frame the RowID points into.

Type:

TableFrame, VertexFrame, or EdgeFrame

get_data(include_row_labels: bool = False) → list

Returns row data. If the frame this row points to has had deletions since the RowID was created, this row is considered invalid and will raise an exception.

Parameters:

include_row_labels (bool) – Indicates whether the security labels for each row should be egested along with the row.

Return type:

list

Raises:

  • XgtNameError – If the frame does not exist on the server.

  • XgtSecurityError – If the user does not have required permissions for this action.

  • XgtTransactionError – If a conflict with another transaction occurs.

  • ValueError – If parameter is out of bounds or the row is no longer valid due to a transactional update.

property position: int

The row position the RowID points to.

Type:

int