Add Optional Large Tier Execution Performance

README.md

@@ -17,15 +17,17 @@ const { DUNE_API_KEY } = process.env;
 
 const client = new DuneClient(DUNE_API_KEY ?? "");
 const queryID = 1215383;
-const parameters = [
-  QueryParameter.text("TextField", "Plain Text"),
-  QueryParameter.number("NumberField", 3.1415926535),
-  QueryParameter.date("DateField", "2022-05-04 00:00:00"),
-  QueryParameter.enum("ListField", "Option 1"),
-];
+const params = {
+  query_parameters = [
+    QueryParameter.text("TextField", "Plain Text"),
+    QueryParameter.number("NumberField", 3.1415926535),
+    QueryParameter.date("DateField", "2022-05-04 00:00:00"),
+    QueryParameter.enum("ListField", "Option 1"),
+  ]
+};
 
 client
-  .runQuery(queryID, parameters)
+  .runQuery(queryID, params)
   .then((executionResult) => console.log(executionResult.result?.rows));
 
 // should look like

src/api/execution.ts

@@ -7,15 +7,25 @@ import {
 import log from "loglevel";
 import { logPrefix } from "../utils";
 import { Router } from "./router";
+import { ExecutionParams, ExecutionPerformance } from "../types/requestPayload";
 
 // This class implements all the routes defined in the Dune API Docs: https://dune.com/docs/api/
 export class ExecutionClient extends Router {
   async executeQuery(
     queryID: number,
-    parameters?: QueryParameter[],
+    params?: ExecutionParams,
   ): Promise<ExecutionResponse> {
+    // Extract possible ExecutionParams
+    let query_parameters: QueryParameter[] = [];
+    let performance = ExecutionPerformance.Medium;
+    if (params !== undefined) {
+      query_parameters = params.query_parameters ? params.query_parameters : [];
+      performance = performance ? performance : ExecutionPerformance.Medium;
+    }
+
     const response = await this._post<ExecutionResponse>(`query/${queryID}/execute`, {
-      query_parameters: parameters ? parameters : [],
+      query_parameters,
+      performance,
     });
     log.debug(logPrefix, `execute response ${JSON.stringify(response)}`);
     return response as ExecutionResponse;
@@ -51,7 +61,7 @@ export class ExecutionClient extends Router {
     queryID: number,
     parameters?: QueryParameter[],
   ): Promise<ExecutionResponse> {
-    return this.executeQuery(queryID, parameters);
+    return this.executeQuery(queryID, {query_parameters: parameters});
   }
 
   /**

src/api/extensions.ts

@@ -4,6 +4,7 @@ import log from "loglevel";
 import { logPrefix } from "../utils";
 import { ExecutionClient } from "./execution";
 import { POLL_FREQUENCY_SECONDS, THREE_MONTHS_IN_HOURS } from "../constants";
+import { ExecutionParams, ExecutionPerformance } from "../types/requestPayload";
 
 const TERMINAL_STATES = [
   ExecutionState.CANCELLED,
@@ -14,16 +15,16 @@ const TERMINAL_STATES = [
 export class ExtendedClient extends ExecutionClient {
   async runQuery(
     queryID: number,
-    parameters?: QueryParameter[],
+    params?: ExecutionParams,
     pingFrequency: number = POLL_FREQUENCY_SECONDS,
   ): Promise<ResultsResponse> {
     log.info(
       logPrefix,
       `refreshing query https://dune.com/queries/${queryID} with parameters ${JSON.stringify(
-        parameters,
+        params,
       )}`,
     );
-    const { execution_id: jobID } = await this.execute(queryID, parameters);
+    const { execution_id: jobID } = await this.executeQuery(queryID, params);
     let { state } = await this.getExecutionStatus(jobID);
     while (!TERMINAL_STATES.includes(state)) {
       log.info(
@@ -57,7 +58,7 @@ export class ExtendedClient extends ExecutionClient {
         logPrefix,
         `results (from ${lastRun}) older than ${maxAgeHours} hours, re-running query.`,
       );
-      results = await this.runQuery(queryId, parameters);
+      results = await this.runQuery(queryId, {query_parameters: parameters});
     }
     return results;
   }
@@ -70,6 +71,6 @@ export class ExtendedClient extends ExecutionClient {
     parameters?: QueryParameter[],
     pingFrequency: number = 1,
   ): Promise<ResultsResponse> {
-    return this.runQuery(queryID, parameters, pingFrequency);
+    return this.runQuery(queryID, {query_parameters: parameters}, pingFrequency);
   }
 }

src/api/query.ts

@@ -1,10 +1,6 @@
 // Assuming the existence of these imports based on your Python code
 import { Router } from "./router";
-import {
-  DuneQuery,
-  QueryParameter,
-  CreateQueryResponse,
-} from "../types";
+import { DuneQuery, QueryParameter, CreateQueryResponse } from "../types";
 import { CreateQueryPayload, UpdateQueryPayload } from "../types/requestPayload";
 
 export class QueryAPI extends Router {

src/api/router.ts

@@ -2,10 +2,7 @@ import { DuneError } from "../types";
 import fetch from "cross-fetch";
 import log from "loglevel";
 import { logPrefix } from "../utils";
-import {
-  RequestPayload,
-  payloadJSON,
-} from "../types/requestPayload";
+import { RequestPayload, payloadJSON } from "../types/requestPayload";
 
 const BASE_URL = "https://api.dune.com/api/v1";
 

src/types/requestPayload.ts

@@ -1,5 +1,15 @@
 import { QueryParameter } from "./queryParameter";
 
+export interface ExecutionParams {
+  query_parameters?: QueryParameter[];
+  performance?: ExecutionPerformance;
+}
+
+export enum ExecutionPerformance {
+  Medium = "medium",
+  Large = "large",
+}
+
 export type RequestPayload =
   | ExecuteQueryPayload
   | UpdateQueryPayload
@@ -24,6 +34,7 @@ export function payloadJSON(payload?: RequestPayload): string {
 
 export interface ExecuteQueryPayload {
   query_parameters?: QueryParameter[];
+  performance: string;
 }
 
 export interface UpdateQueryPayload {

tests/e2e/client.spec.ts

@@ -7,6 +7,7 @@ import {
   QueryAPI,
 } from "../../src/";
 import log from "loglevel";
+import { ExecutionPerformance } from "../../src/types/requestPayload";
 
 const { DUNE_API_KEY } = process.env;
 const apiKey: string = DUNE_API_KEY ? DUNE_API_KEY : "No API Key";
@@ -71,7 +72,17 @@ describe("DuneClient: native routes", () => {
       QueryParameter.enum("ListField", "Option 1"),
     ];
     // Execute and check state
-    const execution = await client.executeQuery(queryID, parameters);
+    const execution = await client.executeQuery(queryID, {
+      query_parameters: parameters,
+    });
+    expect(execution.execution_id).is.not.null;
+  });
+
+  it("execute with Large tier performance", async () => {
+    const client = new DuneClient(apiKey);
+    const execution = await client.executeQuery(1215383, {
+      performance: ExecutionPerformance.Large,
+    });
     expect(execution.execution_id).is.not.null;
   });
 
@@ -180,9 +191,10 @@ describe("DuneClient: Errors", () => {
     const client = new DuneClient(apiKey);
     const queryID = 1215383;
     const invalidParameterName = "Invalid Parameter Name";
-    const parameters = [QueryParameter.text(invalidParameterName, "")];
     await expectAsyncThrow(
-      client.executeQuery(queryID, parameters),
+      client.executeQuery(queryID, {
+        query_parameters: [QueryParameter.text(invalidParameterName, "")],
+      }),
       `unknown parameters (${invalidParameterName})`,
     );
   });