Automated deployment: Tue Jan 4 15:02:19 UTC 2022 d937c4e05be5cfed474d15ea23166e0116dab17a

This commit is contained in:
frankie567
2022-01-04 15:02:19 +00:00
parent afe31623a6
commit 13ff308539
12 changed files with 306 additions and 231 deletions

View File

@ -557,19 +557,21 @@
<div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio"><input id="__tabbed_1_2" name="__tabbed_1" type="radio"><input id="__tabbed_1_3" name="__tabbed_1" type="radio"><div class="tabbed-labels"><label for="__tabbed_1_1">SQLAlchemy</label><label for="__tabbed_1_2">Tortoise ORM</label><label for="__tabbed_1_3">MongoDB</label></div> <div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio"><input id="__tabbed_1_2" name="__tabbed_1" type="radio"><input id="__tabbed_1_3" name="__tabbed_1" type="radio"><div class="tabbed-labels"><label for="__tabbed_1_1">SQLAlchemy</label><label for="__tabbed_1_2">Tortoise ORM</label><label for="__tabbed_1_3">MongoDB</label></div>
<div class="tabbed-content"> <div class="tabbed-content">
<div class="tabbed-block"> <div class="tabbed-block">
<div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">databases</span> <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">AsyncGenerator</span>
<span class="kn">import</span> <span class="nn">sqlalchemy</span>
<span class="kn">from</span> <span class="nn">fastapi</span> <span class="kn">import</span> <span class="n">Depends</span>
<span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span> <span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span>
<span class="hll"><span class="kn">from</span> <span class="nn">fastapi_users_db_sqlalchemy.access_token</span> <span class="kn">import</span> <span class="p">(</span> <span class="hll"><span class="kn">from</span> <span class="nn">fastapi_users_db_sqlalchemy.access_token</span> <span class="kn">import</span> <span class="p">(</span>
</span><span class="hll"> <span class="n">SQLAlchemyAccessTokenDatabase</span><span class="p">,</span> </span><span class="hll"> <span class="n">SQLAlchemyAccessTokenDatabase</span><span class="p">,</span>
</span><span class="hll"> <span class="n">SQLAlchemyBaseAccessTokenTable</span><span class="p">,</span> </span><span class="hll"> <span class="n">SQLAlchemyBaseAccessTokenTable</span><span class="p">,</span>
</span><span class="hll"><span class="p">)</span> </span><span class="hll"><span class="p">)</span>
</span><span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span> </span><span class="kn">from</span> <span class="nn">sqlalchemy.ext.asyncio</span> <span class="kn">import</span> <span class="n">AsyncSession</span><span class="p">,</span> <span class="n">create_async_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">sessionmaker</span>
<span class="hll"><span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">AccessToken</span><span class="p">,</span> <span class="n">UserDB</span> <span class="hll"><span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">AccessToken</span><span class="p">,</span> <span class="n">UserDB</span>
</span> </span>
<span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite:///./test.db"</span> <span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite+aiosqlite:///./test.db"</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">databases</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">)</span>
<span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span> <span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>
@ -581,21 +583,26 @@
</span><span class="hll"> <span class="k">pass</span> </span><span class="hll"> <span class="k">pass</span>
</span> </span>
<span class="n">engine</span> <span class="o">=</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">create_engine</span><span class="p">(</span> <span class="n">engine</span> <span class="o">=</span> <span class="n">create_async_engine</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">})</span>
<span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span> <span class="n">async_session_maker</span> <span class="o">=</span> <span class="n">sessionmaker</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">class_</span><span class="o">=</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="n">expire_on_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
<span class="n">users</span> <span class="o">=</span> <span class="n">UserTable</span><span class="o">.</span><span class="n">__table__</span>
<span class="hll"><span class="n">access_tokens</span> <span class="o">=</span> <span class="n">AccessTokenTable</span><span class="o">.</span><span class="n">__table__</span>
</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">():</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">users</span><span class="p">)</span>
<span class="hll"><span class="k">async</span> <span class="k">def</span> <span class="nf">get_access_token_db</span><span class="p">():</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">create_db_and_tables</span><span class="p">():</span>
</span><span class="hll"> <span class="k">yield</span> <span class="n">SQLAlchemyAccessTokenDatabase</span><span class="p">(</span><span class="n">AccessToken</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">access_tokens</span><span class="p">)</span> <span class="k">async</span> <span class="k">with</span> <span class="n">engine</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<span class="k">await</span> <span class="n">conn</span><span class="o">.</span><span class="n">run_sync</span><span class="p">(</span><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">)</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_async_session</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">AsyncGenerator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
<span class="k">async</span> <span class="k">with</span> <span class="n">async_session_maker</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">session</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">UserTable</span><span class="p">)</span>
<span class="hll"><span class="k">async</span> <span class="k">def</span> <span class="nf">get_access_token_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
</span><span class="hll"> <span class="k">yield</span> <span class="n">SQLAlchemyAccessTokenDatabase</span><span class="p">(</span><span class="n">AccessToken</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">AccessTokenTable</span><span class="p">)</span>
</span></code></pre></div> </span></code></pre></div>
</div> </div>
<div class="tabbed-block"> <div class="tabbed-block">

View File

@ -188,8 +188,8 @@
</label> </label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix=""> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item"> <li class="md-nav__item">
<a class="md-nav__link" href="#installation"> <a class="md-nav__link" href="#asynchronous-driver">
Installation Asynchronous driver
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@ -198,8 +198,8 @@
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a class="md-nav__link" href="#create-the-tables"> <a class="md-nav__link" href="#implement-a-function-to-create-the-tables">
Create the tables Implement a function to create the tables
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@ -207,11 +207,6 @@
Create the database adapter dependency Create the database adapter dependency
</a> </a>
</li> </li>
<li class="md-nav__item">
<a class="md-nav__link" href="#what-about-sqlalchemy-orm">
What about SQLAlchemy ORM?
</a>
</li>
</ul> </ul>
</nav> </nav>
</li> </li>
@ -496,8 +491,8 @@
</label> </label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix=""> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item"> <li class="md-nav__item">
<a class="md-nav__link" href="#installation"> <a class="md-nav__link" href="#asynchronous-driver">
Installation Asynchronous driver
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@ -506,8 +501,8 @@
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a class="md-nav__link" href="#create-the-tables"> <a class="md-nav__link" href="#implement-a-function-to-create-the-tables">
Create the tables Implement a function to create the tables
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@ -515,11 +510,6 @@
Create the database adapter dependency Create the database adapter dependency
</a> </a>
</li> </li>
<li class="md-nav__item">
<a class="md-nav__link" href="#what-about-sqlalchemy-orm">
What about SQLAlchemy ORM?
</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>
@ -528,27 +518,31 @@
<div class="md-content" data-md-component="content"> <div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset"> <article class="md-content__inner md-typeset">
<h1 id="sqlalchemy">SQLAlchemy<a class="headerlink" href="#sqlalchemy" title="Permanent link"></a></h1> <h1 id="sqlalchemy">SQLAlchemy<a class="headerlink" href="#sqlalchemy" title="Permanent link"></a></h1>
<p><strong>FastAPI Users</strong> provides the necessary tools to work with SQL databases thanks to <a href="https://docs.sqlalchemy.org/en/13/core/">SQLAlchemy Core</a> and <a href="https://www.encode.io/databases/">encode/databases</a> package for full async support.</p> <p><strong>FastAPI Users</strong> provides the necessary tools to work with SQL databases thanks to <a href="https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html">SQLAlchemy ORM with asyncio</a>.</p>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link"></a></h2> <div class="admonition warning">
<p>Install the database driver that corresponds to your DBMS:</p> <p class="admonition-title">Warning</p>
<div class="highlight"><pre><span></span><code>pip install <span class="s1">'databases[postgresql]'</span> <p>The previous adapter using <code>encode/databases</code> is now deprecated but can still be installed using <code>fastapi-users[sqlalchemy]</code>.</p>
</code></pre></div> </div>
<div class="highlight"><pre><span></span><code>pip install <span class="s1">'databases[mysql]'</span> <h2 id="asynchronous-driver">Asynchronous driver<a class="headerlink" href="#asynchronous-driver" title="Permanent link"></a></h2>
</code></pre></div> <p>To work with your DBMS, you'll need to install the corresponding asyncio driver. The common choices are:</p>
<div class="highlight"><pre><span></span><code>pip install <span class="s1">'databases[sqlite]'</span> <ul>
</code></pre></div> <li>For PostgreSQL: <code>pip install asyncpg</code></li>
<li>For SQLite: <code>pip install aiosqlite</code></li>
</ul>
<p>For the sake of this tutorial from now on, we'll use a simple SQLite databse.</p> <p>For the sake of this tutorial from now on, we'll use a simple SQLite databse.</p>
<h2 id="setup-user-table">Setup User table<a class="headerlink" href="#setup-user-table" title="Permanent link"></a></h2> <h2 id="setup-user-table">Setup User table<a class="headerlink" href="#setup-user-table" title="Permanent link"></a></h2>
<p>Let's declare our SQLAlchemy <code>User</code> table.</p> <p>Let's declare our SQLAlchemy <code>User</code> table.</p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">databases</span> <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">AsyncGenerator</span>
<span class="kn">import</span> <span class="nn">sqlalchemy</span>
<span class="kn">from</span> <span class="nn">fastapi</span> <span class="kn">import</span> <span class="n">Depends</span>
<span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span> <span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.asyncio</span> <span class="kn">import</span> <span class="n">AsyncSession</span><span class="p">,</span> <span class="n">create_async_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span> <span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">sessionmaker</span>
<span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span> <span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span>
<span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite:///./test.db"</span> <span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite+aiosqlite:///./test.db"</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">databases</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">)</span>
<span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span> <span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>
@ -556,29 +550,37 @@
</span><span class="hll"> <span class="k">pass</span> </span><span class="hll"> <span class="k">pass</span>
</span> </span>
<span class="n">engine</span> <span class="o">=</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">create_engine</span><span class="p">(</span> <span class="n">engine</span> <span class="o">=</span> <span class="n">create_async_engine</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">})</span>
<span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span> <span class="n">async_session_maker</span> <span class="o">=</span> <span class="n">sessionmaker</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">class_</span><span class="o">=</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="n">expire_on_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
<span class="n">users</span> <span class="o">=</span> <span class="n">UserTable</span><span class="o">.</span><span class="n">__table__</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">():</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">create_db_and_tables</span><span class="p">():</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">users</span><span class="p">)</span> <span class="k">async</span> <span class="k">with</span> <span class="n">engine</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<span class="k">await</span> <span class="n">conn</span><span class="o">.</span><span class="n">run_sync</span><span class="p">(</span><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">)</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_async_session</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">AsyncGenerator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
<span class="k">async</span> <span class="k">with</span> <span class="n">async_session_maker</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">session</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">UserTable</span><span class="p">)</span>
</code></pre></div> </code></pre></div>
<p>As you can see, <strong>FastAPI Users</strong> provides a mixin that will include base fields for our <code>User</code> table. You can of course add you own fields there to fit to your needs!</p> <p>As you can see, <strong>FastAPI Users</strong> provides a mixin that will include base fields for our <code>User</code> table. You can of course add you own fields there to fit to your needs!</p>
<h2 id="create-the-tables">Create the tables<a class="headerlink" href="#create-the-tables" title="Permanent link"></a></h2> <h2 id="implement-a-function-to-create-the-tables">Implement a function to create the tables<a class="headerlink" href="#implement-a-function-to-create-the-tables" title="Permanent link"></a></h2>
<p>We'll now create an SQLAlchemy engine and ask it to create all the defined tables.</p> <p>We'll now create an utility function to create all the defined tables.</p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">databases</span> <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">AsyncGenerator</span>
<span class="kn">import</span> <span class="nn">sqlalchemy</span>
<span class="kn">from</span> <span class="nn">fastapi</span> <span class="kn">import</span> <span class="n">Depends</span>
<span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span> <span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.asyncio</span> <span class="kn">import</span> <span class="n">AsyncSession</span><span class="p">,</span> <span class="n">create_async_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span> <span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">sessionmaker</span>
<span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span> <span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span>
<span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite:///./test.db"</span> <span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite+aiosqlite:///./test.db"</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">databases</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">)</span>
<span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span> <span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>
@ -586,32 +588,41 @@
<span class="k">pass</span> <span class="k">pass</span>
<span class="hll"><span class="n">engine</span> <span class="o">=</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">create_engine</span><span class="p">(</span> <span class="n">engine</span> <span class="o">=</span> <span class="n">create_async_engine</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">})</span>
</span><span class="hll"> <span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span> <span class="n">async_session_maker</span> <span class="o">=</span> <span class="n">sessionmaker</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">class_</span><span class="o">=</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="n">expire_on_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span><span class="hll"><span class="p">)</span>
</span><span class="hll"><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
<span class="hll"><span class="k">async</span> <span class="k">def</span> <span class="nf">create_db_and_tables</span><span class="p">():</span>
</span><span class="hll"> <span class="k">async</span> <span class="k">with</span> <span class="n">engine</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
</span><span class="hll"> <span class="k">await</span> <span class="n">conn</span><span class="o">.</span><span class="n">run_sync</span><span class="p">(</span><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">)</span>
</span> </span>
<span class="n">users</span> <span class="o">=</span> <span class="n">UserTable</span><span class="o">.</span><span class="n">__table__</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_async_session</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">AsyncGenerator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
<span class="k">async</span> <span class="k">with</span> <span class="n">async_session_maker</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">session</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">():</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">users</span><span class="p">)</span> <span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">UserTable</span><span class="p">)</span>
</code></pre></div> </code></pre></div>
<p>This function can be called, for example, during the initialization of your FastAPI app.</p>
<div class="admonition warning"> <div class="admonition warning">
<p class="admonition-title">Warning</p> <p class="admonition-title">Warning</p>
<p>In production, it's strongly recommended to setup a migration system to update your SQL schemas. See <a href="https://alembic.sqlalchemy.org/en/latest/">Alembic</a>.</p> <p>In production, it's strongly recommended to setup a migration system to update your SQL schemas. See <a href="https://alembic.sqlalchemy.org/en/latest/">Alembic</a>.</p>
</div> </div>
<h2 id="create-the-database-adapter-dependency">Create the database adapter dependency<a class="headerlink" href="#create-the-database-adapter-dependency" title="Permanent link"></a></h2> <h2 id="create-the-database-adapter-dependency">Create the database adapter dependency<a class="headerlink" href="#create-the-database-adapter-dependency" title="Permanent link"></a></h2>
<p>The database adapter of <strong>FastAPI Users</strong> makes the link between your database configuration and the users logic. It should be generated by a FastAPI dependency.</p> <p>The database adapter of <strong>FastAPI Users</strong> makes the link between your database configuration and the users logic. It should be generated by a FastAPI dependency.</p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">databases</span> <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">AsyncGenerator</span>
<span class="kn">import</span> <span class="nn">sqlalchemy</span>
<span class="kn">from</span> <span class="nn">fastapi</span> <span class="kn">import</span> <span class="n">Depends</span>
<span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span> <span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.asyncio</span> <span class="kn">import</span> <span class="n">AsyncSession</span><span class="p">,</span> <span class="n">create_async_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span> <span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">sessionmaker</span>
<span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span> <span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span>
<span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite:///./test.db"</span> <span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite+aiosqlite:///./test.db"</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">databases</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">)</span>
<span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span> <span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>
@ -619,25 +630,30 @@
<span class="k">pass</span> <span class="k">pass</span>
<span class="n">engine</span> <span class="o">=</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">create_engine</span><span class="p">(</span> <span class="n">engine</span> <span class="o">=</span> <span class="n">create_async_engine</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">})</span>
<span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span> <span class="n">async_session_maker</span> <span class="o">=</span> <span class="n">sessionmaker</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">class_</span><span class="o">=</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="n">expire_on_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
<span class="n">users</span> <span class="o">=</span> <span class="n">UserTable</span><span class="o">.</span><span class="n">__table__</span>
<span class="hll"><span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">():</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">create_db_and_tables</span><span class="p">():</span>
</span><span class="hll"> <span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">users</span><span class="p">)</span> <span class="k">async</span> <span class="k">with</span> <span class="n">engine</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<span class="k">await</span> <span class="n">conn</span><span class="o">.</span><span class="n">run_sync</span><span class="p">(</span><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">)</span>
<span class="hll"><span class="k">async</span> <span class="k">def</span> <span class="nf">get_async_session</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">AsyncGenerator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
</span><span class="hll"> <span class="k">async</span> <span class="k">with</span> <span class="n">async_session_maker</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
</span><span class="hll"> <span class="k">yield</span> <span class="n">session</span>
</span><span class="hll">
</span><span class="hll">
</span><span class="hll"><span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
</span><span class="hll"> <span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">UserTable</span><span class="p">)</span>
</span></code></pre></div> </span></code></pre></div>
<p>Notice that we pass it three things:</p> <p>Notice that we define first a <code>get_async_session</code> dependency returning us a fresh SQLAlchemy session to interact with the database.</p>
<p>It's then used inside the <code>get_user_db</code> dependency to generate our adapter. Notice that we pass it three things:</p>
<ul> <ul>
<li>A reference to your <a href="../../models/"><code>UserDB</code> model</a>.</li> <li>A reference to your <a href="../../models/"><code>UserDB</code> model</a>.</li>
<li>A <code>database</code> instance, which allows us to do asynchronous request to the database.</li> <li>The <code>session</code> instance we just injected.</li>
<li>The <code>users</code> variable, which is the actual SQLAlchemy table behind the table class.</li> <li>The <code>UserTable</code> variable, which is the actual SQLAlchemy model.</li>
</ul> </ul>
<h2 id="what-about-sqlalchemy-orm">What about SQLAlchemy ORM?<a class="headerlink" href="#what-about-sqlalchemy-orm" title="Permanent link"></a></h2>
<p>The primary objective was to use pure async approach as much as possible. However, we understand that ORM is convenient and useful for many developers. If this feature becomes very demanded, we will add a database adapter for SQLAlchemy ORM.</p>
</article> </article>
</div> </div>
</div> </div>

