snowpark-python API reference

246 public APIs from snowpark-python (snowflakedb/snowpark-python) — 79 classes, 78 functions, 89 methods. Signatures extracted by static analysis of the actual source.

Repository: snowflakedb/snowpark-python

Kind	Count
Classes	79
Functions	78
Methods	89

API list

funcsrc.snowflake.snowpark._functions.scalar_functions.as_boolean(variant:ColumnOrName, _emit_ast:bool=True) -> Column

Casts a VARIANT value to a boolean.

funcsrc.snowflake.snowpark._functions.scalar_functions.cot(expr:ColumnOrName, _emit_ast:bool=True) -> Column

Computes the cotangent of the input column.

func

src.snowflake.snowpark._functions.scalar_functions.h3_get_resolution(cell_id:ColumnOrName, _emit_ast:bool=True) -> Column

Returns the resolution of an H3 cell ID.

funcsrc.snowflake.snowpark._functions.scalar_functions.h3_is_valid_cell(cell_id:ColumnOrName, _emit_ast:bool=True) -> Column

Checks if the given H3 cell ID is valid.

func

src.snowflake.snowpark._functions.scalar_functions.hex_decode_binary(input_expr:ColumnOrName, _emit_ast:bool=True) -> Column

Decodes a hex-encoded string to binary data.

funcsrc.snowflake.snowpark._functions.scalar_functions.localtime(_emit_ast:bool=True) -> Column

Returns the current time for the system.

funcsrc.snowflake.snowpark._functions.scalar_functions.map_size(map_col:ColumnOrName, _emit_ast:bool=True) -> Column

Returns the size of the input MAP.

func

src.snowflake.snowpark._functions.scalar_functions.mod(expr1:ColumnOrName, expr2:ColumnOrName, _emit_ast:bool=True) -> Column

Returns the remainder of expr1 divided by expr2.

funcsrc.snowflake.snowpark._functions.scalar_functions.space(n:ColumnOrName, _emit_ast:bool=True) -> Column

Returns a string consisting of n space characters.

func

src.snowflake.snowpark._functions.scalar_functions.st_pointn(geography_or_geometry_expression:ColumnOrName, index:ColumnOrName, _emit_ast:bool=True) -> Column

Returns the Nth point in a LINESTRING.

funcsrc.snowflake.snowpark._functions.scalar_functions.systimestamp(_emit_ast:bool=True) -> Column

Returns the current timestamp for the system.

func

src.snowflake.snowpark._functions.scalar_functions.try_hex_decode_binary(input_expr:ColumnOrName, _emit_ast:bool=True) -> Column

Decodes a hex-encoded string to binary data.

classsrc.snowflake.snowpark._internal.analyzer.select_statement.ColumnStateDict

Store the column states of all columns.

classsrc.snowflake.snowpark._internal.analyzer.select_statement.SelectSQL

Query from a SQL.

method

src.snowflake.snowpark._internal.analyzer.select_statement.SelectStatement.select(cols:List[Expression]) -> 'SelectStatement'

Build a new query.

methodsrc.snowflake.snowpark._internal.analyzer.select_statement.Selectable.add_df_ast_id(ast_id:int) -> None

Method to add a df ast id to the selectable.

methodsrc.snowflake.snowpark._internal.analyzer.select_statement.Selectable.uuid() -> str

Returns the UUID for this Selectable plan.

classsrc.snowflake.snowpark._internal.ast.batch.AstBatch

A batch of AST statements.

methodsrc.snowflake.snowpark._internal.ast.batch.AstBatch.bind(symbol:Optional[str]=None) -> proto.Bind

Creates a new Bind statement.

methodsrc.snowflake.snowpark._internal.ast.batch.AstBatch.flush(target:Optional[proto.Bind]=None) -> SerializedBatch

Ties off a batch and starts a new one.

funcsrc.snowflake.snowpark._internal.ast.utils.ClearTempTables(message:proto.Request) -> None

Removes temp table when passing pandas data.

funcsrc.snowflake.snowpark._internal.ast.utils.clear_line_no_in_ast(ast:Any) -> None

Clear any 'src' information in the statement body.

func

src.snowflake.snowpark._internal.ast.utils.create_ast_for_column(name1:str, name2:Optional[str], fn_name=None) -> proto.Expr

