effect-qb 0.17.0 → 0.20.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 (137) hide show
  1. package/README.md +11 -1
  2. package/dist/index.js +9376 -0
  3. package/dist/mysql.js +4092 -2671
  4. package/dist/postgres/metadata.js +2589 -1402
  5. package/dist/postgres.js +3953 -3583
  6. package/dist/sqlite.js +5527 -4088
  7. package/dist/standard.js +9330 -0
  8. package/package.json +9 -4
  9. package/src/casing.ts +71 -0
  10. package/src/index.ts +2 -0
  11. package/src/internal/casing.ts +89 -0
  12. package/src/internal/coercion/rules.ts +13 -1
  13. package/src/internal/column-state.d.ts +3 -3
  14. package/src/internal/column-state.ts +24 -18
  15. package/src/internal/column.ts +52 -15
  16. package/src/internal/datatypes/define.ts +7 -1
  17. package/src/internal/datatypes/enrich.ts +23 -0
  18. package/src/internal/datatypes/lookup.ts +81 -25
  19. package/src/internal/datatypes/matrix.ts +903 -0
  20. package/src/internal/datatypes/shape.ts +2 -0
  21. package/src/internal/derived-table.ts +4 -36
  22. package/src/{mysql/internal/sql-expression-renderer.ts → internal/dialect-renderers/mysql.ts} +552 -361
  23. package/src/{postgres/internal/sql-expression-renderer.ts → internal/dialect-renderers/postgres.ts} +657 -400
  24. package/src/{sqlite/internal/sql-expression-renderer.ts → internal/dialect-renderers/sqlite.ts} +505 -347
  25. package/src/internal/dialect.ts +36 -1
  26. package/src/internal/dsl-mutation-runtime.ts +12 -162
  27. package/src/internal/dsl-plan-runtime.ts +10 -138
  28. package/src/internal/dsl-query-runtime.ts +5 -79
  29. package/src/internal/dsl-transaction-ddl-runtime.ts +41 -65
  30. package/src/internal/executor.ts +66 -49
  31. package/src/internal/grouping-key.ts +87 -20
  32. package/src/internal/implication-runtime.ts +1 -1
  33. package/src/internal/json/path-access.ts +351 -0
  34. package/src/internal/predicate/runtime.ts +3 -0
  35. package/src/internal/query.d.ts +39 -12
  36. package/src/internal/query.ts +65 -26
  37. package/src/internal/renderer.ts +26 -14
  38. package/src/internal/runtime/driver-value-mapping.ts +3 -3
  39. package/src/internal/runtime/normalize.ts +12 -5
  40. package/src/internal/runtime/schema.ts +28 -38
  41. package/src/internal/runtime/value.ts +20 -23
  42. package/src/internal/scalar.d.ts +1 -1
  43. package/src/internal/scalar.ts +8 -2
  44. package/src/internal/schema-derivation.d.ts +12 -61
  45. package/src/internal/schema-derivation.ts +95 -43
  46. package/src/internal/schema-expression.ts +2 -2
  47. package/src/internal/sql-expression-renderer.ts +19 -0
  48. package/src/internal/standard-dsl.ts +6978 -0
  49. package/src/internal/table-options.ts +126 -66
  50. package/src/internal/table.ts +819 -237
  51. package/src/mysql/column-extension.ts +3 -0
  52. package/src/mysql/column.ts +14 -15
  53. package/src/mysql/datatypes/index.ts +4 -2
  54. package/src/mysql/datatypes/spec.ts +6 -176
  55. package/src/mysql/errors/normalize.ts +0 -1
  56. package/src/mysql/executor.ts +11 -11
  57. package/src/mysql/function/temporal.ts +1 -1
  58. package/src/mysql/internal/dialect.ts +9 -4
  59. package/src/mysql/internal/dsl.ts +334 -170
  60. package/src/mysql/internal/renderer.ts +6 -2
  61. package/src/mysql/json.ts +7 -2
  62. package/src/mysql/query-extension.ts +16 -0
  63. package/src/mysql/renderer.ts +37 -3
  64. package/src/mysql/type.ts +60 -0
  65. package/src/mysql.ts +7 -13
  66. package/src/postgres/check.ts +1 -0
  67. package/src/postgres/column-extension.ts +28 -0
  68. package/src/postgres/column.ts +13 -19
  69. package/src/postgres/datatypes/index.d.ts +2 -1
  70. package/src/postgres/datatypes/index.ts +4 -2
  71. package/src/postgres/datatypes/spec.ts +6 -260
  72. package/src/postgres/errors/normalize.ts +0 -1
  73. package/src/postgres/executor.ts +11 -11
  74. package/src/postgres/foreign-key.ts +24 -0
  75. package/src/postgres/function/core.ts +1 -3
  76. package/src/postgres/function/index.ts +1 -17
  77. package/src/postgres/function/temporal.ts +1 -1
  78. package/src/postgres/index.ts +1 -0
  79. package/src/postgres/internal/dialect.ts +9 -4
  80. package/src/postgres/internal/dsl.ts +328 -179
  81. package/src/postgres/internal/renderer.ts +6 -2
  82. package/src/postgres/internal/schema-ddl.ts +22 -10
  83. package/src/postgres/internal/schema-model.ts +238 -7
  84. package/src/postgres/json-extension.ts +7 -0
  85. package/src/postgres/json.ts +762 -173
  86. package/src/postgres/jsonb.ts +37 -0
  87. package/src/postgres/primary-key.ts +24 -0
  88. package/src/postgres/query-extension.ts +2 -0
  89. package/src/postgres/renderer.ts +37 -3
  90. package/src/postgres/schema-management.ts +13 -13
  91. package/src/postgres/schema.ts +106 -15
  92. package/src/postgres/table.ts +205 -538
  93. package/src/postgres/type.ts +93 -10
  94. package/src/postgres/unique.ts +32 -0
  95. package/src/postgres.ts +20 -16
  96. package/src/sqlite/column-extension.ts +3 -0
  97. package/src/sqlite/column.ts +14 -15
  98. package/src/sqlite/datatypes/index.ts +4 -2
  99. package/src/sqlite/datatypes/spec.ts +6 -94
  100. package/src/sqlite/errors/normalize.ts +0 -1
  101. package/src/sqlite/executor.ts +11 -11
  102. package/src/sqlite/function/temporal.ts +1 -1
  103. package/src/sqlite/internal/dialect.ts +9 -4
  104. package/src/sqlite/internal/dsl.ts +307 -159
  105. package/src/sqlite/internal/renderer.ts +6 -2
  106. package/src/sqlite/json.ts +8 -2
  107. package/src/sqlite/query-extension.ts +2 -0
  108. package/src/sqlite/renderer.ts +37 -3
  109. package/src/sqlite/type.ts +40 -0
  110. package/src/sqlite.ts +7 -13
  111. package/src/standard/cast.ts +113 -0
  112. package/src/standard/check.ts +17 -0
  113. package/src/standard/column.ts +163 -0
  114. package/src/standard/datatypes/index.ts +83 -0
  115. package/src/standard/datatypes/spec.ts +12 -0
  116. package/src/standard/dialect.ts +40 -0
  117. package/src/standard/foreign-key.ts +37 -0
  118. package/src/standard/function/aggregate.ts +2 -0
  119. package/src/standard/function/core.ts +2 -0
  120. package/src/standard/function/index.ts +18 -0
  121. package/src/standard/function/string.ts +2 -0
  122. package/src/standard/function/temporal.ts +78 -0
  123. package/src/standard/function/window.ts +2 -0
  124. package/src/standard/index.ts +17 -0
  125. package/src/standard/internal/renderer.ts +45 -0
  126. package/src/standard/json.ts +883 -0
  127. package/src/standard/primary-key.ts +17 -0
  128. package/src/standard/query.ts +152 -0
  129. package/src/standard/renderer.ts +49 -0
  130. package/src/standard/table.ts +151 -0
  131. package/src/standard/unique.ts +17 -0
  132. package/src/standard.ts +32 -0
  133. package/src/internal/aggregation-validation.ts +0 -57
  134. package/src/internal/table.d.ts +0 -173
  135. package/src/mysql/table.ts +0 -183
  136. package/src/postgres/cast.ts +0 -45
  137. package/src/sqlite/table.ts +0 -183
