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_coverage((Feature)self) → None :¶

New in version 5.4.1.

Remove the coverage from this Feature.

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¶

The list of files attached to the Feature

Type

list(FileDescriptor)

property attributes¶

The metadata of this Feature

Type

AttributeDictionary

property coverage¶

The coverage of the Feature

Type

Raster, Cloud, or VRS

property crs¶

The coordinate reference system of the Feature

Type

CoordinateReferenceSystem

property dataset¶

The Dataset containing this Feature

Type

Dataset

property definition¶

The definition of the Feature

Type

FeatureDefinition

property geometry¶

The geometry of the Feature

Type

Geometry

property id¶

d9f195da-0b0c-11e7-8000-1866da47ee87)

Type

str

Type

The object id of the Feature (Example

property is_offline¶

The offline status of the Feature

Type

bool

property related_features¶

A list of related features

Type

list of Feature

property uri¶

The URI of the Feature

Type

str

class caris.bathy.db.FileDescriptor¶

A file descriptor.

property modified_time¶

The modification time of the attached file in UTC

Type

datetime

property name¶

The name of the attached file

Type

str

property size¶

The size of the attached file in bytes

Type

int