SQL Statements and Expressions API

このセクションでは、SQL式言語のAPIリファレンスを紹介します。概要については、 SQLAlchemy Unified Tutorial の Working with Data から始めてください。

• 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
    • 空のIN式
    • NOT IN
    • タプルのIN式
    • Subquery IN
  • Identity Comparisons
  • String Comparisons
  • String Containment
  • String matching
  • String Alteration
  • Arithmetic Operators
  • Bitwise Operators
  • Using Conjunctions and Negations
  • Conjunction Operators
• 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
    • Alias.inherit_cache
  • AliasedReturnsRows
    • AliasedReturnsRows.description
    • AliasedReturnsRows.is_derived_from()
    • AliasedReturnsRows.original
  • CompoundSelect
    • CompoundSelect.add_cte()
    • CompoundSelect.alias()
    • CompoundSelect.as_scalar()
    • CompoundSelect.c
    • CompoundSelect.corresponding_column()
    • CompoundSelect.cte()
    • CompoundSelect.execution_options()
    • CompoundSelect.exists()
    • CompoundSelect.exported_columns
    • CompoundSelect.fetch()
    • CompoundSelect.get_execution_options()
    • CompoundSelect.get_label_style()
    • CompoundSelect.group_by()
    • CompoundSelect.is_derived_from()
    • CompoundSelect.label()
    • CompoundSelect.lateral()
    • CompoundSelect.limit()
    • CompoundSelect.offset()
    • CompoundSelect.options()
    • CompoundSelect.order_by()
    • CompoundSelect.replace_selectable()
    • CompoundSelect.scalar_subquery()
    • CompoundSelect.select()
    • CompoundSelect.selected_columns
    • CompoundSelect.self_group()
    • CompoundSelect.set_label_style()
    • CompoundSelect.slice()
    • CompoundSelect.subquery()
    • CompoundSelect.with_for_update()
  • CTE
    • CTE.alias()
    • CTE.union()
    • CTE.union_all()
  • Executable
    • Executable.execution_options()
    • Executable.get_execution_options()
    • Executable.options()
  • Exists
    • Exists.correlate()
    • Exists.correlate_except()
    • Exists.inherit_cache
    • Exists.select()
    • Exists.select_from()
    • Exists.where()
  • FromClause
    • FromClause.alias()
    • FromClause.c
    • FromClause.columns
    • FromClause.description
    • FromClause.entity_namespace
    • FromClause.exported_columns
    • FromClause.foreign_keys
    • FromClause.is_derived_from()
    • FromClause.join()
    • FromClause.outerjoin()
    • FromClause.primary_key
    • FromClause.schema
    • FromClause.select()
    • FromClause.tablesample()
  • GenerativeSelect
    • GenerativeSelect.fetch()
    • GenerativeSelect.get_label_style()
    • GenerativeSelect.group_by()
    • GenerativeSelect.limit()
    • GenerativeSelect.offset()
    • GenerativeSelect.order_by()
    • GenerativeSelect.set_label_style()
    • GenerativeSelect.slice()
    • GenerativeSelect.with_for_update()
  • HasCTE
    • HasCTE.add_cte()
    • HasCTE.cte()
  • HasPrefixes
    • HasPrefixes.prefix_with()
  • HasSuffixes
    • HasSuffixes.suffix_with()
  • Join
    • Join.__init__()
    • Join.description
    • Join.is_derived_from()
    • Join.select()
    • Join.self_group()
  • Lateral
    • Lateral.inherit_cache
  • ReturnsRows
    • ReturnsRows.exported_columns
    • ReturnsRows.is_derived_from()
  • ScalarSelect
    • ScalarSelect.correlate()
    • ScalarSelect.correlate_except()
    • ScalarSelect.inherit_cache
    • ScalarSelect.self_group()
    • ScalarSelect.where()
  • Select
    • Select.__init__()
    • Select.add_columns()
    • Select.add_cte()
    • Select.alias()
    • Select.as_scalar()
    • Select.c
    • Select.column()
    • Select.column_descriptions
    • Select.columns_clause_froms
    • Select.correlate()
    • Select.correlate_except()
    • Select.corresponding_column()
    • Select.cte()
    • Select.distinct()
    • Select.except_()
    • Select.except_all()
    • Select.execution_options()
    • Select.exists()
    • Select.exported_columns
    • Select.fetch()
    • Select.filter()
    • Select.filter_by()
    • Select.from_statement()
    • Select.froms
    • Select.get_children()
    • Select.get_execution_options()
    • Select.get_final_froms()
    • Select.get_label_style()
    • Select.group_by()
    • Select.having()
    • Select.inherit_cache
    • Select.inner_columns
    • Select.intersect()
    • Select.intersect_all()
    • Select.is_derived_from()
    • Select.join()
    • Select.join_from()
    • Select.label()
    • Select.lateral()
    • Select.limit()
    • Select.offset()
    • Select.options()
    • Select.order_by()
    • Select.outerjoin()
    • Select.outerjoin_from()
    • Select.prefix_with()
    • Select.reduce_columns()
    • Select.replace_selectable()
    • Select.scalar_subquery()
    • Select.select()
    • Select.select_from()
    • Select.selected_columns
    • Select.self_group()
    • Select.set_label_style()
    • Select.slice()
    • Select.subquery()
    • Select.suffix_with()
    • Select.union()
    • Select.union_all()
    • Select.where()
    • Select.whereclause
    • Select.with_for_update()
    • Select.with_hint()
    • Select.with_only_columns()
    • Select.with_statement_hint()
  • Selectable
    • Selectable.corresponding_column()
    • Selectable.exported_columns
    • Selectable.inherit_cache
    • Selectable.is_derived_from()
    • Selectable.lateral()
    • Selectable.replace_selectable()
  • SelectBase
    • SelectBase.add_cte()
    • SelectBase.alias()
    • SelectBase.as_scalar()
    • SelectBase.c
    • SelectBase.corresponding_column()
    • SelectBase.cte()
    • SelectBase.exists()
    • SelectBase.exported_columns
    • SelectBase.get_label_style()
    • SelectBase.inherit_cache
    • SelectBase.is_derived_from()
    • SelectBase.label()
    • SelectBase.lateral()
    • SelectBase.replace_selectable()
    • SelectBase.scalar_subquery()
    • SelectBase.select()
    • SelectBase.selected_columns
    • SelectBase.set_label_style()
    • SelectBase.subquery()
  • Subquery
    • Subquery.as_scalar()
    • Subquery.inherit_cache
  • TableClause
    • TableClause.alias()
    • TableClause.c
    • TableClause.columns
    • TableClause.compare()
    • TableClause.compile()
    • TableClause.corresponding_column()
    • TableClause.delete()
    • TableClause.description
    • TableClause.entity_namespace
    • TableClause.exported_columns
    • TableClause.foreign_keys
    • TableClause.get_children()
    • TableClause.implicit_returning
    • TableClause.inherit_cache
    • TableClause.insert()
    • TableClause.is_derived_from()
    • TableClause.join()
    • TableClause.lateral()
    • TableClause.outerjoin()
    • TableClause.params()
    • TableClause.primary_key
    • TableClause.replace_selectable()
    • TableClause.schema
    • TableClause.select()
    • TableClause.self_group()
    • TableClause.table_valued()
    • TableClause.tablesample()
    • TableClause.unique_params()
    • TableClause.update()
  • TableSample
  • TableValuedAlias
    • TableValuedAlias.alias()
    • TableValuedAlias.column
    • TableValuedAlias.lateral()
    • TableValuedAlias.render_derived()
  • TextualSelect
    • TextualSelect.add_cte()
    • TextualSelect.alias()
    • TextualSelect.as_scalar()
    • TextualSelect.c
    • TextualSelect.compare()
    • TextualSelect.compile()
    • TextualSelect.corresponding_column()
    • TextualSelect.cte()
    • TextualSelect.execution_options()
    • TextualSelect.exists()
    • TextualSelect.exported_columns
    • TextualSelect.get_children()
    • TextualSelect.get_execution_options()
    • TextualSelect.get_label_style()
    • TextualSelect.inherit_cache
    • TextualSelect.is_derived_from()
    • TextualSelect.label()
    • TextualSelect.lateral()
    • TextualSelect.options()
    • TextualSelect.params()
    • TextualSelect.replace_selectable()
    • TextualSelect.scalar_subquery()
    • TextualSelect.select()
    • TextualSelect.selected_columns
    • TextualSelect.self_group()
    • TextualSelect.set_label_style()
    • TextualSelect.subquery()
    • TextualSelect.unique_params()
  • Values
    • Values.alias()
    • Values.data()
    • Values.lateral()
    • Values.scalar_values()
  • ScalarValues