@@ -0,0 +1,17 @@
1
+ import * as BaseTable from "../internal/table.js"
2
+ import type { TableOptionSpec } from "../internal/table-options.js"
3
+
4
+ type PrimaryKeySpec = Extract<TableOptionSpec, { readonly kind: "primaryKey" }>
5
+
6
+ export const make = BaseTable.primaryKey
7
+
8
+ export const named = <const Name extends string>(
9
+ name: BaseTable.NonEmptyStringInput<Name>
10
+ ) =>
11
+ <Spec extends PrimaryKeySpec, TableContext extends BaseTable.TableDefinition<any, any, any, "schema", any>>(
12
+ option: BaseTable.TableOption<Spec, TableContext>
13
+ ): BaseTable.TableOption<Spec & { readonly name: Name }, TableContext> =>
14
+ BaseTable.mapOption(option, (spec) => ({
15
+ ...spec,
16
+ name
17
+ } as Spec & { readonly name: Name }))
@@ -0,0 +1,152 @@
1
+ import {
2
+ type as standardType
3
+ } from "../internal/standard-dsl.js"
4
+ import type * as Expression from "../internal/scalar.js"
5
+
6
+ export {
7
+ literal,
8
+ column,
9
+ cast,
10
+ eq,
11
+ neq,
12
+ lt,
13
+ lte,
14
+ gt,
15
+ gte,
16
+ isNull,
17
+ isNotNull,
18
+ like,
19
+ ilike,
20
+ collate,
21
+ regexMatch,
22
+ regexIMatch,
23
+ regexNotMatch,
24
+ regexNotIMatch,
25
+ and,
26
+ or,
27
+ not,
28
+ all,
29
+ any,
30
+ case_ as case,
31
+ match,
32
+ in_ as in,
33
+ notIn,
34
+ between,
35
+ contains,
36
+ containedBy,
37
+ overlaps,
38
+ exists,
39
+ isDistinctFrom,
40
+ isNotDistinctFrom,
41
+ excluded,
42
+ as,
43
+ with_ as with,
44
+ withRecursive,
45
+ lateral,
46
+ scalar,
47
+ inSubquery,
48
+ compareAny,
49
+ compareAll,
50
+ values,
51
+ unnest,
52
+ select,
53
+ returning,
54
+ onConflict,
55
+ insert,
56
+ update,
57
+ upsert,
58
+ delete_ as delete,
59
+ truncate,
60
+ merge,
61
+ transaction,
62
+ commit,
63
+ rollback,
64
+ savepoint,
65
+ rollbackTo,
66
+ releaseSavepoint,
67
+ createTable,
68
+ dropTable,
69
+ createIndex,
70
+ dropIndex,
71
+ union,
72
+ unionAll,
73
+ intersect,
74
+ intersectAll,
75
+ except,
76
+ exceptAll,
77
+ where,
78
+ having,
79
+ from,
80
+ innerJoin,
81
+ leftJoin,
82
+ rightJoin,
83
+ fullJoin,
84
+ crossJoin,
85
+ distinct,
86
+ limit,
87
+ offset,
88
+ lock,
89
+ orderBy,
90
+ groupBy,
91
+ lower,
92
+ upper,
93
+ concat,
94
+ coalesce,
95
+ call,
96
+ count,
97
+ max,
98
+ min,
99
+ over,
100
+ rowNumber,
101
+ rank,
102
+ denseRank
103
+ } from "../internal/standard-dsl.js"
104
+
105
+ export { standardType as type }
106
+ export { union_query_capabilities } from "../internal/query.js"
107
+
108
+ export type MutationInputOf<Shape> = {
109
+ readonly [K in keyof Shape]:
110
+ | Shape[K]
111
+ | Expression.Scalar<Shape[K], Expression.DbType.Any, Expression.Nullability, "standard", Expression.ScalarKind, Expression.BindingId>
112
+ }
113
+
114
+ export type {
115
+ AnyTableFunctionSource,
116
+ AnyUnnestSource,
117
+ AnyValuesSource,
118
+ CapabilitiesOfPlan,
119
+ CompletePlan,
120
+ CteSource,
121
+ DialectCompatiblePlan,
122
+ DerivedSourceRequiredError,
123
+ EffectiveNullability,
124
+ ExpressionInput,
125
+ ExpressionOutput,
126
+ GroupByInput,
127
+ HavingPredicateInput,
128
+ MergeCapabilities,
129
+ MergeCapabilityTuple,
130
+ MutationTargetLike,
131
+ NumericExpressionInput,
132
+ OrderDirection,
133
+ OutputOfSelection,
134
+ PredicateInput,
135
+ QueryCapability,
136
+ QueryPlan,
137
+ QueryRequirement,
138
+ QueryStatement,
139
+ ResultRow,
140
+ ResultRows,
141
+ RuntimeResultRow,
142
+ RuntimeResultRows,
143
+ SchemaTableLike,
144
+ SetCompatiblePlan,
145
+ SetCompatibleRightPlan,
146
+ SetOperator,
147
+ SourceCapabilitiesOf,
148
+ SourceRequiredOf,
149
+ SourceRequirementError,
150
+ StatementOfPlan,
151
+ StringExpressionInput
152
+ } from "../internal/query.js"
@@ -0,0 +1,49 @@
1
+ import { pipeArguments, type Pipeable } from "effect/Pipeable"
2
+
3
+ import * as CoreRenderer from "../internal/renderer.js"
4
+ import * as Casing from "../internal/casing.js"
5
+ import type * as Expression from "../internal/scalar.js"
6
+ import type { StandardDatatypeFamily, StandardDatatypeKind } from "./datatypes/spec.js"
7
+ import { renderStandardPlan } from "./internal/renderer.js"
8
+
9
+ export type RenderedQuery<Row> = CoreRenderer.RenderedQuery<Row, "standard">
10
+
11
+ export type RowOf<Value extends RenderedQuery<any>> = CoreRenderer.RowOf<Value>
12
+
13
+ export type Renderer = CoreRenderer.Renderer<"standard"> & Pipeable & {
14
+ readonly [Casing.TypeId]: Casing.State
15
+ readonly withCasing: (options: Casing.Options) => Renderer
16
+ }
17
+
18
+ export type ValueMappings = Expression.DriverValueMappingsFor<StandardDatatypeKind | "uuid", StandardDatatypeFamily | "uuid">
19
+
20
+ export interface MakeOptions {
21
+ readonly valueMappings?: ValueMappings
22
+ }
23
+
24
+ interface RendererState extends MakeOptions {
25
+ readonly casing?: Casing.Options
26
+ }
27
+
28
+ const RendererProto = {
29
+ pipe(this: Pipeable) {
30
+ return pipeArguments(this, arguments)
31
+ }
32
+ }
33
+
34
+ const makeWithState = (state: RendererState = {}): Renderer => {
35
+ const renderer = CoreRenderer.makeTrusted("standard", (plan) => renderStandardPlan(plan, state))
36
+ return Object.assign(Object.create(RendererProto), renderer, {
37
+ [Casing.TypeId]: {
38
+ casing: state.casing
39
+ },
40
+ withCasing: (override: Casing.Options) =>
41
+ makeWithState({
42
+ ...state,
43
+ casing: Casing.merge(state.casing, override)
44
+ })
45
+ }) as Renderer
46
+ }
47
+
48
+ export const make = (options: MakeOptions = {}): Renderer =>
49
+ makeWithState({ valueMappings: options.valueMappings })
@@ -0,0 +1,151 @@
1
+ import type { AnyColumnDefinition } from "../internal/column-state.js"
2
+ import * as BaseTable from "../internal/table.js"
3
+
4
+ type Dialect = string
5
+
6
+ type DialectColumn = AnyColumnDefinition
7
+
8
+ type DialectFieldMap = Record<string, DialectColumn>
9
+
10
+ type InlinePrimaryKeyKeys<Fields extends DialectFieldMap> = Extract<{
11
+ [K in keyof Fields]: Fields[K]["metadata"]["primaryKey"] extends true ? K : never
12
+ }[keyof Fields], string>
13
+
14
+ export type TableDefinition<
15
+ Name extends string,
16
+ Fields extends DialectFieldMap,
17
+ PrimaryKeyColumns extends keyof Fields & string = InlinePrimaryKeyKeys<Fields>,
18
+ Kind extends "schema" | "alias" = "schema",
19
+ SchemaName extends string = "public",
20
+ ConflictArbiters extends BaseTable.ConflictArbiter = BaseTable.TableDefinition<
21
+ Name,
22
+ Fields,
23
+ PrimaryKeyColumns,
24
+ Kind,
25
+ SchemaName
26
+ >[typeof BaseTable.TypeId]["conflictArbiters"][number]
27
+ > = BaseTable.TableDefinition<Name, Fields, PrimaryKeyColumns, Kind, SchemaName, ConflictArbiters>
28
+
29
+ export type TableClassStatic<
30
+ Name extends string,
31
+ Fields extends DialectFieldMap,
32
+ PrimaryKeyColumns extends keyof Fields & string = InlinePrimaryKeyKeys<Fields>,
33
+ SchemaName extends string = "public",
34
+ ConflictArbiters extends BaseTable.ConflictArbiter = BaseTable.TableClassStatic<
35
+ Name,
36
+ Fields,
37
+ PrimaryKeyColumns,
38
+ SchemaName
39
+ >[typeof BaseTable.TypeId]["conflictArbiters"][number]
40
+ > = BaseTable.TableClassStatic<Name, Fields, PrimaryKeyColumns, SchemaName, ConflictArbiters>
41
+
42
+ export type AnyTable = BaseTable.AnyTable<Dialect>
43
+
44
+ type FieldsOfTable<Table extends BaseTable.AnyTable> = Table[typeof BaseTable.TypeId]["fields"] extends infer Fields extends DialectFieldMap
45
+ ? Fields
46
+ : never
47
+
48
+ type PrimaryKeyOfTable<Table extends BaseTable.AnyTable> = Table[typeof BaseTable.TypeId]["primaryKey"][number]
49
+
50
+ type SchemaNameOfTable<Table extends BaseTable.AnyTable> =
51
+ Table[typeof BaseTable.TypeId]["schemaName"] extends infer SchemaName extends string ? SchemaName : "public"
52
+
53
+ type ConflictArbiterOfTable<Table extends BaseTable.AnyTable> = Table[typeof BaseTable.TypeId]["conflictArbiters"][number]
54
+
55
+ export type TableOption = BaseTable.TableOption
56
+
57
+ export const TypeId = BaseTable.TypeId
58
+ export const OptionsSymbol = BaseTable.OptionsSymbol
59
+ export const options = BaseTable.options
60
+ export const option = BaseTable.option
61
+
62
+ export function make<
63
+ Name extends string,
64
+ Fields extends DialectFieldMap
65
+ >(
66
+ name: BaseTable.NonEmptyStringInput<Name>,
67
+ fields: Fields & BaseTable.NonEmptyFieldMap<Fields>
68
+ ): TableDefinition<Name, Fields, InlinePrimaryKeyKeys<Fields>, "schema", "public">
69
+ export function make<
70
+ Name extends string,
71
+ Fields extends DialectFieldMap,
72
+ const SchemaName extends string
73
+ >(
74
+ name: BaseTable.NonEmptyStringInput<Name>,
75
+ fields: Fields & BaseTable.NonEmptyFieldMap<Fields>,
76
+ schemaName: BaseTable.NonEmptySchemaNameInput<SchemaName>
77
+ ): TableDefinition<Name, Fields, InlinePrimaryKeyKeys<Fields>, "schema", SchemaName>
78
+ export function make(
79
+ name: string,
80
+ fields: DialectFieldMap,
81
+ schemaName?: string
82
+ ): any {
83
+ return arguments.length >= 3
84
+ ? BaseTable.make(name, fields, schemaName as string) as TableDefinition<string, DialectFieldMap, string, "schema", string>
85
+ : BaseTable.make(name, fields) as TableDefinition<string, DialectFieldMap, string, "schema", string>
86
+ }
87
+
88
+ export const alias = <
89
+ Table extends AnyTable,
90
+ AliasName extends string
91
+ >(
92
+ table: Table,
93
+ aliasName: BaseTable.LiteralStringInput<AliasName>
94
+ ): TableDefinition<
95
+ AliasName,
96
+ FieldsOfTable<Table>,
97
+ PrimaryKeyOfTable<Table>,
98
+ "alias",
99
+ SchemaNameOfTable<Table>,
100
+ ConflictArbiterOfTable<Table>
101
+ > =>
102
+ BaseTable.alias(table as any, aliasName) as TableDefinition<
103
+ AliasName,
104
+ FieldsOfTable<Table>,
105
+ PrimaryKeyOfTable<Table>,
106
+ "alias",
107
+ SchemaNameOfTable<Table>,
108
+ ConflictArbiterOfTable<Table>
109
+ >
110
+
111
+ type ClassApi = {
112
+ <Self = never>(
113
+ name: "",
114
+ schemaName?: string | undefined
115
+ ): never
116
+ <Self = never>(
117
+ name: string,
118
+ schemaName: ""
119
+ ): never
120
+ <Self = never, const SchemaName extends string = "public", const Name extends string = string>(
121
+ name: BaseTable.NonEmptyStringInput<Name>,
122
+ schemaName?: BaseTable.NonEmptySchemaNameInput<SchemaName>
123
+ ): <
124
+ Fields extends DialectFieldMap
125
+ >(fields: Fields & BaseTable.NonEmptyFieldMap<Fields>) => [Self] extends [never]
126
+ ? BaseTable.MissingSelfGeneric
127
+ : TableClassStatic<Name, Fields, InlinePrimaryKeyKeys<Fields>, SchemaName>
128
+ }
129
+
130
+ export const Class: ClassApi = ((
131
+ name: string,
132
+ schemaName: string | undefined = undefined
133
+ ) => {
134
+ const base = BaseTable.Class(name as never, schemaName)
135
+ return base
136
+ }) as ClassApi
137
+
138
+ export const primaryKey = BaseTable.primaryKey
139
+ export const unique = BaseTable.unique
140
+ export const index = BaseTable.index
141
+ export const foreignKey = BaseTable.foreignKey
142
+
143
+ export const check = BaseTable.check
144
+
145
+ export const selectSchema = BaseTable.selectSchema
146
+ export const insertSchema = BaseTable.insertSchema
147
+ export const updateSchema = BaseTable.updateSchema
148
+
149
+ export type SelectOf<Table extends AnyTable> = BaseTable.SelectOf<Table>
150
+ export type InsertOf<Table extends AnyTable> = BaseTable.InsertOf<Table>
151
+ export type UpdateOf<Table extends AnyTable> = BaseTable.UpdateOf<Table>
@@ -0,0 +1,17 @@
1
+ import * as BaseTable from "../internal/table.js"
2
+ import type { TableOptionSpec } from "../internal/table-options.js"
3
+
4
+ type UniqueSpec = Extract<TableOptionSpec, { readonly kind: "unique" }>
5
+
6
+ export const make = BaseTable.unique
7
+
8
+ export const named = <const Name extends string>(
9
+ name: BaseTable.NonEmptyStringInput<Name>
10
+ ) =>
11
+ <Spec extends UniqueSpec, TableContext extends BaseTable.TableDefinition<any, any, any, "schema", any>>(
12
+ option: BaseTable.TableOption<Spec, TableContext>
13
+ ): BaseTable.TableOption<Spec & { readonly name: Name }, TableContext> =>
14
+ BaseTable.mapOption(option, (spec) => ({
15
+ ...spec,
16
+ name
17
+ } as Spec & { readonly name: Name }))
@@ -0,0 +1,32 @@
1
+ /** Standard SQL column-definition DSL. */
2
+ export * as Column from "./standard/column.js"
3
+ /** Standard SQL cast helpers. */
4
+ export * as Cast from "./standard/cast.js"
5
+ /** Standard SQL datatype witnesses and coercion families. */
6
+ export * as Datatypes from "./standard/datatypes/index.js"
7
+ /** Shared scalar SQL interfaces and DB-type descriptors. */
8
+ export * as Scalar from "./internal/scalar.js"
9
+ /** Standard SQL function expressions. */
10
+ export * as Function from "./standard/function/index.js"
11
+ /** Standard SQL JSON expression helpers and path segments. */
12
+ export * as Json from "./standard/json.js"
13
+ /** Standard SQL typed query execution contracts. */
14
+ export * as Executor from "./internal/executor.js"
15
+ /** Shared logical row-set interfaces. */
16
+ export * as RowSet from "./internal/row-set.js"
17
+ /** Standard SQL query-construction DSL. */
18
+ export * as Query from "./standard/query.js"
19
+ /** Standard SQL table-definition DSL. */
20
+ export * as Table from "./standard/table.js"
21
+ /** Standard SQL table-level primary-key options. */
22
+ export * as PrimaryKey from "./standard/primary-key.js"
23
+ /** Standard SQL table-level unique-constraint options. */
24
+ export * as Unique from "./standard/unique.js"
25
+ /** Standard SQL table-level index options. */
26
+ export * as Index from "./standard/index.js"
27
+ /** Standard SQL table-level foreign-key options. */
28
+ export * as ForeignKey from "./standard/foreign-key.js"
29
+ /** Standard SQL table-level check-constraint options. */
30
+ export * as Check from "./standard/check.js"
31
+ /** Standard SQL built-in renderer entrypoint. */
32
+ export * as Renderer from "./standard/renderer.js"
@@ -1,57 +0,0 @@
1
- import * as Expression from "./scalar.js"
2
- import { groupingKeyOfExpression } from "./grouping-key.js"
3
-
4
- /** Recursive selection value accepted by aggregate-shape validation. */
5
- export type SelectionValue =
6
- | Expression.Any
7
- | {
8
- readonly [key: string]: SelectionValue
9
- }
10
-
11
- const isExpression = (value: unknown): value is Expression.Any =>
12
- typeof value === "object" && value !== null && Expression.TypeId in value
13
-
14
- const selectionHasAggregate = (selection: SelectionValue): boolean => {
15
- if (isExpression(selection)) {
16
- return selection[Expression.TypeId].kind === "aggregate"
17
- }
18
- return Object.values(selection).some((value) => selectionHasAggregate(value))
19
- }
20
-
21
- const isGroupedSelectionValid = (
22
- selection: SelectionValue,
23
- groupedExpressions: ReadonlySet<string>
24
- ): boolean => {
25
- if (isExpression(selection)) {
26
- const aggregation = selection[Expression.TypeId].kind
27
- if (aggregation === "aggregate") {
28
- return true
29
- }
30
- if (aggregation === "window") {
31
- return false
32
- }
33
- if (Object.keys(selection[Expression.TypeId].dependencies).length === 0) {
34
- return true
35
- }
36
- return groupedExpressions.has(groupingKeyOfExpression(selection))
37
- }
38
- return Object.values(selection).every((value) => isGroupedSelectionValid(value, groupedExpressions))
39
- }
40
-
41
- /**
42
- * Validates that grouped/scalar selection mixing is legal for the provided
43
- * `groupBy(...)` expressions.
44
- */
45
- export const validateAggregationSelection = (
46
- selection: SelectionValue,
47
- grouped: readonly Expression.Any[]
48
- ): void => {
49
- const groupedExpressions = new Set(grouped.map(groupingKeyOfExpression))
50
- const hasAggregate = selectionHasAggregate(selection)
51
- const isValid = hasAggregate || grouped.length > 0
52
- ? isGroupedSelectionValid(selection, groupedExpressions)
53
- : true
54
- if (!isValid) {
55
- throw new Error("Invalid grouped selection: scalar expressions must be covered by groupBy(...) when aggregates are present")
56
- }
57
- }
@@ -1,173 +0,0 @@
1
- import { type Pipeable } from "effect/Pipeable";
2
- import * as Schema from "effect/Schema";
3
- import * as Plan from "./row-set.js";
4
- import type { TrueFormula } from "./predicate/formula.js";
5
- import type { BoundColumnFrom } from "./column-state.js";
6
- import { type DdlExpressionLike, type NormalizeColumns, type TableOptionSpec, type ValidateKnownColumns, type ValidatePrimaryKeyColumns } from "./table-options.js";
7
- import { type InsertRow, type SelectRow, type TableFieldMap, type UpdateRow } from "./schema-derivation.js";
8
- /** Symbol used to attach table-definition metadata. */
9
- export declare const TypeId: unique symbol;
10
- /** Symbol for the normalized table option list. */
11
- export declare const OptionsSymbol: unique symbol;
12
- /** Symbol used by `Table.Class` to declare table-level options. */
13
- export declare const options: unique symbol;
14
- declare const DeclaredOptionsSymbol: unique symbol;
15
- type InlinePrimaryKeyKeys<Fields extends TableFieldMap> = Extract<{
16
- [K in keyof Fields]: Fields[K]["metadata"]["primaryKey"] extends true ? K : never;
17
- }[keyof Fields], string>;
18
- type TableDialect<Fields extends TableFieldMap> = Fields[keyof Fields][typeof import("./column-state.js").ColumnTypeId]["dbType"]["dialect"];
19
- type TableKind = "schema" | "alias";
20
- type DefaultSchemaName = "public";
21
- type ClassOptionSpec = Exclude<TableOptionSpec, {
22
- readonly kind: "primaryKey";
23
- }>;
24
- interface TableOptionBuilderLike<Spec extends TableOptionSpec = TableOptionSpec> {
25
- (table: TableDefinition<any, any, any, "schema", any>): TableDefinition<any, any, any, "schema", any>;
26
- readonly option: Spec;
27
- }
28
- type ClassTableOption = TableOptionBuilderLike<ClassOptionSpec>;
29
- type ClassDeclaredTableOptions = readonly ClassTableOption[];
30
- type BuildPrimaryKey<Table extends TableDefinition<any, any, any, "schema", any>, Spec extends TableOptionSpec> = Spec extends {
31
- readonly kind: "primaryKey";
32
- readonly columns: infer Columns extends readonly string[];
33
- } ? Columns[number] & keyof Table[typeof TypeId]["fields"] & string : Table[typeof TypeId]["primaryKey"][number];
34
- type OptionInputTable<Table extends TableDefinition<any, any, any, "schema", any>, Spec extends TableOptionSpec> = Spec extends {
35
- readonly kind: "primaryKey";
36
- readonly columns: infer Columns extends readonly string[];
37
- } ? ValidatePrimaryKeyColumns<Table[typeof TypeId]["fields"], Columns> extends never ? never : Table : Spec extends {
38
- readonly columns: infer Columns extends readonly string[];
39
- } ? ValidateKnownColumns<Table[typeof TypeId]["fields"], Columns> extends never ? never : Table : Table;
40
- type ApplyOption<Table extends TableDefinition<any, any, any, "schema", any>, Spec extends TableOptionSpec> = Spec extends {
41
- readonly kind: "primaryKey";
42
- } ? TableDefinition<Table[typeof TypeId]["name"], Table[typeof TypeId]["fields"], BuildPrimaryKey<Table, Spec>, "schema"> : TableDefinition<Table[typeof TypeId]["name"], Table[typeof TypeId]["fields"], Table[typeof TypeId]["primaryKey"][number], "schema">;
43
- export type MissingSelfGeneric = "Missing `Self` generic - use `class Self extends Table.Class<Self>(...) {}`";
44
- /** Bound columns keyed by field name for a particular table. */
45
- export type BoundColumns<Name extends string, Fields extends TableFieldMap> = {
46
- readonly [K in keyof Fields]: BoundColumnFrom<Fields[K], Name, Extract<K, string>>;
47
- };
48
- /** Derived runtime schemas exposed by a table definition. */
49
- export interface TableSchemas<Name extends string, Fields extends TableFieldMap, PrimaryKeyColumns extends keyof Fields & string> {
50
- readonly select: Schema.Schema<SelectRow<Name, Fields>>;
51
- readonly insert: Schema.Schema<InsertRow<Name, Fields>>;
52
- readonly update: Schema.Schema<UpdateRow<Name, Fields, PrimaryKeyColumns>>;
53
- }
54
- interface TableState<Name extends string, Fields extends TableFieldMap, PrimaryKeyColumns extends keyof Fields & string, Kind extends TableKind = "schema", SchemaName extends string | undefined = DefaultSchemaName> {
55
- readonly name: Name;
56
- readonly baseName: string;
57
- readonly schemaName: SchemaName;
58
- readonly fields: Fields;
59
- readonly primaryKey: readonly PrimaryKeyColumns[];
60
- readonly kind: Kind;
61
- }
62
- /** Namespace-scoped table builder. */
63
- export interface TableSchemaNamespace<SchemaName extends string> {
64
- readonly schemaName: SchemaName;
65
- readonly table: <Name extends string, Fields extends TableFieldMap, PrimaryKeyColumns extends keyof Fields & string = InlinePrimaryKeyKeys<Fields>>(name: Name, fields: Fields, ...options: DeclaredTableOptions) => TableDefinition<Name, Fields, PrimaryKeyColumns, "schema", SchemaName>;
66
- }
67
- export type DeclaredTableOptions = readonly TableOptionBuilderLike[];
68
- export type { DdlExpressionLike, IndexKeySpec, NormalizeColumns, ReferentialAction } from "./table-options.js";
69
- export type TableDefinition<Name extends string, Fields extends TableFieldMap, PrimaryKeyColumns extends keyof Fields & string = InlinePrimaryKeyKeys<Fields>, Kind extends TableKind = "schema", SchemaName extends string | undefined = DefaultSchemaName> = Pipeable & {
70
- readonly name: Name;
71
- readonly columns: BoundColumns<Name, Fields>;
72
- readonly schemas: TableSchemas<Name, Fields, PrimaryKeyColumns>;
73
- readonly [TypeId]: TableState<Name, Fields, PrimaryKeyColumns, Kind, SchemaName>;
74
- readonly [Plan.TypeId]: Plan.State<BoundColumns<Name, Fields>, never, Record<Name, Plan.Source<Name, "required", TrueFormula>>, TableDialect<Fields>>;
75
- readonly [OptionsSymbol]: readonly TableOptionSpec[];
76
- readonly [DeclaredOptionsSymbol]: readonly TableOptionSpec[];
77
- } & BoundColumns<Name, Fields> & Plan.RowSet<BoundColumns<Name, Fields>, never, Record<Name, Plan.Source<Name, "required", TrueFormula>>, TableDialect<Fields>>;
78
- /**
79
- * Static class-based table definition.
80
- *
81
- * The class object itself acts as the table definition, exposing static bound
82
- * columns, derived schemas, and plan metadata.
83
- */
84
- export type TableClassStatic<Name extends string, Fields extends TableFieldMap, PrimaryKeyColumns extends keyof Fields & string = InlinePrimaryKeyKeys<Fields>, SchemaName extends string | undefined = DefaultSchemaName> = (abstract new (...args: any[]) => any) & Pipeable & {
85
- readonly columns: BoundColumns<Name, Fields>;
86
- readonly schemas: TableSchemas<Name, Fields, PrimaryKeyColumns>;
87
- readonly [TypeId]: TableState<Name, Fields, PrimaryKeyColumns, "schema", SchemaName>;
88
- readonly [Plan.TypeId]: Plan.State<BoundColumns<Name, Fields>, never, Record<Name, Plan.Source<Name, "required", TrueFormula>>, TableDialect<Fields>>;
89
- readonly [OptionsSymbol]: readonly TableOptionSpec[];
90
- readonly [DeclaredOptionsSymbol]?: readonly TableOptionSpec[];
91
- readonly [options]?: ClassDeclaredTableOptions;
92
- readonly tableName: Name;
93
- } & BoundColumns<Name, Fields> & Plan.RowSet<BoundColumns<Name, Fields>, never, Record<Name, Plan.Source<Name, "required", TrueFormula>>, TableDialect<Fields>>;
94
- /** Minimal structural table-like contract used across helper APIs. */
95
- export type AnyTable = TableDefinition<any, any, any, any, any> | TableClassStatic<any, any, any, any>;
96
- /** Public table-option builder type used by `Table.index`, `Table.primaryKey`, and friends. */
97
- export type TableOption<Spec extends TableOptionSpec = TableOptionSpec> = {
98
- <Name extends string, Fields extends TableFieldMap, PrimaryKeyColumns extends keyof Fields & string>(table: OptionInputTable<TableDefinition<Name, Fields, PrimaryKeyColumns, "schema", any>, Spec>): ApplyOption<TableDefinition<Name, Fields, PrimaryKeyColumns, "schema", any>, Spec>;
99
- readonly option: Spec;
100
- };
101
- export declare const option: <Spec extends TableOptionSpec>(spec: Spec) => TableOption<Spec>;
102
- export declare const optionFromTable: <Spec extends TableOptionSpec>(spec: Spec, resolve: (table: TableDefinition<any, any, any, "schema", any>) => Spec) => TableOption<Spec>;
103
- /** Creates a table definition from a name and field map. */
104
- export declare function make<Name extends string, Fields extends TableFieldMap, SchemaName extends string | undefined = DefaultSchemaName>(name: Name, fields: Fields, schemaName?: SchemaName): TableDefinition<Name, Fields, InlinePrimaryKeyKeys<Fields>, "schema", SchemaName>;
105
- /**
106
- * Creates a namespace-scoped builder for a concrete SQL schema/database.
107
- */
108
- export declare const schema: <SchemaName extends string>(schemaName: SchemaName) => TableSchemaNamespace<SchemaName>;
109
- /**
110
- * Creates an aliased source from an existing table definition.
111
- *
112
- * The alias becomes the logical source identity used by the query layer while
113
- * the original physical table name is retained in bound-column provenance for
114
- * downstream SQL rendering work.
115
- */
116
- export declare const alias: <Name extends string, Fields extends TableFieldMap, PrimaryKeyColumns extends keyof Fields & string, SchemaName extends string, AliasName extends string>(table: TableClassStatic<Name, Fields, PrimaryKeyColumns, SchemaName> | TableDefinition<Name, Fields, PrimaryKeyColumns, any, SchemaName>, aliasName: AliasName) => TableDefinition<AliasName, Fields, PrimaryKeyColumns, "alias", SchemaName>;
117
- /**
118
- * Class-based table constructor mirroring `Schema.Class`.
119
- *
120
- * The returned base class can be extended and configured with
121
- * `static readonly [Table.options]`.
122
- */
123
- export declare function Class<Self = never, SchemaName extends string | undefined = DefaultSchemaName>(name: string, schemaName?: SchemaName): <Fields extends TableFieldMap>(fields: Fields) => [Self] extends [never] ? "Missing `Self` generic - use `class Self extends Table.Class<Self>(...) {}`" : TableClassStatic<string, Fields, Extract<{ [K in keyof Fields]: Fields[K]["metadata"]["primaryKey"] extends true ? K : never; }[keyof Fields], string>, SchemaName>;
124
- /** Declares a table-level primary key. */
125
- export declare const primaryKey: <const Columns extends string | readonly string[]>(columns: Columns) => TableOption<{
126
- readonly kind: "primaryKey";
127
- readonly columns: NormalizeColumns<Columns>;
128
- }>;
129
- /** Declares a table-level unique constraint. */
130
- export declare const unique: <const Columns extends string | readonly string[]>(columns: Columns) => TableOption<{
131
- readonly kind: "unique";
132
- readonly columns: NormalizeColumns<Columns>;
133
- }>;
134
- /** Declares a table-level index. */
135
- export declare const index: <const Columns extends string | readonly string[]>(columns: Columns) => TableOption<{
136
- readonly kind: "index";
137
- readonly columns: NormalizeColumns<Columns>;
138
- }>;
139
- /** Declares a table-level foreign key. */
140
- export declare const foreignKey: <const LocalColumns extends string | readonly string[], TargetTable extends AnyTable, const TargetColumns extends string | readonly string[]>(columns: LocalColumns, target: () => TargetTable, referencedColumns: TargetColumns) => TableOption<{
141
- readonly kind: "foreignKey";
142
- readonly columns: NormalizeColumns<LocalColumns>;
143
- readonly references: () => {
144
- readonly tableName: string;
145
- readonly schemaName?: string | undefined;
146
- readonly columns: NormalizeColumns<TargetColumns>;
147
- readonly knownColumns: readonly string[];
148
- };
149
- }>;
150
- /** Declares a check constraint expression. */
151
- export declare const check: <Name extends string>(name: Name, predicate: DdlExpressionLike) => TableOption<{
152
- readonly kind: "check";
153
- readonly name: Name;
154
- readonly predicate: DdlExpressionLike;
155
- }>;
156
- /** Extracts the row type of a table's select schema. */
157
- export type SelectOf<Table extends {
158
- readonly schemas: {
159
- readonly select: Schema.Schema<any>;
160
- };
161
- }> = Schema.Schema.Type<Table["schemas"]["select"]>;
162
- /** Extracts the payload type of a table's insert schema. */
163
- export type InsertOf<Table extends {
164
- readonly schemas: {
165
- readonly insert: Schema.Schema<any>;
166
- };
167
- }> = Schema.Schema.Type<Table["schemas"]["insert"]>;
168
- /** Extracts the payload type of a table's update schema. */
169
- export type UpdateOf<Table extends {
170
- readonly schemas: {
171
- readonly update: Schema.Schema<any>;
172
- };
173
- }> = Schema.Schema.Type<Table["schemas"]["update"]>;