gabotorresruiz commented on code in PR #43340:
URL: https://github.com/apache/superset/pull/43340#discussion_r3867275405
##########
docs/docs/using-superset/exporting-dashboard-data.mdx:
##########
@@ -72,23 +91,25 @@ will not register.
## Configuration keys
-| Key | Default | Description
|
-| ------------------------------- | ---------------------- |
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| `EXCEL_EXPORT_S3_BUCKET` | `None` | Destination
bucket. Required; `501` if unset.
|
-| `EXCEL_EXPORT_S3_KEY_PREFIX` | `"dashboard-exports/"` | Key prefix:
`{prefix}{dashboard_id}/{job_id}.xlsx`.
|
-| `EXCEL_EXPORT_LINK_TTL_SECONDS` | `86400` | Lifetime of the
pre-signed download URL (24h).
|
-| `EXCEL_EXPORT_S3_CLIENT_KWARGS` | `{}` | Extra kwargs for
`boto3.client("s3", ...)` — e.g. `region_name`, or `endpoint_url` for
MinIO/LocalStack.
|
-| `EXCEL_EXPORT_TABLE_VIZ_TYPES` | `None` | Viz types kept
tabular in **Export Images to Excel** mode; every other type is embedded as an
image. `None` uses the built-in default (`table`, `pivot_table`,
`pivot_table_v2`). |
-| `EXCEL_EXPORT_QUERY_CONTEXT_BUILDER` | `None` | Optional
`Callable[[form_data_dict], dict \| None]` to build a query context for a chart
missing a saved one, tried before the built-in form-data rebuild. Point it at a
service that runs the chart's real frontend `buildQuery` to faithfully export
viz types the built-in rebuild can't handle. Must return `None` when it can't
build faithfully, so the export falls back. |
-
-Credentials and region resolve through the standard boto3 chain (environment
-variables, shared config, or instance role) unless overridden via
-`EXCEL_EXPORT_S3_CLIENT_KWARGS`. The worker needs `s3:PutObject` on the bucket.
+| Key | Default |
Description
|
+| -------------------------------------- | ---------------------- |
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
+| `EXPORT_STORAGE["bucket"]` | unset |
Destination bucket. Required; `501` if unset.
|
+| `EXPORT_STORAGE["backend"]` | unset | Storage
backend instance: `S3ExportStorage()` (`superset.utils.s3`),
`GCSExportStorage()` (`superset.utils.gcs`), or a custom
`superset.utils.export_storage.ExportStorage` implementation. Required; `501`
if unset. |
+| `EXPORT_STORAGE["key_prefix"]` | `"dashboard-exports/"` | Object
key/blob prefix: `{prefix}{dashboard_id}/{job_id}.xlsx`. A callable (`() ->
str`) is invoked per export, for prefixes only known in request/task context
(e.g. per-tenant scoping of a shared bucket). |
+| `EXCEL_EXPORT_LINK_TTL_SECONDS` | `86400` | Lifetime
of the pre-signed download URL (24h).
|
Review Comment:
Fixed in c75abca73a: the config table now distinguishes the link record
lifetime from the five minute storage URL minted fresh on each click.
##########
docs/docs/using-superset/exporting-dashboard-data.mdx:
##########
@@ -47,12 +47,31 @@ Notes on the generated workbook:
This feature is **disabled by default**. It requires:
-1. **The `boto3` dependency.** It is not installed by default; install it with
- `pip install apache-superset[excel-export]`. Without it, exports fail and
the
- user receives a failure email.
-2. **An S3 bucket.** Set `EXCEL_EXPORT_S3_BUCKET`. Until it is set, the export
- endpoint returns `501` and the menu action surfaces a "not configured"
- message.
+1. **A storage bucket and backend.** Configure `EXPORT_STORAGE` with both
+ a `bucket` and a `backend` matching the bucket's provider — there is no
+ implicit default:
+
+ ```python
+ from superset.utils.s3 import S3ExportStorage # AWS S3
+ # from superset.utils.gcs import GCSExportStorage # Google Cloud Storage
+
+ EXPORT_STORAGE = {
+ "bucket": "my-export-bucket",
+ "backend": S3ExportStorage(),
+ }
+ ```
+
+ Until both are set, the export endpoint returns `501` and the menu action
+ surfaces a "not configured" message.
+2. **The backend's SDK dependency.** Not installed by default; install
+ `pip install apache-superset[excel-export]` (boto3) for `S3ExportStorage`,
+ or `pip install apache-superset[excel-export-gcs]` (google-cloud-storage)
+ for `GCSExportStorage`. Without it, exports fail and the user receives a
+ failure email. For `GCSExportStorage` with token-only Application Default
Review Comment:
Fixed in c75abca73a: the credentials paragraph now spells out both tiers,
the worker uploading and the web server signing at click time, including the
GCS signBlob case for token only credentials.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