Helper function to create Ast for Snowpark Column.

funcsrc.snowflake.snowpark._internal.ast.utils.debug_check_missing_ast(ast, session, container) -> None

Debug check for missing AST.

funcsrc.snowflake.snowpark._internal.ast.utils.set_builtin_fn_alias(ast:proto.Expr, alias:str) -> None

Set the alias for a builtin function call.

funcsrc.snowflake.snowpark._internal.ast.utils.snowpark_expression_to_ast(expr:Expression) -> proto.Expr

Converts Snowpark expression expr to protobuf ast.

funcsrc.snowflake.snowpark._internal.code_generation.get_lambda_code_text(code_text:str) -> str

Extract the lambda expression from code text.

funcsrc.snowflake.snowpark._internal.code_generation.is_lambda(func:FunctionType) -> bool

Check whether the target function is a lambda function.

funcsrc.snowflake.snowpark._internal.compiler.cte_utils.encode_node_id_with_query(node:'TreeNode') -> str

Encode a for the given TreeNode.

funcsrc.snowflake.snowpark._internal.compiler.cte_utils.is_select_from_file_node(node:'TreeNode') -> bool

Check if the current node is a SelectFromFileNode.

funcsrc.snowflake.snowpark._internal.data_source.utils.get_jdbc_dbms(jdbc_url:str) -> str

Extract the DBMS name from a JDBC connection URL.

funcsrc.snowflake.snowpark._internal.packaging_utils.get_signature(packages:List[str]) -> str

Create unique signature for a list of package names.

funcsrc.snowflake.snowpark._internal.type_utils.extract_bracket_content(type_str:str, keyword:str) -> str

Given a string that starts with e.g.

funcsrc.snowflake.snowpark._internal.type_utils.infer_type(obj:Any) -> DataType

Infer the DataType from obj

funcsrc.snowflake.snowpark._internal.type_utils.int_size_to_type(size:int) -> Type[DataType]

Return the Catalyst datatype from the size of integers.

funcsrc.snowflake.snowpark._internal.type_utils.is_likely_struct(s:str) -> bool

Return True if there's a top-level colon, comma, or space.

classsrc.snowflake.snowpark._internal.utils.TimeTravelConfig

Configuration for time travel operations.

methodsrc.snowflake.snowpark._internal.utils.TimeTravelConfig.generate_sql_clause() -> str

Generates the time travel SQL clause.

funcsrc.snowflake.snowpark._internal.utils.get_udf_upload_prefix(udf_name:str) -> str

Get the valid stage prefix when uploading a UDF.

funcsrc.snowflake.snowpark._internal.utils.is_ast_enabled() -> bool

Gets the value of the ast_enabled feature flag.

funcsrc.snowflake.snowpark._internal.utils.parse_positional_args_to_list(*inputs:Any) -> List

Convert the positional arguments to a list.

funcsrc.snowflake.snowpark._internal.utils.random_number() -> int

Get a random unsigned integer.

funcsrc.snowflake.snowpark._internal.utils.remove_comments(sql_query:str, uuids:List[str]) -> str

Removes comments associated with child uuids in a query

funcsrc.snowflake.snowpark._internal.utils.set_ast_state(source:AstFlagSource, enabled:bool) -> None

Sets the value of the ast_enabled feature flag.

funcsrc.snowflake.snowpark._internal.utils.split_path(path:str) -> Tuple[str, str]

Split a file path into directory and file name.

funcsrc.snowflake.snowpark._internal.xml_reader.get_text(element:ET.Element) -> Optional[str]

Do not strip the text

methodsrc.snowflake.snowpark.async_job.AsyncJob.cancel() -> None

Cancels the query associated with this instance.

methodsrc.snowflake.snowpark.async_job.AsyncJob.query() -> Optional[str]

The SQL text of of the executed query.

methodsrc.snowflake.snowpark.async_job.AsyncJob.status() -> str

Returns the current query status as a string.

methodsrc.snowflake.snowpark.catalog.Catalog.database_exists(database:Union[str, Database]) -> bool

Check if the given database exists.

methodsrc.snowflake.snowpark.catalog.Catalog.drop_database(database:Union[str, Database]) -> None

Drop the given database.

method

