mirror of
https://github.com/apache/superset.git
synced 2026-05-23 16:55:19 +00:00
cbcfd9599f
Snapshots all four versioned Docusaurus sections at v6.1.0. Built on top of the version-cutting tooling work in chore/docs-cut-6.1.0-versions so the snapshot benefits from: - Auto-gen refresh before snapshotting (database pages from engine spec metadata, API reference from openapi.json, component pages from Storybook stories) — captured at the SHA we cut from rather than whatever happened to be on disk. - Data-import freeze: country list, feature flag table, database diagnostics, and component metadata are copied into snapshot-local `_versioned_data/` dirs so the historical version doesn't silently mutate when the source files change. - Depth-aware import-path rewriter that handles deeply-nested component MDX files referencing `../../../src/` from the snapshot. Versioning behavior: `lastVersion` stays at `current` for every section, so the canonical URLs (`/docs/...`, `/admin-docs/...`, `/developer-docs/...`, `/components/...`) continue to render content from master. The `current` version is consistently labeled "Next" with an `unreleased` banner, and `6.1.0` is a historical pin accessible only via its explicit version segment. Component playground: previously `disabled: true` in versions-config.json, now enabled and versioned. The plugin block in docusaurus.config.ts was already gated only by the `disabled` flag, so no other code changes were needed to bring it back online. The frozen `databases.json` in the snapshot is the canonical 80-database artifact from the latest committed state in master (preserved by the generator's input-hash cache), not a fallback regenerated from a local Flask environment.
79 lines
3.3 KiB
Plaintext
79 lines
3.3 KiB
Plaintext
---
|
|
title: Granular Export Controls
|
|
sidebar_position: 4
|
|
---
|
|
|
|
# Granular Export Controls
|
|
|
|
Superset provides granular, permission-based controls for data export, image export, and clipboard operations. These replace the legacy `can_csv` permission with three fine-grained permissions that can be assigned independently to roles.
|
|
|
|
## Feature Flag
|
|
|
|
Granular export controls are gated behind the `GRANULAR_EXPORT_CONTROLS` feature flag. When the flag is disabled, the legacy `can_csv` permission behavior is preserved.
|
|
|
|
```python
|
|
FEATURE_FLAGS = {
|
|
"GRANULAR_EXPORT_CONTROLS": True,
|
|
}
|
|
```
|
|
|
|
## Permissions
|
|
|
|
| Permission | Resource | Controls |
|
|
| -------------------- | ---------- | ---------------------------------------------------------------------- |
|
|
| `can_export_data` | `Superset` | CSV, Excel, and JSON data exports from charts, dashboards, and SQL Lab |
|
|
| `can_export_image` | `Superset` | Screenshot (JPEG/PNG) and PDF exports from charts and dashboards |
|
|
| `can_copy_clipboard` | `Superset` | Copy-to-clipboard operations in SQL Lab and the Explore data pane |
|
|
|
|
## Default Role Assignments
|
|
|
|
The migration grants all three new permissions (`can_export_data`, `can_export_image`, `can_copy_clipboard`) to every role that currently has `can_csv`. This preserves existing behavior — no role loses access during the upgrade.
|
|
|
|
After the migration, admins can selectively revoke individual export permissions from any role to restrict access. For example, to prevent Gamma users from exporting data or images while still allowing clipboard operations, revoke `can_export_data` and `can_export_image` from the Gamma role.
|
|
|
|
## Configuration Steps
|
|
|
|
1. **Enable the feature flag** in `superset_config.py`:
|
|
|
|
```python
|
|
FEATURE_FLAGS = {
|
|
"GRANULAR_EXPORT_CONTROLS": True,
|
|
}
|
|
```
|
|
|
|
2. **Run the database migration** to register the new permissions:
|
|
|
|
```bash
|
|
superset db upgrade
|
|
```
|
|
|
|
3. **Initialize permissions** so roles are populated:
|
|
|
|
```bash
|
|
superset init
|
|
```
|
|
|
|
4. **Verify role assignments** in **Settings > List Roles**. Confirm that each role has the expected permissions from the table above.
|
|
|
|
5. **Customize as needed**: Grant or revoke individual export permissions on any role through the role editor.
|
|
|
|
## User Experience
|
|
|
|
When a user lacks a required export permission:
|
|
|
|
- **Menu items** (CSV, Excel, JSON, screenshot) appear **disabled** with an info tooltip icon explaining the restriction
|
|
- **Buttons** (SQL Lab download, clipboard copy) appear **disabled** with a tooltip on hover
|
|
- **API endpoints** return **403 Forbidden** when the corresponding permission is missing
|
|
|
|
## API Enforcement
|
|
|
|
The following API endpoints enforce granular export permissions when the feature flag is enabled:
|
|
|
|
| Endpoint | Required Permission |
|
|
| --------------------------------------------------------- | ------------------- |
|
|
| `GET /api/v1/chart/{id}/data/` (CSV/Excel format) | `can_export_data` |
|
|
| `GET /api/v1/chart/{id}/cache_screenshot/` | `can_export_image` |
|
|
| `POST /api/v1/dashboard/{id}/cache_dashboard_screenshot/` | `can_export_image` |
|
|
| `GET /api/v1/sqllab/export/{client_id}/` | `can_export_data` |
|
|
| `POST /api/v1/sqllab/export_streaming/` | `can_export_data` |
|