SQL Statements and Expressions API

This section presents the API reference for the SQL Expression Language. For an introduction, start with Working with Data in the SQLAlchemy Unified Tutorial.

• Column Elements and Expressions
  • Column Element Foundational Constructors
    • and_()
    • bindparam()
    • bitwise_not()
    • case()
    • cast()
    • column()
    • custom_op
    • distinct()
    • extract()
    • false()
    • func
    • lambda_stmt()
    • literal()
    • literal_column()
    • not_()
    • null()
    • or_()
    • outparam()
    • text()
    • true()
    • try_cast()
    • tuple_()
    • type_coerce()
    • quoted_name
  • Column Element Modifier Constructors
    • all_()
    • any_()
    • asc()
    • between()
    • collate()
    • desc()
    • funcfilter()
    • label()
    • nulls_first()
    • nullsfirst()
    • nulls_last()
    • nullslast()
    • over()
    • within_group()
  • Column Element Class Documentation
    • BinaryExpression
    • BindParameter
    • Case
    • Cast
    • ClauseList
    • ColumnClause
    • ColumnCollection
    • ColumnElement
    • ColumnExpressionArgument
    • ColumnOperators
    • Extract
    • False_
    • FunctionFilter
    • Label
    • Null
    • Operators
    • Over
    • SQLColumnExpression
    • TextClause
    • TryCast
    • Tuple
    • WithinGroup
    • WrapsColumnExpression
    • True_
    • TypeCoerce
    • UnaryExpression
  • Column Element Typing Utilities
    • NotNullable()
    • Nullable()
• Operator Reference
  • Comparison Operators
  • IN Comparisons
    • IN against a list of values
    • Empty IN Expressions
    • NOT IN
    • Tuple IN Expressions
    • Subquery IN
  • Identity Comparisons
  • String Comparisons
  • String Containment
  • String matching
  • String Alteration
  • Arithmetic Operators
  • Bitwise Operators
  • Using Conjunctions and Negations
  • Conjunction Operators
• SELECT and Related Constructs
  • Selectable Foundational Constructors
    • except_()
    • except_all()
    • exists()
    • intersect()
    • intersect_all()
    • select()
    • table()
    • union()
    • union_all()
    • values()
  • Selectable Modifier Constructors
    • alias()
    • cte()
    • join()
    • lateral()
    • outerjoin()
    • tablesample()
  • Selectable Class Documentation
    • Alias
    • AliasedReturnsRows
    • CompoundSelect
    • CTE
    • Executable
    • Exists
    • FromClause
    • GenerativeSelect
    • HasCTE
    • HasPrefixes
    • HasSuffixes
    • Join
    • Lateral
    • ReturnsRows
    • ScalarSelect
    • Select
    • Selectable
    • SelectBase
    • Subquery
    • TableClause
    • TableSample
    • TableValuedAlias
    • TextualSelect
    • Values
    • ScalarValues
  • Label Style Constants
    • SelectLabelStyle
• Insert, Updates, Deletes
  • DML Foundational Constructors
    • delete()
    • insert()
    • update()
  • DML Class Documentation Constructors
    • Delete
    • Insert
    • Update
    • UpdateBase
    • ValuesBase
• SQL and Generic Functions
  • Function API
    • AnsiFunction
    • Function
    • FunctionElement
    • GenericFunction
    • register_function()
  • Selected “Known” Functions
    • aggregate_strings
    • array_agg
    • char_length
    • coalesce
    • concat
    • count
    • cube
    • cume_dist
    • current_date
    • current_time
    • current_timestamp
    • current_user
    • dense_rank
    • grouping_sets
    • localtime
    • localtimestamp
    • max
    • min
    • mode
    • next_value
    • now
    • percent_rank
    • percentile_cont
    • percentile_disc
    • random
    • rank
    • rollup
    • session_user
    • sum
    • sysdate
    • user
• Custom SQL Constructs and Compilation Extension
  • Synopsis
  • Dialect-specific compilation rules
  • Compiling sub-elements of a custom expression construct
    • Cross Compiling between SQL and DDL compilers
  • Changing the default compilation of existing constructs
  • Changing Compilation of Types
  • Subclassing Guidelines
  • Enabling Caching Support for Custom Constructs
  • Further Examples
    • “UTC timestamp” function
    • “GREATEST” function
    • “false” expression
  • compiles()
  • deregister()
• Expression Serializer Extension
  • Deserializer()
  • Serializer()
  • dumps()
  • loads()
• SQL Expression Language Foundational Constructs
  • CacheKey
    • CacheKey.bindparams
    • CacheKey.key
    • CacheKey.to_offline_string()
  • ClauseElement
    • ClauseElement.compare()
    • ClauseElement.compile()
    • ClauseElement.get_children()
    • ClauseElement.inherit_cache
    • ClauseElement.params()
    • ClauseElement.self_group()
    • ClauseElement.unique_params()
  • DialectKWArgs
    • DialectKWArgs.argument_for()
    • DialectKWArgs.dialect_kwargs
    • DialectKWArgs.dialect_options
    • DialectKWArgs.kwargs
  • HasCacheKey
    • HasCacheKey.inherit_cache
  • LambdaElement
  • StatementLambdaElement
    • StatementLambdaElement.add_criteria()
    • StatementLambdaElement.is_delete
    • StatementLambdaElement.is_dml
    • StatementLambdaElement.is_insert
    • StatementLambdaElement.is_select
    • StatementLambdaElement.is_text
    • StatementLambdaElement.is_update
    • StatementLambdaElement.spoil()
• Visitor and Traversal Utilities
  • ExternalTraversal
    • ExternalTraversal.chain()
    • ExternalTraversal.iterate()
    • ExternalTraversal.traverse()
    • ExternalTraversal.visitor_iterator
  • InternalTraversal
    • InternalTraversal.dp_annotations_key
    • InternalTraversal.dp_anon_name
    • InternalTraversal.dp_boolean
    • InternalTraversal.dp_clauseelement
    • InternalTraversal.dp_clauseelement_list
    • InternalTraversal.dp_clauseelement_tuple
    • InternalTraversal.dp_clauseelement_tuples
    • InternalTraversal.dp_dialect_options
    • InternalTraversal.dp_dml_multi_values
    • InternalTraversal.dp_dml_ordered_values
    • InternalTraversal.dp_dml_values
    • InternalTraversal.dp_fromclause_canonical_column_collection
    • InternalTraversal.dp_fromclause_ordered_set
    • InternalTraversal.dp_has_cache_key
    • InternalTraversal.dp_has_cache_key_list
    • InternalTraversal.dp_has_cache_key_tuples
    • InternalTraversal.dp_ignore
    • InternalTraversal.dp_inspectable
    • InternalTraversal.dp_inspectable_list
    • InternalTraversal.dp_multi
    • InternalTraversal.dp_multi_list
    • InternalTraversal.dp_named_ddl_element
    • InternalTraversal.dp_operator
    • InternalTraversal.dp_plain_dict
    • InternalTraversal.dp_plain_obj
    • InternalTraversal.dp_prefix_sequence
    • InternalTraversal.dp_propagate_attrs
    • InternalTraversal.dp_statement_hint_list
    • InternalTraversal.dp_string
    • InternalTraversal.dp_string_clauseelement_dict
    • InternalTraversal.dp_string_list
    • InternalTraversal.dp_string_multi_dict
    • InternalTraversal.dp_table_hint_list
    • InternalTraversal.dp_type
    • InternalTraversal.dp_unknown_structure
  • Visitable
  • anon_map
  • cloned_traverse()
  • iterate()
  • replacement_traverse()
  • traverse()
  • traverse_using()