Alluxio
ProductsLanguageHome
DA-3.5 (stable)
DA-3.5 (stable)
  • Overview
  • Getting Started with K8s
    • Resource Prerequisites and Compatibility
    • Install on Kubernetes
    • Monitoring and Metrics
    • Cluster Administration
    • System Health Check & Quick Recovery
    • Collecting Cluster Information
  • Architecture
    • Alluxio Namespace and Under File System Namespaces
    • I/O Resiliency
    • Worker Management and Consistent Hashing
  • Storage Integrations
    • Amazon AWS S3
    • HDFS
    • Tencent COS
  • Compute Integrations
    • Trino on K8s
    • Spark on K8s
    • Data Lake Connectors
  • Client APIs
    • S3 API
    • Java HDFS-compatible API
  • Caching Operations
    • Cache Preloading
    • Cache Filter Policy
    • Cache Eviction
      • TTL Policy
      • Priority Policy
      • Free CLI Command
  • Resource Management
    • Directory-Based Cluster Quota
    • UFS Bandwidth Limiting
  • Performance Optimizations
    • Read Throughput Via Replicas
    • Reading Large Files
    • Metadata Listing
    • Data Prefetch
  • Security
    • TLS Support
    • Apache Ranger Integration
  • Reference
    • User CLI
    • Metrics
    • S3 API Usage
    • Third Party Licenses
  • Release Notes
Powered by GitBook
On this page
  • Cache Free Overview
  • Freeing Cache Space via Command Line
  • Freeing Cache Space via REST API
  1. Caching Operations
  2. Cache Eviction

Free CLI Command

Cache Free Overview

The free operation provides options to force data eviction to manually manage cache space.

Freeing Cache Space via Command Line

Usage: bin/alluxio job free [flags]

  • Operate a free job:

$ {ALLUXIO_HOME}/bin/alluxio job free --path s3://bucket/path --[submit|progress|stop]

$ {ALLUXIO_HOME}/bin/alluxio job free --local-index-file /indexfile --[submit|progress|stop]

$ {ALLUXIO_HOME}/bin/alluxio job free --ufs-index-file s3://bucket/indexfile --[submit|progress|stop]
  • View the progress a free job:

$ {ALLUXIO_HOME}/bin/alluxio job free --path s3://alluxio/path --progress
Progress for Free path file 's3://alluxio/path':
	Job Id: b21ce9fb-f332-4d39-8bb4-554f9a4fa601
	Job Submitted: Fri Feb 02 21:28:56 CST 2024
	Job path: s3://alluxio/path
	Job State: SUCCEEDED, finished at Fri Feb 02 21:29:01 CST 2024
	Free Info :	totalFile:4 totalByte:3072.00KB
	Free Files Failed: 0
	Free Bytes Failed: 0B
	Free Files Succeeded: 4
	Free Bytes Succeeded: 3072.00KB
  • Stop and interrupt a running free job: Note this will leave some files remaining in the cache

$ {ALLUXIO_HOME}/bin/alluxio job free --path s3://alluxio/path --stop
Parameter Description:
--path [all] the ufs path
--batch-size [submit] The speed of free files per second per worker
--force [submit] Trigger free even if some workers are offline
--verbose [progress] Verbose output
--format string [progress] Format of output, either TEXT or JSON (default "TEXT")
--ufs-index-file [All] Source index file of free operation
--local-index-file [All] Source local index file of free operation
--replicas [submit] Of replicas to free

Freeing Cache Space via REST API

  • Submit a free job:

curl -H "Content-Type: application/json" -v -X POST http://coordinator_host:19999/api/v1/master/submit_job/free -d '{
	"path": "s3://alluxio/path",
	"options": {
	"batchSize": "200"
	}
}'
  • View the progress of a free job:

curl -H "Content-Type: application/json" -v -X GET http://coordinator_host:19999/api/v1/master/progress_job/free -d '{
	"path": "s3://alluxio/path",
	"format": "JSON",
	"verbose": "true"
}'
  • Stop and interrupt a running free job: Note this will leave some files remaining in the cache

curl -H "Content-Type: application/json" -v -X POST http://coordinator_host:19999/api/v1/master/stop_job/free -d '{
	"path": "s3://alluxio/path"
}'

The free jobs can be list by sending a POST request. The results only include free tasks within seven days. The residence time of historical tasks can be configured through alluxio.job.retention.time.

curl http://ip:19999/api/v1/master/list_job?job-type=FREE[&job-state=[RUNNING|VERIFYING|STOPPED|SUCCEEDED|FAILED|ALL]]

Last updated 1 month ago