diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2016-10-17 12:35:26 -0400 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2016-10-17 12:35:26 -0400 |
commit | f9432a0287c79dcde67ac53cdd742fe729e6ce18 (patch) | |
tree | 0e66a91f4fb06b71a7b31a32af4ceb1e86be7e49 | |
parent | 8ef4f6a53864ce9c57c4879d6b2aa0f81ddbf596 (diff) | |
download | sqlalchemy-f9432a0287c79dcde67ac53cdd742fe729e6ce18.tar.gz |
Remove the use of the word "fundamental" to describe ColumnElements
The context is unclear if "fundamental" refers to the object's
role within a SELECT composition or within the class hierarchy
of ClauseElement classes.
Change-Id: I10bbf324fc09034cc27398867b7eca6b6f127abe
Fixes: #3793
-rw-r--r-- | doc/build/core/sqlelement.rst | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/build/core/sqlelement.rst b/doc/build/core/sqlelement.rst index cf52a0166..acee8e4fc 100644 --- a/doc/build/core/sqlelement.rst +++ b/doc/build/core/sqlelement.rst @@ -3,11 +3,16 @@ Column Elements and Expressions .. module:: sqlalchemy.sql.expression -The most fundamental part of the SQL expression API are the "column elements", -which allow for basic SQL expression support. The core of all SQL expression -constructs is the :class:`.ClauseElement`, which is the base for several -sub-branches. The :class:`.ColumnElement` class is the fundamental unit -used to construct any kind of typed SQL expression. +The expression API consists of a series of classes that each represent a +specific lexical element within a SQL string. Composed together +into a larger structure, they form a statement construct that may +be *compiled* into a string representation that can be passed to a database. +The classes are organized into a +hierarchy that begins at the basemost ClauseElement class. Key subclasses +include ColumnElement, which represents the role of any column-based expression +in a SQL statement, such as in the columns clause, WHERE clause, and ORDER BY +clause, and FromClause, which represents the role of a token that is placed in +the FROM clause of a SELECT statement. .. autofunction:: all_ |