Database

class caris.bathy.db.Database((object)arg1, (str)database_name, (NodeManager)node_manager)
add_product_surface((str)geometry) → Surface

New in version 4.1.10.

Add a new product Surface to the Database.

Parameters:geometry (str) – Well-Known Text (WKT) describing the geometry of the Surface.
Return type:The new Surface.
add_surface((str)geometry) → Surface

Add a new Surface to the Database.

Parameters:geometry (str) – Well-Known Text (WKT) describing the geometry of the Surface.
Return type:The new Surface.
add_survey((float)min_x, (float)min_y, (float)max_x, (float)max_y) → Survey

Add the specified Survey to the Database.

Parameters:
  • min_x (float) – The X value of the lower left corner.
  • min_y (float) – The Y value of the lower left corner.
  • max_x (float) – The X value of the upper right corner.
  • max_y (float) – The Y value of the upper right corner.
Return type:

The new Survey.

current_time() → object

New in version 4.1.17.

Get the current time from the server.

Return type:The current time on the database server.
delete_product_surface((int)id) → None

Delete the specified product Surface from the Database.

Parameters:id (int) – The id of the Surface to delete.
delete_surface((int)id) → None

Delete the specified Surface from the Database.

Parameters:id (int) – The id of the Surface to delete.
delete_survey((int)arg2) → None

Delete the specified Survey from the Database.

Parameters:id (int) – The id of the Survey to delete.
get_catalog() → Catalog

New in version 4.0.4.

Get the Catalog associated with the Database.

Return type:The Database’s Catalog.
get_product_surface((int)id) → Surface

Get the specified product Surface from the Database.

Parameters:id (int) – The id of the Surface to get.
Return type:The specified Surface.
get_surface((int)id) → Surface

Get the specified Surface from the Database.

Parameters:id (int) – The id of the Surface to get.
Return type:The specified Surface.
get_survey((int)id) → Survey

Get the specified Survey from the Database.

Parameters:id (int) – The id of the Survey to get.
Return type:The specified Survey.
name

The name of the database.

Type:str
query_journal((object)operation_types, (Operator)query_operator, (object)query_time) → object

New in version 4.1.17.

Query the Database for operations that have happened before or after a specific time.

Parameters:
  • operation_types (List of OperationTypes) – The list of operation types to query for.
  • query_operator (Operator) – The query operator used with the query time to find the appropriate events.
  • query_time (datetime) – The query time used with the query operator to find the appropriate events.
Return type:

List of JournalEntry that pass the query.

query_objects((ObjectQuery)query) → object

Query the Database.

Parameters:query (ObjectQuery) – The query to perform.
Return type:A list of object ids.
Return type:IDList
class caris.bathy.db.FileDescriptor((object)arg1)

A file descriptor.

creation_time

The creation time of the attached file.

Type:str
modified_time

The modification time of the attached file.

Type:str
name

The name of the attached file.

Type:str
size

The size of the attached file.

Type:str