Redash

https://redash.io/help/
Admin
Redash is a query and visualization platform that helps teams query databases, create dashboards,...
Tokens:57,661
Snippets:475
Trust Score:9.8
Update:2 days ago
Show doc for...
Tokens:
Raw
### Add Test Connection support with noop_query property

Source: https://redash.io/help/open-source/dev-guide/write-a-query-runner/

Supply a noop_query property on your Query Runner to enable the Test Connection button on the data source setup screen. This example uses 'SELECT 1' as the noop query.

```python
class Firebolt(BaseQueryRunner):
    noop_query = "SELECT 1"
```

--------------------------------

### Install Node packages with Yarn

Source: https://redash.io/help/open-source/dev-guide/remote-server/

Install Node packages using Yarn with the frozen lockfile flag to ensure reproducible installs. Run this in the repository directory after cloning.

```bash
yarn --frozen-lockfile
```

--------------------------------

### Start debugging session with docker-compose

Source: https://redash.io/help/open-source/dev-guide/debugging/

Run this command in a terminal to stop the server, start a debugging session with service ports, and then start the server again.

```bash
docker-compose stop server && docker-compose run --rm --service-ports server debug && docker-compose start server
```

--------------------------------

### Install PyAthena for Athena data source

Source: https://redash.io/help/open-source/admin-guide/how-to-upgrade-legacy/

Install PyAthena version 1.0.0 or higher to fix missing Athena data source after upgrading to v2.0.0.

```bash
sudo pip install PyAthena>=1.0.0
```

--------------------------------

### Parameterized query example

Source: https://redash.io/help/user-guide/querying/query-results-data-source/

Example of a query with a parameter placeholder ({{id}}) that can be referenced using param_query_ syntax.

```text
SELECT
	name
FROM users
WHERE id = {{id}}
```

--------------------------------

### Start webpack dev-server with REDASH_BACKEND

Source: https://redash.io/help/open-source/dev-guide/remote-server/

Start the webpack dev-server, setting the REDASH_BACKEND environment variable to the URL of your remote Redash server. This command runs the frontend locally while using the remote server as the API backend.

```bash
REDASH_BACKEND="URL of your redash server" yarn start
```

--------------------------------

### Install Yarn globally

Source: https://redash.io/help/open-source/dev-guide/remote-server/

Install Yarn version 1.22.10 or newer globally using npm. This is a prerequisite for the frontend development setup.

```bash
npm install --global yarn@1.22.10
```

--------------------------------

### Start Redash services

Source: https://redash.io/help/open-source/admin-guide/how-to-upgrade/

Starts all Redash services in detached mode after the upgrade.

```bash
docker compose up -d
```

--------------------------------

### Example Returned JSON Data Structure

Source: https://redash.io/help/data-sources/querying/json-api/

The URL endpoint must return JSON with 'columns' and 'rows' keys. This example shows the required structure with column definitions and row data.

```text
{
  "columns": [
    {
      "name": "date",
      "type": "date",
      "friendly_name": "date"
    },
    {
      "name": "day_number",
      "type": "integer",
      "friendly_name": "day_number"
    },
    {
      "name": "value",
      "type": "integer",
      "friendly_name": "value"
    },
    {
      "name": "total",
      "type": "integer",
      "friendly_name": "total"
    }
  ],
  "rows": [
    {
      "value": 40832,
      "total": 53141,
      "day_number": 0,
      "date": "2014-01-30"
    },
    {
      "value": 27296,
      "total": 53141,
      "day_number": 1,
      "date": "2014-01-30"
    },
    {
      "value": 22982,
      "total": 53141,
      "day_number": 2,
      "date": "2014-01-30"
    }
  ]
}
```

--------------------------------

### Equivalent URL with query string

Source: https://redash.io/help/data-sources/querying/json-api/

The same query as the previous example but with the query string embedded in the URL.

```yaml
url: 'https://api.github.com/search/issues?q=+is:open+type:pr+repo:getredash/redash&sort=created&order=desc'
```

--------------------------------

### URL Query Body Example

Source: https://redash.io/help/data-sources/querying/json-api/

The query body for a URL data source should contain only the URL that returns data. This example shows a simple URL.

```sql
http://myserver/path/myquery
```

--------------------------------

### Example /status.json output

Source: https://redash.io/help/open-source/admin-guide/maintenance/

Example JSON output from the /status.json endpoint, showing health metrics like dashboards count, query counts, Redis memory usage, and worker information.

```json
{
  "dashboards_count": 30,
  "manager": {
    "last_refresh_at": "1465392784.433638",
    "outdated_queries_count": 1,
    "query_ids": "[34]",
    "queues": {
      "queries": {
        "data_sources": "Redshift data, redash metadata, MySQL data, MySQL read-only, Redshift read-only",
        "size": 1
      },
      "scheduled_queries": {
        "data_sources": "Redshift data, redash metadata, MySQL data, MySQL read-only, Redshift read-only",
        "size": 0
      }
    }
  },
  "queries_count": 204,
  "query_results_count": 11161,
  "redis_used_memory": "6.09M",
  "unused_query_results_count": 32,
  "version": "0.10.0+b1774",
  "widgets_count": 176,
  "workers": []
}
```

--------------------------------

### Google Analytics query example: new users by date

Source: https://redash.io/help/data-sources/querying/google-analytics/

Example JSON query for Google Analytics that retrieves new users by date, sorted by new users descending.

```json
{
    "ids": "ga:97038718",
    "start_date": "30daysAgo",
    "end_date": "yesterday",
    "metrics": "ga:newUsers",
    "dimensions": "ga:date",
    "sort": "-ga:newUsers"
}
```

--------------------------------

### Query Based Dropdown List Example Query

Source: https://redash.io/help/user-guide/querying/query-parameters/

Example query that returns 'value' and 'name' columns for a query-based dropdown list. Redash uses the first column for display and the associated 'value' column for execution.

```sql
SELECT user_uuid as ‘value’, username as ‘name’
FROM users
```

--------------------------------

### CloudWatch MetricDataQueries YAML example

Source: https://redash.io/help/data-sources/querying/amazon-cloudwatch/

Example YAML query for CloudWatch metrics. It sends two MetricDataQuery objects under the key MetricsDataQueries. Redash converts this array to one or more get_metric_data() calls. The query must be written in YAML syntax, not SQL.

```yaml
MetricDataQueries:
  - Id: database_connections
    MetricStat:
      Metric:
        Namespace: AWS/RDS
        MetricName: DatabaseConnections
      Period: 60
      Stat: Maximum
  - Id: swap_usage
    MetricStat:
      Metric:
        Namespace: AWS/RDS
        MetricName: SwapUsage
      Period: 60
      Stat: Maximum
StartTime: '2020-01-01 00:00:00'
```

--------------------------------

### Jira query returning specific fields

Source: https://redash.io/help/data-sources/querying/jira-ds/

Use the 'fields' key to specify which issue fields to return. This example returns only 'summary' and 'priority'.

```json
{
	"fields": "summary,priority"
}
```

--------------------------------

### Using Multiple Parameters in a Single Query

Source: https://redash.io/help/user-guide/querying/query-parameters/

Demonstrates using multiple unique parameter names in one query. The example uses {{org_id}} and {{start_date}}.

```sql
SELECT count(0)
FROM queries
WHERE org_id = {{org_id}} AND created_at > '{{start_date}}'
```

--------------------------------

### Run downloaded upgrade script

Source: https://redash.io/help/open-source/admin-guide/how-to-upgrade-legacy/

Execute the downloaded upgrade script with sudo.

```bash
sudo ./upgrade
```

--------------------------------

### Jira query to count issues

Source: https://redash.io/help/data-sources/querying/jira-ds/

Set 'queryType' to 'count' to get the number of issues matching the JQL filter. This example counts issues with priority=medium.

```json
{
	"queryType": "count",
	"jql": "priority=medium"
}
```

--------------------------------

### Run upgrade script for v1.0.0 and newer

Source: https://redash.io/help/open-source/admin-guide/how-to-upgrade-legacy/

Navigate to the Redash current directory and run the upgrade script with sudo. For beta versions, use the --channel beta flag.

```bash
cd /opt/redash/current
sudo bin/upgrade
```

--------------------------------

### GET /api/jobs/<job_id>

Source: https://redash.io/help/user-guide/integrations-and-api/api/

Returns a query task result (job). Possible statuses: 1 == PENDING, 2 == STARTED, 3 == SUCCESS, 4 == FAILURE, 5 == CANCELLED. When status is success, the job will include a `query_result_id`.

```APIDOC
## GET /api/jobs/<job_id>

### Description
Returns a query task result (job). Possible statuses: 1 == PENDING, 2 == STARTED, 3 == SUCCESS, 4 == FAILURE, 5 == CANCELLED. When status is success, the job will include a `query_result_id`.

### Method
GET

### Endpoint
/api/jobs/<job_id>

### Parameters
#### Path Parameters
- **job_id** (integer) - Required - The ID of the job.

### Response
#### Success Response (200)
- **job** (object) - The job object. Contains `status` (integer) and, if status is 3 (SUCCESS), a `query_result_id`.

```

--------------------------------

### Firebolt Query Runner class with run_query method

