@clickup/ent-framework/src/abstract/QueryBase.ts

A PostgreSQL graph-database-alike library with microsharding and row-level security

import type { Table } from "../types";
import type { Client } from "./Client";
import type { Query } from "./Query";
import type { QueryAnnotation } from "./QueryAnnotation";
import type { Runner } from "./Runner";
import type { Schema } from "./Schema";

/**
 * A convenient base class for most (but not all) of the queries, where the
 * Runner instance is the same for different query input shapes. If the query
 * doesn't fit the QueryBase framework (like PgQueryUpdate for instance where we
 * have separate Runner instances for separate set of updated fields), a Query
 * is used directly instead.
 */
export abstract class QueryBase<
  TTable extends Table,
  TInput,
  TOutput,
  TClient extends Client,
> implements Query<TOutput>
{
  /** @ignore */
  abstract readonly RUNNER_CLASS: {
    readonly IS_WRITE: boolean;
    new (schema: Schema<TTable>, client: TClient): Runner<TInput, TOutput>;
  };

  constructor(
    public readonly schema: Schema<TTable>,
    public readonly input: TInput,
  ) {}

  get IS_WRITE(): boolean {
    return this.RUNNER_CLASS.IS_WRITE;
  }

  async run(client: TClient, annotation: QueryAnnotation): Promise<TOutput> {
    return client
      .batcher(
        this.constructor,
        this.schema,
        "",
        false,
        () => new this.RUNNER_CLASS(this.schema, client),
      )
      .run(this.input, annotation);
  }
}