• Label Style Constants
  • SelectLabelStyle
    • SelectLabelStyle.LABEL_STYLE_DEFAULT
    • SelectLabelStyle.LABEL_STYLE_DISAMBIGUATE_ONLY
    • SelectLabelStyle.LABEL_STYLE_NONE
    • SelectLabelStyle.LABEL_STYLE_TABLENAME_PLUS_COL
• DML Foundational Constructors
  • delete()
  • insert()
  • update()
• DML Class Documentation Constructors
  • Delete
    • Delete.where()
    • Delete.returning()
  • Insert
    • Insert.values()
    • Insert.returning()
    • Insert.from_select()
    • Insert.inline()
    • Insert.select
  • Update
    • Update.returning()
    • Update.where()
    • Update.values()
    • Update.inline()
    • Update.ordered_values()
  • UpdateBase
    • UpdateBase.entity_description
    • UpdateBase.exported_columns
    • UpdateBase.params()
    • UpdateBase.return_defaults()
    • UpdateBase.returning()
    • UpdateBase.returning_column_descriptions
    • UpdateBase.with_dialect_options()
    • UpdateBase.with_hint()
  • ValuesBase
    • ValuesBase.select
    • ValuesBase.values()
• 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
    • Deserializer.get_engine()
    • Deserializer.persistent_load()
  • Serializer
    • Serializer.persistent_id()
  • 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()