src.snowflake.snowpark.catalog.Catalog.drop_schema(schema:Union[str, Schema], *database:Optional[Union[str, Database]]=None) -> None

Drop the given schema in the given database.

methodsrc.snowflake.snowpark.catalog.Catalog.get_current_database() -> Optional[str]

Get the current database.

methodsrc.snowflake.snowpark.catalog.Catalog.get_current_schema() -> Optional[str]

Get the current schema.

methodsrc.snowflake.snowpark.catalog.Catalog.get_database(database:str) -> Database

Name of the database to get

methodsrc.snowflake.snowpark.catalog.Catalog.get_schema(schema:str, *database:Optional[Union[str, Database]]=None) -> Schema

Name of the schema to get.

method

src.snowflake.snowpark.catalog.Catalog.list_databases(*pattern:Optional[str]=None, *like:Optional[str]=None) -> List[Database]

List databases in the current session.

method

src.snowflake.snowpark.catalog.Catalog.list_schemas(*database:Optional[Union[str, Database]]=None, *pattern:Optional[str]=None, *like:Optional[str]=None) -> List[Schema]

List schemas in the current session.

methodsrc.snowflake.snowpark.catalog.Catalog.set_current_database(database:Union[str, Database]) -> None

Set the current default database for the session.

methodsrc.snowflake.snowpark.catalog.Catalog.set_current_schema(schema:Union[str, Schema]) -> None

Set the current default schema for the session.

classsrc.snowflake.snowpark.column.Column

Represents a column or an expression in a :class:`DataFrame`.

methodsrc.snowflake.snowpark.column.Column.alias(alias:str, _emit_ast:bool=True) -> 'Column'

Returns a new renamed Column.

methodsrc.snowflake.snowpark.column.Column.as_(alias:str, _emit_ast:bool=True) -> 'Column'

Returns a new renamed Column.

method

src.snowflake.snowpark.column.Column.between(lower_bound:Union[ColumnOrLiteral, Expression], upper_bound:Union[ColumnOrLiteral, Expression], _emit_ast:bool=True) -> 'Column'

Between lower bound and upper bound.

methodsrc.snowflake.snowpark.column.Column.bitand(other:Union[ColumnOrLiteral, Expression], _emit_ast:bool=True) -> 'Column'

Bitwise and.

methodsrc.snowflake.snowpark.column.Column.bitor(other:Union[ColumnOrLiteral, Expression], _emit_ast:bool=True) -> 'Column'

Bitwise or.

methodsrc.snowflake.snowpark.column.Column.bitxor(other:Union[ColumnOrLiteral, Expression], _emit_ast:bool=True) -> 'Column'

Bitwise xor.

methodsrc.snowflake.snowpark.column.Column.contains(string:ColumnOrName, _emit_ast:bool=True) -> 'Column'

Returns true if the column contains `string` for each row.

methodsrc.snowflake.snowpark.column.Column.endswith(other:ColumnOrLiteralStr, _emit_ast:bool=True) -> 'Column'

Returns true if this Column ends with another string.

methodsrc.snowflake.snowpark.column.Column.equal_nan(_emit_ast:bool=True) -> 'Column'

Is NaN.

methodsrc.snowflake.snowpark.column.Column.equal_null(other:'Column', _emit_ast:bool=True) -> 'Column'

Equal to.

methodsrc.snowflake.snowpark.column.Column.is_not_null(_emit_ast:bool=True) -> 'Column'

Is not null.

methodsrc.snowflake.snowpark.column.Column.is_null(_emit_ast:bool=True) -> 'Column'

Is null.

method

src.snowflake.snowpark.column.Column.name(alias:str, variant:typing.Literal['as_', 'alias', 'name']='name', _emit_ast:bool=True) -> 'Column'

Returns a new renamed Column.

methodsrc.snowflake.snowpark.column.Column.startswith(other:ColumnOrLiteralStr, _emit_ast:bool=True) -> 'Column'

Returns true if this Column starts with another string.

method

src.snowflake.snowpark.column.Column.substr(start_pos:Union['Column', int], length:Union['Column', int], _emit_ast:bool=True) -> 'Column'

Returns a substring of this string column.

method

