django_sorcery.db.url module

django_sorcery.db.url.boolean(x)

django_sorcery.db.url.get_settings(alias)

Returns database settings from either SQLALCHEMY_CONNECTIONS setting or DATABASES setting.

django_sorcery.db.url.importable(x)

django_sorcery.db.url.importable_list(x)

django_sorcery.db.url.importable_list_tuples(x)

django_sorcery.db.url.integer(x)

django_sorcery.db.url.make_url(alias_or_url)

alias_or_url: str

name of the alias or url as string

django_sorcery.db.url.make_url_from_settings(alias)

alias: str

name of the alias

Overall settings are very similar with django database settings with a few extra keys.

USER - database user

PASSWORD - database user password

HOST - database host

NAME - database name

PORT - database name

DIALECT - dialect to be used in url, if not provided, will use the DIALECT_MAP to figure out a dialect to be used in sqlalchemy url

DRIVER - If provided, will be used as the driver in sqlalchemy url

SQLALCHEMY - If provided, a custom sqlalchemy.SQLAlchemy class to be used

QUERY - querystring arguments for sqlalchemy url

ALCHEMY_OPTIONS - Optional arguments to be used to initialize the sqlalchemy.SQLAlchemy instance

• session_class - a custom session class to be used
• registry_class - a custom registy class to be used for scoping
• model_class - a custom base model class to be used for declarative base models.
• metadata_class - a custom metadata class used in delclarative models.
• metadata_options - custom options to use in metadata creation such as specifying naming conventions.
• engine_options - arguments for sqlalchemy create_engine
• session_options - arguments for sqlalchemy sessionmaker

Other options are ignored.

django_sorcery.db.url.string(x)

django_sorcery.db.url.string_list(x)