Function explain

explain<T = Record<string, unknown>>(
    key: string,
    sql: string,
    bindings?: any[],
    options?: Omit<ExplainOptions, "batchSize">,
): Promise<QueryResult<T>>
Executes an explain query on the shard resolved by key.
Type Parameters
- T = Record<string, unknown>
Parameters
- key: string
  Primary key used for shard routing
- sql: string
  SQL statement to inspect
- bindings: any[] = []
  Parameter values for the SQL statement
- options: Omit<ExplainOptions, "batchSize"> = {}
  Explain mode options
Returns Promise<QueryResult<T>>
Explain rows as a QueryResult

Since
1.1.4
- Defined in src/router.ts:2388