Skip to main content
Version: 0.6

Connect

The standard way to connect to Superduper is via the superduper decorator:

You may provide the URI/ connection details of your data deployment directly:

db = superduper('<database-uri>')

Or add the databackend URI in a config file in ('~/.superduper/config.yaml or export SUPERDUPER_CONFIG=<path>):

data_backend: <database-uri>

And then call superduper with no parameters:

db = superduper()

For example if you are running a (not secure) MongoDB deployment locally, and you want to connect to the "documents" database, you might write:

from superduper import superduper
db = superduper('mongodb://localhost:27017/documents')

Complete connection guide​

For a semi-exhaustive list of possible connections see the supported data-backends here.

Fine grained configuration​

superduper chooses additional values for your connection, based on superduper.CFG. These defaults may be overridden directly:

db = superduper(
    '<database-uri>',
    artifact_store='<artifact-store-path>',
)

As an alternative add additional lines to your superduper config file ('~/.superduper/config.yaml or export SUPERDUPER_CONFIG=<path>).

data_backend: <database-uri>,
artifact_store: <artifact-store-path>
json_native: true|false
log_level: INFO|DEBUG|WARN|ERROR