src.snowflake.snowpark.dataframe.DataFrame.agg(*_emit_ast:bool=True, *exprs:Union[Column, Tuple[ColumnOrName, str], Dict[str, str]]) -> 'DataFrame'

Aggregate the data in the DataFrame.

methodsrc.snowflake.snowpark.dataframe.DataFrame.col(col_name:str, _emit_ast:bool=True) -> Column

Returns a reference to a column in the DataFrame.

methodsrc.snowflake.snowpark.dataframe.DataFrame.columns() -> List[str]

Returns all column names as a list.

method

src.snowflake.snowpark.dataframe.DataFrame.get_execution_profile(output_file:Optional[str]=None, verbose:bool=False) -> None

Get the execution profile of the dataframe.

methodsrc.snowflake.snowpark.dataframe.DataFrame.print_schema(level:Optional[int]=None) -> None

Prints the schema of a dataframe in tree format.

classsrc.snowflake.snowpark.exceptions.SnowparkClientException

Base Snowpark exception class

classsrc.snowflake.snowpark.exceptions.SnowparkDataframeException

Exception for dataframe related errors.

classsrc.snowflake.snowpark.exceptions.SnowparkDataframeReaderException

Exception for dataframe reader errors.

classsrc.snowflake.snowpark.exceptions.SnowparkGeneralException

Exception for general exceptions.

classsrc.snowflake.snowpark.exceptions.SnowparkPandasException

Exception for pandas related errors.

classsrc.snowflake.snowpark.exceptions.SnowparkPlanException

Exception for plan analysis errors.

classsrc.snowflake.snowpark.exceptions.SnowparkServerException

Exception for miscellaneous related errors.

classsrc.snowflake.snowpark.exceptions.SnowparkSessionException

Exception for any session related errors.

classsrc.snowflake.snowpark.exceptions.SnowparkTableException

Exception for table related errors.

classsrc.snowflake.snowpark.file_operation.FileOperation

Provides methods for working on files in a stage.

method

src.snowflake.snowpark.file_operation.FileOperation.list(stage_location:str, *pattern:Optional[str]=None, *statement_params:Optional[Dict[str, str]]=None) -> List[ListResult]

Returns a list of files from a stage.

method

src.snowflake.snowpark.file_operation.FileOperation.remove(stage_location:str, *pattern:Optional[str]=None, *statement_params:Optional[Dict[str, str]]=None) -> List[str]

Removes files from a stage.

classsrc.snowflake.snowpark.lineage.LineageDirection

Directions for tracing the lineage.

func

src.snowflake.snowpark.mock._plan.compare_intervals(lower:Optional[Union[Interval, int]], upper:Optional[Union[Interval, int]]) -> bool

Returns true if lower >= upper.

funcsrc.snowflake.snowpark.mock._plan.negate_interval(interval:Interval) -> Interval

Negates each value in an interval.

classsrc.snowflake.snowpark.mock._select_statement.MockSelectStatement

The main logic plan to be used by a DataFrame.

methodsrc.snowflake.snowpark.mock._select_statement.MockSelectStatement.select(cols:List[Expression]) -> 'SelectStatement'

Build a new query.

funcsrc.snowflake.snowpark.modin.config.__main__.export_config_help(filename:str) -> None

Export all configs help messages to the CSV file.

funcsrc.snowflake.snowpark.modin.config.__main__.print_config_help() -> None

Print configs help messages.

classsrc.snowflake.snowpark.modin.config.envvars.DaskThreadsPerWorker

Number of threads per Dask worker.

classsrc.snowflake.snowpark.modin.config.envvars.DoUseCalcite

Whether to use Calcite for HDK queries execution.

classsrc.snowflake.snowpark.modin.config.envvars.Engine

Distribution engine to run queries by.

classsrc.snowflake.snowpark.modin.config.envvars.EnvironmentVariable

Base class for environment variables-based configuration.

classsrc.snowflake.snowpark.modin.config.envvars.GithubCI

Set to true when running Modin in GitHub CI.

classsrc.snowflake.snowpark.modin.config.envvars.IsExperimental

Whether to Turn on experimental features.

classsrc.snowflake.snowpark.modin.config.envvars.LazyExecution

Lazy execution mode.

classsrc.snowflake.snowpark.modin.config.envvars.LogFileSize

Max size of logs (in MBs) to store per Modin job.

