supabase/apps/studio/components/grid/query/QueryAction.ts

import type { QueryTable } from '../types'
import type { Dictionary } from 'types'
import { IQueryFilter, QueryFilter } from './QueryFilter'

export interface IQueryAction {
  count: () => IQueryFilter
  delete: (options?: { returning: boolean }) => IQueryFilter
  insert: (values: Dictionary<any>[], options?: { returning: boolean }) => IQueryFilter
  select: (columns?: string) => IQueryFilter
  update: (value: Dictionary<any>, options?: { returning: boolean }) => IQueryFilter
  truncate: (options?: { returning: boolean }) => IQueryFilter
}

export class QueryAction implements IQueryAction {
  constructor(protected table: QueryTable) {}

  /**
   * Performs a COUNT on the table.
   */
  count() {
    return new QueryFilter(this.table, 'count')
  }

  /**
   * Performs a DELETE on the table.
   *
   * @param options.returning  If `true`, return the deleted row(s) in the response.
   */
  delete(options?: { returning: boolean; enumArrayColumns?: string[] }) {
    return new QueryFilter(this.table, 'delete', undefined, options)
  }

  /**
   * Performs an INSERT into the table.
   *
   * @param values             The values to insert.
   * @param options.returning  If `true`, return the inserted row(s) in the response.
   */
  insert(values: Dictionary<any>[], options?: { returning: boolean; enumArrayColumns?: string[] }) {
    return new QueryFilter(this.table, 'insert', values, options)
  }

  /**
   * Performs vertical filtering with SELECT.
   *
   * @param columns the query columns, by default set to '*'.
   */
  select(columns?: string) {
    return new QueryFilter(this.table, 'select', columns)
  }

  /**
   * Performs an UPDATE on the table.
   *
   * @param value  The value to update.
   * @param options.returning  If `true`, return the updated row(s) in the response.
   */
  update(value: Dictionary<any>, options?: { returning: boolean; enumArrayColumns?: string[] }) {
    return new QueryFilter(this.table, 'update', value, options)
  }

  /**
   * Performs a TRUNCATE on the table
   */
  truncate(options?: { returning: boolean; enumArrayColumns?: string[] }) {
    return new QueryFilter(this.table, 'truncate', undefined, options)
  }
}