synCreateSnapshotVersion: synCreateSnapshotVersion

In Sage-Bionetworks/synapser: R Language Bindings for Synapse API

synCreateSnapshotVersion

Description

Create a new Table Version, new View version, or new Dataset version.

Usage

synCreateSnapshotVersion(table, comment=NULL, label=NULL, activity=NULL, wait=TRUE)

Arguments

table	The schema of the Table/View, or its ID.
comment	Optional snapshot comment.
label	Optional snapshot label.
activity	Optional activity ID applied to snapshot version.
wait	True if this method should return the snapshot version after waiting for any necessary asynchronous table updates to complete. If False this method will return as soon as any updates are initiated.

Value

the snapshot version number if wait=True, None if wait=False

Examples

## Not run: 
synCreateSnapshotVersion(table='syn123', comment='snapshot comment', wait=TRUE)

## End(Not run)

Sage-Bionetworks/synapser documentation built on Aug. 23, 2024, 11:07 a.m.