Superset

https://superset.apache.org/docs/
Admin
Superset is a modern, enterprise-ready business intelligence web application for data exploration...
Tokens:63,470
Snippets:965
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies and Start Local Docs Server

Source: https://superset.apache.org/docs/contributing/misc

Installs npm dependencies and starts the Docusaurus development server for the Superset documentation site.

```bash
cd docs

npm install

npm run start
```

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

### Install clickhouse-connect Package

Source: https://superset.apache.org/docs/databases/supported/clickhouse

Add the clickhouse-connect package to your local requirements file for installation.

```bash
echo "clickhouse-connect>=0.13.0" >> ./docker/requirements-local.txt
```

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

### Altinity Cloud Connection Example

Source: https://superset.apache.org/docs/databases/supported/clickhouse

Example connection string for connecting to Altinity Cloud, a managed ClickHouse service.

```sql
clickhousedb://demo:demo@github.demo.trial.altinity.cloud/default?secure=true
```

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

### Install Database Drivers with pip

Source: https://superset.apache.org/docs/databases

Install database drivers using pip for non-Docker Superset installations. Replace '<driver-package>' with the specific package name for your database.

```bash
pip install <driver-package>
```

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

### Install Translation Dependencies

Source: https://superset.apache.org/docs/contributing/misc

Install the necessary Python packages for the AI backfilling script. This is a prerequisite before running the script.

```bash
pip install -r superset/translations/requirements.txt

```

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

### Configure Local FileSystemCache for SQL Lab

Source: https://superset.apache.org/docs/contributing/misc

Example of configuring a local FileSystemCache for SQL Lab results. This setup is suitable for testing asynchronous features but is not recommended for production environments.

```python
from flask_caching.backends.filesystemcache import FileSystemCache  
RESULTS_BACKEND = FileSystemCache('/tmp/sqllab')  
```

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

### Checkout Latest Release and Start Superset

Source: https://superset.apache.org/docs/quickstart

Navigate into the cloned repository, checkout the latest official release tag, and start Superset using Docker Compose.

```bash
# Enter the repository you just cloned  
$ cd superset  
  
# Set the repo to the state associated with the latest official version  
$ git checkout tags/6.0.0  
  
# Fire up Superset using Docker Compose  
$ docker compose -f docker-compose-image-tag.yml up  
```

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

### Install SAP HANA Packages for Superset

Source: https://superset.apache.org/docs/databases/supported/sap-hana

Install the required packages for SAP HANA support in Apache Superset.

```bash
pip install apache_superset[hana]
```

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

### Install Trino Package for Superset

Source: https://superset.apache.org/docs/databases/supported/trino

Install the Trino integration package for Apache Superset using pip.

```bash
pip install "apache-superset[trino]"
```

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

### Local ClickHouse Connection Example

Source: https://superset.apache.org/docs/databases/supported/clickhouse

Example connection string for a local ClickHouse instance without authentication or SSL.

```sql
clickhousedb://localhost/default
```

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

### Install Superset with Google Sheets Support

Source: https://superset.apache.org/docs/databases/supported/google-sheets

Install Apache Superset with the necessary packages for Google Sheets integration.

```bash
pip install "apache-superset[gsheets]"
```

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

### Install Databricks Support for Superset

Source: https://superset.apache.org/docs/databases/supported/databricks

Install the necessary packages for Databricks integration with Apache Superset.

```bash
pip install apache-superset[databricks]
```

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

### Install Superset Yeoman Generator

Source: https://superset.apache.org/docs/contributing/misc

Installs the global Yeoman generator for creating Superset visualization plugins.

```bash
npm install -g @superset-ui/generator-superset
```

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

### Local TDengine Connection Example

Source: https://superset.apache.org/docs/databases/supported/tdengine

An example of a local connection string for TDengine. This is useful for development and testing environments.

```sql
taosws://root:taosdata@127.0.0.1:6041
```

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

### Firebird Local Database Connection Example

