sqlalchemy.sql.functions.Function

func.mypackage.some_function(col1, col2)

Method	__init__	Construct a .Function.
Instance Variable	type	Undocumented
Method	​_bind​_param	Undocumented
Method	​_get​_bind	Undocumented
Class Variable	__visit​_name__	Undocumented
Class Variable	​_traverse​_internals	Undocumented
Instance Variable	​_bind	Undocumented
Instance Variable	name	Undocumented
Instance Variable	packagenames	Undocumented

Inherited from FunctionElement:

Method	alias	Produce a _expression.Alias construct against this .FunctionElement.
Method	as​_comparison	Interpret this expression as a boolean comparison between two values.
Method	column​_valued	Return this _functions.FunctionElement as a column expression that selects from itself as a FROM clause.
Method	execute	Execute this .FunctionElement against an embedded 'bind'.
Method	filter	Produce a FILTER clause against this function.
Method	over	Produce an OVER clause against this function.
Method	scalar	Execute this .FunctionElement against an embedded 'bind' and return a scalar value.
Method	scalar​_table​_valued	Return a column expression that's against this _functions.FunctionElement as a scalar table-valued expression.
Method	select	Produce a _expression.select construct against this .FunctionElement.
Method	self​_group	Apply a 'grouping' to this _expression.ClauseElement.
Method	table​_valued	Return a _sql.TableValuedAlias representation of this _functions.FunctionElement with table-valued expressions added.
Method	within​_group	Produce a WITHIN GROUP (ORDER BY expr) clause against this function.
Method	within​_group​_type	For types that define their return type as based on the criteria within a WITHIN GROUP (ORDER BY) expression, called by the .WithinGroup construct.
Method	​_execute​_on​_connection	Undocumented
Method	clauses	Return the underlying .ClauseList which contains the arguments for this .FunctionElement.
Class Variable	​_non​_anon​_label	Undocumented
Class Variable	​_table​_value​_type	Undocumented
Class Variable	​_with​_ordinality	Undocumented
Instance Variable	​_has​_args	Undocumented
Instance Variable	clause​_expr	Undocumented
Property	​_all​_selected​_columns	A sequence of column expression objects that represents the "selected" columns of this _expression.ReturnsRows.
Property	​_from​_objects	Undocumented
Property	​_proxy​_key	Undocumented
Property	columns	The set of columns exported by this .FunctionElement.
Property	entity​_namespace	overrides FromClause.entity_namespace as functions are generally column expressions and not FromClauses.
Property	exported​_columns	A _expression.ColumnCollection that represents the "exported" columns of this _expression.Selectable.

Inherited from Executable (via FunctionElement):

Method	​_add​_context​_option	Add a context option to this statement.
Method	​_set​_compile​_options	Assign the compile options to a new value.
Method	​_update​_compile​_options	update the _compile_options with new keys.
Method	execution​_options	Set non-SQL options for the statement which take effect during execution.
Method	get​_execution​_options	Get the non-SQL options which will take effect during execution.
Method	options	Apply options to this statement.
Class Variable	​_executable​_traverse​_internals	Undocumented
Class Variable	​_with​_context​_options	Undocumented
Class Variable	​_with​_options	Undocumented
Class Variable	is​_delete	Undocumented
Class Variable	is​_dml	Undocumented
Class Variable	is​_insert	Undocumented
Class Variable	is​_select	Undocumented
Class Variable	is​_text	Undocumented
Class Variable	is​_update	Undocumented
Class Variable	supports​_execution	Undocumented
Instance Variable	​_compile​_options	Undocumented
Instance Variable	​_execution​_options	Undocumented
Property	​_effective​_plugin​_target	Undocumented
Property	bind	Returns the _engine.Engine or _engine.Connection to which this .Executable is bound, or None if none found.

Inherited from StatementRole (via FunctionElement, Executable):

Class Variable	​_propagate​_attrs	Undocumented
Class Variable	​_role​_name	Undocumented

Inherited from SQLRole (via FunctionElement, Executable, StatementRole):

Class Variable	allows​_lambda	Undocumented
Class Variable	uses​_inspection	Undocumented

Inherited from Generative (via FunctionElement, Executable):

Method

​_generate

Undocumented

Inherited from FromClause (via FunctionElement):

