The ==> operator

TIN introduces the ==> operator which is followed by a TINQL query.

SELECT id, body
FROM posts
WHERE body ==> 'apple AND "fuji apple"';

Side	Type	Notes
Left	`text`	Indexed text column or matching expression.
Right	`text`	TINQL query string. May be a prepared-statement parameter (`$1`).

Returns true when the document matches the TINQL expression. An input that analyzes to no tokens ('', whitespace, bare punctuation) matches nothing. Explicit empty syntax ("", []) is a parse error. Combine multiple ==> predicates and ordinary SQL filters with AND / OR. When several indexed columns appear in the same query, tin.score(ctid) combines BM25 relevance across those fields. The right-hand side may also be an array via ==> ANY (…), which matches if any element matches:

SELECT *
FROM posts
WHERE body ==> 'juicy AND apple';

-- Zero-token input matches nothing; explicit empty syntax is a parse error
SELECT count(*) FROM posts WHERE body ==> '';
SELECT count(*) FROM posts WHERE body ==> '""';  -- ERROR

-- Match any of several TINQL strings
SELECT id FROM posts
WHERE body ==> ANY (ARRAY['apple', 'grape']);

-- Cross-column: one TIN index per column, combine predicates
SELECT id, tin.score(ctid) AS score, name, notes
FROM fruits
WHERE name ==> 'fuji'
  AND notes ==> 'citrus'
ORDER BY score DESC
LIMIT 10;

Need help?

Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.

Onboarding

Platform

Guides

Need help?

​Need help?

Need help?