From aa5d090194e7c92835811727f9b38add4486dbcc Mon Sep 17 00:00:00 2001 From: Waket Zheng Date: Fri, 2 Jun 2023 00:01:30 +0800 Subject: [PATCH] docs: remove duplicates --- tortoise/contrib/fastapi/__init__.py | 57 ++-------------------------- 1 file changed, 3 insertions(+), 54 deletions(-) diff --git a/tortoise/contrib/fastapi/__init__.py b/tortoise/contrib/fastapi/__init__.py index 817faa10e..fdac50c1e 100644 --- a/tortoise/contrib/fastapi/__init__.py +++ b/tortoise/contrib/fastapi/__init__.py @@ -155,60 +155,9 @@ def register_tortoise( Parameters ---------- - app: - FastAPI app. - config: - Dict containing config: - - Example - ------- - - .. code-block:: python3 - - { - 'connections': { - # Dict format for connection - 'default': { - 'engine': 'tortoise.backends.asyncpg', - 'credentials': { - 'host': 'localhost', - 'port': '5432', - 'user': 'tortoise', - 'password': 'qwerty123', - 'database': 'test', - } - }, - # Using a DB_URL string - 'default': 'postgres://postgres:qwerty123@localhost:5432/events' - }, - 'apps': { - 'models': { - 'models': ['__main__'], - # If no default_connection specified, defaults to 'default' - 'default_connection': 'default', - } - } - } - - config_file: - Path to .json or .yml (if PyYAML installed) file containing config with - same format as above. - db_url: - Use a DB_URL string. See :ref:`db_url` - modules: - Dictionary of ``key``: [``list_of_modules``] that defined "apps" and modules that - should be discovered for models. - generate_schemas: - True to generate schema immediately. Only useful for dev environments - or SQLite ``:memory:`` databases - add_exception_handlers: - True to add some automatic exception handlers for ``DoesNotExist`` & ``IntegrityError``. - This is not recommended for production systems as it may leak data. - - Raises - ------ - ConfigurationError - For any configuration error + See ``tortoise.contrib.fastapi.RegisterTortoise`` + + > Note: it's recommended to use ``RegisterTortoise`` in lifespan instead of this function for ``fastapi>=0.93.0`` """ orm = RegisterTortoise(app, config, config_file, db_url, modules, generate_schemas)