methodsrc.snowflake.snowpark.modin.config.envvars.LogFileSize.get() -> int

Get ``LogFileSize`` with extra checks.

methodsrc.snowflake.snowpark.modin.config.envvars.LogFileSize.put(value:int) -> None

Set ``LogFileSize`` with extra checks.

classsrc.snowflake.snowpark.modin.config.envvars.LogMode

Set ``LogMode`` value if users want to opt-in.

methodsrc.snowflake.snowpark.modin.config.envvars.LogMode.disable() -> None

Disable logging feature.

methodsrc.snowflake.snowpark.modin.config.envvars.LogMode.enable() -> None

Enable all logging levels.

methodsrc.snowflake.snowpark.modin.config.envvars.LogMode.enable_api_only() -> None

Enable API level logging.

classsrc.snowflake.snowpark.modin.config.envvars.PersistentPickle

Whether serialization should be persistent.

classsrc.snowflake.snowpark.modin.config.envvars.ProgressBar

Whether or not to show the progress bar.

methodsrc.snowflake.snowpark.modin.config.envvars.ProgressBar.disable() -> None

Disable ``ProgressBar`` feature.

methodsrc.snowflake.snowpark.modin.config.envvars.ProgressBar.enable() -> None

Enable ``ProgressBar`` feature.

classsrc.snowflake.snowpark.modin.config.envvars.RayRedisPassword

What password to use for connecting to Redis.

classsrc.snowflake.snowpark.modin.config.envvars.ReadSqlEngine

Engine to run `read_sql`.

classsrc.snowflake.snowpark.modin.config.envvars.StorageFormat

Engine to run on a single node of distribution.

classsrc.snowflake.snowpark.modin.config.envvars.TestDatasetSize

Dataset size for running some tests.

classsrc.snowflake.snowpark.modin.config.envvars.TestReadFromPostgres

Set to true to test reading from Postgres.

classsrc.snowflake.snowpark.modin.config.envvars.TestReadFromSqlServer

Set to true to test reading from SQL server.

classsrc.snowflake.snowpark.modin.config.pubsub.DeprecationDescriptor

Describe deprecated parameter.

classsrc.snowflake.snowpark.modin.config.pubsub.Parameter

Base class describing interface for configuration entities.

methodsrc.snowflake.snowpark.modin.config.pubsub.Parameter.add_option(choice:Any) -> Any

Add a new choice for the parameter.

methodsrc.snowflake.snowpark.modin.config.pubsub.Parameter.get() -> Any

Get config value.

methodsrc.snowflake.snowpark.modin.config.pubsub.Parameter.get_help() -> str

Generate user-presentable help for the option.

methodsrc.snowflake.snowpark.modin.config.pubsub.Parameter.get_value_source() -> ValueSource

Get value source of the config.

methodsrc.snowflake.snowpark.modin.config.pubsub.Parameter.put(value:Any) -> None

Set config value.

methodsrc.snowflake.snowpark.modin.config.pubsub.Parameter.subscribe(callback:Callable) -> None

Add `callback` to the `_subs` list and then execute it.

classsrc.snowflake.snowpark.modin.config.pubsub.TypeDescriptor

Class for config data manipulating of exact type.

func

src.snowflake.snowpark.modin.plugin._internal.align_utils.align_axis_0_left(frame:InternalFrame, other_frame:InternalFrame, join:str, dummy_row_pos_mode:bool) -> InternalFrame

Gets the left align results.

func

src.snowflake.snowpark.modin.plugin._internal.align_utils.align_axis_0_right(frame:InternalFrame, other_frame:InternalFrame, join:str, dummy_row_pos_mode:bool) -> InternalFrame

Gets the right align results.

funcsrc.snowflake.snowpark.modin.plugin._internal.apply_utils.clear_session_udf_and_udtf_caches() -> None

Clear all cached UDF and UDTFs.

funcsrc.snowflake.snowpark.modin.plugin._internal.binary_op_utils.BinaryOp.snake_to_camel(snake_str:str) -> str

Converts a snake case string to camel case.

func

src.snowflake.snowpark.modin.plugin._internal.cut_utils.compute_bin_indices(values_frame:InternalFrame, cuts_frame:InternalFrame, n_cuts:int, dummy_row_pos_mode:bool, right:bool=True) -> InternalFrame

