ssm_sort::key_info_t Struct Reference

Collaboration diagram for ssm_sort::key_info_t:

[legend]List of all members.

---

Detailed Description

Descriptor for sort key, used with sort_stream_i.

This structure was used in the original implementation of sort_file (now deprecated). Unfortunately, the API for sort_stream_i has not been updated to use the alternative key descriptor structure, sort_keys_t.

Examples:

sort_stream.cpp.

Definition at line 80 of file sort_s.h.

Public Types
typedef sortorder::keytype	key_type_t
enum	where_t
	Describes where the key is found: in a record header or body. For file sort. More...
Public Member Functions
	key_info_t ()
Public Attributes
key_type_t	type
nbox_t	universe
	For sorting on spatial keys.
bool	derived
	Is a derived key. If true, the key must be the only item in rec header, and the header will not be copied to the result record (allows the user to store derived key in the header temporarily, for sorting purposes).
where_t	where
	Where the key resides: header or body.
w_base_t::uint4_t	offset
	Offset from beginning of header or body where the key starts.
w_base_t::uint4_t	len
	Length of key.
w_base_t::uint4_t	est_reclen
	Estimated record length. A hint.

---

Member Enumeration Documentation

enum ssm_sort::key_info_t::where_t

Describes where the key is found: in a record header or body. For file sort.

• t_hdr : key is in the record header
• t_body : key is in the record body

Definition at line 110 of file sort_s.h.

---

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

• src/sm/sort_s.h

---