API Reference

The following pages provide a full API reference for the datacube python library.

Core Classes & Data Model

• Datacube Class
• Dataset
• Product
• Geometry Classes
• Measurement
• Metadata Type
• LineageTree
• Range
• Query

Querying & Loading Data

• Dataset & Product Discovery
• Dataset Querying
• Product Querying
• Data Loading
• Masking
• Bit Masking

Managing Data

• Dataset Writing
  • Doc2Dataset
• Product Writing
• Index API
  • datacube.index.abstract
    • AbstractDatasetResource
      • AbstractDatasetResource.add()
      • AbstractDatasetResource.add_location()
      • AbstractDatasetResource.archive()
      • AbstractDatasetResource.archive_less_mature()
      • AbstractDatasetResource.archive_location()
      • AbstractDatasetResource.bulk_add()
      • AbstractDatasetResource.bulk_get()
      • AbstractDatasetResource.bulk_has()
      • AbstractDatasetResource.can_update()
      • AbstractDatasetResource.count()
      • AbstractDatasetResource.count_by_product()
      • AbstractDatasetResource.count_by_product_through_time()
      • AbstractDatasetResource.count_product_through_time()
      • AbstractDatasetResource.find_less_mature()
      • AbstractDatasetResource.get()
      • AbstractDatasetResource.get_all_dataset_ids()
      • AbstractDatasetResource.get_all_docs()
      • AbstractDatasetResource.get_archived_location_times()
      • AbstractDatasetResource.get_archived_locations()
      • AbstractDatasetResource.get_datasets_for_location()
      • AbstractDatasetResource.get_derived()
      • AbstractDatasetResource.get_field_names()
      • AbstractDatasetResource.get_location()
      • AbstractDatasetResource.get_locations()
      • AbstractDatasetResource.get_product_time_bounds()
      • AbstractDatasetResource.get_unsafe()
      • AbstractDatasetResource.has()
      • AbstractDatasetResource.purge()
      • AbstractDatasetResource.remove_location()
      • AbstractDatasetResource.restore()
      • AbstractDatasetResource.restore_location()
      • AbstractDatasetResource.search()
      • AbstractDatasetResource.search_by_metadata()
      • AbstractDatasetResource.search_by_product()
      • AbstractDatasetResource.search_eager()
      • AbstractDatasetResource.search_product_duplicates()
      • AbstractDatasetResource.search_returning()
      • AbstractDatasetResource.search_returning_datasets_light()
      • AbstractDatasetResource.search_summaries()
      • AbstractDatasetResource.spatial_extent()
      • AbstractDatasetResource.temporal_extent()
      • AbstractDatasetResource.update()
    • AbstractIndex
      • AbstractIndex.clone()
      • AbstractIndex.close()
      • AbstractIndex.create_spatial_index()
      • AbstractIndex.datasets
      • AbstractIndex.drop_spatial_index()
      • AbstractIndex.environment
      • AbstractIndex.from_config()
      • AbstractIndex.get_dataset_fields()
      • AbstractIndex.index_id
      • AbstractIndex.init_db()
      • AbstractIndex.lineage
      • AbstractIndex.metadata_types
      • AbstractIndex.name
      • AbstractIndex.products
      • AbstractIndex.spatial_indexes()
      • AbstractIndex.thread_transaction()
      • AbstractIndex.transaction()
      • AbstractIndex.update_spatial_index()
      • AbstractIndex.url
      • AbstractIndex.users
    • AbstractIndexDriver
      • AbstractIndexDriver.get_config_option_handlers()
    • AbstractLineageResource
      • AbstractLineageResource.add()
      • AbstractLineageResource.bulk_add()
      • AbstractLineageResource.clear_home()
      • AbstractLineageResource.get_all_lineage()
      • AbstractLineageResource.get_derived_tree()
      • AbstractLineageResource.get_homes()
      • AbstractLineageResource.get_source_tree()
      • AbstractLineageResource.merge()
      • AbstractLineageResource.remove()
      • AbstractLineageResource.set_home()
    • AbstractMetadataTypeResource
      • AbstractMetadataTypeResource.add()
      • AbstractMetadataTypeResource.bulk_add()
      • AbstractMetadataTypeResource.can_update()
      • AbstractMetadataTypeResource.check_field_indexes()
      • AbstractMetadataTypeResource.from_doc()
      • AbstractMetadataTypeResource.get()
      • AbstractMetadataTypeResource.get_all()
      • AbstractMetadataTypeResource.get_all_docs()
      • AbstractMetadataTypeResource.get_by_name()
      • AbstractMetadataTypeResource.get_by_name_unsafe()
      • AbstractMetadataTypeResource.get_unsafe()
      • AbstractMetadataTypeResource.get_with_fields()
      • AbstractMetadataTypeResource.update()
      • AbstractMetadataTypeResource.update_document()
    • AbstractProductResource
      • AbstractProductResource.add()
      • AbstractProductResource.add_document()
      • AbstractProductResource.bulk_add()
      • AbstractProductResource.can_update()
      • AbstractProductResource.delete()
      • AbstractProductResource.from_doc()
      • AbstractProductResource.get()
      • AbstractProductResource.get_all()
      • AbstractProductResource.get_all_docs()
      • AbstractProductResource.get_by_name()
      • AbstractProductResource.get_by_name_unsafe()
      • AbstractProductResource.get_field_names()
      • AbstractProductResource.get_unsafe()
      • AbstractProductResource.get_with_fields()
      • AbstractProductResource.get_with_types()
      • AbstractProductResource.most_recent_change()
      • AbstractProductResource.search()
      • AbstractProductResource.search_by_metadata()
      • AbstractProductResource.search_robust()
      • AbstractProductResource.spatial_extent()
      • AbstractProductResource.temporal_extent()
      • AbstractProductResource.update()
      • AbstractProductResource.update_document()
    • AbstractTransaction
      • AbstractTransaction.active
      • AbstractTransaction.begin()
      • AbstractTransaction.commit()
      • AbstractTransaction.rollback()
    • AbstractUserResource
      • AbstractUserResource.create_user()
      • AbstractUserResource.delete_user()
      • AbstractUserResource.grant_role()
      • AbstractUserResource.list_users()
    • BatchStatus
      • BatchStatus.completed
      • BatchStatus.count()
      • BatchStatus.index()
      • BatchStatus.safe
      • BatchStatus.seconds_elapsed
      • BatchStatus.skipped
    • DatasetTuple
      • DatasetTuple.count()
      • DatasetTuple.index()
      • DatasetTuple.metadata
      • DatasetTuple.product
      • DatasetTuple.uri_
    • NoLineageResource
      • NoLineageResource.add()
      • NoLineageResource.bulk_add()
      • NoLineageResource.clear_home()
      • NoLineageResource.get_all_lineage()
      • NoLineageResource.get_derived_tree()
      • NoLineageResource.get_homes()
      • NoLineageResource.get_source_tree()
      • NoLineageResource.merge()
      • NoLineageResource.remove()
      • NoLineageResource.set_home()
    • UnhandledTransaction
      • UnhandledTransaction.active
      • UnhandledTransaction.begin()
      • UnhandledTransaction.commit()
      • UnhandledTransaction.rollback()
    • default_metadata_type_docs()
    • dsid_to_uuid()

Configuration API

• Configuration API
  • Executive Summary
  • Full API
    • ODCConfig
      • ODCConfig.allow_envvar_overrides
      • ODCConfig.raw_text
      • ODCConfig.raw_config
      • ODCConfig.known_environments
      • ODCConfig.canonical_names
      • ODCConfig.get_aliases()
      • ODCConfig.get_environment()
    • ConfigException
      • ConfigException.add_note()
      • ConfigException.with_traceback()
    • ODCEnvironment

Utilities

• Amazon Web Services (AWS)
• Writing GeoTIFFs
• Dask