Dataset.snapshot — Copy the current manifest into the dataset's snapshot directory.
snapshotPath = Dataset.snapshot(ds, label) copies manifest.json to .snapshots/<sanitized-label>.manifest.json through the handle's pinned provider.
Syntax
snapshotPath = Dataset.snapshot(ds, label)Inputs
ds- Type
Any- Required
- Yes
- Default
- —
- Description
- Managed Dataset receiver.
label- Type
StringScalar- Required
- Yes
- Default
- —
- Description
- Snapshot label.
Returns
s- Type
StringScalar- Description
- Text result.
Errors
RUNMAT:Data:Error- When
- A Dataset family receiver, argument, manifest, payload, or filesystem operation fails.
- Message
data: operation failed
RunMat:data:ManifestConflict- When
- A transaction's expected manifest sequence no longer matches the stored manifest.
- Message
data: manifest conflict
RunMat:data:TransactionNotFound- When
- The transaction is absent from the process-local registry.
- Message
data: transaction not found
Scope
Only the manifest file is copied; array payloads and chunk indexes are not snapshotted. Non-ASCII-alphanumeric label characters other than hyphen and underscore become underscores, so different labels can target the same filename.
Example
Snapshot a manifest
schema = struct(); schema.arrays = struct();
ds = data.create('snapshot.data', schema);
p = Dataset.snapshot(ds, 'baseline');Using Dataset.snapshot with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how Dataset.snapshot changes the result.
Run a small Dataset.snapshot example, explain the result, then change one input and compare the output.
FAQ
Is this a complete immutable dataset backup?⌄
No. It copies the manifest only and can overwrite a same-label snapshot.
Related Io functions
Data
commit · data.copy · data.create · data.delete · data.exists · data.export · data.import · data.inspect · data.list · data.move · data.open · DataArray.chunk_shape · DataArray.codec · DataArray.dtype · DataArray.fill · DataArray.name · DataArray.rank · DataArray.read · DataArray.resize · DataArray.shape · DataArray.write · Dataset.array · Dataset.arrays · Dataset.attrs · Dataset.begin · Dataset.get_attr · Dataset.has_array · Dataset.id · Dataset.path · Dataset.refresh · Dataset.set_attr · Dataset.set_attrs · Dataset.version · DataTransaction.abort · DataTransaction.commit · DataTransaction.create_array · DataTransaction.delete_array · DataTransaction.fill · DataTransaction.id · DataTransaction.resize · DataTransaction.set_attr · DataTransaction.set_attrs · DataTransaction.status · DataTransaction.write
Repl Fs
addpath · cd · copyfile · delete · dir · exist · fileattrib · fileparts · filesep · fullfile · genpath · getenv · getpref · isenv · isfile · isfolder · ispref · ls · matlabroot · memmapfile · memmapfile.subsasgn · memmapfile.subsref · mkdir · movefile · open · opentoline · path · pathsep · pcode · pwd · readstruct · rehash · restoredefaultpath · rmdir · rmpath · run · savepath · setenv · setpref · system · tempdir · tempname · uigetdir · uigetfile · uiputfile · unsetenv · userpath · what · winqueryreg · xmlread · xmlwrite
Tabular
arrayDatastore · csvread · csvwrite · detectImportOptions · dlmread · dlmwrite · fileDatastore · getvaropts · parquetDatastore · parquetinfo · parquetread · readcell · readmatrix · readtable · readtimetable · setvaropts · setvartype · spreadsheetImportOptions · writecell · writematrix · writetable · writetimetable · xlsread · xlswrite
Filetext
fclose · feof · fgetl · fgets · fileread · filewrite · fopen · fprintf · fread · frewind · fwrite · readlines · writelines
Import
Json
Related guides
Source you can read
Every RunMat function's source is public. Read exactly how Dataset.snapshot is executed, line by line, in Rust.
- View the source for Dataset.snapshot in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.