help:string syntax

When searching string fields, the following variation in search parameters may be used.

Direct comparisons

These take the text field in its entirety when making the comparison as selected by the qualifier. The following qualifiers are available.

  • (No qualifier) - Direct equality comparison.
  • *_eq - Direct equality comparison.
  • *_not_eq - Direct inequality comparison.
  • *_like - Equality comparison, supports the wildcard "*".
  • *_ilike - Same as above, though with case-insensitivity.
  • *_not_like - Inequality comparison, supports the wildcard "*".
  • *_not_ilike - Same as above, though with case-insensitivity.
  • *_regex - Regex equality comparison. Follows Postgres' ERE regex formatting rules (see External links below).
  • *_not_regex - Regex inequality comparison. Follows Postgres' ERE regex formatting rules (see External links below).
Array comparisons

These break up the text field allowing multiple comparisons at once, either using the URL array format or a certain text separator. The following qualifiers are available.

  • *_array - Uses the URL array format making direct equality comparisons.
    • Example: search[name_array][]=foo&search[name_array][]=bar
  • *_comma - Uses a comma to break up the text field.
  • *_space - Uses a space to break up the text field.

Note: A lowercase transformation will be applied on both sides of the equality comparison on search parameters that use the "lower" qualifier, e.g. search[name_lower_comma]=Foo,Bar

All parameter variations

For the following, NAME is the name of the record field being searched for.

  • NAME
  • NAME_eq
  • NAME_not_eq
  • NAME_like
  • NAME_not_like
  • NAME_ilike
  • NAME_not_ilike
  • NAME_regex
  • NAME_not_regex
  • NAME_array
  • NAME_comma
  • NAME_space
  • NAME_lower_array
  • NAME_lower_comma
  • NAME_lower_space

See also