Dataset¶

class caris.bathy.db.Dataset¶

Bases: caris.Dataset

Provides an interface to a Bathy DataBASE Server database

commit((Dataset)self) → None :¶

Commit any changes to the dataset

create_feature((Dataset)self, (str)feature_code, (Geometry)geometry[, (object)attributes=None]) → Feature :¶

Create a new feature

Parameters

• feature_code (str) – The type of feature to create

• geometry (Geometry) – The geometry

• attributes (AttributeDictionary, optional) – The attributes

Returns

A Feature object

delete_feature((Dataset)self, (Feature)feature) → None :¶

Delete an existing feature

Parameters

feature (Feature) – The feature to delete

get_feature((Dataset)self, (str)id) → Feature :¶

Gets Feature with given id.

Parameters

id (str) – The ID of the feature.

Returns

The Feature with the given id if it exists, None if it doesn’t.

Return type

Feature

query((Dataset)self, (str)feature_code[, (object)CQL=None[, (object)contains=None[, (object)crosses=None[, (object)intersects=None[, (object)disjoint_from=None[, (object)equal_to=None[, (object)within=None[, (object)overlaps=None[, (object)touches=None]]]]]]]]]) → FeatureRange :¶

Query for specific features

Parameters

• feature_code (str) – The feature type to return

• CQL (str) – The CQL query to run

• contains (Geometry, optional) – Get Features that completely contain the Geometry without touching. Opposite of within

• crosses (Geometry, optional) – Get Features that have some interior points in common with Geometry, and the dimension of their intersection is less than that of at least one of them

• intersects (Geometry, optional) – Get Features that have at least one point in common with Geometry. Opposite of disjoint_from

• disjoint_from (Geometry, optional) – Get Features that have no points in common with Geometry. Opposite of intersects

• equal_to (Geometry, optional) – Get Features that are topologically equal to Geometry.

• within (Geometry, optional) – Get Features that are completely within Geometry without touching. Opposite of contains

• overlaps (Geometry, optional) – Get Features that have some but not all points in common with Geometry and that have the same dimension. The intersection of Feature and Geometry must have the same dimension as the geometries themselves

• touches (Geometry, optional) – Get Features that have at least one boundary point in common with Geometry, but no interior points

Returns

A FeatureRange with the features returned from the query

query_all((Dataset)self) → FeatureRange :¶

Query all features

Returns

Returns all Features

query_all_deleted((Dataset)self) → FeatureRange :¶

Query all deleted features

Returns

Returns all deleted Features

query_all_offline((Dataset)arg1) → FeatureRange :¶

get all offline features

Returns

A FeatureRange with all offline features

query_deleted((Dataset)self, (str)feature_code[, (object)CQL=None[, (object)contains=None[, (object)crosses=None[, (object)intersects=None[, (object)disjoint_from=None[, (object)equal_to=None[, (object)within=None[, (object)overlaps=None[, (object)touches=None]]]]]]]]]) → FeatureRange :¶

Query the deleted features

Parameters

• feature_code (str) – The feature type to return

• CQL (str) – The CQL query to run

• contains (Geometry, optional) – Get Features that completely contain the Geometry without touching. Opposite of within

• crosses (Geometry, optional) – Get Features that have some interior points in common with Geometry, and the dimension of their intersection is less than that of at least one of them

• intersects (Geometry, optional) – Get Features that have at least one point in common with Geometry. Opposite of disjoint_from

• disjoint_from (Geometry, optional) – Get Features that have no points in common with Geometry. Opposite of intersects

• equal_to (Geometry, optional) – Get Features that are topologically equal to Geometry.

• within (Geometry, optional) – Get Features that are completely within Geometry without touching. Opposite of contains

• overlaps (Geometry, optional) – Get Features that have some but not all points in common with Geometry and that have the same dimension. The intersection of Feature and Geometry must have the same dimension as the geometries themselves

• touches (Geometry, optional) – Get Features that have at least one boundary point in common with Geometry, but no interior points

Returns

A FeatureRange with the features returned from the query

query_journal((Dataset)self, (object)operations, (Operator)operator, (object)time_utc[, (object)feature_id=None]) → object :¶

Query the journal

Parameters

• operations ([OperationType]) – The operation type(s) of interest. Only journal entries of the specified type(s) are returned.

• operator (Operator) – The comparison operator used with the specified time.

• time_utc (datetime) – The date and time, in UTC, used to filter the journal entries that are returned.

• feature_id (str, optional) – An optional feature ID. If specified, only journal entries affecting this feature are returned.

Returns

The list of JournalEntries satisfying the query

Return type

([JournalEntry])

query_modified((Dataset)self, (str)feature_code[, (object)CQL=None[, (object)contains=None[, (object)crosses=None[, (object)intersects=None[, (object)disjoint_from=None[, (object)equal_to=None[, (object)within=None[, (object)overlaps=None[, (object)touches=None]]]]]]]]]) → FeatureRange :¶

Query the modified features

Parameters

• feature_code (str) – The feature type to return

• CQL (str) – The CQL query to run

• contains (Geometry, optional) – Get Features that completely contain the Geometry without touching. Opposite of within

• crosses (Geometry, optional) – Get Features that have some interior points in common with Geometry, and the dimension of their intersection is less than that of at least one of them

• intersects (Geometry, optional) – Get Features that have at least one point in common with Geometry. Opposite of disjoint_from

• disjoint_from (Geometry, optional) – Get Features that have no points in common with Geometry. Opposite of intersects

• equal_to (Geometry, optional) – Get Features that are topologically equal to Geometry.

• within (Geometry, optional) – Get Features that are completely within Geometry without touching. Opposite of contains

• overlaps (Geometry, optional) – Get Features that have some but not all points in common with Geometry and that have the same dimension. The intersection of Feature and Geometry must have the same dimension as the geometries themselves

• touches (Geometry, optional) – Get Features that have at least one boundary point in common with Geometry, but no interior points

Returns

A FeatureRange with the features returned from the query

query_offline((Dataset)arg1, (str)feature_code[, (object)CQL=None[, (object)contains=None[, (object)crosses=None[, (object)intersects=None[, (object)disjoint_from=None[, (object)equal_to=None[, (object)within=None[, (object)overlaps=None[, (object)touches=None]]]]]]]]]) → FeatureRange :¶

Query the offline Features

Parameters

• feature_code (str) – The feature type to return

• CQL (str) – The CQL query to run

• contains (Geometry, optional) – The geometry contains filter

• crosses (Geometry, optional) – The geometry crosses filter

• intersects (Geometry, optional) – The geometry intersects filter

• disjoint_from (Geometry, optional) – The geometry disjoint from filter

• equal_to (Geometry, optional) – The geometry equal to filter

• within (Geometry, optional) – The geometry within filter

• overlaps (Geometry, optional) – The geometry overlaps filter

• touches (Geometry, optional) – The geometry touches filter

Returns

A FeatureRange with the features returned from the query

rollback((Dataset)self) → None :¶

Rollback any changes to the dataset

property catalogue¶

The feature catalogue

Type

FeatureCatalogue

property crs¶

The coordinate reference system

Type

CoordinateReferenceSystem

property current_time¶

The current time of the server in UTC

Type

datetime

property name¶

The name of the database

Type

str