ArcticDB Python Documentation

Introduction

This site documents the Python API of ArcticDB.

Tutorials, guides and team contact details are available here.

The API is structured into the following components:

• Arctic: Arctic is the primary API used for accessing and manipulating ArcticDB libraries.

• Library: The Library API enables reading and manipulating symbols inside ArcticDB libraries.

• Query Builder: The QueryBuilder API enables the specification of complex queries, utilised in the Library API.

Contents

• Arctic API
  • arcticdb.Arctic
    • Arctic
      • Arctic.__init__()
  • arcticdb.LibraryOptions
    • LibraryOptions
      • LibraryOptions.dynamic_schema
      • LibraryOptions.dedup
      • LibraryOptions.rows_per_segment
      • LibraryOptions.columns_per_segment
      • LibraryOptions.__init__()
  • Arctic
    • Arctic.__init__()
  • LibraryOptions
    • LibraryOptions.dynamic_schema
    • LibraryOptions.dedup
    • LibraryOptions.rows_per_segment
    • LibraryOptions.columns_per_segment
    • LibraryOptions.__init__()
• Library API
  • arcticdb.version_store.library.Library
    • Library
      • Library.__init__()
  • arcticdb.version_store.library.NormalizableType
    • NormalizableType
  • arcticdb.version_store.library.ArcticInvalidApiUsageException
    • ArcticInvalidApiUsageException
  • arcticdb.version_store.library.ArcticDuplicateSymbolsInBatchException
    • ArcticDuplicateSymbolsInBatchException
  • arcticdb.version_store.library.ArcticUnsupportedDataTypeException
    • ArcticUnsupportedDataTypeException
  • arcticdb.version_store.library.SymbolVersion
    • SymbolVersion
      • SymbolVersion.symbol
      • SymbolVersion.version
      • SymbolVersion.__init__()
  • arcticdb.version_store.library.VersionInfo
    • VersionInfo
      • VersionInfo.date
      • VersionInfo.deleted
      • VersionInfo.snapshots
      • VersionInfo.__init__()
  • arcticdb.version_store.library.SymbolDescription
    • SymbolDescription
      • SymbolDescription.columns
      • SymbolDescription.index
      • SymbolDescription.index_type
      • SymbolDescription.row_count
      • SymbolDescription.last_update_time
      • SymbolDescription.date_range
      • SymbolDescription.__init__()
  • arcticdb.version_store.library.WritePayload
    • WritePayload
      • WritePayload.__init__()
  • arcticdb.version_store.library.ReadRequest
    • ReadRequest
      • ReadRequest.as_of
      • ReadRequest.date_range
      • ReadRequest.columns
      • ReadRequest.query_builder
      • ReadRequest.__init__()
  • Library
    • Library.__init__()
• Query Builder API
  • QueryBuilder