Search Documentation

February 6th, 2008

With the new API, the index methods can take an optional parameter q, which is a search query. I realized there was nothing documenting our search system, so… have some documentation!

Query Format

The query string supports boolean operation, parentheses, phrases, and field-specific search. Query words are stemmed and joined by an implicit AND by default.

  • Valid boolean operators are AND, OR, and NOT.
  • Field-specific searches should be formatted as fieldname:contents.
  • Phrases must be enclosed in double quotes.

Invalid queries will return no results. This will likely be changed later to indicate there was an error.

Fields

Global

  • name: Searches names.
  • type: Searches types, only works on events/venues/artists.
  • description: Searches both description and details on events/venues/artists, details on users.
  • tagged: Searches tags on events/venues/artists, interests on users.
  • comments: Searches comment bodies.

Event specific

  • venue: Searches venue name of events.
  • artists: Searches artist names performing at event.

Venue specific

  • events: Searches names of events at venue.
  • artists: Searches names of artists that have performed at an event at this venue.

Artist specific

  • events: Searches names of events artist has performed at.
  • venues: Searches names of venues artist has performed at.

User specific

  • events: Searches names of events user went to.
  • venues: Searches names of events user has been to.
  • artists: Searches names of artists user has seen.

Sorry, comments are closed for this article.