NdbScanFilter Class Reference

A simple way to specify filters for scan operations. More...

#include <NdbScanFilter.hpp>

List of all members.

Public Types

• enum Group { AND = 1, OR = 2, NAND = 3, NOR = 4 }
• enum BinaryCondition {
    COND_LE = 0, COND_LT = 1, COND_GE = 2, COND_GT = 3,
    COND_EQ = 4, COND_NE = 5, COND_LIKE = 6, COND_NOT_LIKE = 7
  }
• enum Error { FilterTooLarge = 4294 }

  Public Member Functions

  • NdbScanFilter (class NdbOperation *op, bool abort_on_too_large=true, Uint32 max_size=NDB_MAX_SCANFILTER_SIZE_IN_WORDS)
  • int istrue ()
  • int isfalse ()
  • int cmp (BinaryCondition cond, int ColId, const void *val, Uint32 len=0)
  • int isnull (int ColId)
  • int isnotnull (int ColId)
  • class NdbError & getNdbError () const
  Grouping
  • int begin (Group group=AND)
  • int end ()
  Integer Comparators
  • int eq (int ColId, Uint32 value)
  • int ne (int ColId, Uint32 value)
  • int lt (int ColId, Uint32 value)
  • int le (int ColId, Uint32 value)
  • int gt (int ColId, Uint32 value)
  • int ge (int ColId, Uint32 value)
  • int eq (int ColId, Uint64 value)
  • int ne (int ColId, Uint64 value)
  • int lt (int ColId, Uint64 value)
  • int le (int ColId, Uint64 value)
  • int gt (int ColId, Uint64 value)
  • int ge (int ColId, Uint64 value)

  ---

  Detailed Description

  A simple way to specify filters for scan operations.

  Note:

  This filter interface is under development and may change in the future!

  ---

  Member Enumeration Documentation

  enum NdbScanFilter::BinaryCondition

  Enumerator:

  COND_LE	lower bound
  COND_LT	lower bound, strict
  COND_GE	upper bound
  COND_GT	upper bound, strict
  COND_EQ	equality
  COND_NE	not equal
  COND_LIKE	like
  COND_NOT_LIKE	not like

  enum NdbScanFilter::Group

  Group operators

  Enumerator:

  AND	(x1 AND x2 AND x3)
  OR	(x1 OR x2 OR X3)
  NAND	NOT (x1 AND x2 AND x3).
  NOR	NOT (x1 OR x2 OR x3).

  ---

  Constructor & Destructor Documentation

  NdbScanFilter::NdbScanFilter	(	class NdbOperation *	op,
  		bool	abort_on_too_large = true,
  		Uint32	max_size = NDB_MAX_SCANFILTER_SIZE_IN_WORDS
  	)

  Constructor

  Parameters:

  	op	The NdbOperation that the filter belongs to (is applied to).
  	abort_on_too_large	abort transaction on filter too large default: true
  	max_size	Maximum size of generated filter in words

  ---

  Member Function Documentation

  int NdbScanFilter::begin

  (

  Group

  group = AND

  )

  Begin of compound. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::cmp	(	BinaryCondition	cond,
  		int	ColId,
  		const void *	val,
  		Uint32	len = 0
  	)

  Compare column ColId with val

  int NdbScanFilter::end

  (

  )

  End of compound. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::eq	(	int	ColId,
  		Uint64	value
  	)			[inline]

  Compare column value with integer for equal. 64-bit. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::eq	(	int	ColId,
  		Uint32	value
  	)			[inline]

  Compare column value with integer for equal ®return 0 if successful, -1 otherwize

  int NdbScanFilter::ge	(	int	ColId,
  		Uint64	value
  	)			[inline]

  Compare column value with integer for greater than or equal. 64-bit. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::ge	(	int	ColId,
  		Uint32	value
  	)			[inline]

  Compare column value with integer for greater than or equal. ®return 0 if successful, -1 otherwize

  class NdbError& NdbScanFilter::getNdbError

  (

  )

  const

  Get filter level error.

  Most errors are set only on operation level, and they abort the transaction. The error FilterTooLarge is set on filter level and by default it propagates to operation level and also aborts the transaction.

  If option abort_on_too_large is set to false, then FilterTooLarge does not propagate. One can then either ignore this error (in which case no filtering is done) or try to define a new filter immediately.

  int NdbScanFilter::gt	(	int	ColId,
  		Uint64	value
  	)			[inline]

  Compare column value with integer for greater than. 64-bit. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::gt	(	int	ColId,
  		Uint32	value
  	)			[inline]

  Compare column value with integer for greater than. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::isfalse

  (

  )

  Explanation missing

  int NdbScanFilter::isnotnull

  (

  int

  ColId

  )

  Check if column value is non-NULL

  int NdbScanFilter::isnull

  (

  int

  ColId

  )

  Check if column value is NULL

  int NdbScanFilter::istrue

  (

  )

  Explanation missing

  int NdbScanFilter::le	(	int	ColId,
  		Uint64	value
  	)			[inline]

  Compare column value with integer for less than or equal. 64-bit. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::le	(	int	ColId,
  		Uint32	value
  	)			[inline]

  Compare column value with integer for less than or equal. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::lt	(	int	ColId,
  		Uint64	value
  	)			[inline]

  Compare column value with integer for less than. 64-bit. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::lt	(	int	ColId,
  		Uint32	value
  	)			[inline]

  Compare column value with integer for less than. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::ne	(	int	ColId,
  		Uint64	value
  	)			[inline]

  Compare column value with integer for not equal. 64-bit. ®return 0 if successful, -1 otherwize

  int NdbScanFilter::ne	(	int	ColId,
  		Uint32	value
  	)			[inline]

  Compare column value with integer for not equal. ®return 0 if successful, -1 otherwize