Source: https://superset.apache.org/docs/databases/supported/firebird

Example of a connection string for a local Firebird database. This includes default credentials and a common path structure.

```sql
firebird+fdb://SYSDBA:masterkey@192.168.86.38:3050//Library/Frameworks/Firebird.framework/Versions/A/Resources/examples/empbuild/employee.fdb
```

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

### Install sqlalchemy-bigquery

Source: https://superset.apache.org/docs/databases/supported/google-bigquery

Installs the required Python package for BigQuery integration by adding it to the local requirements file.

```bash
echo "sqlalchemy-bigquery" >> ./docker/requirements-local.txt
```

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

### Develop and Test Visualization Plugin Locally

Source: https://superset.apache.org/docs/contributing/misc

Starts the development server for a Superset visualization plugin.

```bash
npm run dev
```

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

### Start Celery Worker for SQL Lab Async

Source: https://superset.apache.org/docs/contributing/misc

Command to start a Celery worker process for Superset's asynchronous SQL Lab features. Ensure the Celery application is correctly configured in your Superset setup.

```bash
celery --app=superset.tasks.celery_app:app worker -O fair  
```

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

### Altinity.Cloud Connection Example

Source: https://superset.apache.org/docs/databases/supported/clickhouse

Connection string for Altinity.Cloud, a managed ClickHouse service with Kubernetes-native deployments.

```sql
clickhousedb://{username}:{password}@{host}/{database}?secure=true
```

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

### Launch Lightweight Superset Development Instance

Source: https://superset.apache.org/docs/installation/docker-compose

Start a single lightweight Superset instance using a specific compose file. Defaults to port 9001.

```bash
# Single lightweight instance (default port 9001)  
docker compose -f docker-compose-light.yml up  
```

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

### Install Superset D1 Engine

Source: https://superset.apache.org/docs/databases/supported/cloudflare-d1

Install the required Python package for Superset to connect to Cloudflare D1.

```bash
pip install superset-engine-d1
```

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

### Install Presto Superset Package

Source: https://superset.apache.org/docs/databases/supported/presto

Install the necessary Python package for Presto integration with Apache Superset.

```bash
pip install "apache-superset[presto]"
```

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

### Databricks Connection String Example

Source: https://superset.apache.org/docs/databases/supported/databricks

Example of a connection string for Databricks using the Python Connector. Ensure to replace placeholders with your actual access token, host, port, HTTP path, catalog, and schema.

```sql
databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}
```

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

### Launch Multiple Lightweight Superset Instances

Source: https://superset.apache.org/docs/installation/docker-compose

Start multiple Superset instances with different ports using the lightweight compose file. Each instance is isolated.

```bash
# Multiple instances with different ports  
NODE_PORT=9001 docker compose -p superset-1 -f docker-compose-light.yml up  
NODE_PORT=9002 docker compose -p superset-2 -f docker-compose-light.yml up  
NODE_PORT=9003 docker compose -p superset-3 -f docker-compose-light.yml up  
```

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

### Install Shillelagh with Google Sheets Support

Source: https://superset.apache.org/docs/databases/supported/shillelagh

Install the Shillelagh library with the necessary packages for Google Sheets API integration.

```bash
pip install shillelagh[gsheetsapi]
```

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

### Local Embedded Mode Connection Example

Source: https://superset.apache.org/docs/databases/supported/apache-drill

Example of a SQLAlchemy connection string for Apache Drill in local embedded mode.

```sql
drill+sadrill://localhost:8047/dfs?use_ssl=False
```

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

### RisingWave Connection String Example

Source: https://superset.apache.org/docs/databases/supported/risingwave

Use this connection string format to connect Superset to your RisingWave instance. Ensure the hostname, port, and database name are correctly specified. SSL mode can be adjusted as needed.

```sql
risingwave://root@{hostname}:{port}/{database}?sslmode=disable
```

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

### ETag Support for Thumbnails Example

