Abstract
This section discusses the NdbScanFilter class
and its public members.
Parent class. None
Child classes. None
Description.
NdbScanFilter provides an alternative means of
specifying filters for scan operations.
Important
Prior to MySQL 5.1.14, the comparison methods of this class did
not work with BIT values (see Bug#24503).
Development of this interface continues in MySQL 5.1, and the charcateristics of the NdbScanFilter class are likely to change further in future releases.
Methods. The following table lists the public methods of this class and the purpose or use of each method:
| Method | Purpose / Use |
|---|---|
NdbScanFilter() |
Constructor method |
~NdbScanFilter() |
Destructor method |
begin() |
Begins a compound (set of conditions) |
end() |
Ends a compound |
istrue() |
Defines a term in a compound as TRUE
|
isfalse() |
Defines a term in a compound as FALSE
|
cmp() |
Compares a column value with an arbitrary value |
eq() |
Tests for equality |
ne() |
Tests for inequality |
lt() |
Tests for a less-than condition |
le() |
Tests for a less-than-or-equal condition |
gt() |
Tests for a greater-than condition |
ge() |
Tests for a greater-than-or-equal condition |
isnull() |
Tests whether a column value is NULL
|
isnotnull() |
Tests whether a column value is not NULL
|
getNdbError() |
Provides access to error information |
getNdbOperation() |
Gets the associated NdbOperation
|
For detailed descriptions, signatures, and examples of use for each
of these methods, see Section 2.3.17.2, “NdbScanFilter Methods”.
Types.
The NdbScanFilter class defines two public
types:
BinaryCondition: The type of condition, such as lower bound or upper bound.Group: A logical grouping operator, such asANDorOR.
For a discussion of each of these types, along with its possible
values, see Section 2.3.17.1, “NdbScanFilter Types”.
Class diagram.
This diagram shows all the public members of the
NdbScanFilter class:
