Feature¶

class caris.bathy.db.Feature¶

Bases: caris.Feature

Database Feature

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.

add_related_feature((Feature)self, (Feature)feature) → None :¶

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.

get_related_features((Feature)self, (str)feature_code) → FeatureList :¶

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.

remove_related_feature((Feature)self, (Feature)feature) → None :¶

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 (bool) – Auto generate a new geometry based on the coverage

property attachments¶

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

property attributes¶

AttributeDictionary: The metadata of this Feature

property coverage¶

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

property crs¶

CoordinateReferenceSystem: The coordinate reference system of the Feature

property dataset¶

Dataset: The Dataset containing this Feature

property definition¶

FeatureDefinition: The definition of the Feature

property geometry¶

Geometry: The geometry of the Feature

property id¶

property is_offline¶

bool: The offline status of the Feature

property related_features¶

list of Feature: A list of related features

property uri¶

str: The URI of the Feature

class caris.bathy.db.FileDescriptor¶

A file descriptor.

property modified_time¶

datetime <datetime.datetime: The modification time of the attached file in UTC

property name¶

str: The name of the attached file

property size¶

int: The size of the attached file in bytes