Source: https://superset.apache.org/docs/configuration/cache

Example of using ETag headers with conditional requests for thumbnail endpoints. Clients can use 'If-None-Match' to avoid re-downloading unchanged images, resulting in a '304 Not Modified' response.

```http
GET /api/v1/chart/42/thumbnail/  

If-None-Match: "abc123..."  

  

→ 304 Not Modified  (if unchanged)  
→ 200 OK            (with new image if changed)
```

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

### Install Snowflake SQLAlchemy

Source: https://superset.apache.org/docs/databases/supported/snowflake

Add the snowflake-sqlalchemy package to your local Docker requirements.

```bash
echo "snowflake-sqlalchemy" >> ./docker/requirements-local.txt
```

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

### Verify AST Parsing Dependencies

Source: https://superset.apache.org/docs/contributing/misc

Checks if the necessary Babel and glob dependencies for AST parsing are installed. This is a troubleshooting step for custom rules not running.

```bash
npm ls @babel/parser @babel/traverse glob
```

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

### Example RLS Filter Combination

Source: https://superset.apache.org/docs/security

Demonstrates how RLS filters with different group keys are combined using AND, while filters with the same group key are combined using OR. This example shows filters for 'Finance' and 'Marketing' departments being OR'd together, and then AND'd with a 'Europe' region filter.

```sql
(department = 'Finance' OR department = 'Marketing') AND (region = 'Europe')
```

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

### Define Frontend Development Alias

Source: https://superset.apache.org/docs/contributing/creating-viz-plugins

Creates a shell alias 'sfront' to navigate to the frontend directory and start the frontend development server. This is used for frontend-specific development tasks.

```bash
alias sfront='cd superset-frontend && npm run dev-server'
```

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

### ClickHouse Cloud Connection Example

Source: https://superset.apache.org/docs/databases/supported/clickhouse

Connection string format for ClickHouse Cloud, specifying a secure connection on port 8443.

```sql
clickhousedb://{username}:{password}@{host}:8443/{database}?secure=true
```

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

### Force Thumbnail and Cache Warmup Executors to a Fixed User

Source: https://superset.apache.org/docs/configuration/cache

Configure both thumbnail rendering and cache warmup tasks to run as a specific service account ('admin' in this example) using `FixedExecutor`. This enhances security and stability.

```python
from superset.tasks.types import ExecutorType, FixedExecutor

THUMBNAIL_EXECUTORS = [FixedExecutor("admin")]
CACHE_WARMUP_EXECUTORS = [FixedExecutor("admin")]
```

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

### Configure Celery Beat for Cache Warmup

Source: https://superset.apache.org/docs/configuration/cache

Set up a Celery task to periodically warm up the cache. This example caches the top 5 dashboards hourly. Ensure 'user_with_permission_to_dashboards' has necessary permissions.

```python
from celery.schedules import crontab
from superset.config import CeleryConfig

# User that will be used to authenticate and render dashboards for cache warmup
SUPERSET_CACHE_WARMUP_USER = "user_with_permission_to_dashboards"

# Extend the default CeleryConfig to add cache warmup schedule
class CustomCeleryConfig(CeleryConfig):

    beat_schedule = {

        **CeleryConfig.beat_schedule,

        'cache-warmup-hourly': {

            'task': 'cache-warmup',

            'schedule': crontab(minute=0, hour='*'),  # hourly

            'kwargs': {

                'strategy_name': 'top_n_dashboards',

                'top_n': 5,

                'since': '7 days ago',

            },

        },

    }

CELERY_CONFIG = CustomCeleryConfig

```

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

### Create requirements-local.txt for Docker

Source: https://superset.apache.org/docs/databases

Create a requirements file for local drivers in a Docker deployment. This file is used to automatically install drivers when containers restart.

```bash
# Create the requirements file
touch ./docker/requirements-local.txt
```

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

### CrateDB SQLAlchemy Connection String

Source: https://superset.apache.org/docs/databases/supported/cratedb

