Debian Codegraph @

docs/modules/jobstores/sqlalchemy.rst

raw
1 :mod:`apscheduler.jobstores.sqlalchemy`
2 =======================================
3
4 .. automodule:: apscheduler.jobstores.sqlalchemy
5
6 API
7 ---
8
9 .. autoclass:: SQLAlchemyJobStore(url=None, engine=None, tablename='apscheduler_jobs', metadata=None, pickle_protocol=pickle.HIGHEST_PROTOCOL)
10 :show-inheritance:
11
12
13 Introduction
14 ------------
15
16 SQLAlchemyJobStore stores jobs in any relational database management system supported by
17 `SQLAlchemy <http://www.sqlalchemy.org/>`_. It can use either a preconfigured
18 `Engine <http://docs.sqlalchemy.org/en/latest/core/connections.html#sqlalchemy.engine.Engine>`_ or you can pass it a
19 connection URL.
20
21 .. list-table::
22 :widths: 1 4
23
24 * - External dependencies
25 - `SQLAlchemy <https://pypi.python.org/pypi/SQLAlchemy/>`_ (+ the backend specific driver package)
26 * - Example
27 - ``examples/jobstores/sqlalchemy_.py``
28 (`view online <https://github.com/agronholm/apscheduler/tree/3.x/examples/jobstores/sqlalchemy_.py>`_).