View File

@ -583,15 +583,17 @@ uvicorn[standard]
</code></pre></div> </code></pre></div>
</div> </div>
<div class="tabbed-block"> <div class="tabbed-block">
<div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">databases</span> <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">AsyncGenerator</span>
<span class="kn">import</span> <span class="nn">sqlalchemy</span>
<span class="kn">from</span> <span class="nn">fastapi</span> <span class="kn">import</span> <span class="n">Depends</span>
<span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span> <span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.asyncio</span> <span class="kn">import</span> <span class="n">AsyncSession</span><span class="p">,</span> <span class="n">create_async_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span> <span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">sessionmaker</span>
<span class="kn">from</span> <span class="nn">app.models</span> <span class="kn">import</span> <span class="n">UserDB</span> <span class="kn">from</span> <span class="nn">app.models</span> <span class="kn">import</span> <span class="n">UserDB</span>
<span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite:///./test.db"</span> <span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite+aiosqlite:///./test.db"</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">databases</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">)</span>
<span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span> <span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>
@ -599,16 +601,22 @@ uvicorn[standard]
<span class="k">pass</span> <span class="k">pass</span>
<span class="n">engine</span> <span class="o">=</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">create_engine</span><span class="p">(</span> <span class="n">engine</span> <span class="o">=</span> <span class="n">create_async_engine</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">})</span>
<span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span> <span class="n">async_session_maker</span> <span class="o">=</span> <span class="n">sessionmaker</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">class_</span><span class="o">=</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="n">expire_on_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
<span class="n">users</span> <span class="o">=</span> <span class="n">UserTable</span><span class="o">.</span><span class="n">__table__</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">():</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">create_db_and_tables</span><span class="p">():</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">users</span><span class="p">)</span> <span class="k">async</span> <span class="k">with</span> <span class="n">engine</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<span class="k">await</span> <span class="n">conn</span><span class="o">.</span><span class="n">run_sync</span><span class="p">(</span><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">)</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_async_session</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">AsyncGenerator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
<span class="k">async</span> <span class="k">with</span> <span class="n">async_session_maker</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">session</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">UserTable</span><span class="p">)</span>
</code></pre></div> </code></pre></div>
</div> </div>
<div class="tabbed-block"> <div class="tabbed-block">