Given a frame of cuts, i.e.

classsrc.snowflake.snowpark.modin.plugin._internal.indexing_utils.LocSetColInfo

Loc setitem information context for columns

funcsrc.snowflake.snowpark.modin.plugin._internal.io_utils.get_non_pandas_kwargs(kwargs:Any) -> Any

Returns a new dict without pandas keyword arguments.

funcsrc.snowflake.snowpark.modin.plugin._internal.io_utils.is_local_filepath(filepath:str) -> bool

Returns whether a filepath is local.

methodsrc.snowflake.snowpark.modin.plugin._internal.snowpark_pandas_types.SnowparkPandasType.type_match(value:Any) -> bool

Return True if the value's type matches self.

funcsrc.snowflake.snowpark.modin.plugin._internal.telemetry.error_to_telemetry_type(e:Exception) -> str

Convert Error to Telemetry Type string Ex.

func

src.snowflake.snowpark.modin.plugin._internal.telemetry.try_add_telemetry_to_attribute(attr_name:str, attr_value:Any) -> Any

Attempts to add telemetry to an attribute.

funcsrc.snowflake.snowpark.modin.plugin._internal.timestamp_utils.is_snowflake_timestamp_format_valid(sf_format:str) -> bool

Check if a timestamp format valid.

func

src.snowflake.snowpark.modin.plugin._internal.timestamp_utils.tz_localize_column(column:Column, tz:Union[str, dt.tzinfo]) -> Column

Localize tz-naive to tz-aware.

funcsrc.snowflake.snowpark.modin.plugin._internal.type_utils.infer_object_type(obj:Any) -> DataType

Infer the snowpark DataType from obj

funcsrc.snowflake.snowpark.modin.plugin._internal.utils.count_rows(df:OrderedDataFrame) -> int

Returns the number of rows of a Snowpark DataFrame.

func

src.snowflake.snowpark.modin.plugin._internal.utils.handle_if_exists_for_to_snowflake(if_exists:str, name:Union[str, Iterable[str]]) -> None

Handle if_exists for to_snowflake.

funcsrc.snowflake.snowpark.modin.plugin._internal.utils.pandas_lit(value:Any, datatype:Optional[DataType]=None) -> Column

Returns a Snowpark column for a literal value.

funcsrc.snowflake.snowpark.modin.plugin._internal.utils.rindex(lst:list, value:int) -> int

Find the last index in the list of item value.

funcsrc.snowflake.snowpark.modin.plugin._internal.utils.try_convert_to_simple_slice(s:Any) -> Optional[slice]

Try converting to simple slice.

classsrc.snowflake.snowpark.modin.plugin._internal.window_utils.WindowFunction

Type of window function.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.dataframe.DataFrame.dropna()

Remove missing values.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.dataframe.DataFrame.isna()

Detect missing values.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.datetime_index.DatetimeIndex.normalize()

Convert times to midnight.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.datetime_index.DatetimeIndex.tz()

Return the timezone.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.index.Index.append()

Append a collection of Index options together.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.index.Index.array()

return the array of values

methodsrc.snowflake.snowpark.modin.plugin.docstrings.index.Index.isna()

Detect missing values.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.index.Index.name()

Get the index name.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.index.Index.nlevels()

Number of levels.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.index.Index.set_names()

Set Index name.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.series.Series.isna()

Detect missing values.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.series.Series.keys()

Return alias for index.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.series.Series.plot()

Make plot of Series.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.series.Series.sort_values()

Sort by the values.

methodsrc.snowflake.snowpark.modin.plugin.docstrings.series_utils.StringMethods.len()

Get the length of a string.

funcsrc.snowflake.snowpark.modin.plugin.extensions.indexing_overrides.boolean_mask_to_numeric(indexer:Any) -> np.ndarray

Convert boolean mask to numeric indices.

funcsrc.snowflake.snowpark.modin.plugin.extensions.indexing_overrides.is_2d_array(x:Any) -> bool

Check that argument is a 2D array.

funcsrc.snowflake.snowpark.modin.plugin.extensions.indexing_overrides.is_boolean_array(x:Any) -> bool

Check that argument is an array of bool.

