Edit and Delete Files and Folders

Update Cloud Storage Information

Once files are uploaded to Encord, their cloud storage information can be updated at any time. This feature allows you to adjust the URL or cloud integration of a file without re-importing the data.

---

Move Files Between Folders

Use the following script to move various types of files to a different folder in Files. Ensure that you:

• Replace <private_key_path> with the path to your private key.
• Replace File Name with the name of the file you want to move to a new folder.
• Replace Target Folder Name with the name of the folder you want to move the file to.

---

Delete Files

Use the following scripts to delete different types of files from Files. Ensure that you:

• Replace <private_key_path> with the path to your private key.
• Replace File Name with the name of the file you want to move to a new folder.
• Replace Parent Folder with the name of the folder containing the file you want to delete.

---

Update Folder Properties

Use the following script to update the name and description of an existing folder in Files. Ensure that you:

• Replace <private_key_path> with the path to your private key.
• Replace Cat Videos with the name of the folder you want to update properties for.
• Replace Cat videos and images with the new name you want to give the folder.
• Replace Images and videos of cats with the description you want to give the folder.

Use the list_storage_folders and find_storage_folders methods to search for specific folders.

---

Move Folders

You can move folders between different parent folders in Files, including moving them to the root (no parent). The following script demonstrates how a folder with the name Folder Name 3 is moved between 2 different target folders. The script must be modified to suit your needs.

Ensure that you:

• Replace <private_key_path> with the path to your private key.
• Replace Folder Name 1 with the name of a target folder.
• Replace Folder Name 2 with the new name of another target folder.
• Replace Folder Name 3 with the name of the folder that is moved.

Folders

from encord import EncordUserClient
from encord.storage import FoldersSortBy

# Instantiate Encord client by substituting the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
                ssh_private_key_path="<private_key_path>"
            )

# Search for folders by name using the find_storage_folders function
folder_1 = next(user_client.find_storage_folders(search="Folder Name 1", dataset_synced=False, order=FoldersSortBy.NAME, desc=False, page_size=1000))
folder_2 = next(user_client.find_storage_folders(search="Folder Name 2", dataset_synced=False, order=FoldersSortBy.NAME, desc=False, page_size=1000))
folder_3 = next(user_client.find_storage_folders(search="Folder Name 3", dataset_synced=False, order=FoldersSortBy.NAME, desc=False, page_size=1000))

# Move folder_3 under folder_1
folder_3.move_to_folder(folder_1.uuid)

# Move folder_3 under folder_2
folder_3.move_to_folder(folder_2.uuid)

# Move folder_3 to root folder (passing None moves it to the root level)
folder_3.move_to_folder(None)

---

Delete Folders

Use the following script to delete a specific folder from Files. Ensure that you:

• Replace <private_key_path> with the path to your private key.
• Replace Specific Folder Name with the name of the folder you want to delete.

from encord import EncordUserClient
from encord.storage import FoldersSortBy

# Instantiate Encord client by substituting the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
                ssh_private_key_path="<private_key_path>"
            )

# Define the search criteria for the folder
folder_search_criteria = "Specific Folder Name"

# Retrieve the target folder
try:
    folder_to_delete = next(user_client.find_storage_folders(search=folder_search_criteria, dataset_synced=None, order=FoldersSortBy.NAME, desc=False, page_size=1000))
    print(f"Deleting folder {folder_to_delete.uuid}")

    # Delete the folder and verify it cannot be accessed anymore
    folder_to_delete.delete()
    print("Folder deleted successfully.")

    try:
        # Try to refetch the folder to verify it's been deleted
        user_client.get_storage_folder(folder_to_delete.uuid)
        print("Error: Folder still accessible after deletion.")
    except Exception as e:
        print(f"Verification successful: {str(e)}")

except StopIteration:
    print("No folder found with the specified criteria.")