View File

@ -635,7 +635,7 @@
<p>FastAPI Users provides an optional OAuth2 authentication support. It relies on <a href="https://frankie567.github.io/httpx-oauth/">HTTPX OAuth library</a>, which is a pure-async implementation of OAuth2.</p> <p>FastAPI Users provides an optional OAuth2 authentication support. It relies on <a href="https://frankie567.github.io/httpx-oauth/">HTTPX OAuth library</a>, which is a pure-async implementation of OAuth2.</p>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link"></a></h2> <h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link"></a></h2>
<p>You should install the library with the optional dependencies for OAuth:</p> <p>You should install the library with the optional dependencies for OAuth:</p>
<div class="highlight"><pre><span></span><code>pip install <span class="s1">'fastapi-users[sqlalchemy,oauth]'</span> <div class="highlight"><pre><span></span><code>pip install <span class="s1">'fastapi-users[sqlalchemy2,oauth]'</span>
</code></pre></div> </code></pre></div>
<div class="highlight"><pre><span></span><code>pip install <span class="s1">'fastapi-users[mongodb,oauth]'</span> <div class="highlight"><pre><span></span><code>pip install <span class="s1">'fastapi-users[mongodb,oauth]'</span>
</code></pre></div> </code></pre></div>
@ -680,79 +680,94 @@
</ul> </ul>
<h3 id="setup-the-database-adapter">Setup the database adapter<a class="headerlink" href="#setup-the-database-adapter" title="Permanent link"></a></h3> <h3 id="setup-the-database-adapter">Setup the database adapter<a class="headerlink" href="#setup-the-database-adapter" title="Permanent link"></a></h3>
<h4 id="sqlalchemy">SQLAlchemy<a class="headerlink" href="#sqlalchemy" title="Permanent link"></a></h4> <h4 id="sqlalchemy">SQLAlchemy<a class="headerlink" href="#sqlalchemy" title="Permanent link"></a></h4>
<p>You'll need to define the table for storing the OAuth account model. We provide a base one for this:</p> <p>You'll need to define the SQLAlchemy model for storing OAuth accounts. We provide a base one for this:</p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">databases</span> <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">AsyncGenerator</span>
<span class="kn">import</span> <span class="nn">sqlalchemy</span>
<span class="kn">from</span> <span class="nn">fastapi</span> <span class="kn">import</span> <span class="n">Depends</span>
<span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="p">(</span> <span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span>
<span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span>
<span class="n">SQLAlchemyUserDatabase</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">,</span>
<span class="p">)</span> <span class="p">)</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.asyncio</span> <span class="kn">import</span> <span class="n">AsyncSession</span><span class="p">,</span> <span class="n">create_async_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span> <span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">relationship</span><span class="p">,</span> <span class="n">sessionmaker</span>
<span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span> <span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span>
<span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite:///./test.db"</span> <span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite+aiosqlite:///./test.db"</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">databases</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">)</span>
<span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span> <span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">UserTable</span><span class="p">(</span><span class="n">Base</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">):</span> <span class="hll"><span class="k">class</span> <span class="nc">UserTable</span><span class="p">(</span><span class="n">Base</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">):</span>
<span class="k">pass</span> </span><span class="hll"> <span class="n">oauth_accounts</span> <span class="o">=</span> <span class="n">relationship</span><span class="p">(</span><span class="s2">"OAuthAccount"</span><span class="p">)</span>
</span><span class="hll">
</span><span class="hll">
<span class="hll"><span class="k">class</span> <span class="nc">OAuthAccount</span><span class="p">(</span><span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">Base</span><span class="p">):</span> </span><span class="hll"><span class="k">class</span> <span class="nc">OAuthAccountTable</span><span class="p">(</span><span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">Base</span><span class="p">):</span>
</span><span class="hll"> <span class="k">pass</span> </span><span class="hll"> <span class="k">pass</span>
</span> </span>
<span class="n">engine</span> <span class="o">=</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">create_engine</span><span class="p">(</span> <span class="n">engine</span> <span class="o">=</span> <span class="n">create_async_engine</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">})</span>
<span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span> <span class="n">async_session_maker</span> <span class="o">=</span> <span class="n">sessionmaker</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">class_</span><span class="o">=</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="n">expire_on_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
<span class="n">users</span> <span class="o">=</span> <span class="n">UserTable</span><span class="o">.</span><span class="n">__table__</span>
<span class="n">oauth_accounts</span> <span class="o">=</span> <span class="n">OAuthAccount</span><span class="o">.</span><span class="n">__table__</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">():</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">create_db_and_tables</span><span class="p">():</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">users</span><span class="p">,</span> <span class="n">oauth_accounts</span><span class="p">)</span> <span class="k">async</span> <span class="k">with</span> <span class="n">engine</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<span class="k">await</span> <span class="n">conn</span><span class="o">.</span><span class="n">run_sync</span><span class="p">(</span><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">)</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_async_session</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">AsyncGenerator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
<span class="k">async</span> <span class="k">with</span> <span class="n">async_session_maker</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">session</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">UserTable</span><span class="p">,</span> <span class="n">OAuthAccountTable</span><span class="p">)</span>
</code></pre></div> </code></pre></div>
<p>When instantiating the database adapter, you should pass this table in argument::</p> <p>Notice that we also manually added a <code>relationship</code> on the <code>UserTable</code> so that SQLAlchemy can properly retrieve the OAuth accounts of the user.</p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">databases</span> <p>When instantiating the database adapter, you should pass this SQLAlchemy model:</p>
<span class="kn">import</span> <span class="nn">sqlalchemy</span> <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">AsyncGenerator</span>
<span class="kn">from</span> <span class="nn">fastapi</span> <span class="kn">import</span> <span class="n">Depends</span>
<span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="p">(</span> <span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span>
<span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span>
<span class="n">SQLAlchemyUserDatabase</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">,</span>
<span class="p">)</span> <span class="p">)</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.asyncio</span> <span class="kn">import</span> <span class="n">AsyncSession</span><span class="p">,</span> <span class="n">create_async_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span> <span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">relationship</span><span class="p">,</span> <span class="n">sessionmaker</span>
<span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span> <span class="kn">from</span> <span class="nn">.models</span> <span class="kn">import</span> <span class="n">UserDB</span>
<span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite:///./test.db"</span> <span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite+aiosqlite:///./test.db"</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">databases</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">)</span>
<span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span> <span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">UserTable</span><span class="p">(</span><span class="n">Base</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">):</span> <span class="k">class</span> <span class="nc">UserTable</span><span class="p">(</span><span class="n">Base</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">):</span>
<span class="n">oauth_accounts</span> <span class="o">=</span> <span class="n">relationship</span><span class="p">(</span><span class="s2">"OAuthAccount"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">OAuthAccountTable</span><span class="p">(</span><span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">Base</span><span class="p">):</span>
<span class="k">pass</span> <span class="k">pass</span>
<span class="k">class</span> <span class="nc">OAuthAccount</span><span class="p">(</span><span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">Base</span><span class="p">):</span> <span class="n">engine</span> <span class="o">=</span> <span class="n">create_async_engine</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">})</span>
<span class="k">pass</span> <span class="n">async_session_maker</span> <span class="o">=</span> <span class="n">sessionmaker</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">class_</span><span class="o">=</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="n">expire_on_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">engine</span> <span class="o">=</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">create_engine</span><span class="p">(</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">create_db_and_tables</span><span class="p">():</span>
<span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span> <span class="k">async</span> <span class="k">with</span> <span class="n">engine</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<span class="p">)</span> <span class="k">await</span> <span class="n">conn</span><span class="o">.</span><span class="n">run_sync</span><span class="p">(</span><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">)</span>
<span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
<span class="n">users</span> <span class="o">=</span> <span class="n">UserTable</span><span class="o">.</span><span class="n">__table__</span>
<span class="hll"><span class="n">oauth_accounts</span> <span class="o">=</span> <span class="n">OAuthAccount</span><span class="o">.</span><span class="n">__table__</span>
</span>
<span class="hll"><span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">():</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">get_async_session</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">AsyncGenerator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
</span><span class="hll"> <span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">users</span><span class="p">,</span> <span class="n">oauth_accounts</span><span class="p">)</span> <span class="k">async</span> <span class="k">with</span> <span class="n">async_session_maker</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">session</span>
<span class="hll"><span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
</span><span class="hll"> <span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">UserTable</span><span class="p">,</span> <span class="n">OAuthAccountTable</span><span class="p">)</span>
</span></code></pre></div> </span></code></pre></div>
<h4 id="mongodb">MongoDB<a class="headerlink" href="#mongodb" title="Permanent link"></a></h4> <h4 id="mongodb">MongoDB<a class="headerlink" href="#mongodb" title="Permanent link"></a></h4>
<p>Nothing to do, the <a href="../databases/mongodb/">basic configuration</a> is enough.</p> <p>Nothing to do, the <a href="../databases/mongodb/">basic configuration</a> is enough.</p>
@ -887,41 +902,48 @@ uvicorn[standard]
</code></pre></div> </code></pre></div>
</div> </div>
<div class="tabbed-block"> <div class="tabbed-block">
<div class="highlight"><pre><span></span><code><span class="kn">import</span> <span class="nn">databases</span> <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">AsyncGenerator</span>
<span class="kn">import</span> <span class="nn">sqlalchemy</span>
<span class="kn">from</span> <span class="nn">fastapi</span> <span class="kn">import</span> <span class="n">Depends</span>
<span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="p">(</span> <span class="kn">from</span> <span class="nn">fastapi_users.db</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span>
<span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">,</span>
<span class="n">SQLAlchemyUserDatabase</span><span class="p">,</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">,</span>
<span class="p">)</span> <span class="p">)</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.asyncio</span> <span class="kn">import</span> <span class="n">AsyncSession</span><span class="p">,</span> <span class="n">create_async_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span> <span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">DeclarativeMeta</span><span class="p">,</span> <span class="n">declarative_base</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">relationship</span><span class="p">,</span> <span class="n">sessionmaker</span>
<span class="kn">from</span> <span class="nn">app.models</span> <span class="kn">import</span> <span class="n">UserDB</span> <span class="kn">from</span> <span class="nn">app.models</span> <span class="kn">import</span> <span class="n">UserDB</span>
<span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite:///./test.db"</span> <span class="n">DATABASE_URL</span> <span class="o">=</span> <span class="s2">"sqlite+aiosqlite:///./test.db"</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">databases</span><span class="o">.</span><span class="n">Database</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">)</span>
<span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span> <span class="n">Base</span><span class="p">:</span> <span class="n">DeclarativeMeta</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">UserTable</span><span class="p">(</span><span class="n">Base</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">):</span> <span class="k">class</span> <span class="nc">UserTable</span><span class="p">(</span><span class="n">Base</span><span class="p">,</span> <span class="n">SQLAlchemyBaseUserTable</span><span class="p">):</span>
<span class="n">oauth_accounts</span> <span class="o">=</span> <span class="n">relationship</span><span class="p">(</span><span class="s2">"OAuthAccount"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">OAuthAccountTable</span><span class="p">(</span><span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">Base</span><span class="p">):</span>
<span class="k">pass</span> <span class="k">pass</span>
<span class="k">class</span> <span class="nc">OAuthAccount</span><span class="p">(</span><span class="n">SQLAlchemyBaseOAuthAccountTable</span><span class="p">,</span> <span class="n">Base</span><span class="p">):</span> <span class="n">engine</span> <span class="o">=</span> <span class="n">create_async_engine</span><span class="p">(</span><span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">})</span>
<span class="k">pass</span> <span class="n">async_session_maker</span> <span class="o">=</span> <span class="n">sessionmaker</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">class_</span><span class="o">=</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="n">expire_on_commit</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">engine</span> <span class="o">=</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">create_engine</span><span class="p">(</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">create_db_and_tables</span><span class="p">():</span>
<span class="n">DATABASE_URL</span><span class="p">,</span> <span class="n">connect_args</span><span class="o">=</span><span class="p">{</span><span class="s2">"check_same_thread"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span> <span class="k">async</span> <span class="k">with</span> <span class="n">engine</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
<span class="p">)</span> <span class="k">await</span> <span class="n">conn</span><span class="o">.</span><span class="n">run_sync</span><span class="p">(</span><span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">)</span>
<span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
<span class="n">users</span> <span class="o">=</span> <span class="n">UserTable</span><span class="o">.</span><span class="n">__table__</span>
<span class="n">oauth_accounts</span> <span class="o">=</span> <span class="n">OAuthAccount</span><span class="o">.</span><span class="n">__table__</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">():</span> <span class="k">async</span> <span class="k">def</span> <span class="nf">get_async_session</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">AsyncGenerator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">users</span><span class="p">,</span> <span class="n">oauth_accounts</span><span class="p">)</span> <span class="k">async</span> <span class="k">with</span> <span class="n">async_session_maker</span><span class="p">()</span> <span class="k">as</span> <span class="n">session</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">session</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">get_user_db</span><span class="p">(</span><span class="n">session</span><span class="p">:</span> <span class="n">AsyncSession</span> <span class="o">=</span> <span class="n">Depends</span><span class="p">(</span><span class="n">get_async_session</span><span class="p">)):</span>
<span class="k">yield</span> <span class="n">SQLAlchemyUserDatabase</span><span class="p">(</span><span class="n">UserDB</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">UserTable</span><span class="p">,</span> <span class="n">OAuthAccountTable</span><span class="p">)</span>
</code></pre></div> </code></pre></div>
</div> </div>
<div class="tabbed-block"> <div class="tabbed-block">

View File

@ -687,7 +687,7 @@
<td align="center"><a href="https://github.com/jnu"><img alt="" src="https://avatars.githubusercontent.com/u/1069899?v=4?s=100" width="100px;"/><br/><sub><b>Joe Nudell</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Ajnu" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/jnu"><img alt="" src="https://avatars.githubusercontent.com/u/1069899?v=4?s=100" width="100px;"/><br/><sub><b>Joe Nudell</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Ajnu" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/cosmosquark"><img alt="" src="https://avatars.githubusercontent.com/u/1540682?v=4?s=100" width="100px;"/><br/><sub><b>Ben</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=cosmosquark" title="Code">💻</a></td> <td align="center"><a href="https://github.com/cosmosquark"><img alt="" src="https://avatars.githubusercontent.com/u/1540682?v=4?s=100" width="100px;"/><br/><sub><b>Ben</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=cosmosquark" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/BoYanZh"><img alt="" src="https://avatars.githubusercontent.com/u/32470225?v=4?s=100" width="100px;"/><br/><sub><b>BoYanZh</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=BoYanZh" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/BoYanZh"><img alt="" src="https://avatars.githubusercontent.com/u/32470225?v=4?s=100" width="100px;"/><br/><sub><b>BoYanZh</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=BoYanZh" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/davidbrochart"><img alt="" src="https://avatars.githubusercontent.com/u/4711805?v=4?s=100" width="100px;"/><br/><sub><b>David Brochart</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=davidbrochart" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/davidbrochart"><img alt="" src="https://avatars.githubusercontent.com/u/4711805?v=4?s=100" width="100px;"/><br/><sub><b>David Brochart</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=davidbrochart" title="Documentation">📖</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=davidbrochart" title="Code">💻</a></td>
<td align="center"><a href="https://www.daanbeverdam.com"><img alt="" src="https://avatars.githubusercontent.com/u/13944585?v=4?s=100" width="100px;"/><br/><sub><b>Daan Beverdam</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=daanbeverdam" title="Code">💻</a></td> <td align="center"><a href="https://www.daanbeverdam.com"><img alt="" src="https://avatars.githubusercontent.com/u/13944585?v=4?s=100" width="100px;"/><br/><sub><b>Daan Beverdam</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=daanbeverdam" title="Code">💻</a></td>
<td align="center"><a href="http://sralab.com"><img alt="" src="https://avatars.githubusercontent.com/u/1815?v=4?s=100" width="100px;"/><br/><sub><b>Stéphane Raimbault</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=stephane" title="Tests">⚠️</a> <a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Astephane" title="Bug reports">🐛</a></td> <td align="center"><a href="http://sralab.com"><img alt="" src="https://avatars.githubusercontent.com/u/1815?v=4?s=100" width="100px;"/><br/><sub><b>Stéphane Raimbault</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=stephane" title="Tests">⚠️</a> <a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Astephane" title="Bug reports">🐛</a></td>
</tr> </tr>

View File

@ -520,7 +520,7 @@
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link"></a></h1> <h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link"></a></h1>
<p>You can add <strong>FastAPI Users</strong> to your FastAPI project in a few easy steps. First of all, install the dependency:</p> <p>You can add <strong>FastAPI Users</strong> to your FastAPI project in a few easy steps. First of all, install the dependency:</p>
<h2 id="with-sqlalchemy-support">With SQLAlchemy support<a class="headerlink" href="#with-sqlalchemy-support" title="Permanent link"></a></h2> <h2 id="with-sqlalchemy-support">With SQLAlchemy support<a class="headerlink" href="#with-sqlalchemy-support" title="Permanent link"></a></h2>
<div class="highlight"><pre><span></span><code>pip install <span class="s1">'fastapi-users[sqlalchemy]'</span> <div class="highlight"><pre><span></span><code>pip install <span class="s1">'fastapi-users[sqlalchemy2]'</span>
</code></pre></div> </code></pre></div>
<h2 id="with-mongodb-support">With MongoDB support<a class="headerlink" href="#with-mongodb-support" title="Permanent link"></a></h2> <h2 id="with-mongodb-support">With MongoDB support<a class="headerlink" href="#with-mongodb-support" title="Permanent link"></a></h2>
<div class="highlight"><pre><span></span><code>pip install <span class="s1">'fastapi-users[mongodb]'</span> <div class="highlight"><pre><span></span><code>pip install <span class="s1">'fastapi-users[mongodb]'</span>

File diff suppressed because one or more lines are too long

View File

@ -2,182 +2,182 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2022-01-03</lastmod> <lastmod>2022-01-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
</urlset> </urlset>

Binary file not shown.

View File

@ -1,12 +1,14 @@
import databases from typing import AsyncGenerator
import sqlalchemy
from fastapi import Depends
from fastapi_users.db import SQLAlchemyBaseUserTable, SQLAlchemyUserDatabase from fastapi_users.db import SQLAlchemyBaseUserTable, SQLAlchemyUserDatabase
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base
from sqlalchemy.orm import sessionmaker
from .models import UserDB from .models import UserDB
DATABASE_URL = "sqlite:///./test.db" DATABASE_URL = "sqlite+aiosqlite:///./test.db"
database = databases.Database(DATABASE_URL)
Base: DeclarativeMeta = declarative_base() Base: DeclarativeMeta = declarative_base()
@ -14,13 +16,19 @@ class UserTable(Base, SQLAlchemyBaseUserTable):
pass pass
engine = sqlalchemy.create_engine( engine = create_async_engine(DATABASE_URL, connect_args={"check_same_thread": False})
DATABASE_URL, connect_args={"check_same_thread": False} async_session_maker = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
)
Base.metadata.create_all(engine)
users = UserTable.__table__
async def get_user_db(): async def create_db_and_tables():
yield SQLAlchemyUserDatabase(UserDB, database, users) async with engine.begin() as conn:
await conn.run_sync(Base.metadata.create_all)
async def get_async_session() -> AsyncGenerator[AsyncSession, None]:
async with async_session_maker() as session:
yield session
async def get_user_db(session: AsyncSession = Depends(get_async_session)):
yield SQLAlchemyUserDatabase(UserDB, session, UserTable)

View File

@ -1,16 +1,18 @@
import databases from typing import AsyncGenerator
import sqlalchemy
from fastapi import Depends
from fastapi_users.db import SQLAlchemyBaseUserTable, SQLAlchemyUserDatabase from fastapi_users.db import SQLAlchemyBaseUserTable, SQLAlchemyUserDatabase
from fastapi_users_db_sqlalchemy.access_token import ( from fastapi_users_db_sqlalchemy.access_token import (
SQLAlchemyAccessTokenDatabase, SQLAlchemyAccessTokenDatabase,
SQLAlchemyBaseAccessTokenTable, SQLAlchemyBaseAccessTokenTable,
) )
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base
from sqlalchemy.orm import sessionmaker
from .models import AccessToken, UserDB from .models import AccessToken, UserDB
DATABASE_URL = "sqlite:///./test.db" DATABASE_URL = "sqlite+aiosqlite:///./test.db"
database = databases.Database(DATABASE_URL)
Base: DeclarativeMeta = declarative_base() Base: DeclarativeMeta = declarative_base()
@ -22,18 +24,23 @@ class AccessTokenTable(SQLAlchemyBaseAccessTokenTable, Base):
pass pass
engine = sqlalchemy.create_engine( engine = create_async_engine(DATABASE_URL, connect_args={"check_same_thread": False})
DATABASE_URL, connect_args={"check_same_thread": False} async_session_maker = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
)
Base.metadata.create_all(engine)
users = UserTable.__table__
access_tokens = AccessTokenTable.__table__
async def get_user_db(): async def create_db_and_tables():
yield SQLAlchemyUserDatabase(UserDB, database, users) async with engine.begin() as conn:
await conn.run_sync(Base.metadata.create_all)
async def get_access_token_db(): async def get_async_session() -> AsyncGenerator[AsyncSession, None]:
yield SQLAlchemyAccessTokenDatabase(AccessToken, database, access_tokens) async with async_session_maker() as session:
yield session
async def get_user_db(session: AsyncSession = Depends(get_async_session)):
yield SQLAlchemyUserDatabase(UserDB, session, UserTable)
async def get_access_token_db(session: AsyncSession = Depends(get_async_session)):
yield SQLAlchemyAccessTokenDatabase(AccessToken, session, AccessTokenTable)

View File

@ -1,35 +1,42 @@
import databases from typing import AsyncGenerator
import sqlalchemy
from fastapi import Depends
from fastapi_users.db import ( from fastapi_users.db import (
SQLAlchemyBaseOAuthAccountTable, SQLAlchemyBaseOAuthAccountTable,
SQLAlchemyBaseUserTable, SQLAlchemyBaseUserTable,
SQLAlchemyUserDatabase, SQLAlchemyUserDatabase,
) )
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base
from sqlalchemy.orm import relationship, sessionmaker
from .models import UserDB from .models import UserDB
DATABASE_URL = "sqlite:///./test.db" DATABASE_URL = "sqlite+aiosqlite:///./test.db"
database = databases.Database(DATABASE_URL)
Base: DeclarativeMeta = declarative_base() Base: DeclarativeMeta = declarative_base()
class UserTable(Base, SQLAlchemyBaseUserTable): class UserTable(Base, SQLAlchemyBaseUserTable):
oauth_accounts = relationship("OAuthAccount")
class OAuthAccountTable(SQLAlchemyBaseOAuthAccountTable, Base):
pass pass
class OAuthAccount(SQLAlchemyBaseOAuthAccountTable, Base): engine = create_async_engine(DATABASE_URL, connect_args={"check_same_thread": False})
pass async_session_maker = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
engine = sqlalchemy.create_engine( async def create_db_and_tables():
DATABASE_URL, connect_args={"check_same_thread": False} async with engine.begin() as conn:
) await conn.run_sync(Base.metadata.create_all)
Base.metadata.create_all(engine)
users = UserTable.__table__
oauth_accounts = OAuthAccount.__table__
async def get_user_db(): async def get_async_session() -> AsyncGenerator[AsyncSession, None]:
yield SQLAlchemyUserDatabase(UserDB, database, users, oauth_accounts) async with async_session_maker() as session:
yield session
async def get_user_db(session: AsyncSession = Depends(get_async_session)):
yield SQLAlchemyUserDatabase(UserDB, session, UserTable, OAuthAccountTable)