get_query_results_csv

Instructions

Implementation Reference

• src/index.ts:309-340 (schema)

  Input schema for the get_query_results_csv tool: expects queryId (number) and optional refresh (boolean, default false).

  // Tool: get_query_results_csv
  const getQueryResultsCsvSchema = z.object({
    queryId: z.coerce.number(),
    refresh: z.boolean().optional().default(false)
  });
  
  async function getQueryResultsCsv(params: z.infer<typeof getQueryResultsCsvSchema>) {
    try {
      const { queryId, refresh } = params;
      const csv = await redashClient.getQueryResultsAsCsv(queryId, refresh);
  
      return {
        content: [
          {
            type: "text",
            text: csv
          }
        ]
      };
    } catch (error) {
      logger.error(`Error getting CSV results for query ${params.queryId}: ${error}`);
      return {
        isError: true,
        content: [
          {
            type: "text",
            text: `Error getting CSV results for query ${params.queryId}: ${error instanceof Error ? error.message : String(error)}`
          }
        ]
      };
    }
  }

• src/index.ts:315-340 (handler)

  Handler function for get_query_results_csv tool. Calls redashClient.getQueryResultsAsCsv(queryId, refresh) and returns the CSV text content.

  async function getQueryResultsCsv(params: z.infer<typeof getQueryResultsCsvSchema>) {
    try {
      const { queryId, refresh } = params;
      const csv = await redashClient.getQueryResultsAsCsv(queryId, refresh);
  
      return {
        content: [
          {
            type: "text",
            text: csv
          }
        ]
      };
    } catch (error) {
      logger.error(`Error getting CSV results for query ${params.queryId}: ${error}`);
      return {
        isError: true,
        content: [
          {
            type: "text",
            text: `Error getting CSV results for query ${params.queryId}: ${error instanceof Error ? error.message : String(error)}`
          }
        ]
      };
    }
  }

• src/index.ts:1700-1711 (registration)

  Tool registration for 'get_query_results_csv' with description and inputSchema defining queryId (required) and refresh (optional, default false) parameters.

  {
    name: "get_query_results_csv",
    description: "Get query results in CSV format. Returns the last cached results, or optionally refreshes the query first to get the latest data. Note: Does not support parameterized queries.",
    inputSchema: {
      type: "object",
      properties: {
        queryId: { type: "number", description: "ID of the query to get results from" },
        refresh: { type: "boolean", description: "Whether to refresh the query before fetching results to ensure latest data (default: false)" }
      },
      required: ["queryId"]
    }
  },

• src/index.ts:2360-2362 (registration)

  Tool execution dispatch: routes 'get_query_results_csv' tool name to getQueryResultsCsv handler with validated args.

  case "get_query_results_csv":
    logger.debug(`Handling get_query_results_csv`);
    return await getQueryResultsCsv(getQueryResultsCsvSchema.parse(args));

• src/redashClient.ts:702-736 (helper)

  Helper method getQueryResultsAsCsv in RedashClient. Optionally refreshes the query first if refresh=true, then fetches CSV from /api/queries/{queryId}/results.csv endpoint.

  async getQueryResultsAsCsv(queryId: number, refresh = false): Promise<string> {
    try {
      // Optionally refresh the query before fetching results
      if (refresh) {
        logger.debug(`Refreshing query ${queryId} before fetching CSV results`);
        await this.executeQuery(queryId);
      }
  
      logger.debug(`Fetching CSV results for query ${queryId}`);
      const response = await this.client.get(`/api/queries/${queryId}/results.csv`, {
        responseType: 'text'
      });
  
      return response.data;
    } catch (error) {
      if (axios.isAxiosError(error)) {
        const axiosError = error as AxiosError;
        logger.error(`Error fetching CSV results for query ${queryId}: ${axiosError.message}`);
  
        if (axiosError.response) {
          const statusCode = axiosError.response.status;
          const errorData = axiosError.response.data;
          throw new Error(`Failed to fetch CSV results for query ${queryId}: Redash API error (${statusCode}): ${errorData}`);
        } else if (axiosError.request) {
          throw new Error(`Failed to fetch CSV results for query ${queryId}: No response received from Redash API: ${axiosError.message}`);
        } else {
          throw new Error(`Failed to fetch CSV results for query ${queryId}: ${axiosError.message}`);
        }
      } else {
        const errorMessage = error instanceof Error ? error.message : String(error);
        logger.error(`Error fetching CSV results for query ${queryId}: ${errorMessage}`);
        throw new Error(`Failed to fetch CSV results for query ${queryId}: ${errorMessage}`);
      }
    }
  }