scan_rt_i Class Reference
[Scanning R-Tree Indexes]

Inherits smlevel_top, and xct_dependent_t.

Collaboration diagram for scan_rt_i:

[legend]List of all members.

---

Detailed Description

Iterator for scanning an R*-Tree.

To iterate over the {key,value} pairs in a spatial index, construct an instance of this class, and use its next() method to advance the cursor and the curr() method to copy out keys and values into server-space. It is unwise to delete or insert associations while you have a scan open on the index (in the same transaction).

See also:

R-Tree Indexes

Definition at line 327 of file scan.h.

Public Member Functions
NORET	scan_rt_i (const stid_t &stid, nbox_t::sob_cmp_t c, const nbox_t &box, bool include_nulls=false, concurrency_t cc=t_cc_page)
	Construct an iterator.
rc_t	next (nbox_t &key, void *el, smsize_t &elen, bool &eof)
bool	eof ()
const rc_t &	error_code () const
Public Attributes
stid_t	stid
	Store id of the R-Tree.
tid_t	tid
	Transaction ID of the transaction that initialized this iterator.
ndx_t	ntype
	Type of this index.

---

Constructor & Destructor Documentation

NORET scan_rt_i::scan_rt_i	(	const stid_t &	stid,
		nbox_t::sob_cmp_t	c,
		const nbox_t &	box,
		bool	include_nulls = false,
		concurrency_t	cc = t_cc_page
	)

Construct an iterator.

Parameters:

[in]	stid	ID of the R-Tree to be scanned.
[in]	c	Comparison type to be used in the scan : t_exact, t_overlap, t_cover, t_inside.
[in]	box	Box to reference for the comparison above.
[in]	include_nulls	If true, we will consider null keys as satisfying the condition.
[in]	cc	Must be t_cc_none, t_cc_page or t_cc_file. In the first two cases, an IS lock is acquired; in the last, an SH lock is acquired; this lock applies to the entire index.

---

The documentation for this class was generated from the following file:

• src/sm/scan.h

---