postgrelize 0.0.0-stage → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. package/CHANGELOG.md +269 -0
  2. package/LICENSE +21 -0
  3. package/README.md +131 -2
  4. package/dist/associations/association-accessors.d.ts +21 -0
  5. package/dist/associations/association-key-types.d.ts +44 -0
  6. package/dist/associations/association-keys.d.ts +98 -0
  7. package/dist/associations/association-lookup.d.ts +26 -0
  8. package/dist/associations/association-shape.d.ts +25 -0
  9. package/dist/associations/association.d.ts +95 -0
  10. package/dist/associations/belongs-to-many.d.ts +86 -0
  11. package/dist/associations/belongs-to.d.ts +45 -0
  12. package/dist/associations/has-many.d.ts +79 -0
  13. package/dist/associations/has-one.d.ts +44 -0
  14. package/dist/associations/include-assembler.d.ts +21 -0
  15. package/dist/associations/include-columns.d.ts +24 -0
  16. package/dist/associations/include-joins.d.ts +17 -0
  17. package/dist/associations/include-loader.d.ts +48 -0
  18. package/dist/associations/include-order.d.ts +22 -0
  19. package/dist/associations/include-query-builder.d.ts +54 -0
  20. package/dist/associations/include-resolver.d.ts +29 -0
  21. package/dist/associations/include-rows.d.ts +47 -0
  22. package/dist/associations/include-sub-query.d.ts +35 -0
  23. package/dist/associations/include.d.ts +112 -0
  24. package/dist/associations/junction-keys.d.ts +23 -0
  25. package/dist/associations/nested-creator.d.ts +44 -0
  26. package/dist/associations/nested-saver.d.ts +30 -0
  27. package/dist/associations/owner-keys.d.ts +34 -0
  28. package/dist/associations/separate-include-loader.d.ts +24 -0
  29. package/dist/associations/types.d.ts +139 -0
  30. package/dist/connection/connection-config.d.ts +33 -0
  31. package/dist/connection/connection-manager.d.ts +65 -0
  32. package/dist/connection/connection-types.d.ts +21 -0
  33. package/dist/connection/copy-from-stdin.d.ts +52 -0
  34. package/dist/connection/copy-runner.d.ts +30 -0
  35. package/dist/connection/copy-to-stdout.d.ts +49 -0
  36. package/dist/connection/copy.d.ts +22 -0
  37. package/dist/connection/notifications.d.ts +28 -0
  38. package/dist/connection/options.d.ts +158 -0
  39. package/dist/connection/query-logger.d.ts +41 -0
  40. package/dist/connection/replica-router.d.ts +20 -0
  41. package/dist/connection/statement-cache.d.ts +36 -0
  42. package/dist/connection/statement-timeout.d.ts +22 -0
  43. package/dist/data-types/abstract-data-type.d.ts +58 -0
  44. package/dist/data-types/array-literal-parser.d.ts +17 -0
  45. package/dist/data-types/array-type.d.ts +18 -0
  46. package/dist/data-types/bit-type.d.ts +14 -0
  47. package/dist/data-types/blob-type.d.ts +12 -0
  48. package/dist/data-types/char-type.d.ts +12 -0
  49. package/dist/data-types/composite-fields.d.ts +26 -0
  50. package/dist/data-types/composite-type.d.ts +32 -0
  51. package/dist/data-types/data-types.d.ts +172 -0
  52. package/dist/data-types/date-type.d.ts +14 -0
  53. package/dist/data-types/decimal-type.d.ts +13 -0
  54. package/dist/data-types/default-value-generator.d.ts +15 -0
  55. package/dist/data-types/enum-type.d.ts +19 -0
  56. package/dist/data-types/ewkb-reader.d.ts +18 -0
  57. package/dist/data-types/ewkb-writer.d.ts +17 -0
  58. package/dist/data-types/float-type.d.ts +12 -0
  59. package/dist/data-types/geometric-text.d.ts +65 -0
  60. package/dist/data-types/geometric-type.d.ts +46 -0
  61. package/dist/data-types/hstore-type.d.ts +16 -0
  62. package/dist/data-types/integer-type.d.ts +24 -0
  63. package/dist/data-types/json-type.d.ts +16 -0
  64. package/dist/data-types/multirange-type.d.ts +19 -0
  65. package/dist/data-types/range-type.d.ts +28 -0
  66. package/dist/data-types/record-text.d.ts +29 -0
  67. package/dist/data-types/scalar-type.d.ts +13 -0
  68. package/dist/data-types/spatial-type.d.ts +20 -0
  69. package/dist/data-types/string-type.d.ts +12 -0
  70. package/dist/data-types/text-type.d.ts +12 -0
  71. package/dist/data-types/timestamp-type.d.ts +15 -0
  72. package/dist/data-types/virtual-type.d.ts +15 -0
  73. package/dist/data-types/wall-clock.d.ts +14 -0
  74. package/dist/ddl/column-ddl.d.ts +73 -0
  75. package/dist/ddl/constraint-ddl.d.ts +30 -0
  76. package/dist/ddl/ddl-generator.d.ts +181 -0
  77. package/dist/ddl/ddl-guards.d.ts +60 -0
  78. package/dist/ddl/ddl-types.d.ts +193 -0
  79. package/dist/ddl/enum-ddl.d.ts +42 -0
  80. package/dist/ddl/extension-ddl.d.ts +57 -0
  81. package/dist/ddl/function-ddl.d.ts +98 -0
  82. package/dist/ddl/index-ddl.d.ts +29 -0
  83. package/dist/ddl/index-element-ddl.d.ts +19 -0
  84. package/dist/ddl/partition-ddl.d.ts +88 -0
  85. package/dist/ddl/partition-types.d.ts +94 -0
  86. package/dist/ddl/policy-ddl.d.ts +137 -0
  87. package/dist/ddl/routine-guards.d.ts +63 -0
  88. package/dist/ddl/sequence-ddl.d.ts +103 -0
  89. package/dist/ddl/sql-literal.d.ts +61 -0
  90. package/dist/ddl/table-ddl.d.ts +35 -0
  91. package/dist/ddl/trigger-ddl.d.ts +81 -0
  92. package/dist/ddl/view-ddl.d.ts +122 -0
  93. package/dist/decorators/association-applier.d.ts +18 -0
  94. package/dist/decorators/association-decorators.d.ts +72 -0
  95. package/dist/decorators/column-decorators.d.ts +147 -0
  96. package/dist/decorators/decorator-factory.d.ts +45 -0
  97. package/dist/decorators/decorator-signature.d.ts +26 -0
  98. package/dist/decorators/decorator-types.d.ts +24 -0
  99. package/dist/decorators/foreign-key-decorator.d.ts +21 -0
  100. package/dist/decorators/hook-decorators.d.ts +393 -0
  101. package/dist/decorators/init-arguments.d.ts +29 -0
  102. package/dist/decorators/model-decorators.d.ts +18 -0
  103. package/dist/decorators/model-metadata.d.ts +70 -0
  104. package/dist/decorators/table-decorators.d.ts +43 -0
  105. package/dist/decorators/timestamp-decorators.d.ts +38 -0
  106. package/dist/errors/base-error.d.ts +40 -0
  107. package/dist/errors/connection-errors.d.ts +152 -0
  108. package/dist/errors/database-errors.d.ts +152 -0
  109. package/dist/errors/errors.d.ts +5 -0
  110. package/dist/errors/map-pg-error.d.ts +27 -0
  111. package/dist/errors/misc-errors.d.ts +188 -0
  112. package/dist/errors/validation-errors.d.ts +117 -0
  113. package/dist/exports-core.d.ts +15 -0
  114. package/dist/exports-decorators.d.ts +8 -0
  115. package/dist/exports-errors.d.ts +2 -0
  116. package/dist/exports-model.d.ts +21 -0
  117. package/dist/exports-schema.d.ts +19 -0
  118. package/dist/expressions/call-expressions.d.ts +54 -0
  119. package/dist/expressions/condition-expressions.d.ts +51 -0
  120. package/dist/expressions/expression.d.ts +52 -0
  121. package/dist/expressions/jsonpath-helpers.d.ts +37 -0
  122. package/dist/expressions/methods.d.ts +188 -0
  123. package/dist/expressions/op.d.ts +182 -0
  124. package/dist/expressions/query-expressions.d.ts +110 -0
  125. package/dist/expressions/row-expressions.d.ts +35 -0
  126. package/dist/expressions/search-helpers.d.ts +138 -0
  127. package/dist/expressions/trigram-helpers.d.ts +40 -0
  128. package/dist/hooks/hooks.d.ts +125 -0
  129. package/dist/index.cjs +20461 -0
  130. package/dist/index.cjs.map +1 -0
  131. package/dist/index.d.ts +5 -0
  132. package/dist/index.js +20332 -0
  133. package/dist/index.js.map +1 -0
  134. package/dist/model/attribute-columns.d.ts +85 -0
  135. package/dist/model/attribute-normalizer.d.ts +42 -0
  136. package/dist/model/attribute-options.d.ts +121 -0
  137. package/dist/model/bulk-insert-builder.d.ts +24 -0
  138. package/dist/model/bulk-options.d.ts +173 -0
  139. package/dist/model/copy-options.d.ts +51 -0
  140. package/dist/model/cte-builder.d.ts +134 -0
  141. package/dist/model/definition-normalizer.d.ts +26 -0
  142. package/dist/model/delete-query-builder.d.ts +42 -0
  143. package/dist/model/find-options.d.ts +144 -0
  144. package/dist/model/find-query-builder.d.ts +38 -0
  145. package/dist/model/insert-query-builder.d.ts +41 -0
  146. package/dist/model/instance-destroyer.d.ts +44 -0
  147. package/dist/model/instance-lifecycle-services.d.ts +61 -0
  148. package/dist/model/instance-lifecycle.d.ts +128 -0
  149. package/dist/model/instance-saver.d.ts +25 -0
  150. package/dist/model/instance-state.d.ts +48 -0
  151. package/dist/model/instance-validation.d.ts +35 -0
  152. package/dist/model/instance-values.d.ts +80 -0
  153. package/dist/model/instance-writer.d.ts +59 -0
  154. package/dist/model/join-source-builder.d.ts +25 -0
  155. package/dist/model/lateral-keys-builder.d.ts +25 -0
  156. package/dist/model/merge-action-builder.d.ts +31 -0
  157. package/dist/model/merge-options.d.ts +72 -0
  158. package/dist/model/merge-query-builder.d.ts +29 -0
  159. package/dist/model/merge-source-builder.d.ts +22 -0
  160. package/dist/model/mixins/model-aggregates.d.ts +69 -0
  161. package/dist/model/mixins/model-associations.d.ts +73 -0
  162. package/dist/model/mixins/model-constructor.d.ts +7 -0
  163. package/dist/model/mixins/model-finders.d.ts +124 -0
  164. package/dist/model/mixins/model-hooks.d.ts +138 -0
  165. package/dist/model/mixins/model-postgres.d.ts +198 -0
  166. package/dist/model/mixins/model-schema-binding.d.ts +36 -0
  167. package/dist/model/mixins/model-schema.d.ts +55 -0
  168. package/dist/model/mixins/model-scopes.d.ts +57 -0
  169. package/dist/model/mixins/model-writers.d.ts +175 -0
  170. package/dist/model/mixins/named-hooks.d.ts +28 -0
  171. package/dist/model/model-accessors.d.ts +22 -0
  172. package/dist/model/model-base.d.ts +83 -0
  173. package/dist/model/model-definition.d.ts +130 -0
  174. package/dist/model/model-instance-persistence.d.ts +132 -0
  175. package/dist/model/model-instance-values.d.ts +154 -0
  176. package/dist/model/model-operations.d.ts +22 -0
  177. package/dist/model/model-registry.d.ts +139 -0
  178. package/dist/model/model-services.d.ts +46 -0
  179. package/dist/model/model-state.d.ts +60 -0
  180. package/dist/model/model-values.d.ts +86 -0
  181. package/dist/model/model.d.ts +560 -0
  182. package/dist/model/on-conflict-builder.d.ts +111 -0
  183. package/dist/model/operations/bulk-create-operation.d.ts +40 -0
  184. package/dist/model/operations/copy-from-source.d.ts +51 -0
  185. package/dist/model/operations/copy-operation.d.ts +54 -0
  186. package/dist/model/operations/count-operation.d.ts +52 -0
  187. package/dist/model/operations/create-operation.d.ts +31 -0
  188. package/dist/model/operations/destroy-operation.d.ts +65 -0
  189. package/dist/model/operations/find-cursor.d.ts +23 -0
  190. package/dist/model/operations/find-lookups.d.ts +89 -0
  191. package/dist/model/operations/find-operation.d.ts +47 -0
  192. package/dist/model/operations/increment-operation.d.ts +40 -0
  193. package/dist/model/operations/insert-operation.d.ts +71 -0
  194. package/dist/model/operations/merge-operation.d.ts +56 -0
  195. package/dist/model/operations/model-operation.d.ts +33 -0
  196. package/dist/model/operations/update-operation.d.ts +45 -0
  197. package/dist/model/operations/upsert-operation.d.ts +39 -0
  198. package/dist/model/options.d.ts +103 -0
  199. package/dist/model/returning-old.d.ts +52 -0
  200. package/dist/model/row-mapper.d.ts +78 -0
  201. package/dist/model/row-plan.d.ts +31 -0
  202. package/dist/model/runtime.d.ts +54 -0
  203. package/dist/model/scope-registry.d.ts +81 -0
  204. package/dist/model/select-aggregates.d.ts +37 -0
  205. package/dist/model/select-lock.d.ts +13 -0
  206. package/dist/model/select-options.d.ts +92 -0
  207. package/dist/model/select-query-builder.d.ts +73 -0
  208. package/dist/model/select-targets.d.ts +77 -0
  209. package/dist/model/source-option-builder.d.ts +23 -0
  210. package/dist/model/source-options.d.ts +108 -0
  211. package/dist/model/statement-builder.d.ts +77 -0
  212. package/dist/model/statement-services.d.ts +2 -0
  213. package/dist/model/sync-hooks.d.ts +18 -0
  214. package/dist/model/table-sample-builder.d.ts +13 -0
  215. package/dist/model/types.d.ts +85 -0
  216. package/dist/model/unnest-insert-builder.d.ts +24 -0
  217. package/dist/model/update-query-builder.d.ts +39 -0
  218. package/dist/model/v6-conflict-builder.d.ts +37 -0
  219. package/dist/model/value-cloner.d.ts +17 -0
  220. package/dist/model/values-writer.d.ts +12 -0
  221. package/dist/model/where-options.d.ts +164 -0
  222. package/dist/model/write-options.d.ts +160 -0
  223. package/dist/model/written-rows.d.ts +56 -0
  224. package/dist/query/query-result-shaper.d.ts +91 -0
  225. package/dist/query/raw-query.d.ts +27 -0
  226. package/dist/query-interface/alter-planner.d.ts +40 -0
  227. package/dist/query-interface/bulk-data.d.ts +44 -0
  228. package/dist/query-interface/column-commands.d.ts +52 -0
  229. package/dist/query-interface/column-describer.d.ts +17 -0
  230. package/dist/query-interface/enum-commands.d.ts +36 -0
  231. package/dist/query-interface/index-commands.d.ts +57 -0
  232. package/dist/query-interface/model-tables.d.ts +58 -0
  233. package/dist/query-interface/object-commands.d.ts +71 -0
  234. package/dist/query-interface/partition-commands.d.ts +43 -0
  235. package/dist/query-interface/policy-commands.d.ts +54 -0
  236. package/dist/query-interface/query-interface-objects.d.ts +108 -0
  237. package/dist/query-interface/query-interface-partitions.d.ts +66 -0
  238. package/dist/query-interface/query-interface-policies.d.ts +86 -0
  239. package/dist/query-interface/query-interface-routines.d.ts +120 -0
  240. package/dist/query-interface/query-interface-tables.d.ts +179 -0
  241. package/dist/query-interface/query-interface-types.d.ts +62 -0
  242. package/dist/query-interface/query-interface-views.d.ts +84 -0
  243. package/dist/query-interface/query-interface.d.ts +256 -0
  244. package/dist/query-interface/routine-commands.d.ts +71 -0
  245. package/dist/query-interface/schema-synchronizer.d.ts +99 -0
  246. package/dist/query-interface/statement-runner.d.ts +40 -0
  247. package/dist/query-interface/sync-planner.d.ts +26 -0
  248. package/dist/query-interface/table-commands.d.ts +63 -0
  249. package/dist/query-interface/table-introspector.d.ts +58 -0
  250. package/dist/query-interface/view-commands.d.ts +47 -0
  251. package/dist/sequelize/sequelize-base.d.ts +196 -0
  252. package/dist/sequelize/sequelize-constructor.d.ts +7 -0
  253. package/dist/sequelize/sequelize-hooks.d.ts +86 -0
  254. package/dist/sequelize/sequelize-internals.d.ts +87 -0
  255. package/dist/sequelize/sequelize-notifications.d.ts +66 -0
  256. package/dist/sequelize/sequelize-schema.d.ts +106 -0
  257. package/dist/sequelize/sequelize-transactions.d.ts +96 -0
  258. package/dist/sequelize.d.ts +790 -0
  259. package/dist/sql/ast-clauses.d.ts +137 -0
  260. package/dist/sql/ast-expressions.d.ts +88 -0
  261. package/dist/sql/ast-statements.d.ts +80 -0
  262. package/dist/sql/ast.d.ts +21 -0
  263. package/dist/sql/compile.d.ts +21 -0
  264. package/dist/sql/dml-compiler.d.ts +54 -0
  265. package/dist/sql/expression-compiler.d.ts +56 -0
  266. package/dist/sql/from-compiler.d.ts +39 -0
  267. package/dist/sql/identifier-quoter.d.ts +15 -0
  268. package/dist/sql/merge-compiler.d.ts +20 -0
  269. package/dist/sql/order.d.ts +15 -0
  270. package/dist/sql/query-compiler.d.ts +45 -0
  271. package/dist/sql/sql-chunks.d.ts +50 -0
  272. package/dist/sql/with-compiler.d.ts +19 -0
  273. package/dist/transaction/advisory-locks.d.ts +28 -0
  274. package/dist/transaction/transaction-constants.d.ts +35 -0
  275. package/dist/transaction/transaction-runner.d.ts +60 -0
  276. package/dist/transaction/transaction-starter.d.ts +25 -0
  277. package/dist/transaction/transaction-statements.d.ts +28 -0
  278. package/dist/transaction/transaction.d.ts +198 -0
  279. package/dist/validation/attribute-validators.d.ts +23 -0
  280. package/dist/validation/builtin-attribute-validator.d.ts +19 -0
  281. package/dist/validation/builtin-validators.d.ts +16 -0
  282. package/dist/validation/core-validator.d.ts +16 -0
  283. package/dist/validation/custom-validators.d.ts +13 -0
  284. package/dist/validation/instance-validator.d.ts +25 -0
  285. package/dist/validation/schema-items.d.ts +22 -0
  286. package/dist/validation/standard-schema-validator.d.ts +30 -0
  287. package/dist/validation/standard-schema.d.ts +39 -0
  288. package/dist/validation/types.d.ts +36 -0
  289. package/dist/validation/validation-target.d.ts +13 -0
  290. package/dist/where/comparison-compiler.d.ts +27 -0
  291. package/dist/where/condition-compiler.d.ts +18 -0
  292. package/dist/where/operand-resolver.d.ts +10 -0
  293. package/dist/where/operator-allowlist.d.ts +14 -0
  294. package/dist/where/where-support.d.ts +52 -0
  295. package/dist/where/where.d.ts +46 -0
  296. package/dist/where/window-compiler.d.ts +14 -0
  297. package/llm/USAGE.md +423 -0
  298. package/package.json +102 -4
  299. package/skills/postgrelize/SKILL.md +57 -0
  300. package/skills/postgrelize/reference/associations.md +108 -0
  301. package/skills/postgrelize/reference/errors.md +37 -0
  302. package/skills/postgrelize/reference/migrating-from-sequelize.md +15 -0
  303. package/skills/postgrelize/reference/postgresql-features.md +157 -0
  304. package/skills/postgrelize/reference/querying.md +111 -0
  305. package/skills/postgrelize/reference/schema.md +135 -0
  306. package/skills/postgrelize/reference/security.md +34 -0
  307. package/skills/postgrelize/reference/transactions-and-sessions.md +122 -0
  308. package/skills/postgrelize/reference/writing.md +198 -0