This is the recommended SQLAlchemy connection string format for CrateDB. Ensure the `crate[sqlalchemy]` package is installed.

```sql
crate://{host}:{port}
```

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

### Build and Serve Documentation Locally

Source: https://superset.apache.org/docs/contributing/misc

Creates a production build of the documentation site and serves it locally to test the build.

```bash
npm run build

npm run serve  # Test the build locally
```

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

### Configure S3 Cache for Thumbnails with Celery

Source: https://superset.apache.org/docs/configuration/cache

Example configuration for storing thumbnails on S3, using Redis as a Celery broker and result backend. Includes a custom function to initialize the S3 cache.

```python
from flask import Flask
from s3cache.s3cache import S3Cache

...

class CeleryConfig(object):
    broker_url = "redis://localhost:6379/0"
    imports = (
        "superset.sql_lab",
        "superset.tasks.thumbnails",
    )
    result_backend = "redis://localhost:6379/0"
    worker_prefetch_multiplier = 10
    task_acks_late = True


CELERY_CONFIG = CeleryConfig

def init_thumbnail_cache(app: Flask) -> S3Cache:
    return S3Cache("bucket_name", 'thumbs_cache/')


THUMBNAIL_CACHE_CONFIG = init_thumbnail_cache
```

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

### Configuring Force HTTPS with Talisman

Source: https://superset.apache.org/docs/security

Example of enabling `force_https` in Talisman configuration. This may impact Superset's Alerts & Reports if workers use HTTP URLs.

```python
TALISMAN_CONFIG = {

    "force_https": True,

    "content_security_policy": { ...

}
```

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

### Dashboards - Export Example

Source: https://superset.apache.org/docs/rest-api

Exports a dashboard as an example bundle.

```APIDOC
## GET /api/v1/dashboard/{pk}/export_as_example/

### Description
Export dashboard as example bundle.

### Method
GET

### Endpoint
/api/v1/dashboard/{pk}/export_as_example/
```

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

### Add New Feature Flag Configuration

Source: https://superset.apache.org/docs/configuration/feature-flags

When adding a new feature flag to `superset/config.py`, include specific annotations for documentation generation. This example shows the required format.

```python
# Description of what the feature does  
# @lifecycle: development | testing | stable | deprecated  
# @docs: https://superset.apache.org/docs/... (optional)  
# @category: runtime_config | path_to_deprecation (optional, for stable flags)  
"MY_NEW_FEATURE": False,
```

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

### Define Development Alias

Source: https://superset.apache.org/docs/contributing/creating-viz-plugins

Creates a shell alias 'sdev' for starting the Superset development server with hot reloading enabled. This simplifies the command for frequent use.

```bash
alias sdev='FLASK_ENV=development superset run -p 8088 --with-threads --reload'
```

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

### Launch Superset with Docker Compose (Development)

Source: https://superset.apache.org/docs/installation/docker-compose

Build and launch Superset for an interactive development environment. Ensures all layers are up-to-date.

```bash
# The --build argument insures all the layers are up-to-date  
docker compose up --build  
```

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

### Initialize a New Language Dictionary

Source: https://superset.apache.org/docs/contributing/misc

Use the `pybabel init` command to create a new language dictionary file. This command initializes a new language catalog based on a template POT file.

```bash
# Initialize a new language
pybabel init -i superset/translations/messages.pot -d superset/translations -l de

```

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

### Base Database Connection String Format

Source: https://superset.apache.org/docs/databases/supported/base

Use this format to construct the connection string for your base database. Replace placeholders with your specific credentials and server details.

```text
engine+driver://user:password@host:port/dbname[?key=value&key=value...]
```

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

### IBM Db2 Connection String

Source: https://superset.apache.org/docs/databases/supported/ibm-db2

Use this connection string format for standard IBM Db2 installations. Ensure the 'ibm_db_sa' package is installed.

```sql
db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}
```

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

### Launch Official Superset Release with Docker Compose

