Skip to content

Add replaceExisting option to createRemoteDatasetDoc #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 31, 2025
Merged

Add replaceExisting option to createRemoteDatasetDoc #494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bed8219
feat: Add replaceExisting option to createRemoteDatasetDoc
google-labs-jules[bot] Oct 31, 2025
2c8c5c4
Update GitHub badges
github-actions[bot] Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/badges/tests.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 18 additions & 2 deletions src/ndi/+ndi/+cloud/+internal/createRemoteDatasetDoc.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
function remoteDatasetDoc = createRemoteDatasetDoc(cloudDatasetId, ndiDataset)
function remoteDatasetDoc = createRemoteDatasetDoc(cloudDatasetId, ndiDataset, options)
% createRemoteDatasetDoc - Create NDI document with remote dataset details.
%
% Syntax:
% remoteDatasetDoc = createRemoteDatasetDoc(cloudDatasetId)
% remoteDatasetDoc = createRemoteDatasetDoc(cloudDatasetId, ndiDataset)
% remoteDatasetDoc = createRemoteDatasetDoc(cloudDatasetId, ndiDataset, 'replaceExisting', true)
%
% This function retrieves a remote dataset from the cloud and creates
% a "dataset remote" NDI document for that dataset.
%
% Input Arguments:
% cloudDatasetId - The unique identifier for the cloud dataset to be
% retrieved.
% ndiDataset - The NDI dataset object.
% options.replaceExisting - A boolean that if true, will replace an
% existing remote dataset document.
%
% Output Arguments:
% remoteDatasetDoc - A document object containing the remote dataset
Expand All @@ -17,6 +22,17 @@
arguments
cloudDatasetId
ndiDataset (1,1) ndi.dataset
options.replaceExisting (1,1) logical = false
end

[~, existingDoc] = ndi.cloud.internal.getCloudDatasetIdForLocalDataset(ndiDataset);

if ~isempty(existingDoc)
if options.replaceExisting
ndiDataset.database_rm(existingDoc{1}.id());
else
error('An existing remote dataset document was found. Use ''replaceExisting'', true to replace it.');
end
end

[success, remoteDataset] = ndi.cloud.api.datasets.getDataset(cloudDatasetId);
Expand Down