maestral.database

This module contains the definitions of our data base tables which store the index, sync history and cache of content hashes.

Module Contents

maestral.database.db_naming_convention[source]
maestral.database.Base[source]
maestral.database.Session[source]
class maestral.database.SyncDirection[source]

Bases: enum.Enum

Enumeration of sync directions

Up = up[source]
Down = down[source]
class maestral.database.SyncStatus[source]

Bases: enum.Enum

Enumeration of sync status

Queued = queued[source]
Syncing = syncing[source]
Done = done[source]
Failed = failed[source]
Skipped = skipped[source]
Aborted = aborted[source]
class maestral.database.ItemType[source]

Bases: enum.Enum

Enumeration of SyncEvent types

File = file[source]
Folder = folder[source]
Unknown = unknown[source]
class maestral.database.ChangeType[source]

Bases: enum.Enum

Enumeration of SyncEvent change types

Added = added[source]
Removed = removed[source]
Moved = moved[source]
Modified = modified[source]
class maestral.database.SyncEvent[source]

Bases: Base

Represents a file or folder change in the sync queue

This class is used to represent both local and remote file system changes and track their sync progress. Some instance attributes will depend on the state of the sync session, e.g., local_path will depend on the current path of the local Dropbox folder. They may therefore become invalid between sync sessions.

The class methods from_dbx_metadata() and from_file_system_event() should be used to properly construct a SyncEvent from a dropbox.files.Metadata instance or a watchdog.events.FileSystemEvent instance, respectively.

id[source]

A unique identifier of the SyncEvent.

direction[source]

The SyncDirection.

item_type[source]

The ItemType. May be undetermined for remote deletions.

sync_time[source]

The time the SyncEvent was registered.

dbx_id[source]

A unique dropbox ID for the file or folder. Will only be set for download events which are not deletions.

dbx_path[source]

Dropbox path of the item to sync. If the sync represents a move operation, this will be the destination path. Follows the casing from server.

local_path[source]

Local path of the item to sync. If the sync represents a move operation, this will be the destination path. This will be correctly cased.

dbx_path_from[source]

Dropbox path that this item was moved from. Will only be set if change_type is ChangeType.Moved. Follows the casing from server.

local_path_from[source]

Local path that this item was moved from. Will only be set if change_type is ChangeType.Moved. This will be correctly cased.

rev[source]

The file revision. Will only be set for remote changes. Will be 'folder' for folders and None for deletions.

content_hash[source]

A hash representing the file content. Will be 'folder' for folders and None for deletions. Set for both local and remote changes.

change_type[source]

The ChangeType. Remote SyncEvents currently do not generate moved events but are reported as deleted and added at the new location.

change_time[source]

Local ctime or remote client_modified time for files. None for folders or for remote deletions. Note that client_modified may not be reliable as it is set by other clients and not verified.

change_dbid[source]

The Dropbox ID of the account which performed the changes. This may not be set for added folders or deletions on the server.

change_user_name[source]

The user name corresponding to change_dbid, if the account still exists. This field may not be set for performance reasons.

status[source]

The SyncStatus.

size[source]

Size of the item in bytes. Always zero for folders.

completed[source]

File size in bytes which has already been uploaded or downloaded. Always zero for folders.

change_time_or_sync_time(self)float[source]

Change time when available, otherwise sync time. This can be used for sorting or user information purposes.

change_time_or_sync_time(cls) → sqlalchemy.sql.elements.Case[source]
property is_file(self)bool[source]

Returns True for file changes

property is_directory(self)bool[source]

Returns True for folder changes

property is_added(self)bool[source]

Returns True for added items

property is_moved(self)bool[source]

Returns True for moved items

property is_changed(self)bool[source]

Returns True for changed file contents

property is_deleted(self)bool[source]

Returns True for deleted items

property is_upload(self)bool[source]

Returns True for changes to upload

property is_download(self)bool[source]

Returns True for changes to download

classmethod from_dbx_metadata(cls, md: dropbox.files.Metadata, sync_engine: maestral.sync.SyncEngine)maestral.database.SyncEvent[source]

Initializes a SyncEvent from the given Dropbox metadata.

Parameters
  • md – Dropbox Metadata.

  • sync_engine – SyncEngine instance.

Returns

An instance of this class with attributes populated from the given Dropbox Metadata.

classmethod from_file_system_event(cls, event: watchdog.events.FileSystemEvent, sync_engine: maestral.sync.SyncEngine)maestral.database.SyncEvent[source]

Initializes a SyncEvent from the given local file system event.

Parameters
  • event – Local file system event.

  • sync_engine – SyncEngine instance.

Returns

An instance of this class with attributes populated from the given SyncEvent.

class maestral.database.IndexEntry[source]

Bases: Base

Represents an entry in our local sync index

dbx_path_lower[source]

Dropbox path of the item in lower case. This acts as a primary key for the SQLites database since there can only be one entry per case-insensitive Dropbox path.

dbx_path_cased[source]

Dropbox path of the item, correctly cased.

dbx_id[source]

The unique dropbox ID for the item.

item_type[source]

The ItemType.

last_sync[source]

The last time a local change was uploaded. Should be the ctime of the local item.

rev[source]

The file revision. Will be 'folder' for folders.

content_hash[source]

A hash representing the file content. Will be 'folder' for folders. May be None if not yet calculated.

property is_file(self)bool[source]

Returns True for file changes

property is_directory(self)bool[source]

Returns True for folder changes

class maestral.database.HashCacheEntry[source]

Bases: Base

Represents an entry in our cache of content hashes

local_path[source]

The local path of the item.

hash_str[source]

The content hash of the item.

mtime[source]

The mtime of the item just before the hash was computed. When the current ctime is newer, the hash will need to be recalculated.