diff options
| author | Nicholas Car <nicholas.car@surroundaustralia.com> | 2021-09-17 21:49:30 +1000 |
|---|---|---|
| committer | Nicholas Car <nicholas.car@surroundaustralia.com> | 2021-09-17 21:49:30 +1000 |
| commit | e2809560fa8916fdff20c27fcdea4f0f8687205a (patch) | |
| tree | a9a063456dba46444ff083759368aefc56dd5990 /docs | |
| parent | dad85e6d58bf848f797fbf5fd8fda11db28bb0e4 (diff) | |
| download | rdflib-e2809560fa8916fdff20c27fcdea4f0f8687205a.tar.gz | |
improved Store docco
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 10 | ||||
| -rw-r--r-- | docs/plugin_stores.rst | 51 |
2 files changed, 56 insertions, 5 deletions
diff --git a/docs/conf.py b/docs/conf.py index 67a0f592..d4ae1ae3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,7 +62,7 @@ master_doc = "index" # General information about the project. project = "rdflib" -copyright = "2009 - 2020, RDFLib Team" +copyright = "2009 - 2021, RDFLib Team" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -210,9 +210,9 @@ htmlhelp_basename = "rdflibdoc" # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ("index", "rdflib.tex", "rdflib Documentation", "RDFLib Team", "manual"), -] +# latex_documents = [ +# ("index", "rdflib.tex", "rdflib Documentation", "RDFLib Team", "manual"), +# ] # The name of an image file (relative to this directory) to place at the top of # the title page. @@ -239,4 +239,4 @@ intersphinx_mapping = { html_experimental_html5_writer = True -needs_sphinx = "2.4" +needs_sphinx = "4.1.2" diff --git a/docs/plugin_stores.rst b/docs/plugin_stores.rst index 8fd511d3..1ac53d03 100644 --- a/docs/plugin_stores.rst +++ b/docs/plugin_stores.rst @@ -4,6 +4,10 @@ Plugin stores ============= +Built In +-------- + +The following Stores are contained within the rdflib core package: ================= ============================================================ Name Class @@ -17,3 +21,50 @@ SPARQLUpdateStore :class:`~rdflib.plugins.stores.sparqlstore.SPARQLUpdateStore` BerkeleyDB :class:`~rdflib.plugins.stores.berkeleydb.BerkeleyDB` default :class:`~rdflib.plugins.stores.memory.Memory` ================= ============================================================ + +External +-------- + +The following Stores are defined externally to rdflib's core package, so look to their documentation elsewhere for +specific details of use. + +================= ==================================================== ============================================================================================= +Name Repository Notes +================= ==================================================== ============================================================================================= +SQLAlchemy `<https://github.com/RDFLib/rdflib-sqlalchemy>`_ An SQLAlchemy-backed, formula-aware RDFLib Store. Tested dialects are: SQLite, MySQL & PostgreSQL +leveldb `<https://github.com/RDFLib/rdflib-leveldb>`_ An adaptation of RDFLib BerkeleyDB Store’s key-value approach, using LevelDB as a back-end +Kyoto Cabinet `<https://github.com/RDFLib/rdflib-kyotocabinet>`_ An adaptation of RDFLib BerkeleyDB Store’s key-value approach, using Kyoto Cabinet as a back-end +HDT `<https://github.com/RDFLib/rdflib-hdt>`_ A Store back-end for rdflib to allow for reading and querying `HDT <https://www.rdfhdt.org/>`_ documents +Oxigraph `<https://github.com/oxigraph/oxrdflib>`_ Works with the `Pyoxigraph <https://oxigraph.org/pyoxigraph>`_ Python graph database library +================= ==================================================== ============================================================================================= + +_If you have, or know of a Store implementation and would like it listed here, please submit a Pull Request!_ + +Use +--- + +You can use these stores like this: + +.. code-block:: python + + from rdflib import Graph + + # use the default memory Store + graph = Graph() + + # use the BerkeleyDB Store + graph = Graph(store="BerkeleyDB") + + +In some cases, you must explicitly _open_ and _close_ a store, for example: + +.. code-block:: python + + from rdflib import Graph + + # use the BerkeleyDB Store + graph = Graph(store="BerkeleyDB") + graph.open("/some/folder/location") + # do things ... + graph.close() + |