Source: https://redash.io/help/open-source/dev-guide/write-a-query-runner/

Start by creating a new firebolt.py file in /redash/query_runner and implement the BaseQueryRunner class. The only required method is run_query, which accepts a query string and the user who invoked it; the user is often irrelevant and can be ignored.

```python
from redash.query_runner import BaseQueryRunner, register

class Firebolt(BaseQueryRunner):
    def run_query(self, query, user):
        pass
```

--------------------------------

### Install ptvsd

Source: https://redash.io/help/open-source/dev-guide/debugging/

Install the ptvsd package using pip, which is required for remote debugging.

```bash
pip install ptvsd
```

--------------------------------

### GET /api/queries/<id>/results

Source: https://redash.io/help/user-guide/integrations-and-api/api/

Gets a cached result for this query ID. Only works for non-parameterized queries. If you attempt to GET results for a parameterized query you’ll receive the error: `no cached result found for this query`.

```APIDOC
## GET /api/queries/<id>/results

### Description
Gets a cached result for this query ID. Only works for non-parameterized queries. If you attempt to GET results for a parameterized query you’ll receive the error: `no cached result found for this query`.

### Method
GET

### Endpoint
/api/queries/<id>/results

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the query.

### Response
#### Success Response (200)
- **query result** (object) - The cached query result.

#### Error Response
- **error** (string) - `no cached result found for this query` if the query is parameterized.

```

--------------------------------

### Launch Redash instance on GCE

Source: https://redash.io/help/open-source/setup/

Launches a Redash instance using the created image. The n1-standard-1 machine type is recommended; specify zone with --zone if needed.

```text
$ gcloud compute instances create redash --image redash-8-0-0
```

--------------------------------

### Start Celery workers after queue reset

Source: https://redash.io/help/open-source/admin-guide/maintenance/

Starts the Celery workers again after flushing Redis. This is the final step to resume query processing.

```bash
sudo supervisorctl start redash_celery
```

--------------------------------

### Compressed database backup with pg_dump and gzip

Source: https://redash.io/help/open-source/admin-guide/maintenance/

Creates a compressed backup of the Redash database using gzip. Run as the redash user.

```bash
sudo -u redash pg_dump redash | gzip > backup_filename.gz
```

--------------------------------

### Download and make upgrade script executable for pre-v1.0.0

Source: https://redash.io/help/open-source/admin-guide/how-to-upgrade-legacy/

Download the upgrade script from the Redash GitHub repository to your Redash server and make it executable.

```bash
wget https://raw.githubusercontent.com/getredash/redash/master/bin/upgrade
chmod +x upgrade
```

--------------------------------

### QRDS query using param_query_ with parameters

Source: https://redash.io/help/user-guide/querying/query-results-data-source/

Shows how to pass parameters to a parameterized query using the param_query_<query_id>_{<URL ENCODED KEY=VALUE PARAMETER STRING>} syntax.

```text
SELECT
	a.name
FROM param_query_123_{id=1} AS a
```

--------------------------------

### Uncompressed database backup with pg_dump

Source: https://redash.io/help/open-source/admin-guide/maintenance/

Creates an uncompressed backup of the Redash database. Run as the redash user.

```bash
sudo -u redash pg_dump > backup_filename.sql
```

--------------------------------

### Google Analytics query example: new users by country

Source: https://redash.io/help/data-sources/querying/google-analytics/

Example JSON query for Google Analytics that retrieves new users by country, sorted by new users descending, with a maximum of 10 results.

```json
{
    "ids": "ga:97038718",
    "start_date": "30daysAgo",
    "end_date": "yesterday",
    "metrics": "ga:newUsers",
    "dimensions": "ga:country",
    "max_results": 10,
    "sort": "-ga:newUsers"
}
```

--------------------------------

### Complete file structure with imports and register call

Source: https://redash.io/help/open-source/dev-guide/write-a-query-runner/

Shows the top and bottom of the query runner file: imports for dependencies, the try/except block, Redash base classes, type mappings, and the register call at the bottom. The implementation is omitted as indicated by the comment.

```python
# top of file

try:
    from firebolt.db import connect
    from firebolt.client import DEFAULT_API_URL
    enabled = True
except ImportError:
    enabled = False

from redash.query_runner import BaseQueryRunner, register
from redash.query_runner import TYPE_STRING, TYPE_INTEGER, TYPE_BOOLEAN
from redash.utils import json_dumps, json_loads

TYPES_MAP = {1: TYPE_STRING, 2: TYPE_INTEGER, 3: TYPE_BOOLEAN}

# ... implementation

# bottom of file
register(Firebolt)
```
Tokens:
Raw