summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2022-03-11 14:07:09 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2022-03-11 14:07:09 -0500
commit575a5e44bae4e587ff19d4137e54a7888ee08e41 (patch)
tree30c685176bd5d3a17d1bdeec46b3d63cbb693035
parent7a48471f6482576ac50abab35ce4fa64c1f633b4 (diff)
downloadsqlalchemy-575a5e44bae4e587ff19d4137e54a7888ee08e41.tar.gz
fix section format headings, remove "Step: "
Change-Id: I25a837cf866b152a30aa373d07f704e0cc11d497
-rw-r--r--doc/build/orm/quickstart.rst38
1 files changed, 20 insertions, 18 deletions
diff --git a/doc/build/orm/quickstart.rst b/doc/build/orm/quickstart.rst
index d670fadb9..95cace918 100644
--- a/doc/build/orm/quickstart.rst
+++ b/doc/build/orm/quickstart.rst
@@ -14,8 +14,8 @@ proceed to the full :ref:`unified_tutorial` for a much more in-depth
description of each of the concepts being illustrated here.
-Step One - Declare Models
-==========================
+Declare Models
+---------------
Here, we define module-level constructs that will form the structures
which we will be querying from the database. This structure, known as a
@@ -73,8 +73,9 @@ including :class:`_types.Integer` and :class:`_types.String`.
More on table metadata and an intro to ORM declared mapping is in the
Tutorial at :ref:`tutorial_working_with_metadata`.
-Step Two - Create an Engine
-============================
+Create an Engine
+------------------
+
The :class:`_engine.Engine` is a **factory** that can create new
database connections for us, which also holds onto connections inside
@@ -93,8 +94,9 @@ for convenience::
A full intro to the :class:`_engine.Engine` starts at :ref:`tutorial_engine`.
-Step Three - Emit CREATE TABLE DDL
-==================================
+Emit CREATE TABLE DDL
+----------------------
+
Using our table metadata and our engine, we can generate our schema at once
in our target SQLite database, using a method called :meth:`_schema.MetaData.create_all`:
@@ -128,8 +130,8 @@ A lot just happened from that bit of Python code we wrote. For a complete
overview of what's going on on with Table metadata, proceed in the
Tutorial at :ref:`tutorial_working_with_metadata`.
-Step Four - Create Objects and Persist
-======================================
+Create Objects and Persist
+---------------------------
We are now ready to insert data in the database. We accomplish this by
creating instances of ``User`` and ``Address`` objects, which have
@@ -199,8 +201,8 @@ Basics on creating a :class:`_orm.Session` are at
Then, some varieties of basic persistence operations are introduced
at :ref:`tutorial_inserting_orm`.
-Step Five - Simple SELECT
-==========================
+Simple SELECT
+--------------
With some rows in the database, here's the simplest form of emitting a SELECT
statement to load some objects. To create SELECT statements, we use the
@@ -237,8 +239,8 @@ SQL IN operator.
More detail on how to select objects and individual columns is at
:ref:`tutorial_selecting_orm_entities`.
-Step Six - SELECT with JOIN
-===========================
+SELECT with JOIN
+-----------------
It's very common to query amongst multiple tables at once, and in SQL
the JOIN keyword is the primary way this happens. The :class:`_sql.Select`
@@ -269,8 +271,8 @@ method :meth:`_sql.ColumnOperators.__eq__` to produce a SQL criteria object.
Some more background on the concepts above are at
:ref:`tutorial_select_where_clause` and :ref:`tutorial_select_join`.
-Step Seven - Make Changes
-=========================
+Make Changes
+------------
The :class:`_orm.Session` object, in conjunction with our ORM-mapped classes
``User`` and ``Address``, automatically track changes to the objects as they
@@ -314,8 +316,8 @@ items using more or less SQL is introduced at :ref:`tutorial_orm_loader_strategi
A detailed walkthrough on ORM data manipulation starts at
:ref:`tutorial_orm_data_manipulation`.
-Step Eight - Some Deletes
-=========================
+Some Deletes
+------------
All things must come to an end, as is the case for some of our database
rows - here's a quick demonstration of two different forms of deletion, both
@@ -400,8 +402,8 @@ The Tutorial discusses ORM deletion at :ref:`tutorial_orm_deleting`.
Background on object expiration is at :ref:`session_expiring`; cascades
are discussed in depth at :ref:`unitofwork_cascades`.
-Step Nine - Learn the above concepts in depth
-=============================================
+Learn the above concepts in depth
+---------------------------------
For a new user, the above sections were likely a whirlwind tour. There's a
lot of important concepts in each step above that weren't covered. With a