Class SchemaEngineCLI

packages/migrate/src/SchemaEngineCLI.ts:54–598

export type SchemaEngineCLIOptions = SchemaEngineCLISetupInput

export class SchemaEngineCLI implements SchemaEngine {
  private debug: boolean
  private child?: ChildProcess
  private schemaContext?: SchemaContext
  private datasource?: Datasource
  private listeners: { [key: string]: (result: any, err?: any) => any } = {}
  /**  _All_ the logs from the engine process. */
  private messages: string[] = []
  private lastRequest?: any
  /** The fields of the last engine log event with an `ERROR` level. */
  private lastError: SchemaEngineLogLine['fields'] | null = null
  private initPromise?: Promise<void>
  private enabledPreviewFeatures?: string[]
  private extensionConfig?: SchemaExtensionConfig
  private baseDir: string

  // `isRunning` is set to true when the engine is initialized, and set to false when the engine is stopped
  public isRunning = false

  private constructor({
    debug = false,
    schemaContext,
    datasource,
    enabledPreviewFeatures,
    extensions,
    baseDir,
  }: SchemaEngineCLIOptions) {
    this.schemaContext = schemaContext
    this.datasource = datasource
    if (debug) {
      Debug.enable('SchemaEngine*')
    }
    this.debug = debug
    this.enabledPreviewFeatures = enabledPreviewFeatures
    this.extensionConfig = extensions ? { types: extensions.flatMap((ext) => ext.types) } : undefined
    this.baseDir = baseDir
  }

  static setup(input: SchemaEngineCLISetupInput): Promise<SchemaEngineCLI> {
    return Promise.resolve(new SchemaEngineCLI(input))
  }

  //
  // See JSON-RPC API definition:
  // https://prisma.github.io/prisma-engines/doc/migration_core/json_rpc/index.html
  //

  /**
   * Apply the migrations from the migrations directory to the database.
   * This is the command behind prisma migrate deploy.
   */
  public applyMigrations(args: EngineArgs.ApplyMigrationsInput): Promise<EngineResults.ApplyMigrationsOutput> {
    return this.runCommand(this.getRPCPayload('applyMigrations', args))
  }

  /**
   * Create the logical database from the Prisma schema.
   */