summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/reflection.py
diff options
context:
space:
mode:
authoraplatkouski <5857672+aplatkouski@users.noreply.github.com>2020-06-22 11:34:39 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2020-06-25 19:42:28 -0400
commit2a1a9f5f5a9723f757439657d2bdf224baed8748 (patch)
tree0fb5b7e4dfbe21b329da52e0774ad557ecac1714 /lib/sqlalchemy/engine/reflection.py
parent3138201a82d4e62e56e44ca9c8914c20dd46d1b4 (diff)
downloadsqlalchemy-2a1a9f5f5a9723f757439657d2bdf224baed8748.tar.gz
Fix a wide variety of typos and broken links
Note the PR has a few remaining doc linking issues listed in the comment that must be addressed separately. Signed-off-by: aplatkouski <5857672+aplatkouski@users.noreply.github.com> Closes: #5371 Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/5371 Pull-request-sha: 7e7d233cf3a0c66980c27db0fcdb3c7d93bc2510 Change-Id: I9c36e8d8804483950db4b42c38ee456e384c59e3
Diffstat (limited to 'lib/sqlalchemy/engine/reflection.py')
-rw-r--r--lib/sqlalchemy/engine/reflection.py48
1 files changed, 24 insertions, 24 deletions
diff --git a/lib/sqlalchemy/engine/reflection.py b/lib/sqlalchemy/engine/reflection.py
index fded37b2a..198b5e568 100644
--- a/lib/sqlalchemy/engine/reflection.py
+++ b/lib/sqlalchemy/engine/reflection.py
@@ -316,7 +316,7 @@ class Inspector(object):
:meth:`_reflection.Inspector.get_table_names`
:func:`.sort_tables_and_constraints` - similar method which works
- with an already-given :class:`_schema.MetaData`.
+ with an already-given :class:`_schema.MetaData`.
"""
@@ -351,7 +351,7 @@ class Inspector(object):
] + [(None, list(remaining_fkcs))]
def get_temp_table_names(self):
- """return a list of temporary table names for the current bind.
+ """Return a list of temporary table names for the current bind.
This method is unsupported by most dialects; currently
only SQLite implements it.
@@ -366,7 +366,7 @@ class Inspector(object):
)
def get_temp_view_names(self):
- """return a list of temporary view names for the current bind.
+ """Return a list of temporary view names for the current bind.
This method is unsupported by most dialects; currently
only SQLite implements it.
@@ -458,7 +458,7 @@ class Inspector(object):
* ``autoincrement`` - indicates that the column is auto incremented -
this is returned as a boolean or 'auto'
- * ``comment`` - (optional) the commnet on the column. Only some
+ * ``comment`` - (optional) the comment on the column. Only some
dialects return this key
* ``computed`` - (optional) when present it indicates that this column
@@ -505,10 +505,10 @@ class Inspector(object):
Given a string `table_name`, and an optional string `schema`, return
primary key information as a dictionary with these keys:
- constrained_columns
+ * ``constrained_columns`` -
a list of column names that make up the primary key
- name
+ * ``name`` -
optional name of the primary key constraint.
:param table_name: string name of the table. For special quoting,
@@ -530,20 +530,20 @@ class Inspector(object):
Given a string `table_name`, and an optional string `schema`, return
foreign key information as a list of dicts with these keys:
- constrained_columns
+ * ``constrained_columns`` -
a list of column names that make up the foreign key
- referred_schema
+ * ``referred_schema`` -
the name of the referred schema
- referred_table
+ * ``referred_table`` -
the name of the referred table
- referred_columns
+ * ``referred_columns`` -
a list of column names in the referred table that correspond to
constrained_columns
- name
+ * ``name`` -
optional name of the foreign key constraint.
:param table_name: string name of the table. For special quoting,
@@ -566,22 +566,22 @@ class Inspector(object):
Given a string `table_name` and an optional string `schema`, return
index information as a list of dicts with these keys:
- name
+ * ``name`` -
the index's name
- column_names
+ * ``column_names`` -
list of column names in order
- unique
+ * ``unique`` -
boolean
- column_sorting
+ * ``column_sorting`` -
optional dict mapping column names to tuple of sort keywords,
which may include ``asc``, ``desc``, ``nullsfirst``, ``nullslast``.
.. versionadded:: 1.3.5
- dialect_options
+ * ``dialect_options`` -
dict of dialect-specific index options. May not be present
for all dialects.
@@ -607,10 +607,10 @@ class Inspector(object):
Given a string `table_name` and an optional string `schema`, return
unique constraint information as a list of dicts with these keys:
- name
+ * ``name`` -
the unique constraint's name
- column_names
+ * ``column_names`` -
list of column names in order
:param table_name: string name of the table. For special quoting,
@@ -633,7 +633,7 @@ class Inspector(object):
Given a string ``table_name`` and an optional string ``schema``,
return table comment information as a dictionary with these keys:
- text
+ * ``text`` -
text of the comment.
Raises ``NotImplementedError`` for a dialect that does not support
@@ -654,13 +654,13 @@ class Inspector(object):
Given a string `table_name` and an optional string `schema`, return
check constraint information as a list of dicts with these keys:
- name
+ * ``name`` -
the check constraint's name
- sqltext
+ * ``sqltext`` -
the check constraint's SQL expression
- dialect_options
+ * ``dialect_options`` -
may or may not be present; a dictionary with additional
dialect-specific options for this CHECK constraint
@@ -701,8 +701,8 @@ class Inspector(object):
resolve_fks=True,
_extend_on=None,
):
- """Given a Table object, load its internal constructs based on
- introspection.
+ """Given a :class:`_schema.Table` object, load its internal
+ constructs based on introspection.
This is the underlying method used by most dialects to produce
table reflection. Direct usage is like::