IQSS / IQSS/dataverse

(Experimental feature) Expose the location/path of the physical file via the Access api

Open
#10,302 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: API
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Same idea as behind the existing direct upload, but simplified and generalized for all datafiles.
/api/access/datafile/{id} downloads the bytes
/api/access/datafile/{id}/storageLocation outputs something like /mnt/files/data/xxxxxxxx (for a filesystem-stored datafile).
The use case is Dataverse deployed on a cluster along with other nodes all sharing block access to the data objects; a computational node serving as an "external tool" will be able to run on a big data file directly without having to stream it via the Dataverse API.
May be needed for the MOC-POC demo.

Implementation should be trivial/straightforward.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing direct-upload Access API implementation and the handlers for /api/access/datafile/{id}. Check how filesystem-stored datafiles expose their storage location and how the response should behave for other storage types. Done means the storageLocation endpoint returns the expected physical path for supported datafiles without changing the existing download endpoint.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.