@@ -0,0 +1,110 @@
1
+ import { ModifyingNode, QueryNode } from '../sql/ast.ts';
2
+ import { SqlExpression, SqlExpressionVisitor } from './expression.ts';
3
+ /**
4
+ * Options of {@link Subquery.union}, {@link Subquery.intersect} and {@link Subquery.except}.
5
+ *
6
+ * @example
7
+ * ```ts
8
+ * const opts: SetOperationOptions = { all: true };
9
+ * const rows = Post.subquery({ attributes: ['userId'] }).union(Task.subquery({ attributes: ['userId'] }), opts);
10
+ * ```
11
+ */
12
+ export type SetOperationOptions = Readonly<{
13
+ /**
14
+ * Keep duplicate rows (`UNION ALL`, `INTERSECT ALL`, `EXCEPT ALL`).
15
+ *
16
+ * @defaultValue false
17
+ */
18
+ all?: boolean;
19
+ }>;
20
+ /**
21
+ * SELECT embedded in another statement. Created by `Model.subquery()`, or by combining subqueries
22
+ * with a set operation. PostgreSQL extension.
23
+ */
24
+ export declare class Subquery extends SqlExpression {
25
+ #private;
26
+ /** @internal */
27
+ static readonly kind = "Subquery";
28
+ /** Builds the query AST (called when the outer statement is compiled). */
29
+ readonly build: () => QueryNode;
30
+ /**
31
+ * @param build - Builds the query AST.
32
+ */
33
+ constructor(build: () => QueryNode);
34
+ /**
35
+ * Rows of this query or of `other`, without duplicates unless `all` is set (`UNION`).
36
+ *
37
+ * Both queries must select the same number of columns of compatible types. Use the result
38
+ * wherever a subquery fits: `source`, `with`, `Op.in`, `insertFrom`, `merge`.
39
+ *
40
+ * @param other - Query to combine with.
41
+ * @param options - `all` keeps duplicates.
42
+ * @returns Combined subquery.
43
+ * @example
44
+ * ```ts
45
+ * const ids = Post.subquery({ attributes: ['userId'] }).union(Task.subquery({ attributes: ['userId'] }));
46
+ * const users = await User.findAll({ where: { id: { [Op.in]: ids } } });
47
+ * ```
48
+ */
49
+ union(other: Subquery, options?: SetOperationOptions): Subquery;
50
+ /**
51
+ * Rows that are in both this query and `other` (`INTERSECT`).
52
+ *
53
+ * @param other - Query to intersect with.
54
+ * @param options - `all` keeps duplicates.
55
+ * @returns Combined subquery.
56
+ * @example
57
+ * ```ts
58
+ * const both = Post.subquery({ attributes: ['userId'] }).intersect(Task.subquery({ attributes: ['userId'] }));
59
+ * ```
60
+ */
61
+ intersect(other: Subquery, options?: SetOperationOptions): Subquery;
62
+ /**
63
+ * Rows of this query that are not in `other` (`EXCEPT`).
64
+ *
65
+ * @param other - Query whose rows are removed.
66
+ * @param options - `all` keeps duplicates.
67
+ * @returns Combined subquery.
68
+ * @example
69
+ * ```ts
70
+ * const quiet = User.subquery({ attributes: ['id'] }).except(Post.subquery({ attributes: ['userId'] }));
71
+ * ```
72
+ */
73
+ except(other: Subquery, options?: SetOperationOptions): Subquery;
74
+ /** @internal */
75
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
76
+ }
77
+ /** `EXISTS (subquery)` / `NOT EXISTS (subquery)`. Created by {@link exists} / {@link notExists}. */
78
+ export declare class Exists extends SqlExpression {
79
+ /** @internal */
80
+ static readonly kind = "Exists";
81
+ /** The wrapped `SELECT` that `EXISTS` tests for rows. */
82
+ readonly subquery: Subquery;
83
+ /** `NOT EXISTS`. */
84
+ readonly negated: boolean;
85
+ /**
86
+ * @param subquery - Subquery.
87
+ * @param negated - `NOT EXISTS`.
88
+ */
89
+ constructor(subquery: Subquery, negated: boolean);
90
+ /** @internal */
91
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
92
+ }
93
+ /**
94
+ * INSERT, UPDATE or DELETE statement for a data-modifying CTE. Created by `Model.insertStatement()`,
95
+ * `Model.updateStatement()` and `Model.deleteStatement()`; not executed on its own. PostgreSQL extension.
96
+ *
97
+ * @example
98
+ * ```ts
99
+ * const moved = Task.deleteStatement({ where: { done: true }, returning: true });
100
+ * const rows = await Task.findAll({ with: { moved }, source: 'moved' });
101
+ * ```
102
+ */
103
+ export declare class WriteStatement {
104
+ /** Builds the statement AST (called when the outer statement is compiled). */
105
+ readonly build: () => ModifyingNode;
106
+ /**
107
+ * @param build - Builds the statement AST.
108
+ */
109
+ constructor(build: () => ModifyingNode);
110
+ }
@@ -0,0 +1,35 @@
1
+ import { Fn } from './call-expressions.ts';
2
+ import { SqlExpression, SqlExpressionVisitor } from './expression.ts';
3
+ import { Literal } from './methods.ts';
4
+ /** Window function call `fn OVER (...)`. Created by {@link over}. */
5
+ export declare class Over extends SqlExpression {
6
+ /** @internal */
7
+ static readonly kind = "Over";
8
+ /** Window function, e.g. `fn('row_number')`. */
9
+ readonly fn: Fn | Literal;
10
+ /** `PARTITION BY` attributes or expressions. */
11
+ readonly partitionBy: readonly unknown[];
12
+ /** `ORDER BY` items: attribute, `[attribute, direction]` or expression. */
13
+ readonly orderBy: readonly unknown[];
14
+ /**
15
+ * @param fn - Window function.
16
+ * @param partitionBy - `PARTITION BY` items.
17
+ * @param orderBy - `ORDER BY` items.
18
+ */
19
+ constructor(fn: Fn | Literal, partitionBy: readonly unknown[], orderBy: readonly unknown[]);
20
+ /** @internal */
21
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
22
+ }
23
+ /** Row constructor `(a, b, ...)` for row comparisons. Created by {@link tuple}. */
24
+ export declare class Tuple extends SqlExpression {
25
+ /** @internal */
26
+ static readonly kind = "Tuple";
27
+ /** Row items. */
28
+ readonly items: readonly unknown[];
29
+ /**
30
+ * @param items - Row items.
31
+ */
32
+ constructor(items: readonly unknown[]);
33
+ /** @internal */
34
+ accept<R>(visitor: SqlExpressionVisitor<R>): R;
35
+ }
@@ -0,0 +1,138 @@
1
+ import { Fn } from './call-expressions.ts';
2
+ /**
3
+ * Options of {@link tsRank}.
4
+ *
5
+ * @example
6
+ * ```ts
7
+ * const options: TsRankOptions = { cd: true, weights: [0.1, 0.2, 0.4, 1], normalization: 1 };
8
+ * ```
9
+ */
10
+ export type TsRankOptions = Readonly<{
11
+ /** Uses `ts_rank_cd` (cover density) instead of `ts_rank`. */
12
+ cd?: boolean;
13
+ /** Weights of the labels `D`, `C`, `B`, `A`, in this order. */
14
+ weights?: readonly [number, number, number, number];
15
+ /** Normalization bit mask, an integer from 0 to 63. */
16
+ normalization?: number;
17
+ }>;
18
+ /**
19
+ * Options of {@link tsHeadline}.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const options: TsHeadlineOptions = { config: 'english', options: 'StartSel=<b>, StopSel=</b>' };
24
+ * ```
25
+ */
26
+ export type TsHeadlineOptions = Readonly<{
27
+ /** Text search configuration, e.g. `'english'`. */
28
+ config?: string;
29
+ /** `ts_headline` options string, e.g. `'StartSel=<b>, StopSel=</b>'`. Bound as a parameter. */
30
+ options?: string;
31
+ }>;
32
+ /**
33
+ * `to_tsvector([config,] document)`: parses a document into a `tsvector`. PostgreSQL extension.
34
+ *
35
+ * @param document - Text value (bound as a parameter) or an expression such as `col('body')`.
36
+ * @param config - Text search configuration; the server default when omitted.
37
+ * @returns Function call expression.
38
+ * @throws Error when `config` is not a plain or schema-qualified identifier.
39
+ * @example
40
+ * ```ts
41
+ * await Post.findAll({ where: where(toTsVector(col('body'), 'english'), Op.match, websearchToTsQuery('cat -dog', 'english')) });
42
+ * ```
43
+ */
44
+ export declare const toTsVector: (document: unknown, config?: string) => Fn;
45
+ /**
46
+ * `to_tsquery([config,] query)`: parses `tsquery` syntax (`&`, `|`, `!`, `<->`). PostgreSQL extension.
47
+ *
48
+ * @param query - Query text in `tsquery` syntax, bound as a parameter. Invalid syntax is a database error.
49
+ * @param config - Text search configuration; the server default when omitted.
50
+ * @returns Function call expression.
51
+ * @throws Error when `config` is not a plain or schema-qualified identifier.
52
+ * @example
53
+ * ```ts
54
+ * await Post.findAll({ where: { search: { [Op.match]: toTsQuery('cat & !dog', 'english') } } });
55
+ * ```
56
+ */
57
+ export declare const toTsQuery: (query: unknown, config?: string) => Fn;
58
+ /**
59
+ * `plainto_tsquery([config,] text)`: ANDs all words of plain text. PostgreSQL extension.
60
+ *
61
+ * @param text - Plain text, bound as a parameter.
62
+ * @param config - Text search configuration; the server default when omitted.
63
+ * @returns Function call expression.
64
+ * @throws Error when `config` is not a plain or schema-qualified identifier.
65
+ * @example
66
+ * ```ts
67
+ * await Post.findAll({ where: { search: { [Op.match]: plainToTsQuery('fat cats', 'english') } } });
68
+ * ```
69
+ */
70
+ export declare const plainToTsQuery: (text: unknown, config?: string) => Fn;
71
+ /**
72
+ * `phraseto_tsquery([config,] text)`: words of plain text that must follow each other. PostgreSQL extension.
73
+ *
74
+ * @param text - Plain text, bound as a parameter.
75
+ * @param config - Text search configuration; the server default when omitted.
76
+ * @returns Function call expression.
77
+ * @throws Error when `config` is not a plain or schema-qualified identifier.
78
+ * @example
79
+ * ```ts
80
+ * await Post.findAll({ where: { search: { [Op.match]: phraseToTsQuery('fat cats', 'english') } } });
81
+ * ```
82
+ */
83
+ export declare const phraseToTsQuery: (text: unknown, config?: string) => Fn;
84
+ /**
85
+ * `websearch_to_tsquery([config,] text)`: web-search syntax (quotes, `or`, `-`) that never fails to parse. PostgreSQL extension.
86
+ *
87
+ * @param text - User search text, bound as a parameter.
88
+ * @param config - Text search configuration; the server default when omitted.
89
+ * @returns Function call expression.
90
+ * @throws Error when `config` is not a plain or schema-qualified identifier.
91
+ * @example
92
+ * ```ts
93
+ * await Post.findAll({ where: { search: { [Op.match]: websearchToTsQuery('"fat cat" -dog', 'english') } } });
94
+ * ```
95
+ */
96
+ export declare const websearchToTsQuery: (text: unknown, config?: string) => Fn;
97
+ /**
98
+ * `ts_rank` / `ts_rank_cd`: relevance of a `tsvector` for a `tsquery`, for `attributes` and `order`. PostgreSQL extension.
99
+ *
100
+ * @param vector - `tsvector` expression, e.g. `col('search')`.
101
+ * @param query - `tsquery` expression, e.g. {@link websearchToTsQuery}.
102
+ * @param options - `cd`, `weights` and `normalization`.
103
+ * @returns Function call expression.
104
+ * @throws Error when `weights` is not four finite numbers or `normalization` is not an integer from 0 to 63.
105
+ * @example
106
+ * ```ts
107
+ * const query = websearchToTsQuery('cat', 'english');
108
+ * await Post.findAll({ where: { search: { [Op.match]: query } }, order: [[tsRank(col('search'), query, { normalization: 1 }), 'DESC']] });
109
+ * ```
110
+ */
111
+ export declare const tsRank: (vector: unknown, query: unknown, options?: TsRankOptions) => Fn;
112
+ /**
113
+ * `ts_headline`: a document excerpt with the query terms highlighted. PostgreSQL extension.
114
+ *
115
+ * @param document - Text expression or value, bound as a parameter.
116
+ * @param query - `tsquery` expression.
117
+ * @param options - Configuration and `ts_headline` options string.
118
+ * @returns Function call expression.
119
+ * @throws Error when `config` is not a plain or schema-qualified identifier.
120
+ * @example
121
+ * ```ts
122
+ * await Post.findAll({ attributes: [[tsHeadline(col('body'), websearchToTsQuery('cat'), { options: 'StartSel=<b>, StopSel=</b>' }), 'excerpt']] });
123
+ * ```
124
+ */
125
+ export declare const tsHeadline: (document: unknown, query: unknown, options?: TsHeadlineOptions) => Fn;
126
+ /**
127
+ * `setweight(vector, weight)`: labels every lexeme of a `tsvector` `A`, `B`, `C` or `D`. PostgreSQL extension.
128
+ *
129
+ * @param vector - `tsvector` expression, e.g. {@link toTsVector}.
130
+ * @param weight - Label `'A'`, `'B'`, `'C'` or `'D'`.
131
+ * @returns Function call expression.
132
+ * @throws Error when `weight` is not one of the four labels.
133
+ * @example
134
+ * ```ts
135
+ * await Post.findAll({ attributes: [[setWeight(toTsVector(col('title'), 'english'), 'A'), 'titleVector']] });
136
+ * ```
137
+ */
138
+ export declare const setWeight: (vector: unknown, weight: "A" | "B" | "C" | "D") => Fn;
@@ -0,0 +1,40 @@
1
+ import { Fn } from './call-expressions.ts';
2
+ import { Where } from './condition-expressions.ts';
3
+ /**
4
+ * `similarity(a, b)` of `pg_trgm`: trigram similarity from 0 to 1. PostgreSQL extension; needs
5
+ * `CREATE EXTENSION pg_trgm`.
6
+ *
7
+ * @param left - Text expression, e.g. `col('name')`.
8
+ * @param right - Text expression or value (bound as a parameter).
9
+ * @returns Function call expression.
10
+ * @example
11
+ * ```ts
12
+ * await User.findAll({ order: [[trigramSimilarity(col('name'), 'jon'), 'DESC']], limit: 5 });
13
+ * ```
14
+ */
15
+ export declare const trigramSimilarity: (left: unknown, right: unknown) => Fn;
16
+ /**
17
+ * `word_similarity(a, b)` of `pg_trgm`: similarity of `a` to the best matching part of `b`. PostgreSQL extension.
18
+ *
19
+ * @param left - Text expression or value, the searched word.
20
+ * @param right - Text expression, e.g. `col('body')`.
21
+ * @returns Function call expression.
22
+ * @example
23
+ * ```ts
24
+ * await Post.findAll({ attributes: [[trigramWordSimilarity('postgre', col('title')), 'score']] });
25
+ * ```
26
+ */
27
+ export declare const trigramWordSimilarity: (left: unknown, right: unknown) => Fn;
28
+ /**
29
+ * `left <-> right` of `pg_trgm`: trigram distance (`1 - similarity`), served by GiST trigram
30
+ * indexes for nearest-neighbour `order`. PostgreSQL extension.
31
+ *
32
+ * @param left - Text expression, e.g. `col('name')`.
33
+ * @param right - Text expression or value (bound as a parameter).
34
+ * @returns Where expression usable in `order` and `attributes`.
35
+ * @example
36
+ * ```ts
37
+ * await User.findAll({ order: [[trigramDistance(col('name'), 'jon'), 'ASC']], limit: 5 });
38
+ * ```
39
+ */
40
+ export declare const trigramDistance: (left: unknown, right: unknown) => Where;
@@ -0,0 +1,125 @@
1
+ /**
2
+ * Hook names accepted by `addHook` (Sequelize v6). Model lifecycle hooks, `beforeConnect` and the sync hooks
3
+ * (`beforeBulkSync`, `afterBulkSync`, `beforeSync`, `afterSync`) run; the other connection / define hooks are accepted
4
+ * and not run yet.
5
+ */
6
+ export declare const HOOK_TYPES: readonly ["beforeValidate", "afterValidate", "validationFailed", "beforeCreate", "afterCreate", "beforeUpdate", "afterUpdate", "beforeSave", "afterSave", "beforeDestroy", "afterDestroy", "beforeRestore", "afterRestore", "beforeUpsert", "afterUpsert", "beforeBulkCreate", "afterBulkCreate", "beforeBulkUpdate", "afterBulkUpdate", "beforeBulkDestroy", "afterBulkDestroy", "beforeBulkRestore", "afterBulkRestore", "beforeFind", "beforeFindAfterExpandIncludeAll", "beforeFindAfterOptions", "afterFind", "beforeCount", "beforeConnect", "afterConnect", "beforeDisconnect", "afterDisconnect", "beforePoolAcquire", "afterPoolAcquire", "beforeQuery", "afterQuery", "beforeSync", "afterSync", "beforeBulkSync", "afterBulkSync", "beforeDefine", "afterDefine", "beforeInit", "afterInit", "beforeAssociate", "afterAssociate"];
7
+ /** One of {@link HOOK_TYPES}. */
8
+ export type HookType = (typeof HOOK_TYPES)[number];
9
+ /** Hook function. May be async; its return value is ignored. Receives the model class as `this`. */
10
+ export type HookFunction = (...args: never[]) => unknown;
11
+ /** Registered hook: a function, optionally named so it can be removed by name. */
12
+ export type Hook = Readonly<{
13
+ /** Hook name, used by `removeHook`. */
14
+ name?: string;
15
+ /** Hook function. */
16
+ fn: HookFunction;
17
+ }>;
18
+ /** Hooks passed in `init({ hooks })` / `define({ hooks })`: one function or a list per hook type. */
19
+ export type HooksOption = Partial<Readonly<Record<HookType, HookFunction | readonly HookFunction[]>>>;
20
+ /**
21
+ * Immutable registry of hooks by type: `add` and `remove` return a new registry, so a model or `Sequelize`
22
+ * instance replaces its registry on change.
23
+ */
24
+ export declare class HookRegistry {
25
+ #private;
26
+ /** Registry without hooks. */
27
+ static readonly EMPTY: HookRegistry;
28
+ private constructor();
29
+ /**
30
+ * Builds a registry from the `hooks` option.
31
+ *
32
+ * @param option - One function or a list per hook type.
33
+ * @param base - Registry the hooks are added to.
34
+ * @returns Registry with the hooks of `base`, then those of `option`.
35
+ */
36
+ static fromOption(option: HooksOption | undefined, base?: HookRegistry): HookRegistry;
37
+ /**
38
+ * Runs hooks of `type` from each registry in order (model hooks first, then Sequelize-level hooks).
39
+ *
40
+ * @param registries - Registries in run order.
41
+ * @param type - Hook type.
42
+ * @param context - `this` of the hook functions.
43
+ * @param args - Hook arguments.
44
+ * @returns Resolves when all hooks finished.
45
+ */
46
+ static runAll(registries: readonly HookRegistry[], type: HookType, context: unknown, ...args: readonly unknown[]): Promise<void>;
47
+ /**
48
+ * Returns a registry with `fn` added (to the proxied types for `beforeSave` / `afterSave`, like v6).
49
+ *
50
+ * @param type - Hook type.
51
+ * @param fn - Hook function.
52
+ * @param name - Name to remove the hook by.
53
+ * @returns New registry; the receiver is not modified.
54
+ * @throws Error for an unknown hook type.
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * let registry!: HookRegistry;
59
+ * const next = registry.add('beforeCreate', () => {}, 'audit');
60
+ * next.has('beforeCreate');
61
+ * ```
62
+ */
63
+ add(type: string, fn: HookFunction, name?: string): HookRegistry;
64
+ /**
65
+ * Returns a registry without hooks matching `nameOrFn`.
66
+ *
67
+ * @param type - Hook type.
68
+ * @param nameOrFn - Hook name or function; all hooks of the type when omitted.
69
+ * @returns New registry; the receiver is not modified.
70
+ * @throws Error for an unknown hook type.
71
+ *
72
+ * @example
73
+ * ```ts
74
+ * let registry!: HookRegistry;
75
+ * const next = registry.remove('beforeCreate', 'audit');
76
+ * next.has('beforeCreate');
77
+ * ```
78
+ */
79
+ remove(type: string, nameOrFn?: string | HookFunction): HookRegistry;
80
+ /**
81
+ * Checks whether the registry has hooks of the type.
82
+ *
83
+ * @param type - Hook type.
84
+ * @returns True when at least one hook exists.
85
+ * @throws Error for an unknown hook type.
86
+ *
87
+ * @example
88
+ * ```ts
89
+ * let registry!: HookRegistry;
90
+ * if (registry.has('afterCreate')) {
91
+ * console.log('afterCreate hooks registered');
92
+ * }
93
+ * ```
94
+ */
95
+ has(type: string): boolean;
96
+ /**
97
+ * Like {@link HookRegistry.has}, but `undefined` for a type that never had a hook (what
98
+ * Sequelize v6 `hasHook` returns).
99
+ *
100
+ * @param type - Hook type.
101
+ * @returns Whether hooks exist, `undefined` when none was ever added.
102
+ * @throws Error for an unknown hook type.
103
+ * @example
104
+ * ```ts
105
+ * let registry!: HookRegistry;
106
+ * const known = registry.hasOrUndefined('beforeCreate'); // undefined until a hook was added
107
+ * ```
108
+ */
109
+ hasOrUndefined(type: string): boolean | undefined;
110
+ /**
111
+ * Runs the hooks of `type` in registration order.
112
+ *
113
+ * @param type - Hook type.
114
+ * @param context - `this` of the hook functions.
115
+ * @param args - Hook arguments.
116
+ * @returns Resolves when all hooks finished; a rejecting hook stops the chain.
117
+ *
118
+ * @example
119
+ * ```ts
120
+ * let registry!: HookRegistry;
121
+ * await registry.run('beforeCreate', User, { name: 'Ann' }, {});
122
+ * ```
123
+ */
124
+ run(type: HookType, context: unknown, ...args: readonly unknown[]): Promise<void>;
125
+ }