Welcome to pdc python api's documentation!
==========================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Main APIs
=========

Thoughout the documentation, you may see the following types used when an integer must be in a certain range:

===========  =================
type name    range
===========  =================
int32        -2**31 to 2**31-1
uint32       0 to 2**32-1
uint64       0 to 2**64-1
===========  =================

These bounds are checked at runtime and will result in an OverflowError if they are exceeded.

.. automodule:: pdc
   :imported-members:
   :members: KVTags, PDCError, init, ready, ServerContext
   :undoc-members:
   :exclude-members: tag_types, tag_types_union

   .. autoclass:: Type
      :members: as_numpy_type, from_numpy_type
      :show-inheritance:

      .. autoattribute:: INT
         :annotation: 
         
         A 32-bit signed integer.  This is the default value for Type aguments
      
      .. autoattribute:: UINT
         :annotation: 
         
         A 32-bit unsigned integer.
      
      .. autoattribute:: FLOAT
         :annotation: 
         
         A 32-bit floating point number.
      
      .. autoattribute:: DOUBLE
         :annotation: 
         
         A 64-bit floating point number.
            
      .. autoattribute:: INT64
         :annotation: 
         
         A 64-bit signed integer.
      
      .. autoattribute:: UINT64
         :annotation: 
         
         A 64-bit unsigned integer.
      
      .. autoattribute:: INT16
         :annotation: 
         
         A 16-bit signed integer.
      
      .. autoattribute:: INT8
         :annotation: 
         
         An 8-bit signed integer.

Containers
==========

.. automodule:: pdc
   :noindex:
   :imported-members:
   :exclude-members: containers_by_id, Container
   :members: all_local_containers

   .. autoclass:: Container
      :members:
      :exclude-members: Lifetime
      
      .. autoclass:: pdc.Container.Lifetime
         :show-inheritance:

         .. autoattribute:: pdc.Container.Lifetime.PERSISTENT
            :annotation:

            The container and all objects in it will persist across server restarts.
         
         .. autoattribute:: pdc.Container.Lifetime.TRANSIENT
            :annotation:

            The container and all objects in it will be deleted when the server restarts.

Objects
=======

.. automodule:: pdc
   :noindex:
   :imported-members:
   :members: Object

Regions
=======

.. automodule:: pdc.region
   :members:
   :undoc-members:

   .. property:: region
   
   	An object used to create regions.
   	See :class:`Region` for details.

.. _queries:

Queries
=======

.. automodule:: pdc.query
   :members:
   :undoc-members:
   :exclude-members: Query

   .. autoclass:: pdc.Query
      :members:
      :undoc-members:
      :exclude-members: Result

      .. autoclass:: pdc.Query.Result
         :members:
         :undoc-members:

         .. property:: hits

            Number of hits in the result.
            If you *only* want the number of hits, use :func:`query.get_num_hits`
      
      
      

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`