Skip to content

feat(gooddata-sdk): [AUTO] add Arrow binary result endpoint support (retrieveResultBinary)#1439

Closed
yenkins-admin wants to merge 1 commit intomasterfrom
feature/auto-P003-arrow-binary-endpoint
Closed

feat(gooddata-sdk): [AUTO] add Arrow binary result endpoint support (retrieveResultBinary)#1439
yenkins-admin wants to merge 1 commit intomasterfrom
feature/auto-P003-arrow-binary-endpoint

Conversation

@yenkins-admin
Copy link
Copy Markdown
Contributor

Expose the new BETA Apache Arrow binary result endpoint (retrieveResultBinary) through the gooddata-sdk wrapper by adding a read_result_binary() method to BareExecutionResponse and Execution.

Problem: P003 | Workflow: https://github.com/gooddata/gdc-nas/actions/runs/23194184862

What changed in gdc-nas

Two PRs added Arrow binary format support to the afm-exec-api execute-result endpoint:

  • PR #21285 (78be9c1): Initial feature — added Arrow content types (application/vnd.apache.arrow.file, application/vnd.apache.arrow.stream) to the existing /result/{resultId} endpoint.
  • PR #21382 (81eb97a): Refactored Arrow responses into a new dedicated GET /result/{resultId}/binary endpoint (operationId: retrieveResultBinary, marked BETA). The original endpoint now returns JSON only. The binary endpoint has no paging parameters (offset/limit/excludedTotalDimensions).

The gooddata-api-client was already regenerated with retrieve_result_binary in computation_api.py and actions_api.py.

What was implemented in SDK

  • Added read_result_binary(workspace_id, result_id, x_gdc_cancel_token=None) method to BareExecutionResponse and Execution classes, calling retrieve_result_binary via _actions_api. The method explicitly omits paging parameters, matching the binary endpoint's API contract.
  • Added unit tests in test_execution_binary.py verifying correct parameter forwarding and absence of paging parameters.

Files modified

  • packages/gooddata-sdk/src/gooddata_sdk/compute/model/execution.py
  • packages/gooddata-sdk/tests/compute/test_execution_binary.py

JIRA: PENDING (Jira ticket will be created after review)
Risk: Low

…I format support

Expose the new BETA retrieveResultBinary endpoint (GET /result/{resultId}/binary)
through BareExecutionResponse and Execution wrapper classes. The method accepts an
optional cancel token but deliberately omits paging parameters (offset/limit/
excludedTotalDimensions) which are not supported on the binary endpoint.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 17, 2026

Codecov Report

❌ Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 77.25%. Comparing base (4dc3f87) to head (59005d5).

Files with missing lines Patch % Lines
...ta-sdk/src/gooddata_sdk/compute/model/execution.py 88.88% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1439   +/-   ##
=======================================
  Coverage   77.24%   77.25%           
=======================================
  Files         227      227           
  Lines       14672    14681    +9     
=======================================
+ Hits        11334    11342    +8     
- Misses       3338     3339    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hkad98 hkad98 closed this Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants