Feature

class caris.bathy.db.Feature

Bases: caris.Feature

Database Feature

coverage

Raster, Cloud, or VRS – The coverage of the Feature

is_offline

Boolean – The offline status of the Feature

attachments

list(FileDescriptor) – The list of files attached to the Feature

uri

str – The URI of the Feature

id

str – The object id of the Feature (Example: d9f195da-0b0c-11e7-8000-1866da47ee87)

add_attachment((Feature)self, (str)file_name) → None :

Upload a new attachment to the object.

Parameters:file_name (str) – The full path of the attachment to upload.

Adds a related Feature to this Feature’s relationships.

Parameters:feature (Feature) – The related feature to add.
delete((Feature)self) → None :

Deletes the feature.

delete_attachment((Feature)self, (str)file_name) → None :

Delete an attachment from the object.

Parameters:file_name (str) – The file name of the attachment to be deleted.
download_attachment((Feature)self, (str)file_name, (str)dest_path) → None :

Download an attachment from the object

Parameters:
  • file_name (str) – The name of the attachment to download.
  • dest_path (str) – The file path where the file is to be saved.

Returns related features of the given feature code.

Parameters:feature_code (str) – The feature code of the related features
Returns:A list of features of the given code that are related.
Return type:list(Feature)
purge((Feature)self) → None :

Marks the Feature as purgeable.

The database is configured with a “Purge” interval which executes a process to permanently purge these features from the database every time this interval elapses.

Removes a related Feature from this Feature's relationships.

Parameters:feature (Feature) – The related feature to remove.
restore((Feature)self) → None :

Restores the feature if it’s been deleted.

upload_coverage((Feature)self[, (object)file_path=None[, (object)coverage=None[, (bool)update_geometry=True]]]) → None :

Upload/Replace coverage for the Feature

Parameters:
  • file_path (str) – The file path of the file to upload
  • coverage (Raster or Cloud or VRS) – The coverage of the feature
  • update_geometry (Boolean) – Auto generate a new geometry based on the coverage
attachments
attributes
coverage
crs
dataset
definition
geometry
id
is_offline
related_features
uri
class caris.bathy.db.FileDescriptor

A file descriptor.

name

str – The name of the attached file

size

int – The size of the attached file in bytes

modified_time

datetime – The modification time of the attached file in UTC