Method	is​_derived​_from	Return True if this _expression.FromClause is 'derived' from the given FromClause.
Method	join	Return a _expression.Join from this _expression.FromClause to another FromClause.
Method	outerjoin	No summary
Method	tablesample	Return a TABLESAMPLE alias of this _expression.FromClause.
Class Variable	c	Undocumented
Class Variable	schema	Define the 'schema' attribute for this _expression.FromClause.
Instance Variable	foreign​_keys	Return the collection of _schema.ForeignKey marker objects which this FromClause references.
Instance Variable	primary​_key	Return the iterable collection of _schema.Column objects which comprise the primary key of this _selectable.FromClause.
Method	​_anonymous​_fromclause	Undocumented
Method	​_generate​_fromclause​_column​_proxies	Undocumented
Method	​_init​_collections	Undocumented
Method	​_is​_lexical​_equivalent	Return True if this _expression.FromClause and the other represent the same lexical identity.
Method	​_populate​_column​_collection	Called on subclasses to establish the .c collection.
Method	​_refresh​_for​_new​_column	Given a column added to the .c collection of an underlying selectable, produce the local version of that column, assuming this selectable ultimately should proxy this column.
Method	​_reset​_column​_collection	Reset the attributes linked to the FromClause.c attribute.
Class Variable	​_hide​_froms	Undocumented
Class Variable	​_is​_from​_clause	Undocumented
Class Variable	​_is​_join	Undocumented
Class Variable	​_select​_iterable	Undocumented
Class Variable	​_use​_schema​_map	Undocumented
Class Variable	is​_selectable	Undocumented
Class Variable	named​_with​_column	Undocumented
Instance Variable	​_columns	Undocumented
Property	​_cols​_populated	Undocumented
Property	description	A brief description of this _expression.FromClause.

Inherited from FromClauseRole (via FunctionElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole):

Class Variable	​_is​_subquery	Undocumented
Class Variable	​_role​_name	Undocumented