Source: https://superset.apache.org/docs/installation/docker-compose

Set the desired release tag, fetch it, and then launch Superset using the official release compose file.

```bash
# Set the version you want to run  
export TAG=5.0.0  
# Fetch the tag you're about to check out (assuming you shallow-cloned the repo)  
git fetch --depth=1 origin tag $TAG  
# Could also fetch all tags too if you've got bandwidth to spare  
# git fetch --tags  
# Checkout the corresponding git ref  
git checkout $TAG  
# Fire up docker compose  
docker compose -f docker-compose-image-tag.yml up  
```

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

### MonetDB Connection String Format

Source: https://superset.apache.org/docs/databases/supported/monetdb

Use this format to establish a connection to your MonetDB instance. Ensure all placeholders are replaced with your specific database credentials and host information.

```sql
monetdb://{username}:{password}@{host}:{port}/{database}
```

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

### Backfill Translations via npm

Source: https://superset.apache.org/docs/contributing/misc

Run the AI translation backfill process using npm scripts. Arguments for the script can be passed after `--`.

```bash
# Backfill (pass arguments after --)
npm run translations:backfill -- --lang fr --dry-run

```

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

### Get Schemas

Source: https://superset.apache.org/docs/rest-api

Retrieves all schemas from a specific database.

```APIDOC
## GET /api/v1/database/{pk}/schemas/

### Description
Retrieves all schemas from a specific database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/schemas/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Get Catalogs

Source: https://superset.apache.org/docs/rest-api

Retrieves all catalogs from a specific database.

```APIDOC
## GET /api/v1/database/{pk}/catalogs/

### Description
Retrieves all catalogs from a specific database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/catalogs/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Add PostgreSQL Driver to requirements-local.txt

Source: https://superset.apache.org/docs/databases

Append the psycopg2-binary package to the requirements-local.txt file to include the PostgreSQL driver for Docker deployments.

```bash
# Add your driver (e.g., for PostgreSQL)
echo "psycopg2-binary" >> ./docker/requirements-local.txt
```

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

### Get OAuth2 Tokens

Source: https://superset.apache.org/docs/rest-api

Receives personal access tokens from OAuth2.

```APIDOC
## GET /api/v1/database/oauth2/

### Description
Receives personal access tokens from OAuth2.

### Method
GET

### Endpoint
/api/v1/database/oauth2/
```

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

### Link Local Plugin to Superset Frontend

Source: https://superset.apache.org/docs/contributing/misc

Links a local visualization plugin globally and then links it into a local Superset frontend development environment.

```bash
npm link
# In your Superset frontend directory:  
npm link superset-plugin-chart-hello-world
```

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

### Get Available Databases

Source: https://superset.apache.org/docs/rest-api

Retrieves the names of databases that are currently available.

```APIDOC
## GET /api/v1/database/available/

### Description
Retrieves the names of databases that are currently available.

### Method
GET

### Endpoint
/api/v1/database/available/
```

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

### Get Tables

Source: https://superset.apache.org/docs/rest-api

Retrieves a list of tables available in a specific database.

```APIDOC
## GET /api/v1/database/{pk}/tables/

### Description
Retrieves a list of tables available in a specific database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/tables/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Get Table Metadata

Source: https://superset.apache.org/docs/rest-api

Retrieves metadata for tables in a specific database.

```APIDOC
## GET /api/v1/database/{pk}/table_metadata/

### Description
Retrieves metadata for tables in a specific database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/table_metadata/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Ascend Connection String Format

Source: https://superset.apache.org/docs/databases/supported/ascend

Use this format to construct the connection string for Ascend.io. Ensure all placeholders are replaced with your specific credentials and database details.

```sql
ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true
```

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

### Dashboards - Info

Source: https://superset.apache.org/docs/rest-api

Gets metadata information about the dashboard API resource.

```APIDOC
## GET /api/v1/dashboard/_info

### Description
Get metadata information about this API resource (dashboard--info).

### Method
GET

### Endpoint
/api/v1/dashboard/_info
```

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

### Backfill Translations via npm

Source: https://superset.apache.org/docs/contributing/creating-viz-plugins

Run the translation backfilling process using npm scripts. Arguments for the script can be passed after the `--` separator.

```bash
# Backfill (pass arguments after --)
npm run translations:backfill -- --lang fr --dry-run
```

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

### Manage Database Migrations

Source: https://superset.apache.org/docs/contributing/misc

Commands to create new database migrations, apply pending migrations, and downgrade to a previous migration state.

```bash
# Create a new migration
superset db migrate -m "Description of changes"

# Apply migrations
superset db upgrade

# Downgrade
superset db downgrade
```

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

### Get Database Connection Info

Source: https://superset.apache.org/docs/rest-api

Retrieves connection information for a specific database.

```APIDOC
## GET /api/v1/database/{pk}/connection

### Description
Retrieves connection information for a specific database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/connection

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Get Database

Source: https://superset.apache.org/docs/rest-api

Retrieves details for a specific database identified by its primary key.

```APIDOC
## GET /api/v1/database/{pk}

### Description
Retrieves details for a specific database identified by its primary key.

### Method
GET

### Endpoint
/api/v1/database/{pk}

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database to retrieve.
```

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

### Get Database Info

Source: https://superset.apache.org/docs/rest-api

Retrieves metadata information about the database API resource.

```APIDOC
## GET /api/v1/database/_info

### Description
Retrieves metadata information about the database API resource.

### Method
GET

### Endpoint
/api/v1/database/_info
```

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

### Create Database

Source: https://superset.apache.org/docs/rest-api

Creates a new database configuration within Apache Superset.

```APIDOC
## POST /api/v1/database/

### Description
Creates a new database configuration within Apache Superset.

### Method
POST

### Endpoint
/api/v1/database/
```

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

### Dashboards - Embedded Config Get

Source: https://superset.apache.org/docs/rest-api

Retrieves the embedded configuration for a specific dashboard.

```APIDOC
## GET /api/v1/dashboard/{id_or_slug}/embedded

### Description
Get the dashboard's embedded configuration.

### Method
GET

### Endpoint
/api/v1/dashboard/{id_or_slug}/embedded
```

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

### Get Database Table

Source: https://superset.apache.org/docs/rest-api

Retrieves metadata for a specific table within a schema in a database.

```APIDOC
## GET /api/v1/database/{pk}/table/{table_name}/{schema_name}/

### Description
Retrieves metadata for a specific table within a schema in a database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/table/{table_name}/{schema_name}/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
- **table_name** (string) - Required - The name of the table.
- **schema_name** (string) - Required - The name of the schema.
```

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

### Configure Fixed Thumbnail Executor

Source: https://superset.apache.org/docs/configuration/cache

Set up a fixed user to render thumbnails, falling back to this user for anonymous requests. Requires `FixedExecutor` import.

```python
from superset.tasks.types import FixedExecutor

THUMBNAIL_EXECUTORS = [FixedExecutor("admin")]
```

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

### Get Related Objects

Source: https://superset.apache.org/docs/rest-api

Retrieves the count of charts and dashboards associated with a specific database.

```APIDOC
## GET /api/v1/database/{pk}/related_objects/

### Description
Retrieves the count of charts and dashboards associated with a specific database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/related_objects/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Get Function Names

Source: https://superset.apache.org/docs/rest-api

Retrieves a list of function names supported by a specific database.

```APIDOC
## GET /api/v1/database/{pk}/function_names/

### Description
Retrieves a list of function names supported by a specific database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/function_names/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Create a New Superset Visualization Plugin

Source: https://superset.apache.org/docs/contributing/misc

Generates a new Superset visualization plugin project using the Yeoman generator and navigates into the new directory.

```bash
mkdir superset-plugin-chart-hello-world
cd superset-plugin-chart-hello-world
yo @superset-ui/superset
```

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

### Set up Local Presto Connection for Testing

Source: https://superset.apache.org/docs/contributing/misc

Configure Superset to test against a local Presto instance running in Docker. Ensure the SQLALCHEMY_DATABASE_URI is correctly set in superset_config.py.

```bash
# Start Presto locally using Docker  
docker run -p 8080:8080 \  
  --name presto \  
  -d prestodb/presto  

