Folder : index_files_for_migration
Folder_IndexFilesForMigration.RdIndex files in this entity for migration to a new storage location.
This is the first step in migrating files to a new storage location.
After indexing, use synMigrateIndexedFiles() to perform the actual migration.
Usage
synIndexFilesForMigration(instance, dest_storage_location_id, db_path=NULL, source_storage_location_ids=NULL, file_version_strategy="new", include_table_files=FALSE, continue_on_error=FALSE, synapse_client=NULL)Arguments
- instance
(Folder) The Folder instance to operate on.
- dest_storage_location_id
(integer) The destination storage location ID.
- db_path
(Optional[character]) Path to the SQLite database file for tracking migration state. If not provided, a temporary directory will be used. The path can be retrieved from the
db_pathfield of the returnedMigrationResult.- source_storage_location_ids
(Optional[list[integer]]) Optional list of source storage location IDs to filter which files to migrate. If NULL, all files are indexed.
- file_version_strategy
(character) Strategy for handling file versions. Options: 'new' (default) - create new versions, 'all' - migrate all versions, 'latest' - only migrate latest version, 'skip' - skip if file exists.
- include_table_files
(logical) Whether to include files attached to tables.
- continue_on_error
(logical) Whether to continue indexing if an error occurs.
- synapse_client
(Optional[Synapse]) If not passed in, the last created instance from the Synapse class constructor will be used.
Value
A MigrationResult object containing indexing statistics and the database
path (accessible via result$db_path).
Examples
if (FALSE) { # \dontrun{
## Indexing files for migration
# Index files in a folder for migration:
library(synapser)
synLogin()
folder = Folder(id = "syn123") |> synGet()
result = folder |> synIndexFilesForMigration(
dest_storage_location_id = 12345L
)
print(sprintf("Database path: %s", result$db_path))
print(result$counts_by_status)
} # }