okmodel 0.8.0 → 0.9.1

package/README.md

@@ -50,7 +50,15 @@ bun add okmodel @electric-sql/pglite
 bun add okmodel
 ```
 
-postgres.js is the default on Node and Bun. node-postgres is for a project that already has `pg`. PGlite runs Postgres in the process. The last line is Bun.sql, built into Bun, and it runs only there.
+postgres.js is the default on Node and Bun. node-postgres is for a project that already has `pg`. PGlite runs Postgres in the process. The last line is Bun.sql, built into Bun 1.4+, and it runs only there.
+
+Date and time columns need a `Temporal` global. Bun and Node 26 have it. On Node 22 and 24 assign a polyfill before those columns run (OKM1210 when it is missing). Example with `temporal-polyfill` (not part of the quickstart script):
+
+```typescript
+import { Temporal } from "temporal-polyfill";
+
+globalThis.Temporal = Temporal;
+```
 
 ## Quick start
 
@@ -135,6 +143,20 @@ export async function removeNote(id: string) {
 
 `okm push` is for a database you can recreate. A shared database uses reviewed migrations: `okm generate init`, then `okm migrate apply`.
 
+## 0.9
+
+This release is the tooling train. `okm pull` writes schema files from a database. `okm import drizzle` writes them from a Drizzle schema. Several catalogs share one database through `external()` and `okm catalog export`. `describe` and `buildCatalog` are on `okmodel/migrate`. Extension packs cover `unaccent`, `hstore`, `ltree`, `btree_gist`, `btree_gin`, `fuzzystrmatch`, and `pgcrypto`. The GitHub Action posts the migration plan on a pull request. A type change that rewrites a table is five migrations, not one `ALTER COLUMN … TYPE`.
+
+| Want…                   | Go to                                                                  |
+| ----------------------- | ---------------------------------------------------------------------- |
+| Pull a database         | [pull](https://okm.omqkhafi.dev/docs/reference/cli#pull)               |
+| Import Drizzle          | [From Drizzle](https://okm.omqkhafi.dev/docs/start/from-drizzle)       |
+| Several catalogs        | [Catalogs](https://okm.omqkhafi.dev/docs/define/schema/catalogs)       |
+| `describe`              | [Schema API](https://okm.omqkhafi.dev/docs/reference/schema-api)       |
+| Extension packs         | [Extensions](https://okm.omqkhafi.dev/docs/define/schema/extensions)   |
+| The GitHub Action       | [GitHub Action](https://okm.omqkhafi.dev/docs/reference/github-action) |
+| A rewriting type change | [Type change](https://okm.omqkhafi.dev/docs/reference/type-change)     |
+
 ## Next
 
 | Want…                       | Go to                                                                                    |

package/dist/adapters/pg/bunsql-extra.d.ts

@@ -4,14 +4,15 @@
  * Loaded on the first reserve, batch, stream, or dead connection. A read that
  * succeeds does not use it.
  */
-import type { ReservedSQL, SQL } from "./bun-sql.js";
+import type { SQL } from "./bun-sql.js";
 import type { DriverConnection, WireValue } from "../../contracts/driver.js";
 import { type HeldPool } from "./bunsql.js";
 /**
  * Checks out one connection and clears it on release.
  *
- * A connection that is gone is neither reset nor parked: Bun.sql has already
- * dropped it, and parking it would hand a dead session to the next caller.
+ * A connection that is gone is neither reset nor returned to the pool: Bun.sql
+ * has already dropped it. A reset or release failure after the caller's work
+ * finished destroys the handle and does not fail the call.
  *
  * @param held - The pool and its counters
  * @returns A connection the caller must release
@@ -45,13 +46,12 @@ export declare function drainClosed(sql: SQL): Promise<void>;
  * Subscribes on one pooled connection.
  *
  * @param sql - The pool
- * @param parked - Reserved handles to put back first
  * @param closed - The pool is closed
  * @param channel - Notify channel
  * @param onNotify - Payload callback
  * @returns Stops the subscription
  */
-export declare function listen(sql: SQL, parked: ReservedSQL[], closed: boolean, channel: string, onNotify: (payload: string) => void): Promise<() => Promise<void>>;
+export declare function listen(sql: SQL, closed: boolean, channel: string, onNotify: (payload: string) => void): Promise<() => Promise<void>>;
 export declare function checkout(held: HeldPool): Promise<DriverConnection & {
     evict(): void;
 }>;

package/dist/adapters/pg/bunsql.d.ts

@@ -36,7 +36,6 @@ export type BunSqlConfig = DriverPoolConfig & {
 /** What a checkout needs from the pool that opened it. */
 export type HeldPool = {
     readonly sql: SQL;
-    readonly parked: ReservedSQL[];
     readonly acquireMs: number | undefined;
     readonly counters: Counters;
     readonly notices: ReturnType<typeof noticeBuffer>;
@@ -70,4 +69,9 @@ export type Counters = {
 export declare function open(config: BunSqlConfig): DriverPool;
 export declare function send(sql: SQL, text: string, params: readonly WireValue[] | undefined): WireQuery;
 export declare function reserve(sql: SQL, acquireMs: number | undefined, counters: Counters): Promise<ReservedSQL>;
-export declare function park(parked: ReservedSQL[], reserved: ReservedSQL): Promise<void>;
+/**
+ * Returns a reserved handle to Bun's pool.
+ *
+ * @param reserved - The handle to release
+ */
+export declare function releaseReserved(reserved: ReservedSQL): Promise<void>;

package/dist/adapters/pg/nodepostgres.d.ts

@@ -55,7 +55,22 @@ export type Counters = {
  * @param source - Pool or client
  * @param handle - What to do with the error
  */
-export declare function armDriverError(source: object, handle?: () => void): void;
+export declare function armDriverError(source: object, handle?: (error?: unknown) => void): void;
+/**
+ * Records an idle or checked-out client error on the notice path (B-44).
+ *
+ * Does not throw. The pool has already dropped a dead idle client.
+ *
+ * @param notices - Pool notice buffer
+ * @param error - The `error` event value
+ */
+export declare function logClientError(notices: {
+    push(notice: {
+        severity: string;
+        message: string;
+        code?: string;
+    }): void;
+}, error: unknown): void;
 /**
  * Opens a node-postgres pool for one endpoint.
  *

package/dist/adapters/pg/postgres-extra.d.ts

@@ -29,23 +29,7 @@ export type HeldPool = {
  * @returns A connection the caller must release
  */
 export declare function checkout(pool: HeldPool, timeoutMs?: number): Promise<DriverConnection>;
-/**
- * Describes a statement.
- *
- * @param sql - Pool client
- * @param text - SQL
- * @param params - Wire parameters
- * @returns Column names and the parameter count
- */
 export declare function describe(sql: Sql, text: string, params?: readonly WireValue[]): Promise<DescribeResult>;
-/**
- * Yields cursor chunks.
- *
- * @param sql - Pool client
- * @param text - SQL
- * @param params - Wire parameters
- * @returns Chunks of wire rows
- */
 export declare function stream(sql: Sql, text: string, params?: readonly WireValue[]): AsyncIterable<readonly (readonly WireValue[])[]>;
 /**
  * Settles `run` when `ms` elapses, the reserved connection closes, or every
@@ -80,7 +64,9 @@ export declare function runBatch(pool: HeldPool, statements: readonly Statement[
  * @param sql - Reserved connection
  * @param lost - Set when that socket closes
  */
-export declare function watchReserved(sql: Sql, lost: Lost): void;
+declare function arm(sql: Sql, lost: Lost): void;
+/** @inheritdoc */
+export declare const watchReserved: typeof arm;
 type Gate = {
     enter(): void;
     leave(): void;

package/dist/adapters/pg/postgresjs.d.ts

@@ -53,7 +53,8 @@ export declare function open(config: PostgresJsConfig): DriverPool;
 export declare class PgSession implements BatchSession {
     readonly canCancel = true;
     private transactionDepth;
-    private readonly sql;
+    /** Current client. A storm rebuild assigns a new pool client here. */
+    sql: Sql;
     private readonly counters;
     private readonly scope;
     private readonly local;

package/dist/contracts/driver.d.ts

@@ -162,8 +162,9 @@ export type DriverPoolConfig = {
     readonly max?: number;
     /**
      * Ceilings in milliseconds. An adapter reads `acquire`: it waits for a
-     * connection up to that long, then fails with OKM1846. Omitted means wait
-     * without a deadline. The other keys belong to the runtime.
+     * connection up to that long, then fails with OKM1846. Omitted means the
+     * adapter default (10 s on postgres.js and node-postgres). The other keys
+     * belong to the runtime.
      */
     readonly timeouts?: DriverTimeouts;
 };

package/dist/contracts/error.d.ts

@@ -31,7 +31,7 @@ export type ColumnCode = (typeof COLUMN_CODES)[number];
  * These are spec §21 codes. They are a type only, so the runtime entry does
  * not gain a second registry.
  */
-export type QueryCode = "OKM1101" | "OKM1102" | "OKM1104" | "OKM1105" | "OKM1111" | "OKM1120" | "OKM1121" | "OKM1124" | "OKM1125" | "OKM1130" | "OKM1190" | "OKM1701" | "OKM1704" | "OKM1801" | "OKM1802" | "OKM1803" | "OKM1843";
+export type QueryCode = "OKM1101" | "OKM1102" | "OKM1104" | "OKM1105" | "OKM1111" | "OKM1120" | "OKM1121" | "OKM1124" | "OKM1125" | "OKM1126" | "OKM1130" | "OKM1190" | "OKM1701" | "OKM1704" | "OKM1801" | "OKM1802" | "OKM1803" | "OKM1843";
 /** Kinds from spec §14, in category order. */
 export declare const ERROR_KINDS: readonly ["invalid", "not_null", "check", "foreign_key", "unique", "exclusion", "conflict", "not_found", "not_unique", "forbidden", "serialization", "deadlock", "lock_timeout", "timeout", "cancelled", "unavailable", "schema_drift", "driver", "read_only", "outcome_unknown"];
 /** One spec §14 kind. */

package/dist/dialects/pg/errors.d.ts

@@ -25,6 +25,8 @@ export type MapPostgresErrorSchema = {
 type SqlField = {
     readonly field: string;
     readonly sql: string;
+    /** When true, mapped errors for this table keep values out of `cause` (B-33). */
+    readonly sensitive?: boolean;
 };
 /** Options for {@link mapPostgresError}. */
 export type MapPostgresErrorOptions = {

package/dist/dialects/pg/ext/btree-gin.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The `btree_gin` extension. `gin` stores a GIN operator class for scalar equality.
+ *
+ * Generated by scripts/ext-generate.ts. Do not edit.
+ * `minPostgres` for the base methods is 15. A feature
+ * a declared version lacks fails with OKM1812.
+ */
+import type { IndexCall } from "../table.js";
+import { type Extension, type ExtensionOptions } from "./index.js";
+/** `btree_gin` plus the methods the naming overlay selected. */
+export type BtreeGin = Extension & {
+    /**
+     * A GIN index with `int4_ops`.
+     *
+     * @param column - SQL column name
+     * @returns An index call whose expression is the `using` tail
+     */
+    gin(column: string): IndexCall;
+};
+/**
+ * Declares `btree_gin`.
+ *
+ * @param options - Schema and version pin
+ * @returns The extension object and its methods
+ */
+export declare function btreeGin(options?: ExtensionOptions): BtreeGin;

package/dist/dialects/pg/ext/btree-gin.js

@@ -0,0 +1,20 @@
+import {
+  extension2
+} from "../../../shared/6f0z3hzh.js";
+import {
+  usingIndex
+} from "../../../shared/h9811jjm.js";
+
+// src/dialects/pg/ext/btree-gin.ts
+function btreeGin(options = {}) {
+  const declared = extension2("btree_gin", options);
+  return {
+    ...declared,
+    gin(column) {
+      return usingIndex(column, "gin", "int4_ops");
+    }
+  };
+}
+export {
+  btreeGin
+};

package/dist/dialects/pg/ext/btree-gist.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The `btree_gist` extension. `gist` stores a GiST operator class so an exclude constraint can use `=`.
+ *
+ * Generated by scripts/ext-generate.ts. Do not edit.
+ * `minPostgres` for the base methods is 15. A feature
+ * a declared version lacks fails with OKM1812.
+ */
+import type { IndexCall } from "../table.js";
+import { type Extension, type ExtensionOptions } from "./index.js";
+/** `btree_gist` plus the methods the naming overlay selected. */
+export type BtreeGist = Extension & {
+    /**
+     * A GiST index with `gist_int4_ops`.
+     *
+     * @param column - SQL column name
+     * @returns An index call whose expression is the `using` tail
+     */
+    gist(column: string): IndexCall;
+};
+/**
+ * Declares `btree_gist`.
+ *
+ * @param options - Schema and version pin
+ * @returns The extension object and its methods
+ */
+export declare function btreeGist(options?: ExtensionOptions): BtreeGist;

package/dist/dialects/pg/ext/btree-gist.js

@@ -0,0 +1,20 @@
+import {
+  extension2
+} from "../../../shared/6f0z3hzh.js";
+import {
+  usingIndex
+} from "../../../shared/h9811jjm.js";
+
+// src/dialects/pg/ext/btree-gist.ts
+function btreeGist(options = {}) {
+  const declared = extension2("btree_gist", options);
+  return {
+    ...declared,
+    gist(column) {
+      return usingIndex(column, "gist", "gist_int4_ops");
+    }
+  };
+}
+export {
+  btreeGist
+};

package/dist/dialects/pg/ext/call.d.ts

@@ -0,0 +1,53 @@
+/**
+ * SQL fragments for an extension function or operator.
+ *
+ * The fragment is the whole predicate, the same way `fragment` is. Values
+ * are parameters. The schema and function names are quoted identifiers the
+ * generator wrote.
+ */
+import { type Fragment } from "../ops/fragment.js";
+/**
+ * `schema.fn(column, …) = schema.fn($1)`.
+ *
+ * @param schema - Install schema
+ * @param name - Function name
+ * @param value - Parameter
+ * @returns A where fragment
+ */
+export declare function fnEqualsArg(schema: string, name: string, value: string): Fragment;
+/**
+ * `schema.fn(column, $1) = $2::integer`.
+ *
+ * @param schema - Install schema
+ * @param name - Function name
+ * @param value - Text argument
+ * @param distance - Integer the function result must equal
+ * @returns A where fragment
+ */
+export declare function fnDistance(schema: string, name: string, value: string, distance: number): Fragment;
+/**
+ * `column <op> $1`, with an optional cast on the parameter.
+ *
+ * @param op - Operator token the generator wrote
+ * @param value - Parameter
+ * @param cast - SQL type to cast the parameter to, when the operator needs one
+ * @returns A where fragment
+ */
+export declare function opArg(op: string, value: string, cast?: string): Fragment;
+/**
+ * `schema.fn()` as the whole predicate.
+ *
+ * @param schema - Install schema
+ * @param name - Function name
+ * @returns A where fragment
+ */
+export declare function bareCall(schema: string, name: string): Fragment;
+/**
+ * `encode(schema.digest(column, $1), 'hex') = $2`.
+ *
+ * @param schema - Install schema
+ * @param algorithm - Digest algorithm, a parameter
+ * @param hex - Expected hex digest, a parameter
+ * @returns A where fragment
+ */
+export declare function digestEquals(schema: string, algorithm: string, hex: string): Fragment;

package/dist/dialects/pg/ext/citext.js

@@ -1,6 +1,6 @@
 import {
   extension2
-} from "../../../shared/jgqj11w4.js";
+} from "../../../shared/6f0z3hzh.js";
 
 // src/dialects/pg/ext/citext.ts
 function citext(options = {}) {

package/dist/dialects/pg/ext/feature.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Version gate for one extension feature (OKM1812).
+ *
+ * The factory reads the declared extension version. An omitted pin is
+ * unpinned: apply checks the server. A pin that still allows a version
+ * without the feature fails here, at the call, which is schema build when
+ * the schema file calls the method. The message names the feature, the
+ * extension version, and `minPostgres`.
+ */
+/** What a feature needs. */
+export type FeatureNeed = {
+    /** Extension the feature belongs to. */
+    readonly name: string;
+    /** Minimum extension version (`1.2`). */
+    readonly extension: string;
+    /** Minimum Postgres major. Named in the message. */
+    readonly postgres: number;
+};
+/**
+ * Refuses a pin that does not guarantee the feature.
+ *
+ * @param declared - `version` on the extension, when the caller set one
+ * @param feature - Feature name, such as `daitch_mokotoff`
+ * @param need - Versions the feature needs
+ */
+export declare function assertExtFeature(declared: string | undefined, feature: string, need: FeatureNeed): void;

package/dist/dialects/pg/ext/fuzzystrmatch.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The `fuzzystrmatch` extension. `levenshtein` compares edit distance. `daitchMokotoff` needs version 1.2 and PostgreSQL 16.
+ *
+ * Generated by scripts/ext-generate.ts. Do not edit.
+ * `minPostgres` for the base methods is 15. A feature
+ * a declared version lacks fails with OKM1812.
+ */
+import type { Fragment } from "../ops/fragment.js";
+import { type Extension, type ExtensionOptions } from "./index.js";
+/** `fuzzystrmatch` plus the methods the naming overlay selected. */
+export type Fuzzystrmatch = Extension & {
+    /**
+     * `levenshtein(column, value) = distance`.
+     *
+     * @param value - Text to compare
+     * @param distance - Edit distance the function must return
+     * @returns A where fragment
+     */
+    levenshtein(value: string, distance: number): Fragment;
+    /**
+     * `daitch_mokotoff(column) = daitch_mokotoff(value)`. Needs fuzzystrmatch 1.2 and PostgreSQL 16.
+     *
+     * @param value - Text to compare
+     * @returns A where fragment
+     */
+    daitchMokotoff(value: string): Fragment;
+};
+/**
+ * Declares `fuzzystrmatch`.
+ *
+ * @param options - Schema and version pin
+ * @returns The extension object and its methods
+ */
+export declare function fuzzystrmatch(options?: ExtensionOptions): Fuzzystrmatch;

package/dist/dialects/pg/ext/fuzzystrmatch.js

@@ -0,0 +1,33 @@
+import {
+  extension2
+} from "../../../shared/6f0z3hzh.js";
+import {
+  assertExtFeature
+} from "../../../shared/kzgrnckd.js";
+import {
+  fnEqualsArg,
+  fnDistance
+} from "../../../shared/zecrwdk9.js";
+
+// src/dialects/pg/ext/fuzzystrmatch.ts
+function fuzzystrmatch(options = {}) {
+  const declared = extension2("fuzzystrmatch", options);
+  const schema = declared.schema;
+  return {
+    ...declared,
+    levenshtein(value, distance) {
+      return fnDistance(schema, "levenshtein", value, distance);
+    },
+    daitchMokotoff(value) {
+      assertExtFeature(options.version, "daitch_mokotoff", {
+        name: "fuzzystrmatch",
+        extension: "1.2",
+        postgres: 16
+      });
+      return fnEqualsArg(schema, "daitch_mokotoff", value);
+    }
+  };
+}
+export {
+  fuzzystrmatch
+};

package/dist/dialects/pg/ext/hstore.d.ts

@@ -0,0 +1,41 @@
+/**
+ * The `hstore` extension. `hasKey` is `?`. `gin` and `gist` index an hstore column.
+ *
+ * Generated by scripts/ext-generate.ts. Do not edit.
+ * `minPostgres` for the base methods is 15. A feature
+ * a declared version lacks fails with OKM1812.
+ */
+import type { Fragment } from "../ops/fragment.js";
+import type { IndexCall } from "../table.js";
+import { type Extension, type ExtensionOptions } from "./index.js";
+/** `hstore` plus the methods the naming overlay selected. */
+export type Hstore = Extension & {
+    /**
+     * `column ? key`.
+     *
+     * @param value - Text to compare
+     * @returns A where fragment
+     */
+    hasKey(value: string): Fragment;
+    /**
+     * A GIN index with `gin_hstore_ops`.
+     *
+     * @param column - SQL column name
+     * @returns An index call whose expression is the `using` tail
+     */
+    gin(column: string): IndexCall;
+    /**
+     * A GiST index with `gist_hstore_ops`.
+     *
+     * @param column - SQL column name
+     * @returns An index call whose expression is the `using` tail
+     */
+    gist(column: string): IndexCall;
+};
+/**
+ * Declares `hstore`.
+ *
+ * @param options - Schema and version pin
+ * @returns The extension object and its methods
+ */
+export declare function hstore(options?: ExtensionOptions): Hstore;

package/dist/dialects/pg/ext/hstore.js

@@ -0,0 +1,29 @@
+import {
+  extension2
+} from "../../../shared/6f0z3hzh.js";
+import {
+  opArg
+} from "../../../shared/zecrwdk9.js";
+import {
+  usingIndex
+} from "../../../shared/h9811jjm.js";
+
+// src/dialects/pg/ext/hstore.ts
+function hstore(options = {}) {
+  const declared = extension2("hstore", options);
+  return {
+    ...declared,
+    hasKey(value) {
+      return opArg("?", value);
+    },
+    gin(column) {
+      return usingIndex(column, "gin", "gin_hstore_ops");
+    },
+    gist(column) {
+      return usingIndex(column, "gist", "gist_hstore_ops");
+    }
+  };
+}
+export {
+  hstore
+};

package/dist/dialects/pg/ext/index.d.ts

@@ -6,6 +6,50 @@
  * object for its records.
  */
 import type { ExtensionObject } from "../../../contracts/catalog/types.js";
+/** One type the definition says the extension provides. */
+export type ExtensionType = {
+    readonly name: string;
+};
+/** One operator the definition says the extension provides. */
+export type ExtensionOperator = {
+    readonly name: string;
+    readonly left?: string;
+    readonly right?: string;
+    readonly result: string;
+};
+/** One function the definition says the extension provides. */
+export type ExtensionFunction = {
+    readonly name: string;
+    readonly args: readonly string[];
+    readonly returns: string;
+};
+/** One index method the definition says the extension provides. */
+export type ExtensionIndexMethod = {
+    readonly name: string;
+    readonly opclass?: string;
+};
+/**
+ * Types, operators, functions, and index methods a definition declares.
+ *
+ * `okm ext test` checks these against the connected server. They are not
+ * catalog objects and they do not change the catalog hash.
+ */
+export type ExtensionProvides = {
+    readonly types?: readonly ExtensionType[];
+    readonly operators?: readonly ExtensionOperator[];
+    readonly functions?: readonly ExtensionFunction[];
+    readonly indexMethods?: readonly ExtensionIndexMethod[];
+};
+/**
+ * Version floors for a definition.
+ *
+ * `postgres` is `>=15`. `version` is an exact pin or a `>=` floor.
+ * `okm ext test` checks both against the connected server (OKM1812).
+ */
+export type ExtensionRequires = {
+    readonly postgres?: string;
+    readonly version?: string;
+};
 /** Options on {@link extension}. */
 export type ExtensionOptions = {
     /** Exact pin (`1.6`) or a floor (`>=0.7`). Omitted means unpinned. */
@@ -18,6 +62,14 @@ export type ExtensionOptions = {
      * The default is `true`. A move of a non-relocatable extension is OKM1814.
      */
     readonly relocatable?: boolean;
+    /**
+     * Floors `okm ext test` checks. Not stored in the catalog record.
+     */
+    readonly requires?: ExtensionRequires;
+    /**
+     * Objects `okm ext test` checks. Not stored in the catalog record.
+     */
+    readonly provides?: ExtensionProvides;
 };
 /**
  * One declared extension.
@@ -30,6 +82,10 @@ export type Extension = {
     readonly schema: string;
     readonly relocatable: boolean;
     readonly version?: string;
+    /** Floors from {@link ExtensionOptions.requires}. Absent when omitted. */
+    readonly requires?: ExtensionRequires;
+    /** Objects from {@link ExtensionOptions.provides}. Absent when omitted. */
+    readonly provides?: ExtensionProvides;
     /**
      * Catalog records for this declaration.
      *

package/dist/dialects/pg/ext/index.js

@@ -1,6 +1,6 @@
 import {
   extension2
-} from "../../../shared/jgqj11w4.js";
+} from "../../../shared/6f0z3hzh.js";
 export {
   extension2 as extension
 };

package/dist/dialects/pg/ext/ltree.d.ts

@@ -0,0 +1,41 @@
+/**
+ * The `ltree` extension. `ancestorOf` is `@>` and `descendantOf` is `<@`. This is not the parent-column walk.
+ *
+ * Generated by scripts/ext-generate.ts. Do not edit.
+ * `minPostgres` for the base methods is 15. A feature
+ * a declared version lacks fails with OKM1812.
+ */
+import type { Fragment } from "../ops/fragment.js";
+import type { IndexCall } from "../table.js";
+import { type Extension, type ExtensionOptions } from "./index.js";
+/** `ltree` plus the methods the naming overlay selected. */
+export type Ltree = Extension & {
+    /**
+     * `column @> path`. The column is an ancestor of `path`.
+     *
+     * @param value - Text to compare
+     * @returns A where fragment
+     */
+    ancestorOf(value: string): Fragment;
+    /**
+     * `column <@ path`. The column is a descendant of `path`.
+     *
+     * @param value - Text to compare
+     * @returns A where fragment
+     */
+    descendantOf(value: string): Fragment;
+    /**
+     * A GiST index with `gist_ltree_ops`.
+     *
+     * @param column - SQL column name
+     * @returns An index call whose expression is the `using` tail
+     */
+    gist(column: string): IndexCall;
+};
+/**
+ * Declares `ltree`.
+ *
+ * @param options - Schema and version pin
+ * @returns The extension object and its methods
+ */
+export declare function ltree(options?: ExtensionOptions): Ltree;