# Configure in superset_config.py  
SQLALCHEMY_DATABASE_URI = 'presto://localhost:8080/hive/default'
```

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

### SingleStore Connection String Format

Source: https://superset.apache.org/docs/databases/supported/singlestore

This is the standard URI format for connecting to a SingleStore database. Ensure you replace the placeholders with your actual credentials and database details.

```sql
singlestoredb://{username}:{password}@{host}:{port}/{database}
```

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

### Get Related Column Data

Source: https://superset.apache.org/docs/rest-api

Retrieves related field data based on a column name.

```APIDOC
## GET /api/v1/database/related/{column_name}

### Description
Retrieves related field data based on a column name.

### Method
GET

### Endpoint
/api/v1/database/related/{column_name}

### Parameters
#### Path Parameters
- **column_name** (string) - Required - The name of the column to find related data for.
```

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

### Enable API Key Authentication

Source: https://superset.apache.org/docs/security

Configure `superset_config.py` to enable API key authentication and expose the management UI via feature flags.

```python
FAB_API_KEY_ENABLED = True  

FEATURE_FLAGS = {  
    "FAB_API_KEY_ENABLED": True,  
}
```

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

### Get Table Metadata Extra

Source: https://superset.apache.org/docs/rest-api

Retrieves extra metadata related to tables in a specific database.

```APIDOC
## GET /api/v1/database/{pk}/table_metadata/extra/

### Description
Retrieves extra metadata related to tables in a specific database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/table_metadata/extra/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Get Table Select Star

Source: https://superset.apache.org/docs/rest-api

Retrieves SQL for selecting all columns from a specific table in a database.

```APIDOC
## GET /api/v1/database/{pk}/select_star/{table_name}/

### Description
Retrieves SQL for selecting all columns from a specific table in a database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/select_star/{table_name}/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
- **table_name** (string) - Required - The name of the table.
```

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

### Get Schemas for File Upload

Source: https://superset.apache.org/docs/rest-api

Retrieves the list of database schemas available for file uploads.

```APIDOC
## GET /api/v1/database/{pk}/schemas_access_for_file_upload/

### Description
Retrieves the list of database schemas available for file uploads.

### Method
GET

### Endpoint
/api/v1/database/{pk}/schemas_access_for_file_upload/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
```

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

### Get Table Extra Metadata

Source: https://superset.apache.org/docs/rest-api

Retrieves extra metadata for a specific table within a schema in a database.

```APIDOC
## GET /api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/

### Description
Retrieves extra metadata for a specific table within a schema in a database.

### Method
GET

### Endpoint
/api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/

### Parameters
#### Path Parameters
- **pk** (integer) - Required - The primary key of the database.
- **table_name** (string) - Required - The name of the table.
- **schema_name** (string) - Required - The name of the schema.
```

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

### Dashboards - Related Column Name

Source: https://superset.apache.org/docs/rest-api

Gets related fields data for a dashboard based on a column name.

```APIDOC
## GET /api/v1/dashboard/related/{column_name}

### Description
Get related fields data (dashboard-related-column-name).

### Method
GET

### Endpoint
/api/v1/dashboard/related/{column_name}
```

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

### Enable Thumbnail Caching Feature Flags

Source: https://superset.apache.org/docs/configuration/cache

Activate the thumbnail generation and SQLA listener feature flags in your Superset configuration.

```python
FEATURE_FLAGS = {

    "THUMBNAILS": True,

    "THUMBNAILS_SQLA_LISTENERS": True,

}
```
Tokens:
Raw