RepositoryCapabilities

Defined in: types.ts:84

Machine-readable description of what a repository adapter can do. Returned by Repository.describe() so tooling (OpenAPI generation, /_services introspection, agents) can discover adapter capabilities without trial-and-error queries.

Properties

adapter

adapter: string

Defined in: types.ts:86

Package name of the adapter, e.g. “@mantlejs/knex”.

---

fullTextSearch

fullTextSearch: boolean

Defined in: types.ts:92

Whether the adapter exposes native full-text search.

---

nestedPaths

nestedPaths: boolean

Defined in: types.ts:100

Whether dot-path field names (e.g. "metadata.owner.name") address nested fields for querying. Required (not optional) so the absence of this capability is a discoverable false, not a silent omission — a caller (or an agent) can check this before assuming a dot-path query will work, rather than discovering the gap as a runtime error or, worse, a literal-column-name misinterpretation.

---

operators

operators: string[]

Defined in: types.ts:88

Exactly the $-operators the adapter’s where-clause translator accepts — the same set its assertOperators call enforces.

---

pagination

pagination: "offset" | "cursor" | "both"

Defined in: types.ts:90

Pagination styles the adapter supports through QueryParams.

---

scanning?

optional scanning?: (where) => boolean

Defined in: types.ts:102

When present, returns true if the given where clause forces a full scan (e.g. DynamoDB Scan instead of Query).

Parameters

where

Record<string, unknown>

Returns

boolean