Inherited from AllowsLambdaRole (via FunctionElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable

allows​_lambda

Undocumented

Inherited from UsesInspection (via FunctionElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole):

Class Variable	​_post​_inspect	Undocumented
Class Variable	uses​_inspection	Undocumented

Inherited from SQLRole (via FunctionElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, ColumnsClauseRole, ColumnListRole):

Class Variable	allows​_lambda	Undocumented
Class Variable	uses​_inspection	Undocumented

Inherited from AllowsLambdaRole (via FunctionElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable

allows​_lambda

Undocumented

Inherited from UsesInspection (via FunctionElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole):

Class Variable	​_post​_inspect	Undocumented
Class Variable	uses​_inspection	Undocumented

Inherited from SQLRole (via FunctionElement, FromClause, AnonymizedFromClauseRole, StrictFromClauseRole, FromClauseRole, JoinTargetRole, StructuralRole):

Class Variable	allows​_lambda	Undocumented
Class Variable	uses​_inspection	Undocumented

Inherited from Selectable (via FunctionElement, FromClause):

Method	corresponding​_column	No summary
Method	lateral	Return a LATERAL alias of this _expression.Selectable.
Method	replace​_selectable	Replace all occurrences of _expression.FromClause 'old' with the given _expression.Alias object, returning a copy of this _expression.FromClause.

Inherited from ReturnsRows (via FunctionElement, FromClause, Selectable):

Class Variable	​_is​_lateral	Undocumented
Class Variable	​_is​_returns​_rows	Undocumented
Class Variable	​_is​_select​_statement	Undocumented
Property	selectable	Undocumented

Inherited from ReturnsRowsRole (via FunctionElement, FromClause, Selectable, ReturnsRows):

Class Variable

​_role​_name

Undocumented

Inherited from SQLRole (via FunctionElement, FromClause, Selectable, ReturnsRows, ReturnsRowsRole):

Class Variable	allows​_lambda	Undocumented
Class Variable	uses​_inspection	Undocumented

Inherited from ClauseElement (via FunctionElement, FromClause, Selectable, ReturnsRows):

Method	compare	Compare this _expression.ClauseElement to the given _expression.ClauseElement.
Method	compile	Compile this SQL expression.
Method	params	Return a copy with _expression.bindparam elements replaced.
Method	unique​_params	Return a copy with _expression.bindparam elements replaced.
Method	__bool__	Undocumented
Method	__getstate__	Undocumented
Method	__invert__	Undocumented
Method	__repr__	Undocumented
Method	__str__	Undocumented
Method	​_clone	Create a shallow copy of this ClauseElement.
Method	​_cloned​_set	Return the set consisting all cloned ancestors of this ClauseElement.
Method	​_compile​_w​_cache	Undocumented
Method	​_compiler	Return a compiler appropriate for this ClauseElement, given a Dialect.
Method	​_negate	Undocumented
Method	​_negate​_in​_binary	a hook to allow the right side of a binary expression to respond to a negation of the binary expression.
Method	​_replace​_params	Undocumented
Method	​_set​_propagate​_attrs	Undocumented
Method	​_ungroup	Return this _expression.ClauseElement without any groupings.
Method	​_with​_binary​_element​_type	in the context of binary expression, convert the type of this object to the one given.
Class Variable	​_cache​_key​_traversal	Undocumented
Class Variable	​_is​_bind​_parameter	Undocumented
Class Variable	​_is​_clause​_list	Undocumented
Class Variable	​_is​_clone​_of	Undocumented
Class Variable	​_is​_from​_container	Undocumented
Class Variable	​_is​_immutable	Undocumented
Class Variable	​_is​_lambda​_element	Undocumented
Class Variable	​_is​_select​_container	Undocumented
Class Variable	​_is​_singleton​_constant	Undocumented
Class Variable	​_is​_text​_clause	Undocumented
Class Variable	​_is​_textual	Undocumented
Class Variable	​_order​_by​_label​_element	Undocumented
Class Variable	bind	Undocumented
Class Variable	is​_clause​_element	Undocumented
Class Variable	stringify​_dialect	Undocumented
Class Variable	supports​_execution	Undocumented
Instance Variable	​_propagate​_attrs	like annotations, however these propagate outwards liberally as SQL constructs are built, and are set up at construction time.
Property	​_constructor	return the 'constructor' for this ClauseElement.

Inherited from SQLRole (via FunctionElement, FromClause, Selectable, ReturnsRows, ClauseElement):

Class Variable	allows​_lambda	Undocumented
Class Variable	uses​_inspection	Undocumented

Inherited from SupportsWrappingAnnotations (via FunctionElement, FromClause, Selectable, ReturnsRows, ClauseElement):

Method	​_annotate	return a copy of this ClauseElement with annotations updated by the given dictionary.
Method	​_deannotate	return a copy of this _expression.ClauseElement with annotations removed.
Method	​_with​_annotations	return a copy of this ClauseElement with annotations replaced by the given dictionary.

Inherited from SupportsAnnotations (via FunctionElement, FromClause, Selectable, ReturnsRows, ClauseElement, SupportsWrappingAnnotations):

Property

​_annotations​_cache​_key

Undocumented

Inherited from MemoizedHasCacheKey (via FunctionElement, FromClause, Selectable, ReturnsRows, ClauseElement):

Method

​_generate​_cache​_key

return a cache key.

Inherited from HasCacheKey (via FunctionElement, FromClause, Selectable, ReturnsRows, ClauseElement, MemoizedHasCacheKey):

Class Variable	inherit​_cache	Indicate if this .HasCacheKey instance should make use of the cache key generation scheme used by its immediate superclass.
Class Method	​_generate​_cache​_attrs	generate cache key dispatcher for a new class.
Class Method	​_generate​_cache​_key​_for​_object	Undocumented
Method	​_gen​_cache​_key	return an optional cache key.
Class Variable	__slots__	Undocumented
Class Variable	​_hierarchy​_supports​_caching	private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses.
Class Variable	​_is​_has​_cache​_key	Undocumented

Inherited from HasCopyInternals (via FunctionElement, FromClause, Selectable, ReturnsRows, ClauseElement):

Method

​_copy​_internals

Reassign internal elements to be clones of themselves.

Inherited from Traversible (via FunctionElement, FromClause, Selectable, ReturnsRows, ClauseElement):

Method	get​_children	Return immediate child .visitors.Traversible elements of this .visitors.Traversible.
Method	__class​_getitem__	Undocumented

Inherited from Generative (via FunctionElement):

Method

​_generate

Undocumented