feat: add alter type query support. (#1363)

Co-authored-by: Igal Klebanov <igalklebanov@gmail.com>

Author: lucianolix

src/index.ts

@@ -7,6 +7,7 @@ import type { KyselyTypeError } from './util/type-error.js'
 
 export * from './kysely.js'
 export * from './query-creator.js'
+export * from './query-finalizer.js'
 
 export * from './expression/expression.js'
 export {
@@ -49,7 +50,7 @@ export type * from './query-executor/query-executor-provider.js'
 export * from './query-compiler/default-query-compiler.js'
 export * from './query-compiler/compiled-query.js'
 
-export * from './schema/schema.js'
+export * from './schema/schema-module.js'
 export * from './schema/create-table-builder.js'
 export * from './schema/create-type-builder.js'
 export * from './schema/drop-table-builder.js'
@@ -235,6 +236,9 @@ export * from './operation-node/values-node.js'
 export * from './operation-node/when-node.js'
 export * from './operation-node/where-node.js'
 export * from './operation-node/with-node.js'
+export * from './operation-node/alter-type-node.js'
+export * from './operation-node/add-value-node.js'
+export * from './operation-node/rename-value-node.js'
 
 export type * from './util/column-type.js'
 export * from './util/compilable.js'

src/kysely.ts

@@ -1,5 +1,5 @@
 import type { Dialect } from './dialect/dialect.js'
-import { SchemaModule } from './schema/schema.js'
+import { SchemaModule } from './schema/schema-module.js'
 import { DynamicModule } from './dynamic/dynamic.js'
 import { DefaultConnectionProvider } from './driver/default-connection-provider.js'
 import type { QueryExecutor } from './query-executor/query-executor.js'

src/operation-node/add-value-node.ts

@@ -0,0 +1,45 @@
+import type { OperationNode } from './operation-node.js'
+import { freeze } from '../util/object-utils.js'
+import type { ValueNode } from './value-node.js'
+
+export type AddValueNodeProps = Omit<AddValueNode, 'kind' | 'value'>
+
+export interface AddValueNode extends OperationNode {
+  readonly kind: 'AddValueNode'
+  readonly value: ValueNode
+  readonly ifNotExists?: boolean
+  readonly neighborValue?: ValueNode
+  readonly isBefore?: boolean
+}
+
+type AddValueNodeFactory = Readonly<{
+  is(node: OperationNode): node is AddValueNode
+  create(value: ValueNode): Readonly<AddValueNode>
+  cloneWith(
+    node: AddValueNode,
+    props: AddValueNodeProps,
+  ): Readonly<AddValueNode>
+}>
+
+/**
+ * @internal
+ */
+export const AddValueNode: AddValueNodeFactory = freeze<AddValueNodeFactory>({
+  is(node): node is AddValueNode {
+    return node.kind === 'AddValueNode'
+  },
+
+  create(value) {
+    return freeze({
+      kind: 'AddValueNode',
+      value,
+    })
+  },
+
+  cloneWith(node, props) {
+    return freeze({
+      ...node,
+      ...props,
+    })
+  },
+})

src/operation-node/alter-type-node.ts

@@ -0,0 +1,51 @@
+import type { OperationNode } from './operation-node.js'
+import { freeze } from '../util/object-utils.js'
+import type { SchemableIdentifierNode } from './schemable-identifier-node.js'
+import type { IdentifierNode } from './identifier-node.js'
+import type { AddValueNode } from './add-value-node.js'
+import type { RenameValueNode } from './rename-value-node.js'
+
+export type AlterTypeNodeProps = Omit<AlterTypeNode, 'kind' | 'name'>
+
+export interface AlterTypeNode extends OperationNode {
+  readonly kind: 'AlterTypeNode'
+  readonly name: SchemableIdentifierNode
+  readonly addValue?: AddValueNode
+  readonly renameTo?: IdentifierNode
+  readonly renameValue?: RenameValueNode
+  readonly setSchema?: IdentifierNode
+}
+
+type AlterTypeNodeFactory = Readonly<{
+  is(node: OperationNode): node is AlterTypeNode
+  create(name: SchemableIdentifierNode): Readonly<AlterTypeNode>
+  cloneWith(
+    node: AlterTypeNode,
+    props: AlterTypeNodeProps,
+  ): Readonly<AlterTypeNode>
+}>
+
+/**
+ * @internal
+ */
+export const AlterTypeNode: AlterTypeNodeFactory = freeze<AlterTypeNodeFactory>(
+  {
+    is(node): node is AlterTypeNode {
+      return node.kind === 'AlterTypeNode'
+    },
+
+    create(name) {
+      return freeze({
+        kind: 'AlterTypeNode',
+        name,
+      })
+    },
+
+    cloneWith(node, props) {
+      return freeze({
+        ...node,
+        ...props,
+      })
+    },
+  },
+)

src/operation-node/operation-node-transformer.ts

@@ -99,6 +99,9 @@ import type { OrActionNode } from './or-action-node.js'
 import type { CollateNode } from './collate-node.js'
 import type { QueryId } from '../util/query-id.js'
 import type { RenameConstraintNode } from './rename-constraint-node.js'
+import type { AddValueNode } from './add-value-node.js'
+import type { AlterTypeNode } from './alter-type-node.js'
+import type { RenameValueNode } from './rename-value-node.js'
 
 /**
  * Transforms an operation node tree into another one.
@@ -242,6 +245,9 @@ export class OperationNodeTransformer {
     OutputNode: this.transformOutput.bind(this),
     OrActionNode: this.transformOrAction.bind(this),
     CollateNode: this.transformCollate.bind(this),
+    AlterTypeNode: this.transformAlterType.bind(this),
+    AddValueNode: this.transformAddValue.bind(this),
+    RenameValueNode: this.transformRenameValue.bind(this),
   })
 
   transformNode<T extends OperationNode | undefined>(
@@ -1289,6 +1295,44 @@ export class OperationNodeTransformer {
     })
   }
 
+  protected transformAlterType(
+    node: AlterTypeNode,
+    queryId?: QueryId,
+  ): AlterTypeNode {
+    return requireAllProps<AlterTypeNode>({
+      kind: 'AlterTypeNode',
+      name: this.transformNode(node.name, queryId),
+      addValue: this.transformNode(node.addValue, queryId),
+      renameTo: this.transformNode(node.renameTo, queryId),
+      renameValue: this.transformNode(node.renameValue, queryId),
+      setSchema: this.transformNode(node.setSchema, queryId),
+    })
+  }
+
+  protected transformAddValue(
+    node: AddValueNode,
+    queryId?: QueryId,
+  ): AddValueNode {
+    return requireAllProps<AddValueNode>({
+      kind: 'AddValueNode',
+      value: this.transformNode(node.value, queryId),
+      ifNotExists: node.ifNotExists,
+      isBefore: node.isBefore,
+      neighborValue: this.transformNode(node.neighborValue, queryId),
+    })
+  }
+
+  protected transformRenameValue(
+    node: RenameValueNode,
+    queryId?: QueryId,
+  ): RenameValueNode {
+    return requireAllProps<RenameValueNode>({
+      kind: 'RenameValueNode',
+      oldValue: this.transformNode(node.oldValue, queryId),
+      newValue: this.transformNode(node.newValue, queryId),
+    })
+  }
+
   protected transformDataType(
     node: DataTypeNode,
     _queryId?: QueryId,

src/operation-node/operation-node-visitor.ts

@@ -100,6 +100,9 @@ import type { RefreshMaterializedViewNode } from './refresh-materialized-view-no
 import type { OrActionNode } from './or-action-node.js'
 import type { CollateNode } from './collate-node.js'
 import type { RenameConstraintNode } from './rename-constraint-node.js'
+import type { AlterTypeNode } from './alter-type-node.js'
+import type { AddValueNode } from './add-value-node.js'
+import type { RenameValueNode } from './rename-value-node.js'
 
 export abstract class OperationNodeVisitor {
   protected readonly nodeStack: OperationNode[] = []
@@ -207,6 +210,9 @@ export abstract class OperationNodeVisitor {
     OutputNode: this.visitOutput.bind(this),
     OrActionNode: this.visitOrAction.bind(this),
     CollateNode: this.visitCollate.bind(this),
+    AlterTypeNode: this.visitAlterType.bind(this),
+    AddValueNode: this.visitAddValue.bind(this),
+    RenameValueNode: this.visitRenameValue.bind(this),
   })
 
   protected readonly visitNode = (node: OperationNode): void => {
@@ -324,4 +330,7 @@ export abstract class OperationNodeVisitor {
   protected abstract visitOutput(node: OutputNode): void
   protected abstract visitOrAction(node: OrActionNode): void
   protected abstract visitCollate(node: CollateNode): void
+  protected abstract visitAlterType(node: AlterTypeNode): void
+  protected abstract visitAddValue(node: AddValueNode): void
+  protected abstract visitRenameValue(node: RenameValueNode): void
 }

src/operation-node/operation-node.ts

@@ -98,6 +98,9 @@ export type OperationNodeKind =
   | 'OrActionNode'
   | 'CollateNode'
   | 'RenameConstraintNode'
+  | 'AlterTypeNode'
+  | 'AddValueNode'
+  | 'RenameValueNode'
 
 export interface OperationNode {
   readonly kind: OperationNodeKind

src/operation-node/rename-value-node.ts

@@ -0,0 +1,34 @@
+import { freeze } from '../util/object-utils.js'
+import type { OperationNode } from './operation-node.js'
+import type { ValueNode } from './value-node.js'
+
+export type RenameValueNodeProps = Omit<RenameValueNode, 'kind'>
+
+export interface RenameValueNode extends OperationNode {
+  readonly kind: 'RenameValueNode'
+  readonly oldValue: ValueNode
+  readonly newValue: ValueNode
+}
+
+type RenameValueNodeFactory = Readonly<{
+  is(node: OperationNode): node is RenameValueNode
+  create(
+    existingEnumValue: ValueNode,
+    newEnumValue: ValueNode,
+  ): Readonly<RenameValueNode>
+}>
+
+export const RenameValueNode: RenameValueNodeFactory =
+  freeze<RenameValueNodeFactory>({
+    is(node): node is RenameValueNode {
+      return node.kind === 'RenameValueNode'
+    },
+
+    create(oldValue, newValue) {
+      return freeze({
+        kind: 'RenameValueNode',
+        oldValue,
+        newValue,
+      })
+    },
+  })

src/operation-node/root-operation-node.ts

@@ -1,4 +1,5 @@
 import type { AlterTableNode } from './alter-table-node.js'
+import type { AlterTypeNode } from './alter-type-node.js'
 import type { CreateIndexNode } from './create-index-node.js'
 import type { CreateSchemaNode } from './create-schema-node.js'
 import type { CreateTableNode } from './create-table-node.js'
@@ -29,11 +30,13 @@ export type RootOperationNode =
   | RawNode
   | CreateTypeNode
   | DropTypeNode
+  | AlterTypeNode
 
 const ROOT_OPERATION_NODE_KINDS: Readonly<
   Record<RootOperationNode['kind'], true>
 > = {
   AlterTableNode: true,
+  AlterTypeNode: true,
   CreateIndexNode: true,
   CreateSchemaNode: true,
   CreateTableNode: true,

src/query-compiler/default-query-compiler.ts

@@ -117,6 +117,9 @@ import type { CollateNode } from '../operation-node/collate-node.js'
 import type { QueryId } from '../util/query-id.js'
 import type { RenameConstraintNode } from '../operation-node/rename-constraint-node.js'
 import type { RootOperationNode } from '../operation-node/root-operation-node.js'
+import type { AddValueNode } from '../operation-node/add-value-node.js'
+import type { AlterTypeNode } from '../operation-node/alter-type-node.js'
+import type { RenameValueNode } from '../operation-node/rename-value-node.js'
 
 const LIT_WRAP_REGEX = /'/g
 
@@ -1461,6 +1464,46 @@ export class DefaultQueryCompiler
     }
   }
 
+  protected override visitAlterType(node: AlterTypeNode): void {
+    this.append('alter type ')
+    this.visitNode(node.name)
+    this.append(' ')
+
+    if (node.addValue) {
+      this.visitNode(node.addValue)
+    } else if (node.renameTo) {
+      this.append('rename to ')
+      this.visitNode(node.renameTo)
+    } else if (node.renameValue) {
+      this.visitNode(node.renameValue)
+    } else if (node.setSchema) {
+      this.append('set schema ')
+      this.visitNode(node.setSchema)
+    }
+  }
+
+  protected override visitAddValue(node: AddValueNode): void {
+    this.append('add value ')
+
+    if (node.ifNotExists) {
+      this.append('if not exists ')
+    }
+
+    this.visitNode(node.value)
+
+    if (node.neighborValue) {
+      this.append(node.isBefore ? ' before ' : ' after ')
+      this.visitNode(node.neighborValue)
+    }
+  }
+
+  protected override visitRenameValue(node: RenameValueNode): void {
+    this.append('rename value ')
+    this.visitNode(node.oldValue)
+    this.append(' to ')
+    this.visitNode(node.newValue)
+  }
+
   protected override visitExplain(node: ExplainNode): void {
     this.append('explain')