funcsrc.snowflake.snowpark.modin.plugin.extensions.indexing_overrides.is_range_like(obj:Any) -> bool

Check if the object is range-like.

func

src.snowflake.snowpark.modin.plugin.extensions.series_overrides.memory_usage(self, index:bool=True, deep:bool=False) -> int

Return zero bytes for memory_usage

funcsrc.snowflake.snowpark.modin.plugin.extensions.series_overrides.to_list(self) -> list

Return a list of the values.

funcsrc.snowflake.snowpark.modin.plugin.extensions.series_overrides.unique(self) -> ArrayLike

Return unique values of Series object.

funcsrc.snowflake.snowpark.modin.plugin.extensions.utils.add_cache_result_docstring(func:Fn) -> Fn

Decorator to add docstring to cache_result method.

classsrc.snowflake.snowpark.modin.plugin.utils.exceptions.SnowparkPandasException

Base Snowpark pandas exception class.

funcsrc.snowflake.snowpark.modin.utils.align_indents(source:str, target:str) -> str

Align indents of two strings.

funcsrc.snowflake.snowpark.modin.utils.extract_sections(text:str) -> list[dict[str, str]]

split docstring into sections.

funcsrc.snowflake.snowpark.modin.utils.hashable(obj:bool) -> bool

Return whether the `obj` is hashable.

funcsrc.snowflake.snowpark.modin.utils.import_optional_dependency(name:str, message:str) -> types.ModuleType

Import an optional dependecy.

funcsrc.snowflake.snowpark.modin.utils.instancer(_class:Callable[[], T]) -> T

Create a dummy instance each time this is imported.

funcsrc.snowflake.snowpark.modin.utils.is_property(key:Any) -> bool

Check whether `key` is a property.

funcsrc.snowflake.snowpark.modin.utils.translate_pandas_default(arg:Any) -> Any

Returns None if `arg` is no_default, otherwise `arg`.

funcsrc.snowflake.snowpark.modin.utils.wrap_into_list(*skipna:bool=True, *args:Any) -> list[Any]

Wrap a sequence of passed values in a flattened list.

classsrc.snowflake.snowpark.row.Row

Represents a row in :class:`DataFrame`.

methodsrc.snowflake.snowpark.row.Row.as_dict(recursive:bool=False) -> Dict

Convert to a dict if this row object has both keys and values.

funcsrc.snowflake.snowpark.secrets.get_cloud_provider_token(secret_name:str) -> CloudProviderToken

Get a cloud provider token secret from Snowflake.

funcsrc.snowflake.snowpark.secrets.get_generic_secret_string(secret_name:str) -> str

Get a generic token string from Snowflake.

funcsrc.snowflake.snowpark.secrets.get_oauth_access_token(secret_name:str) -> str

Get an OAuth2 access token from Snowflake.

funcsrc.snowflake.snowpark.secrets.get_secret_type(secret_name:str) -> str

Get the type of a secret from Snowflake.

funcsrc.snowflake.snowpark.secrets.get_username_password(secret_name:str) -> UsernamePassword

Get a username and password secret from Snowflake.

methodsrc.snowflake.snowpark.session.Session.append_query_tag(tag:str, separator:str=',') -> None

Appends a tag to the current query tag.

methodsrc.snowflake.snowpark.session.Session.begin_transaction(name:Optional[str]=None, _emit_ast:bool=True) -> None

Begins a new transaction in the current session.

methodsrc.snowflake.snowpark.session.Session.cancel_all() -> None

Cancel all action methods that are running currently.

methodsrc.snowflake.snowpark.session.Session.close() -> None

Close this session.

methodsrc.snowflake.snowpark.session.Session.commit(_emit_ast:bool=True) -> None

Commits an open transaction in the current session.

methodsrc.snowflake.snowpark.session.Session.create_async_job(query_id:str) -> AsyncJob

Creates an :class:`AsyncJob` from a query ID.

methodsrc.snowflake.snowpark.session.Session.get_active_session() -> Optional['Session']

Gets the active session if one is created.

methodsrc.snowflake.snowpark.session.Session.query_tag() -> Optional[str]

The query tag for this session.

method

src.snowflake.snowpark.session.Session.range(start:int, end:Optional[int]=None, step:int=1, _emit_ast:bool=True) -> DataFrame

