Skip to content

Commit

Permalink
improved Store docco
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholascar committed Sep 17, 2021
1 parent dad85e6 commit e280956
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@

# 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
Expand Down Expand Up @@ -210,9 +210,9 @@ def find_version(filename):

# 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.
Expand All @@ -239,4 +239,4 @@ def find_version(filename):

html_experimental_html5_writer = True

needs_sphinx = "2.4"
needs_sphinx = "4.1.2"
51 changes: 51 additions & 0 deletions docs/plugin_stores.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
Plugin stores
=============

Built In
--------

The following Stores are contained within the rdflib core package:

================= ============================================================
Name Class
Expand All @@ -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()

0 comments on commit e280956

Please sign in to comment.