Page History

Here you can find a all the averrable options

Name Operator Variation Examples Manual QPL

Term

{TOKEN}

Code Block

language	text
theme	Confluence

one

Code Block

language	py
theme	DJango

qpl.term(term='one')

Terms

{TOKEN} {TOKEN} {TOKEN} {TOKEN}

Code Block

language	text
theme	Confluence

all these are tokens

Code Block

language	py
theme	DJango

qpl.terms(terms=['all', 'these', 'are', 'tokens'])

Phrase

"{TOKEN} {TOKEN}"

'{TOKEN} {TOKEN}'

Code Block

language	text
theme	Confluence

"This is a phrase" but all these are tokens

Code Block

language	text
theme	Confluence

'This is a phrase' but all these are tokens

Just the phrase

Code Block

language	py
theme	DJango

qpl.phrase(phrase='This is a phrase')

Full example

Code Block

language	py
theme	DJango

qpl.or_(operands=[qpl.phrase(phrase='This is a phrase'), qpl.terms(terms=['but', 'all', 'these', 'are', 'tokens'])])

Or

{OPERAND} OR {OPERAND}

Explicit

Code Block

language	text
theme	Confluence

one OR two

If OR is the implicit operator

Code Block

language	text
theme	Confluence

one two

Code Block

language	py
theme	DJango

qpl.or_(operands=[qpl.term(term='one'), qpl.term(term='two')])

And

{OPERAND} AND {OPERAND}

Explicit

Code Block

language	text
theme	Confluence

one AND two

If AND is the implicit operator

Code Block

language	text
theme	Confluence

one two

Code Block

language	py
theme	DJango

qpl.and_(operands=[qpl.term(term='one'), qpl.term(term='two')])

Not

NOT {OPERAND}

- {OPERAND}

Code Block

language	text
theme	Confluence

this but NOT that

Code Block

language	text
theme	Confluence

this but -that

Just the not

Code Block

language	py
theme	DJango

qpl.not_(operands=qpl.term(term='that'))

Full example

Code Block

language	py
theme	DJango

qpl.or_(operands=[qpl.term(term='this'), qpl.term(term='but'), qpl.not_(operands=qpl.term(term='that'))])

Grouping

( {OPERAND} {OPERAND} ... )

Code Block

language	text
theme	Confluence

(cats AND dogs)

Code Block

language	text
theme	Confluence

(cats AND dogs NOT ("black cats" OR "white dogs"))

No manual equivalent for grouping

BOOST

{OPERAND}^{NUMBER}

Code Block

language	text
theme	Confluence

dogs^3.5 have more boost than cats^2

Works with phrases as well

Code Block

language	text
theme	Confluence

"this phase"^3.5

Term example

Code Block

language	py
theme	DJango

qpl.term(term='dogs', boost=3.5)

Phrase example

Code Block

language	py
theme	DJango

qpl.phrase(phrase='this phase', boost=3.5)

Tip
Applies for almost all operators

Wildcard

* or ?

Just *

For zero o more characters

Code Block

language	text
theme	Confluence

All *.py files

Code Block

language	text
theme	Confluence

I want my ki*y

for any character

Code Block

language	text
theme	Confluence

I want my p?t

Code Block

language	text
theme	Confluence

the year was 19??

For zero or more characters

Code Block

language	py
theme	DJango

qpl.wildcard(wildcard='*.py')

for any character

Code Block

language	py
theme	DJango

qpl.wildcard(wildcard='p?t')

Just *

Code Block

language	py
theme	DJango

qpl.wildcard(wildcard='*')

Date Range

{DATE}:{DATE}

{DATE}-{DATE}

With colon (:)

Tip
We encourage the use of colon (:) for date ranges, is easier to read for us

Code Block

language	text
theme	Confluence

1970/08/03:2022/09/29

Code Block

language	text
theme	Confluence

1970-08-03:2022-09-29

Code Block

language	text
theme	Confluence

1970.08.03:2022.09.29

Code Block

language	text
theme	Confluence

70/AUG/03:22/SEP/29

Code Block

language	text
theme	Confluence

70-AUG-03:22-SEP-29

Code Block

language	text
theme	Confluence

1970.08.03:2022.09.29

Code Block

language	text
theme	Confluence

70.AUG.03:22.SEP.29

Code Block

language	text
theme	Confluence

08/03/1970:09/29/2022

Code Block

language	text
theme	Confluence

08-03-1970:09-29-2022

Code Block

language	text
theme	Confluence

08.03.1970:09.29.2022

Code Block

language	text
theme	Confluence

AUG/03/70:SEP/29/22

Code Block

language	text
theme	Confluence

AUG-03-70:SEP-29-22

Code Block

language	text
theme	Confluence

AUG.03.70:SEP.29.22

Code Block

language	text
theme	Confluence

03/08/1970:29/09/2022

Code Block

language	text
theme	Confluence

03-08-1970:29-09-2022

Code Block

language	text
theme	Confluence

03.08.1970:29.09.2022

Code Block