Creates a new DataFrame from a range of numbers.

methodsrc.snowflake.snowpark.session.Session.rollback(_emit_ast:bool=True) -> None

Rolls back an open transaction in the current session.

methodsrc.snowflake.snowpark.session.Session.update_query_tag(tag:dict) -> None

Updates a query tag that is a json encoded string.

methodsrc.snowflake.snowpark.session.Session.use_database(database:str) -> None

Specifies the active/current database for the session.

methodsrc.snowflake.snowpark.session.Session.use_role(role:str) -> None

Specifies the active/current primary role for the session.

methodsrc.snowflake.snowpark.session.Session.use_schema(schema:str) -> None

Specifies the active/current schema for the session.

methodsrc.snowflake.snowpark.session.Session.use_warehouse(warehouse:str) -> None

Specifies the active/current warehouse for the session.

classsrc.snowflake.snowpark.table.DeleteResult

Result of deleting rows in a :class:`Table`.

classsrc.snowflake.snowpark.table.Table

Represents a lazily-evaluated Table.

methodsrc.snowflake.snowpark.table.Table.drop_table(_emit_ast:bool=True) -> None

Drops the table from the Snowflake database.

classsrc.snowflake.snowpark.table.UpdateResult

Result of updating rows in a :class:`Table`.

classsrc.snowflake.snowpark.table.WhenMatchedClause

A matched clause for the :meth:`Table.merge` action.

classsrc.snowflake.snowpark.table_function.TableFunctionCall

Represents a table function call.

classsrc.snowflake.snowpark.types.ArrayType

Array data type.

classsrc.snowflake.snowpark.types.BinaryType

Binary data type.

classsrc.snowflake.snowpark.types.BooleanType

Boolean data type.

classsrc.snowflake.snowpark.types.ByteType

Byte data type.

classsrc.snowflake.snowpark.types.ColumnIdentifier

Represents a column identifier.

classsrc.snowflake.snowpark.types.DataType

The base class of Snowpark data types.

classsrc.snowflake.snowpark.types.DateType

Date data type.

classsrc.snowflake.snowpark.types.DayTimeIntervalType

DayTimeIntervalType data type.

classsrc.snowflake.snowpark.types.DecFloatType

DecFloat data type.

classsrc.snowflake.snowpark.types.DecimalType

Decimal data type.

classsrc.snowflake.snowpark.types.DoubleType

Double data type.

classsrc.snowflake.snowpark.types.FileType

File data type.

classsrc.snowflake.snowpark.types.FloatType

Float data type.

classsrc.snowflake.snowpark.types.GeographyType

Geography data type.

classsrc.snowflake.snowpark.types.GeometryType

Geometry data type.

classsrc.snowflake.snowpark.types.IntegerType

Integer data type.

classsrc.snowflake.snowpark.types.LongType

Long integer data type.

classsrc.snowflake.snowpark.types.MapType

Map data type.

classsrc.snowflake.snowpark.types.NullType

Represents a null type.

classsrc.snowflake.snowpark.types.PandasDataFrameType

pandas DataFrame data type.

classsrc.snowflake.snowpark.types.PandasSeriesType

pandas Series data type.

classsrc.snowflake.snowpark.types.ShortType

Short integer data type.

classsrc.snowflake.snowpark.types.StringType

String data type.

classsrc.snowflake.snowpark.types.StructField

Represents the content of :class:`StructField`.

classsrc.snowflake.snowpark.types.StructType

Represents a table schema or structured column.

classsrc.snowflake.snowpark.types.TimeType

Time data type.

classsrc.snowflake.snowpark.types.TimestampType

Timestamp data type.

classsrc.snowflake.snowpark.types.VariantType

Variant data type.

classsrc.snowflake.snowpark.types.VectorType

Vector data type.

classsrc.snowflake.snowpark.types.YearMonthIntervalType

YearMonthIntervalType data type.

classsrc.snowflake.snowpark.udf_profiler.UDFProfiler

Set up profiler to receive profiles of UDFs.

classsrc.snowflake.snowpark.window.Window

Contains functions to form :class:`WindowSpec`.

classsrc.snowflake.snowpark.window.WindowSpec

Represents a window frame clause.

About this data

These signatures were extracted from the public source of snowflakedb/snowpark-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries