sqlalchemy.engine.mock

def create_mock_engine(url, executor, **kw):

Create a "mock" engine used for echoing DDL.

This is a utility function used for debugging or storing the output of DDL sequences as generated by _schema.MetaData.create_all and related methods.

The function accepts a URL which is used only to determine the kind of dialect to be used, as well as an "executor" callable function which will receive a SQL expression object and parameters, which can then be echoed or otherwise printed. The executor's return value is not handled, nor does the engine allow regular string statements to be invoked, and is therefore only useful for DDL that is sent to the database without receiving any results.

E.g.:

from sqlalchemy import create_mock_engine

def dump(sql, *multiparams, **params):
    print(sql.compile(dialect=engine.dialect))

engine = create_mock_engine('postgresql://', dump)
metadata.create_all(engine, checkfirst=False)

New in version 1.4: - the .create_mock_engine function replaces the previous "mock" engine strategy used with _sa.create_engine.

See Also

:ref:`faq_ddl_as_string`

Parameters
url	A string URL which typically needs to contain only the database backend name.
executor	a callable which receives the arguments `sql`, `multiparams` and `*params`. The `sql` parameter is typically an instance of `.DDLElement`, which can then be compiled into a string using `.DDLElement.compile`.
**kw	Undocumented

Class	`MockConnection`	Undocumented
Function	`create_mock_engine`	Create a "mock" engine used for echoing DDL.