Commit db7cfa42 authored by Matthieu Dorier's avatar Matthieu Dorier
Browse files

more docs

parent fea13a2a
Storing and retrieving products
Creating and accessing DataSets
===============================
Creating and accessing events
=============================
Creating and accessing Products
===============================
Creating and accessing Runs
===========================
Creating and accessing objects
Creating and accessing SubRuns
==============================
Client connection
=================
Client connection and service shutdown
======================================
.. literalinclude:: ../../../examples/01_init_shutdown/main.cpp
The following code sample showcases how to initialize a DataStore
object in a client program. This object is the main entry point to
the HEPnOS storage system. Its :code:`connect()` function takes
the name of a YAML file as a parameter, which should be the file
created by HEPnOS when starting up.
.. literalinclude:: ../../examples/01_init_shutdown/main.cpp
:language: cpp
The :code:`DataStore::shutdown()` method can be used to tell
HEPnOS to shutdown. This method should be called by only one client
and will terminate all the HEPnOS processes. If HEPnOS is setup to
use in-memory databases, you will loose all the data store in HEPnOS.
......@@ -27,8 +27,11 @@ Contents
organization.rst
deployment.rst
connection.rst
accessing.rst
products.rst
accessing_datasets.rst
accessing_runs.rst
accessing_subruns.rst
accessing_events.rst
accessing_products.rst
optimizations.rst
theta.rst
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment