`dissect.esedb.index`#

Module Contents#

Classes#

Index

Represents an index on a table.

Functions#

encode_key

Encode various values into their normalized index key form.

Attributes#

`JET_cbKeyMost_OLD`
`bPrefixNull`
`bPrefixZeroLength`
`bPrefixNullHigh`
`bPrefixData`
`bSentinel`

dissect.esedb.index.JET_cbKeyMost_OLD = 255#

class dissect.esedb.index.Index(table: dissect.esedb.table.Table, record: dissect.esedb.record.Record = None)#

Bases: object

Represents an index on a table.

This is still very much WIP but works for basic indexes. For example, none of the special flags are currently implemented.

Parameters:

table – The table this index is from.
record – The record in the catalog for this index.

root() → dissect.esedb.page.Page#: Return the root page of this index.

column_ids() → list[int]#: Return a list of column IDs that are used in this index.

columns() → list[dissect.esedb.table.Column]#: Return a list of all columns that are used in this index.

search(**kwargs) → dissect.esedb.record.Record#

Search the index for the requested values.

Specify the column and value as a keyword argument.

search_key(key: bytes) → dissect.esedb.page.Node#

Search the index for a specific key.

Parameters:: key – The key to search for.

key_from_record(record: dissect.esedb.record.Record) → bytes#

Generate a key for this index from a record.

Parameters:: record – The record to generate a key for.

make_key(values: dict[str, dissect.esedb.c_esedb.RecordValue]) → bytes#

Generate a key out of the given values.

Parameters:: values – A map of the column names and values to generate a key for.

__repr__() → str#: Return repr(self).

dissect.esedb.index.bPrefixNull = 0#

dissect.esedb.index.bPrefixZeroLength = 64#

dissect.esedb.index.bPrefixNullHigh = 192#

dissect.esedb.index.bPrefixData = 127#

dissect.esedb.index.bSentinel = 255#

dissect.esedb.index.encode_key(index: Index, column: dissect.esedb.table.Column, value: dissect.esedb.c_esedb.RecordValue, max_size: int) → bytes#