Home
####

What is disk-objectstore
------------------------

``disk-objectstore`` is an implementation of an efficient key-value store that writes directly on disk
and does not require a server running.

.. panels::
   :body: bg-light text-center
   :footer: bg-light border-0


   :fa:`rocket,mr-1` **Getting Started**

   Simple example of how to use the API.

   +++++++++++++++++++++++++++++++++++++++++++++

   .. link-button:: pages/getting_started
      :type: ref
      :text: To the getting-started guide
      :classes: btn-outline-primary btn-block stretched-link

   ----------------------------------------------

   :fa:`info-circle,mr-1` **Advanced usage**

   Bulk operations, memory-savvy usage, ...

   +++++++++++++++++++++++++++++++++++++++++++++

   .. link-button:: pages/advanced_usage
      :type: ref
      :text: To the advanced-usage guide
      :classes: btn-outline-primary btn-block stretched-link

   ----------------------------------------------

   :fa:`question-circle,mr-1` **CLI usage**

   Learn how to use the `dostore` command line.

   +++++++++++++++++++++++++++++++++++++++++++++

   .. link-button:: pages/cli_usage
      :type: ref
      :text: To the how-to guides
      :classes: btn-outline-primary btn-block stretched-link

   ----------------------------------------------

   :fa:`bookmark,mr-1` **Packing**

   Explanation of what packing is and when you should pack your container.

   +++++++++++++++++++++++++++++++++++++++++++++

   .. link-button:: pages/packing
      :type: ref
      :text: To the explanation of packing
      :classes: btn-outline-primary btn-block stretched-link

   ----------------------------------------------

   :fa:`bookmark,mr-1` **Making backups**

   Information on how to back up a container.

   +++++++++++++++++++++++++++++++++++++++++++++

   .. link-button:: pages/backup
      :type: ref
      :text: To the backup explanation
      :classes: btn-outline-primary btn-block stretched-link

   ----------------------------------------------

   :fa:`cogs,mr-1` **Design**

   Background information on the design of the package.

   +++++++++++++++++++++++++++++++++++++++++++++

   .. link-button:: pages/design
      :type: ref
      :text: To the reference guide
      :classes: btn-outline-primary btn-block stretched-link


.. toctree::
   :maxdepth: 3
   :hidden:

   pages/getting_started
   pages/advanced_usage
   pages/cli_usage
   pages/packing
   pages/backup
   pages/design