cache_dataset
Cache a dataset or asset locally for faster subsequent downloads without creating execution or provenance records, ideal for warming the cache before experiments.
Instructions
Download a dataset bag or asset into the local cache without creating an execution.
Use this to warm the cache before running experiments. No execution or provenance records are created — this is purely a local download operation. After caching, subsequent download_dataset or download_execution_dataset calls will use the cached copy.
Provide either dataset_rid (for bags) or asset_rid (for individual assets), not both.
Args: dataset_rid: RID of a dataset to cache (mutually exclusive with asset_rid). asset_rid: RID of an asset to cache (mutually exclusive with dataset_rid). version: Dataset version to cache (required when using dataset_rid). materialize: If True (default), download all asset files in the bag. If False, download only table metadata (faster, smaller). Ignored for asset cache. exclude_tables: Optional list of table names to exclude from FK path traversal during bag export. Only applies to dataset cache.
Returns: JSON with cache results. For datasets: bag_info including cache_status and size. For assets: file path and metadata.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | ||
| asset_rid | No | ||
| dataset_rid | No | ||
| materialize | No | ||
| exclude_tables | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |