Teledyne Logo | Teledyne CARISSoftware


Account
  • Home
  • Products
    • Hydrographic Survey

      • CARIS Collect
      • CARIS Onboard
      • HIPS and SIPS
      • Bathy DataBASE
      • Sonar Noise Classifier
      • ADMIRALTY GAM

      Free Data Viewer

      • CARIS Easy View

      Chart Production

      • BASE Editor
      • HPD
      • S-57 Composer
      • S-100 Composer
      • Paper Chart Composer
      • CARIS AutoChart
      • LOTS Limits and Boundaries

      Educational

      • Academic Software
      • Online Learning

      Spatial Data Analysis

      • BASE Editor
      • Engineering Analysis Module

      CARIS Cloud

      • CARIS Cloud Overview
      • CARIS Bathy Data Service
      • CARIS S-57 ENC Service
      • CARIS Chart Data Service

      CARIS Mira AI

      • CARIS Mira AI Overview
      • Sonar Noise Classifier
      • ADMIRALTY GAM
  • Support
    • Product Support & Downloads
    • CARIS Python API
    • Academic Partnering Program
    • Training
  • News
    • Newsroom
    • Media Kit
    • Events & Tradeshows
    • Recorded Webinars
    • Subscribe to Mailing List
    • Calendar Images
  • Company
    • Company Profile
    • Corporate Background
    • Careers
    • Quality & Certifications
    • Terms and Conditions
    • Privacy Policy
    • Cookies Policy
    • Website Terms of Use
    • Teledyne Technologies
  • Contact
    • Contact Sales
    • Office Locations
    • Find a Distributor
    • Request for Credit Account
  • Terms and Conditions

Python API 5.6

Documentation

Teledyne CARIS provides bindings for scripting with the Python programming language. These bindings provide a simple, consistent model to automate and integrate data and operations with external functions and software.


Navigation

  • index
  • modules |
  • next |
  • previous |
  • CARIS API 5.6.10 documentation »
  • BDB Server Module »
  • Classes

Classes¶

  • NodeManager
    • NodeManager
      • NodeManager.create_database()
      • NodeManager.get_database()
      • NodeManager.get_database_state()
      • NodeManager.start_database()
      • NodeManager.stop_database()
      • NodeManager.unregister_database()
      • NodeManager.databases
      • NodeManager.hostname
      • NodeManager.password
      • NodeManager.username
    • DatabaseState
  • Feature
    • Feature
      • Feature.add_attachment()
      • Feature.add_related_feature()
      • Feature.delete()
      • Feature.delete_attachment()
      • Feature.download_attachment()
      • Feature.get_related_features()
      • Feature.purge()
      • Feature.remove_coverage()
      • Feature.remove_related_feature()
      • Feature.restore()
      • Feature.upload_coverage()
      • Feature.attachments
      • Feature.attributes
      • Feature.coverage
      • Feature.crs
      • Feature.dataset
      • Feature.definition
      • Feature.geometry
      • Feature.id
      • Feature.is_offline
      • Feature.related_features
      • Feature.uri
    • FileDescriptor
      • FileDescriptor.modified_time
      • FileDescriptor.name
      • FileDescriptor.size
  • Dataset
    • Dataset
      • Dataset.commit()
      • Dataset.create_feature()
      • Dataset.delete_feature()
      • Dataset.get_feature()
      • Dataset.query()
      • Dataset.query_all()
      • Dataset.query_all_deleted()
      • Dataset.query_all_offline()
      • Dataset.query_deleted()
      • Dataset.query_journal()
      • Dataset.query_modified()
      • Dataset.query_offline()
      • Dataset.rollback()
      • Dataset.catalogue
      • Dataset.crs
      • Dataset.current_time
      • Dataset.name
  • JournalEntry
    • JournalEntry
      • JournalEntry.identifier
      • JournalEntry.operation
      • JournalEntry.userName
      • JournalEntry.time
      • JournalEntry.metadata
    • OperationType
    • Operator

CARIS API

Navigation

  • Configuration
  • Changes List
  • Coverage Module
  • CARIS Module
  • BDB Server Module
    • Tutorial
    • Classes
    • Indices and tables
  • BDB Server 6 Module
  • HPD
  • Application User Interface Module

Related Topics

  • Documentation overview
    • BDB Server Module
      • Previous: Introduction
      • Next: NodeManager

Quick search


Back to top

Teledyne CARIS is the leading developer of marine mapping software, headquartered in Fredericton, NB, Canada.

Company
  • Company Profile
  • Careers
  • News
  • Distributors
  • Contact Sales
  • Teledyne Technologies
Downloads
  • CARIS Easy View
  • Media Kit
Support
  • Software Support & Downloads
  • Training
  • Academic Partnering
Connect With Us

A Teledyne Technologies company. © 2025 Teledyne CARIS.

Privacy Policy | Cookies Policy | Website Terms of Use

HIPS and SIPS product
CARIS HIPS & SIPS Professional

HIPS and SIPS
BASE Editor
Engineering Analysis Module
S-57 Composer
Paper Chart Composer