Skip to Content
prisma-ltree
Query Operations

Array boolean operators

Existence checks on ltree[] columns (ancestor, descendant, patterns)

Array boolean operators run on ltree[] columns and return a boolean: whether any element satisfies the predicate. Method names differ from the scalar forms (isAncestorOf, matchesLquery, …) because Prisma 8 keys operations by name only.

Declare the column with ltreeArray() or ltree.LtreeArray(). For the first matching path as a value, see Array first-match operators.

import { db } from "../prisma/db";

containsAncestorOf()

True when the array contains an ancestor of the argument (ltree[] @> ltree).

const rows = await db.orm.Page.where((p) =>
  p.breadcrumbs.containsAncestorOf("Top.Science.Astronomy"),
)
  .select("id")
  .all();

SQL equivalent: breadcrumbs @> $1::ltree

GiST: gist__ltree_ops does not index this operator. Prefer containsDescendantOf when you can rewrite the predicate, or accept a sequential scan. See Add a GiST index.

containsDescendantOf()

True when the array contains a descendant of the argument (ltree[] <@ ltree).

const rows = await db.orm.Page.where((p) => p.breadcrumbs.containsDescendantOf("Top.Science"))
  .select("id")
  .all();

SQL equivalent: breadcrumbs <@ $1::ltree

GiST required for index use: declare @@index([breadcrumbs], type: "gist") on the ltree[] column. See Add a GiST index.

matchesAnyLquery()

True when any array entry matches an lquery pattern (ltree[] ~ lquery).

const rows = await db.orm.Page.where((p) => p.breadcrumbs.matchesAnyLquery("*.Astronomy.*"))
  .select("id")
  .all();

SQL equivalent: breadcrumbs ~ $1::lquery

GiST required for index use: Add a GiST index.

matchesAnyLqueryArray()

True when any array entry matches any pattern in a string[] (ltree[] ? lquery[]).

const rows = await db.orm.Page.where((p) =>
  p.breadcrumbs.matchesAnyLqueryArray(["*.Astronomy.*", "Top.Science.*"]),
)
  .select("id")
  .all();

SQL equivalent: breadcrumbs ? $1::lquery[]

GiST required for index use: Add a GiST index.

matchesAnyLtxtquery()

True when any array entry matches an ltxtquery (ltree[] @ ltxtquery).

const rows = await db.orm.Page.where((p) =>
  p.breadcrumbs.matchesAnyLtxtquery("science & astronomy"),
)
  .select("id")
  .all();

SQL equivalent: breadcrumbs @ $1::ltxtquery

GiST required for index use: Add a GiST index.

Index summary

MethodIndexed by gist__ltree_ops?
containsAncestorOfNo
containsDescendantOfYes
matchesAnyLqueryYes
matchesAnyLqueryArrayYes
matchesAnyLtxtqueryYes

On this page