1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
|
from _typeshed import Self
from typing import Any
from .. import util
from ..util import HasMemoized, memoized_property
from . import roles, traversals, visitors
from .annotation import Annotated, SupportsCloneAnnotations
from .base import CacheableOptions, CompileState, Executable, Generative, HasCompileState, Immutable
from .elements import (
BindParameter as BindParameter,
BooleanClauseList as BooleanClauseList,
ClauseElement as ClauseElement,
ClauseList as ClauseList,
ColumnClause as ColumnClause,
GroupedElement as GroupedElement,
Grouping as Grouping,
TableValuedColumn as TableValuedColumn,
UnaryExpression as UnaryExpression,
literal_column as literal_column,
)
class _OffsetLimitParam(BindParameter[Any]):
inherit_cache: bool
def subquery(alias, *args, **kwargs): ...
class ReturnsRows(roles.ReturnsRowsRole, ClauseElement):
@property
def selectable(self): ...
@property
def exported_columns(self) -> None: ...
class Selectable(ReturnsRows):
__visit_name__: str
is_selectable: bool
def lateral(self, name: Any | None = ...): ...
def replace_selectable(self, old, alias): ...
def corresponding_column(self, column, require_embedded: bool = ...): ...
class HasPrefixes:
def prefix_with(self: Self, *expr, **kw) -> Self: ...
class HasSuffixes:
def suffix_with(self: Self, *expr, **kw) -> Self: ...
class HasHints:
def with_statement_hint(self, text, dialect_name: str = ...): ...
def with_hint(self: Self, selectable, text: str, dialect_name: str = ...) -> Self: ...
class FromClause(roles.AnonymizedFromClauseRole, Selectable):
__visit_name__: str
named_with_column: bool
schema: Any
is_selectable: bool
def select(self, whereclause: Any | None = ..., **kwargs): ...
def join(self, right, onclause: Any | None = ..., isouter: bool = ..., full: bool = ...): ...
def outerjoin(self, right, onclause: Any | None = ..., full: bool = ...): ...
def alias(self, name: Any | None = ..., flat: bool = ...): ...
def table_valued(self): ...
def tablesample(self, sampling, name: Any | None = ..., seed: Any | None = ...): ...
def is_derived_from(self, fromclause): ...
@property
def description(self): ...
@property
def exported_columns(self): ...
@memoized_property
def columns(self): ...
@property
def entity_namespace(self): ...
@memoized_property
def primary_key(self): ...
@memoized_property
def foreign_keys(self): ...
@property
def c(self): ...
LABEL_STYLE_NONE: Any
LABEL_STYLE_TABLENAME_PLUS_COL: Any
LABEL_STYLE_DISAMBIGUATE_ONLY: Any
LABEL_STYLE_DEFAULT: Any
class Join(roles.DMLTableRole, FromClause):
__visit_name__: str
left: Any
right: Any
onclause: Any
isouter: Any
full: Any
def __init__(self, left, right, onclause: Any | None = ..., isouter: bool = ..., full: bool = ...) -> None: ...
@property
def description(self): ...
def is_derived_from(self, fromclause): ...
def self_group(self, against: Any | None = ...): ...
def select(self, whereclause: Any | None = ..., **kwargs): ...
@property
def bind(self): ...
def alias(self, name: Any | None = ..., flat: bool = ...): ...
class NoInit:
def __init__(self, *arg, **kw) -> None: ...
class AliasedReturnsRows(NoInit, FromClause):
named_with_column: bool
@property
def description(self): ...
@property
def original(self): ...
def is_derived_from(self, fromclause): ...
@property
def bind(self): ...
class Alias(roles.DMLTableRole, AliasedReturnsRows):
__visit_name__: str
inherit_cache: bool
class TableValuedAlias(Alias):
__visit_name__: str
@HasMemoized.memoized_attribute
def column(self): ...
def alias(self, name: Any | None = ...): ... # type: ignore[override]
def lateral(self, name: Any | None = ...): ...
def render_derived(self, name: Any | None = ..., with_types: bool = ...): ...
class Lateral(AliasedReturnsRows):
__visit_name__: str
inherit_cache: bool
class TableSample(AliasedReturnsRows):
__visit_name__: str
class CTE(roles.DMLTableRole, roles.IsCTERole, Generative, HasPrefixes, HasSuffixes, AliasedReturnsRows):
__visit_name__: str
def alias(self, name: Any | None = ..., flat: bool = ...): ...
def union(self, *other): ...
def union_all(self, *other): ...
class HasCTE(roles.HasCTERole):
def add_cte(self, cte) -> None: ...
def cte(self, name: Any | None = ..., recursive: bool = ..., nesting: bool = ...): ...
class Subquery(AliasedReturnsRows):
__visit_name__: str
inherit_cache: bool
def as_scalar(self): ...
class FromGrouping(GroupedElement, FromClause):
element: Any
def __init__(self, element) -> None: ...
@property
def columns(self): ...
@property
def primary_key(self): ...
@property
def foreign_keys(self): ...
def is_derived_from(self, element): ...
def alias(self, **kw): ...
class TableClause(roles.DMLTableRole, Immutable, FromClause):
__visit_name__: str
named_with_column: bool
implicit_returning: bool
name: Any
primary_key: Any
foreign_keys: Any
schema: Any
fullname: Any
def __init__(self, name, *columns, **kw) -> None: ...
@memoized_property
def description(self): ...
def append_column(self, c, **kw) -> None: ...
def insert(self, values: Any | None = ..., inline: bool = ..., **kwargs): ...
def update(self, whereclause: Any | None = ..., values: Any | None = ..., inline: bool = ..., **kwargs): ...
def delete(self, whereclause: Any | None = ..., **kwargs): ...
class ForUpdateArg(ClauseElement):
def __eq__(self, other): ...
def __ne__(self, other): ...
def __hash__(self): ...
nowait: Any
read: Any
skip_locked: Any
key_share: Any
of: Any
def __init__(
self, nowait: bool = ..., read: bool = ..., of: Any | None = ..., skip_locked: bool = ..., key_share: bool = ...
) -> None: ...
class Values(Generative, FromClause):
named_with_column: bool
__visit_name__: str
name: Any
literal_binds: Any
def __init__(self, *columns, **kw) -> None: ...
def alias(self: Self, name: Any | None, **kw) -> Self: ... # type: ignore[override]
def lateral(self: Self, name: Any | None = ...) -> Self: ...
def data(self: Self, values) -> Self: ...
class SelectBase(
roles.SelectStatementRole,
roles.DMLSelectRole,
roles.CompoundElementRole,
roles.InElementRole,
HasCTE,
Executable,
SupportsCloneAnnotations,
Selectable,
):
is_select: bool
@property
def selected_columns(self) -> None: ...
@property
def exported_columns(self): ...
@property
def c(self): ...
@property
def columns(self): ...
def select(self, *arg, **kw): ...
def as_scalar(self): ...
def exists(self): ...
def scalar_subquery(self): ...
def label(self, name): ...
def lateral(self, name: Any | None = ...): ...
def subquery(self, name: Any | None = ...): ...
def alias(self, name: Any | None = ..., flat: bool = ...): ...
class SelectStatementGrouping(GroupedElement, SelectBase):
__visit_name__: str
element: Any
def __init__(self, element) -> None: ...
def get_label_style(self): ...
def set_label_style(self, label_style): ...
@property
def select_statement(self): ...
def self_group(self, against: Any | None = ...): ...
@property
def selected_columns(self): ...
class DeprecatedSelectBaseGenerations:
def append_order_by(self, *clauses) -> None: ...
def append_group_by(self, *clauses) -> None: ...
class GenerativeSelect(DeprecatedSelectBaseGenerations, SelectBase):
def __init__(
self,
_label_style=...,
use_labels: bool = ...,
limit: Any | None = ...,
offset: Any | None = ...,
order_by: Any | None = ...,
group_by: Any | None = ...,
bind: Any | None = ...,
) -> None: ...
def with_for_update(
self: Self, nowait: bool = ..., read: bool = ..., of: Any | None = ..., skip_locked: bool = ..., key_share: bool = ...
) -> Self: ...
def get_label_style(self): ...
def set_label_style(self, style): ...
def apply_labels(self): ...
def limit(self: Self, limit: Any | None) -> Self: ...
def fetch(self: Self, count: Any | None, with_ties: bool = ..., percent: bool = ...) -> Self: ...
def offset(self: Self, offset: Any | None) -> Self: ...
def slice(self: Self, start: Any | None, stop: Any | None) -> Self: ...
def order_by(self: Self, *clauses) -> Self: ...
def group_by(self: Self, *clauses) -> Self: ...
class CompoundSelectState(CompileState): ...
class CompoundSelect(HasCompileState, GenerativeSelect):
__visit_name__: str
UNION: Any
UNION_ALL: Any
EXCEPT: Any
EXCEPT_ALL: Any
INTERSECT: Any
INTERSECT_ALL: Any
keyword: Any
selects: Any
def __init__(self, keyword, *selects, **kwargs) -> None: ...
def self_group(self, against: Any | None = ...): ...
def is_derived_from(self, fromclause): ...
@property
def selected_columns(self): ...
@property
def bind(self): ...
@bind.setter
def bind(self, bind) -> None: ...
class DeprecatedSelectGenerations:
def append_correlation(self, fromclause) -> None: ...
def append_column(self, column) -> None: ...
def append_prefix(self, clause) -> None: ...
def append_whereclause(self, whereclause) -> None: ...
def append_having(self, having) -> None: ...
def append_from(self, fromclause) -> None: ...
class SelectState(util.MemoizedSlots, CompileState):
class default_select_compile_options(CacheableOptions): ...
statement: Any
from_clauses: Any
froms: Any
columns_plus_names: Any
def __init__(self, statement, compiler, **kw) -> None: ...
@classmethod
def get_column_descriptions(cls, statement) -> None: ...
@classmethod
def from_statement(cls, statement, from_statement) -> None: ...
@classmethod
def get_columns_clause_froms(cls, statement): ...
@classmethod
def determine_last_joined_entity(cls, stmt): ...
@classmethod
def all_selected_columns(cls, statement): ...
class _SelectFromElements: ...
class _MemoizedSelectEntities(traversals.HasCacheKey, traversals.HasCopyInternals, visitors.Traversible):
__visit_name__: str
class Select(
HasPrefixes, HasSuffixes, HasHints, HasCompileState, DeprecatedSelectGenerations, _SelectFromElements, GenerativeSelect
):
__visit_name__: str
@classmethod
def create_legacy_select(
cls,
columns: Any | None = ...,
whereclause: Any | None = ...,
from_obj: Any | None = ...,
distinct: bool = ...,
having: Any | None = ...,
correlate: bool = ...,
prefixes: Any | None = ...,
suffixes: Any | None = ...,
**kwargs,
): ...
def __init__(self) -> None: ...
def filter(self, *criteria): ...
def filter_by(self, **kwargs): ...
@property
def column_descriptions(self): ...
def from_statement(self, statement): ...
def join(self: Self, target, onclause: Any | None = ..., isouter: bool = ..., full: bool = ...) -> Self: ...
def outerjoin_from(self, from_, target, onclause: Any | None = ..., full: bool = ...): ...
def join_from(self: Self, from_, target, onclause: Any | None = ..., isouter: bool = ..., full: bool = ...) -> Self: ...
def outerjoin(self, target, onclause: Any | None = ..., full: bool = ...): ...
def get_final_froms(self): ...
@property
def froms(self): ...
@property
def columns_clause_froms(self): ...
@property
def inner_columns(self): ...
def is_derived_from(self, fromclause): ...
def get_children(self, **kwargs): ...
def add_columns(self: Self, *columns) -> Self: ...
def column(self, column): ...
def reduce_columns(self, only_synonyms: bool = ...): ...
def with_only_columns(self: Self, *columns, **kw) -> Self: ...
@property
def whereclause(self): ...
def where(self: Self, *whereclause) -> Self: ...
def having(self: Self, having) -> Self: ...
def distinct(self: Self, *expr) -> Self: ...
def select_from(self: Self, *froms) -> Self: ...
def correlate(self: Self, *fromclauses) -> Self: ...
def correlate_except(self: Self, *fromclauses) -> Self: ...
@HasMemoized.memoized_attribute
def selected_columns(self): ...
def self_group(self, against: Any | None = ...): ...
def union(self, *other, **kwargs): ...
def union_all(self, *other, **kwargs): ...
def except_(self, *other, **kwargs): ...
def except_all(self, *other, **kwargs): ...
def intersect(self, *other, **kwargs): ...
def intersect_all(self, *other, **kwargs): ...
@property
def bind(self): ...
@bind.setter
def bind(self, bind) -> None: ...
class ScalarSelect(roles.InElementRole, Generative, Grouping):
inherit_cache: bool
element: Any
type: Any
def __init__(self, element) -> None: ...
@property
def columns(self) -> None: ...
@property
def c(self): ...
def where(self: Self, crit) -> Self: ...
def self_group(self, **kwargs): ...
def correlate(self: Self, *fromclauses) -> Self: ...
def correlate_except(self: Self, *fromclauses) -> Self: ...
class Exists(UnaryExpression):
inherit_cache: bool
def __init__(self, *args, **kwargs) -> None: ...
def select(self, whereclause: Any | None = ..., **kwargs): ...
def correlate(self, *fromclause): ...
def correlate_except(self, *fromclause): ...
def select_from(self, *froms): ...
def where(self, *clause): ...
class TextualSelect(SelectBase):
__visit_name__: str
is_text: bool
is_select: bool
element: Any
column_args: Any
positional: Any
def __init__(self, text, columns, positional: bool = ...) -> None: ...
@HasMemoized.memoized_attribute
def selected_columns(self): ...
def bindparams(self: Self, *binds, **bind_as_values) -> Self: ...
TextAsFrom = TextualSelect
class AnnotatedFromClause(Annotated):
def __init__(self, element, values) -> None: ...
|