-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Engine.ts
133 lines (114 loc) · 3.88 KB
/
Engine.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
import type { DataSource, DMMF, GeneratorConfig } from '@prisma/generator-helper'
import { TracingConfig } from '../tracing/getTracingConfig'
import { EventEmitter } from './types/Events'
import type { Metrics, MetricsOptionsJson, MetricsOptionsPrometheus } from './types/Metrics'
import type { QueryEngineRequestHeaders, QueryEngineResult } from './types/QueryEngine'
import type * as Transaction from './types/Transaction'
export interface FilterConstructor {
new (config: EngineConfig): Engine
}
export type NullableEnvValue = {
fromEnvVar: string | null
value?: string | null
}
export type InlineDatasource = {
url: NullableEnvValue
}
export type BatchTransactionOptions = {
isolationLevel?: Transaction.IsolationLevel
}
export type InteractiveTransactionOptions<Payload> = Transaction.Info<Payload>
export type RequestOptions<InteractiveTransactionPayload> = {
query: string
headers?: QueryEngineRequestHeaders
numTry?: number
transaction?: InteractiveTransactionOptions<InteractiveTransactionPayload>
isWrite: boolean
}
export type RequestBatchOptions = {
queries: string[]
headers?: QueryEngineRequestHeaders
transaction?: BatchTransactionOptions
numTry?: number
containsWrite: boolean
}
export type BatchQueryEngineResult<T> = QueryEngineResult<T> | Error
// TODO Move shared logic in here
export abstract class Engine {
abstract on(event: EngineEventType, listener: (args?: any) => any): void
abstract start(): Promise<void>
abstract stop(): Promise<void>
abstract getConfig(): Promise<GetConfigResult>
abstract getDmmf(): Promise<DMMF.Document>
abstract version(forceRun?: boolean): Promise<string> | string
abstract request<T>(options: RequestOptions<unknown>): Promise<QueryEngineResult<T>>
abstract requestBatch<T>(options: RequestBatchOptions): Promise<BatchQueryEngineResult<T>[]>
abstract transaction(
action: 'start',
headers: Transaction.TransactionHeaders,
options?: Transaction.Options,
): Promise<Transaction.Info<unknown>>
abstract transaction(
action: 'commit',
headers: Transaction.TransactionHeaders,
info: Transaction.Info<unknown>,
): Promise<void>
abstract transaction(
action: 'rollback',
headers: Transaction.TransactionHeaders,
info: Transaction.Info<unknown>,
): Promise<void>
abstract metrics(options: MetricsOptionsJson): Promise<Metrics>
abstract metrics(options: MetricsOptionsPrometheus): Promise<string>
}
export type EngineEventType = 'query' | 'info' | 'warn' | 'error' | 'beforeExit'
export interface DatasourceOverwrite {
name: string
url?: string
env?: string
}
export interface EngineConfig {
cwd?: string
dirname?: string
datamodelPath: string
enableDebugLogs?: boolean
allowTriggerPanic?: boolean // dangerous! https://github.com/prisma/prisma-engines/issues/764
prismaPath?: string
fetcher?: (query: string) => Promise<{ data?: any; error?: any }>
generator?: GeneratorConfig
datasources?: DatasourceOverwrite[]
showColors?: boolean
logQueries?: boolean
logLevel?: 'info' | 'warn'
env: Record<string, string>
flags?: string[]
clientVersion?: string
previewFeatures?: string[]
engineEndpoint?: string
activeProvider?: string
logEmitter: EventEmitter
/**
* The contents of the schema encoded into a string
* @remarks only used for the purpose of data proxy
*/
inlineSchema?: string
/**
* The contents of the datasource url saved in a string
* @remarks only used for the purpose of data proxy
*/
inlineDatasources?: Record<string, InlineDatasource>
/**
* The string hash that was produced for a given schema
* @remarks only used for the purpose of data proxy
*/
inlineSchemaHash?: string
/**
* The configuration object for enabling tracing
* @remarks enabling is determined by the client
*/
tracingConfig: TracingConfig
}
export type GetConfigResult = {
datasources: DataSource[]
generators: GeneratorConfig[]
}