query vs document_query

• query and document_query queries are translated to RQL and sent to the server.
• Available query methods are listed here.
• Available document_query methods and extensions are listed here.

• All Python queries (query and document_query) are mutable.
  You may get different results if you try to reuse a query.

• The usage of the Query method in the following example:

  query = session.query(object_type=User).where_starts_with("name", "A")
  
  age_query = query.where_greater_than_or_equal("age", 21)
  
  eye_query = query.where_equals("eye_color", "blue")

  will result with the following Lucene-syntax queries:

  query: from Users where startsWith(name, 'A')

  ageQuery: from Users where startsWith(name, 'A') and age > 21

  eyeQuery: from Users where startsWith(name, 'A') and eye_color = 'blue'

• A similar usage with document_query:

  document_query = session.advanced.document_query(object_type=User).where_starts_with("name", "A")
  
  age_document_query = document_query.where_greater_than_or_equal("age", 21)
  
  eye_document_query = document_query.where_equals("eye_color", "blue")
  
  # Here all of the DocumentQuery variables have the same reference

  will result with the following Lucene queries:

  documentQuery: from Users where startsWith(name, 'A')
  (before creating ageDocumentQuery)

  ageDocumentQuery: from Users where startsWith(name, 'A') and age > 21
  (before creating eyeDocumentQuery)

  eyeDocumentuery: from Users where startsWith(name, 'A') and age > 21 and eye_color = 'blue'

  All created Lucene queries are the same query (actually the same instance).
  This is an important hint to be aware of if you are going to reuse document_query.

• Queries use AND as the default operator.

• The operator can be replaced by calling using_default_operator:

session.advanced.document_query(object_type=User).using_default_operator(QueryOperator.OR)