language	text
theme	Confluence

03/AUG/70:29/SEP/22

Code Block

language	text
theme	Confluence

03-AUG-70:29-SEP-22

Code Block

language	text
theme	Confluence

03.AUG.70:29.SEP.22

With dash (-)

Warning
We recommend not to use - for date ranges. The parser does understand these, but we hardly can

Code Block

language	text
theme	Confluence

1970/08/03-2022/09/29

Code Block

language	text
theme	Confluence

1970-08-03-2022-09-29

Code Block

language	text
theme	Confluence

1970.08.03-2022.09.29

Code Block

language	text
theme	Confluence

70/AUG/03-22/SEP/29

Code Block

language	text
theme	Confluence

70-AUG-03-22-SEP-29

Code Block

language	text
theme	Confluence

1970.08.03-2022.09.29

Code Block

language	text
theme	Confluence

70.AUG.03-22.SEP.29

Code Block

language	text
theme	Confluence

08/03/1970-09/29/2022

Code Block

language	text
theme	Confluence

08-03-1970-09-29-2022

Code Block

language	text
theme	Confluence

08.03.1970-09.29.2022

Code Block

language	text
theme	Confluence

AUG/03/70-SEP/29/22

Code Block

language	text
theme	Confluence

AUG-03-70:SEP-29-22

Code Block

language	text
theme	Confluence

AUG.03.70-SEP.29.22

Code Block

language	text
theme	Confluence

03/08/1970-29/09/2022

Code Block

language	text
theme	Confluence

03-08-1970-29-09-2022

Code Block

language	text
theme	Confluence

03.08.1970-29.09.2022

Code Block

language	text
theme	Confluence

03/AUG/70-29/SEP/22

Code Block

language	text
theme	Confluence

03-AUG-70-29-SEP-22

Code Block

language	text
theme	Confluence

03.AUG.70-29.SEP.22

Applies for all formats

Code Block

language	py
theme	DJango

qpl.date_range(start='1970/08/03', end='2022/09/29')

Range

{NUMBER}:{NUMBER}

{NUMBER}-{NUMBER}

With colon (:)

Tip
We encourage the use of colon (:) for ranges, is easier to read for us

Code Block

language	text
theme	Confluence

10:20

Code Block

language	text
theme	Confluence

-10:20

Code Block

language	text
theme	Confluence

-10:-20

Code Block

language	text
theme	Confluence

-10.5:-20.32

With dash (-)

Warning
We recommend not to use - for ranges. The parser does understand these, but we hardly can

Code Block

language	text
theme	Confluence

10-20

Code Block

language	text
theme	Confluence

-10-20

Code Block

language	text
theme	Confluence

-10--20

Code Block

language	text
theme	Confluence

-10.5--20.32

Applies for all formats

Code Block

language	py
theme	DJango

qpl.range(start=10, end=-20)

Field

{FIELD_NAME}:{OPERAND}

Code Block

language	text
theme	Confluence

title:Cheese

Code Block

language	text
theme	Confluence

title:Cheese^2

Code Block

language	text
theme	Confluence

title:"Cheese & Beacon"

Code Block

language	text
theme	Confluence

title:"Cheese & Beacon"^2

Term example

Code Block

language	py
theme	DJango

qpl.term(term='Cheese', fields=['title'], boost=2)

Phrase example

Code Block

language	py
theme	DJango

qpl.phrase(phrase='Cheese & Beacon', fields=['title'], boost=2)

Tip
Applies for almost all operators

Near

{OPERAND} NEAR {OPERAND}

Code Block

language	text
theme	Confluence

"this phrase" NEAR (this tokens)

Code Block

language	py
theme	DJango

qpl.near(operands=[qpl.phrase(phrase='this phrase'), qpl.or_(operands=[qpl.term(term='this'), qpl.term(term='tokens')])],  slop=10)

Before

{OPERAND} BEFORE {OPERAND}

Code Block

language	text
theme	Confluence

"this phrase" BEFORE (this tokens)

Code Block

language	py
theme	DJango

qpl.before(operands=[qpl.phrase(phrase='this phrase'), qpl.or_(operands=[qpl.term(term='this'), qpl.term(term='tokens')])],  slop=2)

Adjacent

{OPERAND} ADJ {OPERAND}

Code Block

language	text
theme	Confluence

"this phrase" ADJ (this tokens)

Code Block

language	py
theme	DJango

qpl.adj(operands=[qpl.phrase(phrase='this phrase'), qpl.or_(operands=[qpl.term(term='this'), qpl.term(term='tokens')])], slop=0)

Span Not

{OPERAND} SPAN_NOT {OPERAND}

Code Block

language	text
theme	Confluence

"this phrase" SPAN_NOT (this tokens)

Code Block

language	py
theme	DJango

qpl.span_not(operands=[qpl.phrase(phrase='this phrase'), qpl.or_(operands=[qpl.term(term='this'), qpl.term(term='tokens')])], slop=0)

Page tree

Versions Compared

Old Version 9

New Version 10

Key