drizzle-orm 0.31.2-5b29cb4 → 0.31.2-aaea9bd

package/expo-sqlite/index.cjs

@@ -16,10 +16,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var expo_sqlite_exports = {};
 module.exports = __toCommonJS(expo_sqlite_exports);
 __reExport(expo_sqlite_exports, require("./driver.cjs"), module.exports);
+__reExport(expo_sqlite_exports, require("./query.cjs"), module.exports);
 __reExport(expo_sqlite_exports, require("./session.cjs"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./driver.cjs"),
+  ...require("./query.cjs"),
   ...require("./session.cjs")
 });
 //# sourceMappingURL=index.cjs.map

package/expo-sqlite/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/expo-sqlite/index.ts"],"sourcesContent":["export * from './driver.ts';\nexport * from './session.ts';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,gCAAc,wBAAd;AACA,gCAAc,yBADd;","names":[]}
+{"version":3,"sources":["../../src/expo-sqlite/index.ts"],"sourcesContent":["export * from './driver.ts';\nexport * from './query.ts';\nexport * from './session.ts';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,gCAAc,wBAAd;AACA,gCAAc,uBADd;AAEA,gCAAc,yBAFd;","names":[]}

package/expo-sqlite/index.d.cts

@@ -1,2 +1,3 @@
 export * from "./driver.cjs";
+export * from "./query.cjs";
 export * from "./session.cjs";

package/expo-sqlite/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./driver.js";
+export * from "./query.js";
 export * from "./session.js";

package/expo-sqlite/index.js

@@ -1,3 +1,4 @@
 export * from "./driver.js";
+export * from "./query.js";
 export * from "./session.js";
 //# sourceMappingURL=index.js.map

package/expo-sqlite/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/expo-sqlite/index.ts"],"sourcesContent":["export * from './driver.ts';\nexport * from './session.ts';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}
+{"version":3,"sources":["../../src/expo-sqlite/index.ts"],"sourcesContent":["export * from './driver.ts';\nexport * from './query.ts';\nexport * from './session.ts';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/expo-sqlite/query.cjs

@@ -0,0 +1,69 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var query_exports = {};
+__export(query_exports, {
+  useLiveQuery: () => useLiveQuery
+});
+module.exports = __toCommonJS(query_exports);
+var import_next = require("expo-sqlite/next");
+var import_react = require("react");
+var import__ = require("../index.cjs");
+var import_sqlite_core = require("../sqlite-core/index.cjs");
+var import_query = require("../sqlite-core/query-builders/query.cjs");
+const useLiveQuery = (query) => {
+  const [data, setData] = (0, import_react.useState)(
+    (0, import__.is)(query, import_query.SQLiteRelationalQuery) && query.mode === "first" ? void 0 : []
+  );
+  const [error, setError] = (0, import_react.useState)();
+  const [updatedAt, setUpdatedAt] = (0, import_react.useState)();
+  (0, import_react.useEffect)(() => {
+    const entity = (0, import__.is)(query, import_query.SQLiteRelationalQuery) ? query.table : query.config.table;
+    if ((0, import__.is)(entity, import__.Subquery) || (0, import__.is)(entity, import__.SQL)) {
+      setError(new Error("Selecting from subqueries and SQL are not supported in useLiveQuery"));
+      return;
+    }
+    let listener;
+    const handleData = (data2) => {
+      setData(data2);
+      setUpdatedAt(/* @__PURE__ */ new Date());
+    };
+    query.then(handleData).catch(setError);
+    if ((0, import__.is)(entity, import_sqlite_core.SQLiteTable) || (0, import__.is)(entity, import_sqlite_core.SQLiteView)) {
+      const config = (0, import__.is)(entity, import_sqlite_core.SQLiteTable) ? (0, import_sqlite_core.getTableConfig)(entity) : (0, import_sqlite_core.getViewConfig)(entity);
+      listener = (0, import_next.addDatabaseChangeListener)(({ tableName }) => {
+        if (config.name === tableName) {
+          query.then(handleData).catch(setError);
+        }
+      });
+    }
+    return () => {
+      listener?.remove();
+    };
+  }, []);
+  return {
+    data,
+    error,
+    updatedAt
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useLiveQuery
+});
+//# sourceMappingURL=query.cjs.map

package/expo-sqlite/query.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/expo-sqlite/query.ts"],"sourcesContent":["import { addDatabaseChangeListener } from 'expo-sqlite/next';\nimport { useEffect, useState } from 'react';\nimport { is, SQL, Subquery } from '~/index.ts';\nimport type { AnySQLiteSelect } from '~/sqlite-core/index.ts';\nimport { getTableConfig, getViewConfig, SQLiteTable, SQLiteView } from '~/sqlite-core/index.ts';\nimport { SQLiteRelationalQuery } from '~/sqlite-core/query-builders/query.ts';\n\nexport const useLiveQuery = <T extends Pick<AnySQLiteSelect, '_' | 'then'> | SQLiteRelationalQuery<'sync', unknown>>(\n\tquery: T,\n) => {\n\tconst [data, setData] = useState<Awaited<T>>(\n\t\t(is(query, SQLiteRelationalQuery) && query.mode === 'first' ? undefined : []) as Awaited<T>,\n\t);\n\tconst [error, setError] = useState<Error>();\n\tconst [updatedAt, setUpdatedAt] = useState<Date>();\n\n\tuseEffect(() => {\n\t\tconst entity = is(query, SQLiteRelationalQuery) ? query.table : (query as AnySQLiteSelect).config.table;\n\n\t\tif (is(entity, Subquery) || is(entity, SQL)) {\n\t\t\tsetError(new Error('Selecting from subqueries and SQL are not supported in useLiveQuery'));\n\t\t\treturn;\n\t\t}\n\n\t\tlet listener: ReturnType<typeof addDatabaseChangeListener> | undefined;\n\n\t\tconst handleData = (data: any) => {\n\t\t\tsetData(data);\n\t\t\tsetUpdatedAt(new Date());\n\t\t};\n\n\t\tquery.then(handleData).catch(setError);\n\n\t\tif (is(entity, SQLiteTable) || is(entity, SQLiteView)) {\n\t\t\tconst config = is(entity, SQLiteTable) ? getTableConfig(entity) : getViewConfig(entity);\n\t\t\tlistener = addDatabaseChangeListener(({ tableName }) => {\n\t\t\t\tif (config.name === tableName) {\n\t\t\t\t\tquery.then(handleData).catch(setError);\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\n\t\treturn () => {\n\t\t\tlistener?.remove();\n\t\t};\n\t}, []);\n\n\treturn {\n\t\tdata,\n\t\terror,\n\t\tupdatedAt,\n\t} as const;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA0C;AAC1C,mBAAoC;AACpC,eAAkC;AAElC,yBAAuE;AACvE,mBAAsC;AAE/B,MAAM,eAAe,CAC3B,UACI;AACJ,QAAM,CAAC,MAAM,OAAO,QAAI;AAAA,QACtB,aAAG,OAAO,kCAAqB,KAAK,MAAM,SAAS,UAAU,SAAY,CAAC;AAAA,EAC5E;AACA,QAAM,CAAC,OAAO,QAAQ,QAAI,uBAAgB;AAC1C,QAAM,CAAC,WAAW,YAAY,QAAI,uBAAe;AAEjD,8BAAU,MAAM;AACf,UAAM,aAAS,aAAG,OAAO,kCAAqB,IAAI,MAAM,QAAS,MAA0B,OAAO;AAElG,YAAI,aAAG,QAAQ,iBAAQ,SAAK,aAAG,QAAQ,YAAG,GAAG;AAC5C,eAAS,IAAI,MAAM,qEAAqE,CAAC;AACzF;AAAA,IACD;AAEA,QAAI;AAEJ,UAAM,aAAa,CAACA,UAAc;AACjC,cAAQA,KAAI;AACZ,mBAAa,oBAAI,KAAK,CAAC;AAAA,IACxB;AAEA,UAAM,KAAK,UAAU,EAAE,MAAM,QAAQ;AAErC,YAAI,aAAG,QAAQ,8BAAW,SAAK,aAAG,QAAQ,6BAAU,GAAG;AACtD,YAAM,aAAS,aAAG,QAAQ,8BAAW,QAAI,mCAAe,MAAM,QAAI,kCAAc,MAAM;AACtF,qBAAW,uCAA0B,CAAC,EAAE,UAAU,MAAM;AACvD,YAAI,OAAO,SAAS,WAAW;AAC9B,gBAAM,KAAK,UAAU,EAAE,MAAM,QAAQ;AAAA,QACtC;AAAA,MACD,CAAC;AAAA,IACF;AAEA,WAAO,MAAM;AACZ,gBAAU,OAAO;AAAA,IAClB;AAAA,EACD,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,EACD;AACD;","names":["data"]}

package/expo-sqlite/query.d.cts

@@ -0,0 +1,7 @@
+import type { AnySQLiteSelect } from "../sqlite-core/index.cjs";
+import { SQLiteRelationalQuery } from "../sqlite-core/query-builders/query.cjs";
+export declare const useLiveQuery: <T extends Pick<AnySQLiteSelect, "_" | "then"> | SQLiteRelationalQuery<"sync", unknown>>(query: T) => {
+    readonly data: Awaited<T>;
+    readonly error: Error | undefined;
+    readonly updatedAt: Date | undefined;
+};

package/expo-sqlite/query.d.ts

@@ -0,0 +1,7 @@
+import type { AnySQLiteSelect } from "../sqlite-core/index.js";
+import { SQLiteRelationalQuery } from "../sqlite-core/query-builders/query.js";
+export declare const useLiveQuery: <T extends Pick<AnySQLiteSelect, "_" | "then"> | SQLiteRelationalQuery<"sync", unknown>>(query: T) => {
+    readonly data: Awaited<T>;
+    readonly error: Error | undefined;
+    readonly updatedAt: Date | undefined;
+};

package/expo-sqlite/query.js

@@ -0,0 +1,45 @@
+import { addDatabaseChangeListener } from "expo-sqlite/next";
+import { useEffect, useState } from "react";
+import { is, SQL, Subquery } from "../index.js";
+import { getTableConfig, getViewConfig, SQLiteTable, SQLiteView } from "../sqlite-core/index.js";
+import { SQLiteRelationalQuery } from "../sqlite-core/query-builders/query.js";
+const useLiveQuery = (query) => {
+  const [data, setData] = useState(
+    is(query, SQLiteRelationalQuery) && query.mode === "first" ? void 0 : []
+  );
+  const [error, setError] = useState();
+  const [updatedAt, setUpdatedAt] = useState();
+  useEffect(() => {
+    const entity = is(query, SQLiteRelationalQuery) ? query.table : query.config.table;
+    if (is(entity, Subquery) || is(entity, SQL)) {
+      setError(new Error("Selecting from subqueries and SQL are not supported in useLiveQuery"));
+      return;
+    }
+    let listener;
+    const handleData = (data2) => {
+      setData(data2);
+      setUpdatedAt(/* @__PURE__ */ new Date());
+    };
+    query.then(handleData).catch(setError);
+    if (is(entity, SQLiteTable) || is(entity, SQLiteView)) {
+      const config = is(entity, SQLiteTable) ? getTableConfig(entity) : getViewConfig(entity);
+      listener = addDatabaseChangeListener(({ tableName }) => {
+        if (config.name === tableName) {
+          query.then(handleData).catch(setError);
+        }
+      });
+    }
+    return () => {
+      listener?.remove();
+    };
+  }, []);
+  return {
+    data,
+    error,
+    updatedAt
+  };
+};
+export {
+  useLiveQuery
+};
+//# sourceMappingURL=query.js.map

package/expo-sqlite/query.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/expo-sqlite/query.ts"],"sourcesContent":["import { addDatabaseChangeListener } from 'expo-sqlite/next';\nimport { useEffect, useState } from 'react';\nimport { is, SQL, Subquery } from '~/index.ts';\nimport type { AnySQLiteSelect } from '~/sqlite-core/index.ts';\nimport { getTableConfig, getViewConfig, SQLiteTable, SQLiteView } from '~/sqlite-core/index.ts';\nimport { SQLiteRelationalQuery } from '~/sqlite-core/query-builders/query.ts';\n\nexport const useLiveQuery = <T extends Pick<AnySQLiteSelect, '_' | 'then'> | SQLiteRelationalQuery<'sync', unknown>>(\n\tquery: T,\n) => {\n\tconst [data, setData] = useState<Awaited<T>>(\n\t\t(is(query, SQLiteRelationalQuery) && query.mode === 'first' ? undefined : []) as Awaited<T>,\n\t);\n\tconst [error, setError] = useState<Error>();\n\tconst [updatedAt, setUpdatedAt] = useState<Date>();\n\n\tuseEffect(() => {\n\t\tconst entity = is(query, SQLiteRelationalQuery) ? query.table : (query as AnySQLiteSelect).config.table;\n\n\t\tif (is(entity, Subquery) || is(entity, SQL)) {\n\t\t\tsetError(new Error('Selecting from subqueries and SQL are not supported in useLiveQuery'));\n\t\t\treturn;\n\t\t}\n\n\t\tlet listener: ReturnType<typeof addDatabaseChangeListener> | undefined;\n\n\t\tconst handleData = (data: any) => {\n\t\t\tsetData(data);\n\t\t\tsetUpdatedAt(new Date());\n\t\t};\n\n\t\tquery.then(handleData).catch(setError);\n\n\t\tif (is(entity, SQLiteTable) || is(entity, SQLiteView)) {\n\t\t\tconst config = is(entity, SQLiteTable) ? getTableConfig(entity) : getViewConfig(entity);\n\t\t\tlistener = addDatabaseChangeListener(({ tableName }) => {\n\t\t\t\tif (config.name === tableName) {\n\t\t\t\t\tquery.then(handleData).catch(setError);\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\n\t\treturn () => {\n\t\t\tlistener?.remove();\n\t\t};\n\t}, []);\n\n\treturn {\n\t\tdata,\n\t\terror,\n\t\tupdatedAt,\n\t} as const;\n};\n"],"mappings":"AAAA,SAAS,iCAAiC;AAC1C,SAAS,WAAW,gBAAgB;AACpC,SAAS,IAAI,KAAK,gBAAgB;AAElC,SAAS,gBAAgB,eAAe,aAAa,kBAAkB;AACvE,SAAS,6BAA6B;AAE/B,MAAM,eAAe,CAC3B,UACI;AACJ,QAAM,CAAC,MAAM,OAAO,IAAI;AAAA,IACtB,GAAG,OAAO,qBAAqB,KAAK,MAAM,SAAS,UAAU,SAAY,CAAC;AAAA,EAC5E;AACA,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAgB;AAC1C,QAAM,CAAC,WAAW,YAAY,IAAI,SAAe;AAEjD,YAAU,MAAM;AACf,UAAM,SAAS,GAAG,OAAO,qBAAqB,IAAI,MAAM,QAAS,MAA0B,OAAO;AAElG,QAAI,GAAG,QAAQ,QAAQ,KAAK,GAAG,QAAQ,GAAG,GAAG;AAC5C,eAAS,IAAI,MAAM,qEAAqE,CAAC;AACzF;AAAA,IACD;AAEA,QAAI;AAEJ,UAAM,aAAa,CAACA,UAAc;AACjC,cAAQA,KAAI;AACZ,mBAAa,oBAAI,KAAK,CAAC;AAAA,IACxB;AAEA,UAAM,KAAK,UAAU,EAAE,MAAM,QAAQ;AAErC,QAAI,GAAG,QAAQ,WAAW,KAAK,GAAG,QAAQ,UAAU,GAAG;AACtD,YAAM,SAAS,GAAG,QAAQ,WAAW,IAAI,eAAe,MAAM,IAAI,cAAc,MAAM;AACtF,iBAAW,0BAA0B,CAAC,EAAE,UAAU,MAAM;AACvD,YAAI,OAAO,SAAS,WAAW;AAC9B,gBAAM,KAAK,UAAU,EAAE,MAAM,QAAQ;AAAA,QACtC;AAAA,MACD,CAAC;AAAA,IACF;AAEA,WAAO,MAAM;AACZ,gBAAU,OAAO;AAAA,IAClB;AAAA,EACD,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,EACD;AACD;","names":["data"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drizzle-orm",
-  "version": "0.31.2-5b29cb4",
+  "version": "0.31.2-aaea9bd",
   "description": "Drizzle ORM package for SQL databases",
   "type": "module",
   "scripts": {
@@ -656,6 +656,18 @@
       "types": "./expo-sqlite/migrator.d.ts",
       "default": "./expo-sqlite/migrator.js"
     },
+    "./expo-sqlite/query": {
+      "import": {
+        "types": "./expo-sqlite/query.d.ts",
+        "default": "./expo-sqlite/query.js"
+      },
+      "require": {
+        "types": "./expo-sqlite/query.d.cts",
+        "default": "./expo-sqlite/query.cjs"
+      },
+      "types": "./expo-sqlite/query.d.ts",
+      "default": "./expo-sqlite/query.js"
+    },
     "./expo-sqlite/session": {
       "import": {
         "types": "./expo-sqlite/session.d.ts",
@@ -3176,6 +3188,18 @@
       "types": "./sql/functions/aggregate.d.ts",
       "default": "./sql/functions/aggregate.js"
     },
+    "./sql/functions/full-text-search": {
+      "import": {
+        "types": "./sql/functions/full-text-search.d.ts",
+        "default": "./sql/functions/full-text-search.js"
+      },
+      "require": {
+        "types": "./sql/functions/full-text-search.d.cts",
+        "default": "./sql/functions/full-text-search.cjs"
+      },
+      "types": "./sql/functions/full-text-search.d.ts",
+      "default": "./sql/functions/full-text-search.js"
+    },
     "./sql/functions": {
       "import": {
         "types": "./sql/functions/index.d.ts",

package/sql/functions/full-text-search.cjs

@@ -0,0 +1,75 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var full_text_search_exports = {};
+__export(full_text_search_exports, {
+  phraseto_tsquery: () => phraseto_tsquery,
+  plainto_tsquery: () => plainto_tsquery,
+  setweight: () => setweight,
+  to_tsquery: () => to_tsquery,
+  to_tsvector: () => to_tsvector,
+  ts_rank: () => ts_rank,
+  ts_rank_cd: () => ts_rank_cd,
+  websearch_to_tsquery: () => websearch_to_tsquery
+});
+module.exports = __toCommonJS(full_text_search_exports);
+var import_sql = require("../sql.cjs");
+function to_tsvector(arg1, arg2) {
+  return arg2 ? import_sql.sql`to_tsvector(${arg1}, ${arg2})` : import_sql.sql`to_tsvector(${arg1})`;
+}
+function to_tsquery(arg1, arg2) {
+  return arg2 ? import_sql.sql`to_tsquery(${arg1}, ${arg2})` : import_sql.sql`to_tsquery(${arg1})`;
+}
+function plainto_tsquery(arg1, arg2) {
+  return arg2 ? import_sql.sql`plainto_tsquery(${arg1}, ${arg2})` : import_sql.sql`plainto_tsquery(${arg1})`;
+}
+function phraseto_tsquery(arg1, arg2) {
+  return arg2 ? import_sql.sql`phraseto_tsquery(${arg1}, ${arg2})` : import_sql.sql`phraseto_tsquery(${arg1})`;
+}
+function websearch_to_tsquery(arg1, arg2) {
+  return arg2 ? import_sql.sql`websearch_to_tsquery(${arg1}, ${arg2})` : import_sql.sql`websearch_to_tsquery(${arg1})`;
+}
+function ts_rank(arg1, arg2, arg3, arg4) {
+  if (Array.isArray(arg1) && typeof arg2 !== "number" && arg3 !== void 0) {
+    return arg4 ? import_sql.sql`ts_rank(string_to_array(${arg1.join(",")}, ',')::float4[], ${arg2}, ${arg3}, ${arg4})` : import_sql.sql`ts_rank(string_to_array(${arg1.join(",")}, ',')::float4[], ${arg2}, ${arg3})`;
+  } else {
+    return arg3 ? import_sql.sql`ts_rank(${arg1}, ${arg2}, ${arg3})` : import_sql.sql`ts_rank(${arg1}, ${arg2})`;
+  }
+}
+function ts_rank_cd(arg1, arg2, arg3, arg4) {
+  if (Array.isArray(arg1) && typeof arg2 !== "number" && arg3 !== void 0) {
+    return arg4 ? import_sql.sql`ts_rank_cd(string_to_array(${arg1.join(",")}, ',')::float4[], ${arg2}, ${arg3}, ${arg4})` : import_sql.sql`ts_rank_cd(string_to_array(${arg1.join(",")}, ',')::float4[], ${arg2}, ${arg3})`;
+  } else {
+    return arg3 ? import_sql.sql`ts_rank_cd(${arg1}, ${arg2}, ${arg3})` : import_sql.sql`ts_rank_cd(${arg1}, ${arg2})`;
+  }
+}
+function setweight(vector, weight) {
+  return import_sql.sql`setweight(${vector}, ${weight})`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  phraseto_tsquery,
+  plainto_tsquery,
+  setweight,
+  to_tsquery,
+  to_tsvector,
+  ts_rank,
+  ts_rank_cd,
+  websearch_to_tsquery
+});
+//# sourceMappingURL=full-text-search.cjs.map

package/sql/functions/full-text-search.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/sql/functions/full-text-search.ts"],"sourcesContent":["import type { AnyPgColumn } from '~/pg-core/index.ts';\nimport { type SQL, sql } from '../sql.ts';\n\ntype Configuration =\n\t| 'simple'\n\t| 'arabic'\n\t| 'armenian'\n\t| 'basque'\n\t| 'catalan'\n\t| 'danish'\n\t| 'dutch'\n\t| 'english'\n\t| 'finnish'\n\t| 'french'\n\t| 'german'\n\t| 'greek'\n\t| 'hindi'\n\t| 'hungarian'\n\t| 'indonesian'\n\t| 'irish'\n\t| 'italian'\n\t| 'lithuanian'\n\t| 'nepali'\n\t| 'norwegian'\n\t| 'portuguese'\n\t| 'romanian'\n\t| 'serbian'\n\t| 'spanish'\n\t| 'swedish'\n\t| 'tamil'\n\t| 'turkish'\n\t| 'yiddish';\n\ntype Weight = 'A' | 'B' | 'C' | 'D';\n\n/**\n * Converts a document to the `tsvector` data type.\n *\n * @param {AnyPgColumn | string} document - The document to be converted into `tsvector`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select({ value: to_tsvector(posts.title) }).from(posts);\n * ```\n */\nexport function to_tsvector(document: AnyPgColumn | string): SQL;\n/**\n * Converts a document to the `tsvector` data type.\n *\n * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').\n * @param {AnyPgColumn | string} document - The document to be converted into `tsvector`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select({ value: to_tsvector('english', posts.title) }).from(posts);\n * ```\n */\nexport function to_tsvector(configuration: Configuration | string & {}, document: AnyPgColumn | string): SQL;\nexport function to_tsvector(arg1: Configuration | AnyPgColumn | string & {}, arg2?: AnyPgColumn | string): SQL {\n\treturn arg2 ? sql`to_tsvector(${arg1}, ${arg2})` : sql`to_tsvector(${arg1})`;\n}\n\n/**\n * Converts a query to the `tsquery` data type.\n *\n * @param {string} query - The text to be converted into `tsquery`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select().from(posts).where(sql`${to_tsvector(posts.title)} @@ ${to_tsquery('Drizzle')}`);\n * ```\n */\nexport function to_tsquery(query: string): SQL;\n/**\n * Converts a query to the `tsquery` data type.\n *\n * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').\n * @param {string} query - The text to be converted into `tsquery`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select().from(posts).where(sql`${to_tsvector('english', posts.title)} @@ ${to_tsquery('english', 'Drizzle')}`);\n * ```\n */\nexport function to_tsquery(configuration: Configuration | string & {}, query: string): SQL;\nexport function to_tsquery(arg1: Configuration | string & {}, arg2?: string): SQL {\n\treturn arg2 ? sql`to_tsquery(${arg1}, ${arg2})` : sql`to_tsquery(${arg1})`;\n}\n\n/**\n * Converts a query to the `tsquery` data type.\n *\n * The text is parsed and normalized much as for `to_tsvector`, then the `&` (AND) tsquery operator is inserted between surviving words.\n *\n * @param {string} query - The text to be converted into `tsquery`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select().from(posts).where(sql`${to_tsvector(posts.title)} @@ ${plainto_tsquery('PostgreSQL MySQL SQLite')}`);\n * ```\n */\nexport function plainto_tsquery(query: string): SQL;\n/**\n * Converts a query to the `tsquery` data type.\n *\n * The text is parsed and normalized much as for `to_tsvector`, then the `&` (AND) tsquery operator is inserted between surviving words.\n *\n * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').\n * @param {string} query - The text to be converted into `tsquery`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select().from(posts).where(sql`${to_tsvector('english', posts.title)} @@ ${plainto_tsquery('english', 'PostgreSQL MySQL SQLite')}`);\n * ```\n */\nexport function plainto_tsquery(configuration: Configuration | string & {}, query: string): SQL;\nexport function plainto_tsquery(arg1: Configuration | string & {}, arg2?: string): SQL {\n\treturn arg2 ? sql`plainto_tsquery(${arg1}, ${arg2})` : sql`plainto_tsquery(${arg1})`;\n}\n\n/**\n * Converts a query to the `tsquery` data type.\n *\n * `phraseto_tsquery` behaves much like `plainto_tsquery`, except that it inserts the `<->` (FOLLOWED BY) operator between surviving words instead of the `&` (AND) operator.\n *\n * @param {string} query - The text to be converted into `tsquery`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select().from(posts).where(sql`${to_tsvector(posts.title)} @@ ${phraseto_tsquery('Drizzle best practice')}`);\n * ```\n */\nexport function phraseto_tsquery(query: string): SQL;\n/**\n * Converts a query to the `tsquery` data type.\n *\n * `phraseto_tsquery` behaves much like `plainto_tsquery`, except that it inserts the `<->` (FOLLOWED BY) operator between surviving words instead of the `&` (AND) operator.\n *\n * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').\n * @param {string} query - The text to be converted into `tsquery`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select().from(posts).where(sql`${to_tsvector('english', posts.title)} @@ ${phraseto_tsquery('english', 'Drizzle best practice')}`);\n * ```\n */\nexport function phraseto_tsquery(configuration: Configuration | string & {}, query: string): SQL;\nexport function phraseto_tsquery(arg1: Configuration | string & {}, arg2?: string): SQL {\n\treturn arg2 ? sql`phraseto_tsquery(${arg1}, ${arg2})` : sql`phraseto_tsquery(${arg1})`;\n}\n\n/**\n * Converts a query to the `tsquery` data type.\n *\n * `websearch_to_tsquery` creates a `tsquery` value from querytext using an alternative syntax in which simple unformatted text is a valid query. Unlike `plainto_tsquery` and `phraseto_tsquery`, it also recognizes certain operators. Moreover, this function will never raise syntax errors, which makes it possible to use raw user-supplied input for search.\n *\n * @param {string} query - The text to be converted into `tsquery`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select().from(posts).where(sql`${to_tsvector(posts.title)} @@ ${websearch_to_tsquery('tips or updates Drizzle')}`);\n * ```\n */\nexport function websearch_to_tsquery(query: string): SQL;\n/**\n * Converts a query to the `tsquery` data type.\n *\n * `websearch_to_tsquery` creates a `tsquery` value from querytext using an alternative syntax in which simple unformatted text is a valid query. Unlike `plainto_tsquery` and `phraseto_tsquery`, it also recognizes certain operators. Moreover, this function will never raise syntax errors, which makes it possible to use raw user-supplied input for search.\n *\n * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').\n * @param {string} query - The text to be converted into `tsquery`.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * await db.select().from(posts).where(sql`${to_tsvector('english', posts.title)} @@ ${websearch_to_tsquery('english', 'tips or updates Drizzle')}`);\n * ```\n */\nexport function websearch_to_tsquery(configuration: Configuration | string & {}, query: string): SQL;\nexport function websearch_to_tsquery(arg1: Configuration | string & {}, arg2?: string): SQL {\n\treturn arg2 ? sql`websearch_to_tsquery(${arg1}, ${arg2})` : sql`websearch_to_tsquery(${arg1})`;\n}\n\n/**\n * Calculates the text search rank of a document represented by a `tsvector` against a `tsquery`.\n *\n * @param {SQL} vector - The `tsvector` representation of the document.\n * @param {SQL} query - The `tsquery` to compare against the vector.\n * @param {number} [normalization] - Optional normalization parameter. Specifies whether and how a document's length should impact its rank.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * const vector = to_tsvector('english', posts.title);\n * const query = to_tsquery('english', 'Drizzle');\n * const rank = ts_rank(vector, query);\n *\n * await db.select({ post: posts, rank }).from(posts).where(gt(rank, 0));\n * ```\n */\nexport function ts_rank(vector: SQL, query: SQL, normalization?: number): SQL;\n/**\n * Calculates the text search rank of a document represented by a `tsvector` against a `tsquery`, using weights.\n *\n * @param {number[]} weights - Array of weights applied to the document's components.\n * @param {SQL} vector - The `tsvector` representation of the document.\n * @param {SQL} query - The `tsquery` to compare against the vector.\n * @param {number} [normalization] - Optional normalization parameter. Specifies whether and how a document's length should impact its rank.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * const weights = [0.1, 0.2, 0.4, 0.3];\n * const vector = to_tsvector('english', posts.title);\n * const query = to_tsquery('english', 'Drizzle');\n * const rank = ts_rank(weights, vector, query);\n *\n * await db.select({ post: posts, rank }).from(posts).where(gt(rank, 0));\n * ```\n */\nexport function ts_rank(weights: number[], vector: SQL, query: SQL, normalization?: number): SQL;\nexport function ts_rank(arg1: number[] | SQL, arg2: SQL | number, arg3?: SQL | number, arg4?: number): SQL {\n\tif (Array.isArray(arg1) && typeof arg2 !== 'number' && arg3 !== undefined) {\n\t\treturn arg4\n\t\t\t? sql`ts_rank(string_to_array(${arg1.join(',')}, ',')::float4[], ${arg2}, ${arg3}, ${arg4})`\n\t\t\t: sql`ts_rank(string_to_array(${arg1.join(',')}, ',')::float4[], ${arg2}, ${arg3})`;\n\t} else {\n\t\treturn arg3 ? sql`ts_rank(${arg1}, ${arg2}, ${arg3})` : sql`ts_rank(${arg1}, ${arg2})`;\n\t}\n}\n\n/**\n * Calculates the text search rank of a document with cover density ranking, represented by a `tsvector` against a `tsquery`.\n *\n * @param {SQL} vector - The `tsvector` representation of the document.\n * @param {SQL} query - The `tsquery` to compare against the vector.\n * @param {number} [normalization] - Optional normalization parameter. Specifies whether and how a document's length should impact its rank.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * const vector = to_tsvector('english', posts.title);\n * const query = to_tsquery('english', 'Drizzle');\n * const rankCd = ts_rank_cd(vector, query);\n *\n * await db.select({ post: posts, rankCd }).from(posts).where(gt(rankCd, 0));\n * ```\n */\nexport function ts_rank_cd(vector: SQL, query: SQL, normalization?: number): SQL;\n/**\n * Calculates the text search rank of a document represented by a `tsvector` against a `tsquery`, using weights.\n *\n * @param {number[]} weights - Array of weights applied to the document's components.\n * @param {SQL} vector - The `tsvector` representation of the document.\n * @param {SQL} query - The `tsquery` to compare against the vector.\n * @param {number} [normalization] - Optional normalization parameter. Specifies whether and how a document's length should impact its rank.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * const weights = [0.1, 0.2, 0.4, 0.3];\n * const vector = to_tsvector('english', posts.title);\n * const query = to_tsquery('english', 'Drizzle');\n * const rankCd = ts_rank_cd(weights, vector, query);\n *\n * await db.select({ post: posts, rankCd }).from(posts).where(gt(rankCd, 0));\n * ```\n */\nexport function ts_rank_cd(weights: number[], vector: SQL, query: SQL, normalization?: number): SQL;\nexport function ts_rank_cd(arg1: number[] | SQL, arg2: SQL | number, arg3?: SQL | number, arg4?: number): SQL {\n\tif (Array.isArray(arg1) && typeof arg2 !== 'number' && arg3 !== undefined) {\n\t\treturn arg4\n\t\t\t? sql`ts_rank_cd(string_to_array(${arg1.join(',')}, ',')::float4[], ${arg2}, ${arg3}, ${arg4})`\n\t\t\t: sql`ts_rank_cd(string_to_array(${arg1.join(',')}, ',')::float4[], ${arg2}, ${arg3})`;\n\t} else {\n\t\treturn arg3 ? sql`ts_rank_cd(${arg1}, ${arg2}, ${arg3})` : sql`ts_rank_cd(${arg1}, ${arg2})`;\n\t}\n}\n\n/**\n * Used to label the entries of a `tsvector` with a given weight, where a weight is one of the letters A, B, C, or D.\n *\n * @param {SQL} vector - The `tsvector` representation of the document.\n * @param {Weight} weight - The weight to be assigned to the elements of the vector.\n * @returns {SQL}\n *\n * @example\n * ```ts\n * const weightedVectorTitle = setweight(to_tsvector('english', posts.title), 'A');\n * const weightedVectorDescription = setweight(to_tsvector('english', posts.description), 'B');\n * const query = to_tsquery('english', 'Drizzle');\n *\n * await db.select().from(posts).where(sql`(${weightedVectorTitle} || ${weightedVectorDescription}) @@ ${query}`);\n * ```\n */\nexport function setweight(vector: SQL, weight: Weight | string & {}): SQL {\n\treturn sql`setweight(${vector}, ${weight})`;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,iBAA8B;AA2DvB,SAAS,YAAY,MAAiD,MAAkC;AAC9G,SAAO,OAAO,6BAAkB,IAAI,KAAK,IAAI,MAAM,6BAAkB,IAAI;AAC1E;AA2BO,SAAS,WAAW,MAAmC,MAAoB;AACjF,SAAO,OAAO,4BAAiB,IAAI,KAAK,IAAI,MAAM,4BAAiB,IAAI;AACxE;AA+BO,SAAS,gBAAgB,MAAmC,MAAoB;AACtF,SAAO,OAAO,iCAAsB,IAAI,KAAK,IAAI,MAAM,iCAAsB,IAAI;AAClF;AA+BO,SAAS,iBAAiB,MAAmC,MAAoB;AACvF,SAAO,OAAO,kCAAuB,IAAI,KAAK,IAAI,MAAM,kCAAuB,IAAI;AACpF;AA+BO,SAAS,qBAAqB,MAAmC,MAAoB;AAC3F,SAAO,OAAO,sCAA2B,IAAI,KAAK,IAAI,MAAM,sCAA2B,IAAI;AAC5F;AAwCO,SAAS,QAAQ,MAAsB,MAAoB,MAAqB,MAAoB;AAC1G,MAAI,MAAM,QAAQ,IAAI,KAAK,OAAO,SAAS,YAAY,SAAS,QAAW;AAC1E,WAAO,OACJ,yCAA8B,KAAK,KAAK,GAAG,CAAC,qBAAqB,IAAI,KAAK,IAAI,KAAK,IAAI,MACvF,yCAA8B,KAAK,KAAK,GAAG,CAAC,qBAAqB,IAAI,KAAK,IAAI;AAAA,EAClF,OAAO;AACN,WAAO,OAAO,yBAAc,IAAI,KAAK,IAAI,KAAK,IAAI,MAAM,yBAAc,IAAI,KAAK,IAAI;AAAA,EACpF;AACD;AAwCO,SAAS,WAAW,MAAsB,MAAoB,MAAqB,MAAoB;AAC7G,MAAI,MAAM,QAAQ,IAAI,KAAK,OAAO,SAAS,YAAY,SAAS,QAAW;AAC1E,WAAO,OACJ,4CAAiC,KAAK,KAAK,GAAG,CAAC,qBAAqB,IAAI,KAAK,IAAI,KAAK,IAAI,MAC1F,4CAAiC,KAAK,KAAK,GAAG,CAAC,qBAAqB,IAAI,KAAK,IAAI;AAAA,EACrF,OAAO;AACN,WAAO,OAAO,4BAAiB,IAAI,KAAK,IAAI,KAAK,IAAI,MAAM,4BAAiB,IAAI,KAAK,IAAI;AAAA,EAC1F;AACD;AAkBO,SAAS,UAAU,QAAa,QAAmC;AACzE,SAAO,2BAAgB,MAAM,KAAK,MAAM;AACzC;","names":[]}

package/sql/functions/full-text-search.d.cts

@@ -0,0 +1,235 @@
+import type { AnyPgColumn } from "../../pg-core/index.cjs";
+import { type SQL } from "../sql.cjs";
+type Configuration = 'simple' | 'arabic' | 'armenian' | 'basque' | 'catalan' | 'danish' | 'dutch' | 'english' | 'finnish' | 'french' | 'german' | 'greek' | 'hindi' | 'hungarian' | 'indonesian' | 'irish' | 'italian' | 'lithuanian' | 'nepali' | 'norwegian' | 'portuguese' | 'romanian' | 'serbian' | 'spanish' | 'swedish' | 'tamil' | 'turkish' | 'yiddish';
+type Weight = 'A' | 'B' | 'C' | 'D';
+/**
+ * Converts a document to the `tsvector` data type.
+ *
+ * @param {AnyPgColumn | string} document - The document to be converted into `tsvector`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select({ value: to_tsvector(posts.title) }).from(posts);
+ * ```
+ */
+export declare function to_tsvector(document: AnyPgColumn | string): SQL;
+/**
+ * Converts a document to the `tsvector` data type.
+ *
+ * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').
+ * @param {AnyPgColumn | string} document - The document to be converted into `tsvector`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select({ value: to_tsvector('english', posts.title) }).from(posts);
+ * ```
+ */
+export declare function to_tsvector(configuration: Configuration | string & {}, document: AnyPgColumn | string): SQL;
+/**
+ * Converts a query to the `tsquery` data type.
+ *
+ * @param {string} query - The text to be converted into `tsquery`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select().from(posts).where(sql`${to_tsvector(posts.title)} @@ ${to_tsquery('Drizzle')}`);
+ * ```
+ */
+export declare function to_tsquery(query: string): SQL;
+/**
+ * Converts a query to the `tsquery` data type.
+ *
+ * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').
+ * @param {string} query - The text to be converted into `tsquery`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select().from(posts).where(sql`${to_tsvector('english', posts.title)} @@ ${to_tsquery('english', 'Drizzle')}`);
+ * ```
+ */
+export declare function to_tsquery(configuration: Configuration | string & {}, query: string): SQL;
+/**
+ * Converts a query to the `tsquery` data type.
+ *
+ * The text is parsed and normalized much as for `to_tsvector`, then the `&` (AND) tsquery operator is inserted between surviving words.
+ *
+ * @param {string} query - The text to be converted into `tsquery`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select().from(posts).where(sql`${to_tsvector(posts.title)} @@ ${plainto_tsquery('PostgreSQL MySQL SQLite')}`);
+ * ```
+ */
+export declare function plainto_tsquery(query: string): SQL;
+/**
+ * Converts a query to the `tsquery` data type.
+ *
+ * The text is parsed and normalized much as for `to_tsvector`, then the `&` (AND) tsquery operator is inserted between surviving words.
+ *
+ * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').
+ * @param {string} query - The text to be converted into `tsquery`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select().from(posts).where(sql`${to_tsvector('english', posts.title)} @@ ${plainto_tsquery('english', 'PostgreSQL MySQL SQLite')}`);
+ * ```
+ */
+export declare function plainto_tsquery(configuration: Configuration | string & {}, query: string): SQL;
+/**
+ * Converts a query to the `tsquery` data type.
+ *
+ * `phraseto_tsquery` behaves much like `plainto_tsquery`, except that it inserts the `<->` (FOLLOWED BY) operator between surviving words instead of the `&` (AND) operator.
+ *
+ * @param {string} query - The text to be converted into `tsquery`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select().from(posts).where(sql`${to_tsvector(posts.title)} @@ ${phraseto_tsquery('Drizzle best practice')}`);
+ * ```
+ */
+export declare function phraseto_tsquery(query: string): SQL;
+/**
+ * Converts a query to the `tsquery` data type.
+ *
+ * `phraseto_tsquery` behaves much like `plainto_tsquery`, except that it inserts the `<->` (FOLLOWED BY) operator between surviving words instead of the `&` (AND) operator.
+ *
+ * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').
+ * @param {string} query - The text to be converted into `tsquery`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select().from(posts).where(sql`${to_tsvector('english', posts.title)} @@ ${phraseto_tsquery('english', 'Drizzle best practice')}`);
+ * ```
+ */
+export declare function phraseto_tsquery(configuration: Configuration | string & {}, query: string): SQL;
+/**
+ * Converts a query to the `tsquery` data type.
+ *
+ * `websearch_to_tsquery` creates a `tsquery` value from querytext using an alternative syntax in which simple unformatted text is a valid query. Unlike `plainto_tsquery` and `phraseto_tsquery`, it also recognizes certain operators. Moreover, this function will never raise syntax errors, which makes it possible to use raw user-supplied input for search.
+ *
+ * @param {string} query - The text to be converted into `tsquery`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select().from(posts).where(sql`${to_tsvector(posts.title)} @@ ${websearch_to_tsquery('tips or updates Drizzle')}`);
+ * ```
+ */
+export declare function websearch_to_tsquery(query: string): SQL;
+/**
+ * Converts a query to the `tsquery` data type.
+ *
+ * `websearch_to_tsquery` creates a `tsquery` value from querytext using an alternative syntax in which simple unformatted text is a valid query. Unlike `plainto_tsquery` and `phraseto_tsquery`, it also recognizes certain operators. Moreover, this function will never raise syntax errors, which makes it possible to use raw user-supplied input for search.
+ *
+ * @param {Configuration | string} configuration - Text search configuration (e.g., 'english', 'simple').
+ * @param {string} query - The text to be converted into `tsquery`.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * await db.select().from(posts).where(sql`${to_tsvector('english', posts.title)} @@ ${websearch_to_tsquery('english', 'tips or updates Drizzle')}`);
+ * ```
+ */
+export declare function websearch_to_tsquery(configuration: Configuration | string & {}, query: string): SQL;
+/**
+ * Calculates the text search rank of a document represented by a `tsvector` against a `tsquery`.
+ *
+ * @param {SQL} vector - The `tsvector` representation of the document.
+ * @param {SQL} query - The `tsquery` to compare against the vector.
+ * @param {number} [normalization] - Optional normalization parameter. Specifies whether and how a document's length should impact its rank.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * const vector = to_tsvector('english', posts.title);
+ * const query = to_tsquery('english', 'Drizzle');
+ * const rank = ts_rank(vector, query);
+ *
+ * await db.select({ post: posts, rank }).from(posts).where(gt(rank, 0));
+ * ```
+ */
+export declare function ts_rank(vector: SQL, query: SQL, normalization?: number): SQL;
+/**
+ * Calculates the text search rank of a document represented by a `tsvector` against a `tsquery`, using weights.
+ *
+ * @param {number[]} weights - Array of weights applied to the document's components.
+ * @param {SQL} vector - The `tsvector` representation of the document.
+ * @param {SQL} query - The `tsquery` to compare against the vector.
+ * @param {number} [normalization] - Optional normalization parameter. Specifies whether and how a document's length should impact its rank.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * const weights = [0.1, 0.2, 0.4, 0.3];
+ * const vector = to_tsvector('english', posts.title);
+ * const query = to_tsquery('english', 'Drizzle');
+ * const rank = ts_rank(weights, vector, query);
+ *
+ * await db.select({ post: posts, rank }).from(posts).where(gt(rank, 0));
+ * ```
+ */
+export declare function ts_rank(weights: number[], vector: SQL, query: SQL, normalization?: number): SQL;
+/**
+ * Calculates the text search rank of a document with cover density ranking, represented by a `tsvector` against a `tsquery`.
+ *
+ * @param {SQL} vector - The `tsvector` representation of the document.
+ * @param {SQL} query - The `tsquery` to compare against the vector.
+ * @param {number} [normalization] - Optional normalization parameter. Specifies whether and how a document's length should impact its rank.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * const vector = to_tsvector('english', posts.title);
+ * const query = to_tsquery('english', 'Drizzle');
+ * const rankCd = ts_rank_cd(vector, query);
+ *
+ * await db.select({ post: posts, rankCd }).from(posts).where(gt(rankCd, 0));
+ * ```
+ */
+export declare function ts_rank_cd(vector: SQL, query: SQL, normalization?: number): SQL;
+/**
+ * Calculates the text search rank of a document represented by a `tsvector` against a `tsquery`, using weights.
+ *
+ * @param {number[]} weights - Array of weights applied to the document's components.
+ * @param {SQL} vector - The `tsvector` representation of the document.
+ * @param {SQL} query - The `tsquery` to compare against the vector.
+ * @param {number} [normalization] - Optional normalization parameter. Specifies whether and how a document's length should impact its rank.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * const weights = [0.1, 0.2, 0.4, 0.3];
+ * const vector = to_tsvector('english', posts.title);
+ * const query = to_tsquery('english', 'Drizzle');
+ * const rankCd = ts_rank_cd(weights, vector, query);
+ *
+ * await db.select({ post: posts, rankCd }).from(posts).where(gt(rankCd, 0));
+ * ```
+ */
+export declare function ts_rank_cd(weights: number[], vector: SQL, query: SQL, normalization?: number): SQL;
+/**
+ * Used to label the entries of a `tsvector` with a given weight, where a weight is one of the letters A, B, C, or D.
+ *
+ * @param {SQL} vector - The `tsvector` representation of the document.
+ * @param {Weight} weight - The weight to be assigned to the elements of the vector.
+ * @returns {SQL}
+ *
+ * @example
+ * ```ts
+ * const weightedVectorTitle = setweight(to_tsvector('english', posts.title), 'A');
+ * const weightedVectorDescription = setweight(to_tsvector('english', posts.description), 'B');
+ * const query = to_tsquery('english', 'Drizzle');
+ *
+ * await db.select().from(posts).where(sql`(${weightedVectorTitle} || ${weightedVectorDescription}) @@ ${query}`);
+ * ```
+ */
+export declare function setweight(vector: SQL, weight: Weight | string & {}): SQL;
+export {};