snowflake-connector-python API reference

152 public APIs from snowflake-connector-python (snowflakedb/snowflake-connector-python) — 64 classes, 32 functions, 56 methods. Signatures extracted by static analysis of the actual source.

Repository: snowflakedb/snowflake-connector-python

Kind	Count
Classes	64
Functions	32
Methods	56

API list

funcci.anaconda.validate_deps_sync.get_meta_run_requirements(meta_path:Path) -> List[str]

Extract normalized run requirements from meta.yaml.

funcci.anaconda.validate_deps_sync.normalize_name(name:str) -> str

Normalize a dependency name to a canonical form.

funcci.anaconda.validate_deps_sync.split_requirement(req:str) -> Tuple[str, str]

Split a requirement into name and version specifier.

funcci.docker.connector_test_lambda.app.run_tests()

Run tests using tox

funcci.download_minicore.build_download_url(platform_dir:str, filename_arch:str, version:str) -> str

Build the download URL.

funcci.download_minicore.detect_arch() -> str

Detect the CPU architecture.

funcci.download_minicore.detect_libc() -> str

Detect libc type on Linux (glibc vs musl).

funcci.download_minicore.detect_os() -> str

Detect the operating system.

funcci.download_minicore.download_file(url:str, dest_path:Path) -> None

Download a file from URL to destination path.

funcci.download_minicore.extract_tar_gz(tar_path:Path, extract_to:Path) -> None

Extract a tar.gz file to the specified directory.

funcci.download_minicore.get_filename_arch(os_name:str, arch:str, libc:str) -> str

Build filename architecture component.

funcci.download_minicore.get_platform_dir(os_name:str, arch:str) -> str

Build platform directory name for URL.

funcci.download_minicore.get_repo_root() -> Path

Get the repository root directory.

classci.generate_full_matrix.CSP

Available cloud service providers.

classci.generate_full_matrix.OperatingSystemInfo

Operating system configuration.

classci.generate_full_matrix.Python

Available Python versions.

classci.generate_full_matrix.PythonVersion

Python version configuration.

classci.pre-commit.check_no_native_http.ASTHelper

Helper functions for AST analysis.

methodci.pre-commit.check_no_native_http.ASTHelper.is_type_checking_test(node:ast.expr) -> bool

Check if expression is TYPE_CHECKING test.

classci.pre-commit.check_no_native_http.CallAnalyzer

Analyzes function calls for violations.

methodci.pre-commit.check_no_native_http.ContextBuilder.visit_AnnAssign(node:ast.AnnAssign)

Handle annotated assignments.

methodci.pre-commit.check_no_native_http.ContextBuilder.visit_Call(node:ast.Call)

Track runtime usage of names.

methodci.pre-commit.check_no_native_http.ContextBuilder.visit_Import(node:ast.Import)

Handle import statements.

methodci.pre-commit.check_no_native_http.FileChecker.check_file() -> Tuple[List[HTTPViolation], List[str]]

Check a file for HTTP violations.

methodci.pre-commit.check_no_native_http.FileChecker.is_exempt() -> bool

Check if file is exempt from all checks.

classci.pre-commit.check_no_native_http.ImportContext

Tracks all import-related information.

methodci.pre-commit.check_no_native_http.ImportContext.add_import(import_info:ImportInfo)

Add an import.

methodci.pre-commit.check_no_native_http.ImportContext.add_runtime_usage(name:str)

Mark a name as used at runtime.

methodci.pre-commit.check_no_native_http.ImportContext.add_star_import(module:str)

Add a star import.

methodci.pre-commit.check_no_native_http.ImportContext.get_import_location(name:str) -> Tuple[int, int]

Get line/col for an import.

classci.pre-commit.check_no_native_http.ImportInfo

Information about an import statement.

classci.pre-commit.check_no_native_http.ModulePattern

Utility class for module pattern matching.

methodci.pre-commit.check_no_native_http.ModulePattern.is_aiohttp_api(name:str) -> bool

Check if name is an aiohttp API function.

methodci.pre-commit.check_no_native_http.ModulePattern.is_aiohttp_module(module_or_symbol:str) -> bool

Check if module or symbol is aiohttp-related.

methodci.pre-commit.check_no_native_http.ModulePattern.is_aiohttp_session(name:str) -> bool

Check if name is an aiohttp session class.

methodci.pre-commit.check_no_native_http.ModulePattern.is_http_method(name:str) -> bool

Check if name is an HTTP method.

methodci.pre-commit.check_no_native_http.ModulePattern.is_pool_manager(name:str) -> bool

Check if name is a pool manager class.

methodci.pre-commit.check_no_native_http.ModulePattern.is_requests_module(module_or_symbol:str) -> bool

Check if module or symbol is requests-related.

methodci.pre-commit.check_no_native_http.ModulePattern.is_urllib3_api(name:str) -> bool

Check if name is a urllib3 API function.

methodci.pre-commit.check_no_native_http.ModulePattern.is_urllib3_module(module_or_symbol:str) -> bool

Check if module or symbol is urllib3-related.

classci.pre-commit.check_no_native_http.ViolationType

Types of HTTP violations.

classci.pre-commit.check_optional_imports.ImportViolation

Pretty prints a violation import restrictions.

funcci.pre-commit.check_optional_imports.check_file(filename:str) -> List[ImportViolation]

Check a file for optional import violations.

funcprober.probes.put_fetch_get.get_driver_version() -> str

Returns the version of the Snowflake connector.

funcprober.probes.put_fetch_get.get_python_version() -> str

Returns the Python version being used.

funcsrc.snowflake.connector._sql_util.remove_starting_comments(sql:str) -> str

Remove all comments from the start of a SQL statement.

classsrc.snowflake.connector.aio._cursor.DictCursor

Cursor returning results in a dictionary.

methodsrc.snowflake.connector.aio._network.SnowflakeRestful.delete_session(retry:bool=False) -> None

Deletes the session.

funcsrc.snowflake.connector.aio._wif_util.get_aws_region() -> str

Get the current AWS workload's region.

funcsrc.snowflake.connector.aio._wif_util.get_gcp_access_token(session_manager:SessionManager) -> str

Gets a GCP access token from the metadata server.

method

src.snowflake.connector.aio.auth._by_plugin.AuthByPlugin.handle_timeout(*authenticator:str, *service_name:str | None, *account:str, *user:str, *password:str, **kwargs:Any) -> None

Default timeout handler.

method

src.snowflake.connector.aio.auth._by_plugin.AuthByPlugin.reauthenticate(*conn:SnowflakeConnection, **kwargs:Any) -> dict[str, Any]

Re-perform authentication.

methodsrc.snowflake.connector.aio.auth._by_plugin.AuthByPlugin.reset_secrets() -> None

Reset secret members.

methodsrc.snowflake.connector.aio.auth._by_plugin.AuthByPlugin.update_body(body:dict[Any, Any]) -> None

Update the body of the authentication request.

methodsrc.snowflake.connector.aio.auth._default.AuthByDefault.update_body(body:dict[Any, Any]) -> None

Sets the password if available.

methodsrc.snowflake.connector.aio.auth._idtoken.AuthByIdToken.update_body(body:dict[Any, Any]) -> None

Sets the id_token if available.

methodsrc.snowflake.connector.aio.auth._keypair.AuthByKeyPair.update_body(body:dict[Any, Any]) -> None

Sets the private key if available.

classsrc.snowflake.connector.aio.auth._no_auth.AuthNoAuth

No-auth Authentication.

method

src.snowflake.connector.aio.auth._okta.AuthByOkta.prepare(*conn:SnowflakeConnection, *authenticator:str, *service_name:str | None, *account:str, *user:str, *password:str, **kwargs:Any) -> None

SAML Authentication.

classsrc.snowflake.connector.auth._auth.Auth

Snowflake Authenticator.

classsrc.snowflake.connector.auth._oauth_base.AuthByOAuthBase

A base abstract class for OAuth authenticators

methodsrc.snowflake.connector.auth._oauth_base.AuthByOAuthBase.assertion_content() -> str

Returns the token.

classsrc.snowflake.connector.auth.by_plugin.AuthByPlugin

External Authenticator interface.

method

src.snowflake.connector.auth.by_plugin.AuthByPlugin.handle_timeout(*authenticator:str, *service_name:str | None, *account:str, *user:str, *password:str, **kwargs:Any) -> None

Default timeout handler.

method

src.snowflake.connector.auth.by_plugin.AuthByPlugin.reauthenticate(*conn:SnowflakeConnection, **kwargs:Any) -> dict[str, Any]

Re-perform authentication.

methodsrc.snowflake.connector.auth.by_plugin.AuthByPlugin.reset_secrets() -> None

Reset secret members.

methodsrc.snowflake.connector.auth.by_plugin.AuthByPlugin.update_body(body:dict[Any, Any]) -> None

Update the body of the authentication request.

classsrc.snowflake.connector.auth.default.AuthByDefault

Default username and password authenticator.

methodsrc.snowflake.connector.auth.default.AuthByDefault.update_body(body:dict[Any, Any]) -> None

Sets the password if available.

classsrc.snowflake.connector.auth.idtoken.AuthByIdToken

Internal IdToken Based Authentication.

classsrc.snowflake.connector.auth.keypair.AuthByKeyPair

Key pair based authentication.

classsrc.snowflake.connector.auth.no_auth.AuthNoAuth

No-auth Authentication.

classsrc.snowflake.connector.auth.oauth.AuthByOAuth

OAuth Based Authentication.

methodsrc.snowflake.connector.auth.oauth.AuthByOAuth.assertion_content() -> str | None

Returns the token.

methodsrc.snowflake.connector.auth.oauth.AuthByOAuth.update_body(body:dict[Any, Any]) -> None

Update some information required by OAuth.

classsrc.snowflake.connector.auth.oauth_code.AuthByOauthCode

Authenticates user by OAuth code flow.

classsrc.snowflake.connector.auth.okta.AuthByOkta

Authenticate user by OKTA.

method

src.snowflake.connector.auth.okta.AuthByOkta.prepare(*conn:SnowflakeConnection, *authenticator:str, *service_name:str | None, *account:str, *user:str, *password:str, **kwargs:Any) -> None

SAML Authentication.

classsrc.snowflake.connector.auth.usrpwdmfa.AuthByUsrPwdMfa

Username & password & mfa authenticator.

methodsrc.snowflake.connector.auth.usrpwdmfa.AuthByUsrPwdMfa.update_body(body:dict[Any, Any]) -> None

Sets the password and mfa_token if available.

classsrc.snowflake.connector.auth.webbrowser.AuthByWebBrowser

Authenticates user by web browser.

methodsrc.snowflake.connector.auth.webbrowser.AuthByWebBrowser.assertion_content() -> str

Returns the token.

method

src.snowflake.connector.config_manager.ConfigManager.add_option(*option_cls:type[ConfigOption]=ConfigOption, **kwargs) -> None

Add a ConfigOption to this ConfigManager.

methodsrc.snowflake.connector.config_manager.ConfigManager.add_submanager(new_child:ConfigManager) -> None

Nest another ConfigManager under this one.

methodsrc.snowflake.connector.config_manager.ConfigManager.read_config(skip_file_permissions_check:bool=False) -> None

Read and cache config file contents.

classsrc.snowflake.connector.config_manager.ConfigOption

ConfigOption represents a flag/setting.

methodsrc.snowflake.connector.config_manager.ConfigOption.option_name() -> str

User-friendly name of the config option.

methodsrc.snowflake.connector.config_manager.ConfigOption.value() -> Any

Retrieve a value of option.

classsrc.snowflake.connector.connection.TypeAndBinding

Stores the type name and the Snowflake binding.

classsrc.snowflake.connector.constants.OCSPMode

OCSP Mode enumerator for all the available modes.

funcsrc.snowflake.connector.converter.convert_datetime_to_epoch(dt:datetime) -> float

Converts datetime to epoch time in seconds.

classsrc.snowflake.connector.converter_snowsql.SnowflakeConverterSnowSQL

Snowflake Converter for SnowSQL.

classsrc.snowflake.connector.crl.CRLConfig

Configuration class for CRL validation settings.

classsrc.snowflake.connector.crl_cache.CRLCache

Abstract base class for CRL caches.

methodsrc.snowflake.connector.crl_cache.CRLCache.get(crl_url:str) -> CRLCacheEntry | None

Get a CRL cache entry by URL.

methodsrc.snowflake.connector.crl_cache.CRLCache.put(crl_url:str, entry:CRLCacheEntry) -> None

Store a CRL cache entry.

classsrc.snowflake.connector.crl_cache.CRLFileCache

File-based CRL cache that persists CRLs to disk.

methodsrc.snowflake.connector.crl_cache.CRLFileCache.cleanup() -> None

Remove expired files from disk cache.

methodsrc.snowflake.connector.crl_cache.CRLFileCache.get(crl_url:str) -> CRLCacheEntry | None

Get a CRL cache entry from disk.

methodsrc.snowflake.connector.crl_cache.CRLFileCache.put(crl_url:str, entry:CRLCacheEntry) -> None

Store a CRL cache entry to disk.

methodsrc.snowflake.connector.crl_cache.NoopCRLCache.cleanup() -> None

Does nothing.

methodsrc.snowflake.connector.crl_cache.NoopCRLCache.get(crl_url:str) -> CRLCacheEntry | None

Always returns None.

methodsrc.snowflake.connector.crl_cache.NoopCRLCache.put(crl_url:str, entry:CRLCacheEntry) -> None

Does nothing.

classsrc.snowflake.connector.cursor.DictCursor

Cursor returning results in a dictionary.

classsrc.snowflake.connector.cursor.QueryResultStats

Statistics for rows affected by a DML operation.

funcsrc.snowflake.connector.cursor.exit_handler(*_) -> NoReturn

Handler for signal.

funcsrc.snowflake.connector.encryption_util.matdesc_to_unicode(matdesc:MaterialDescriptor) -> str

Convert Material Descriptor to Unicode String.

classsrc.snowflake.connector.errors.BadGatewayError

Exception for 502 HTTP error for retry.

classsrc.snowflake.connector.errors.BadRequest

Exception for 400 HTTP error for retry.

classsrc.snowflake.connector.errors.ConfigManagerError

Configuration manager related errors.

classsrc.snowflake.connector.errors.ConfigSourceError

Configuration source related errors.

classsrc.snowflake.connector.errors.DatabaseError

Exception for errors related to the database.

classsrc.snowflake.connector.errors.Error

Base Snowflake exception class.

methodsrc.snowflake.connector.errors.Error.generate_telemetry_exception_data() -> dict[str, tuple[bool, str, str] | str]

Generate the data to send through telemetry.

classsrc.snowflake.connector.errors.ForbiddenError

Exception for 403 HTTP error for retry.

classsrc.snowflake.connector.errors.GatewayTimeoutError

Exception for 504 HTTP error for retry.

classsrc.snowflake.connector.errors.InterfaceError

Exception for errors related to the interface.

classsrc.snowflake.connector.errors.InternalError

Exception for errors internal database errors.

classsrc.snowflake.connector.errors.InternalServerError

Exception for 500 HTTP code for retry.

classsrc.snowflake.connector.errors.MethodNotAllowed

Exception for 405 HTTP error for retry.

classsrc.snowflake.connector.errors.MissingDependencyError

Exception for missing extras dependencies.

classsrc.snowflake.connector.errors.OperationalError

Exception for errors related to the database's operation.

classsrc.snowflake.connector.errors.OtherHTTPRetryableError

Exception for other HTTP error for retry.

classsrc.snowflake.connector.errors.ProgrammingError

Exception for errors programming errors.

classsrc.snowflake.connector.errors.RequestTimeoutError

Exception for 408 HTTP error for retry.

classsrc.snowflake.connector.errors.ServiceUnavailableError

Exception for 503 HTTP code for retry.

classsrc.snowflake.connector.errors.TooManyRequests

Exception for 429 HTTP error for retry.

classsrc.snowflake.connector.file_transfer_agent.SnowflakeProgressPercentage

Built-in Progress bar for PUT commands.

funcsrc.snowflake.connector.interval_util.interval_year_month_to_string(interval:int, scale:int) -> str

Convert a year-month interval to a string.

classsrc.snowflake.connector.network.ReauthenticationRequest

Signal to reauthenticate.

classsrc.snowflake.connector.network.RetryRequest

Signal to retry request.

classsrc.snowflake.connector.network.SnowflakeAuth

Attaches HTTP Authorization header for Snowflake.

classsrc.snowflake.connector.network.SnowflakeRestful

Snowflake Restful class.

methodsrc.snowflake.connector.network.SnowflakeRestful.delete_session(retry:bool=False) -> None

Deletes the session.

funcsrc.snowflake.connector.network.is_retryable_http_code(code:int) -> bool

Decides whether code is a retryable HTTP issue.

classsrc.snowflake.connector.ocsp_asn1crypto.SnowflakeOCSPAsn1Crypto

OCSP checks by asn1crypto.

method

src.snowflake.connector.ocsp_asn1crypto.SnowflakeOCSPAsn1Crypto.create_ocsp_request(issuer:Certificate, subject:Certificate) -> tuple[CertId, OCSPRequest]

Creates CertId and OCSPRequest.

method

src.snowflake.connector.ocsp_asn1crypto.SnowflakeOCSPAsn1Crypto.extract_good_status(single_response:SingleResponse) -> tuple[datetime, datetime]

Extracts GOOD status.

classsrc.snowflake.connector.options.MissingOptionalDependency

A class to replace missing dependencies.

classsrc.snowflake.connector.session_manager.HttpConfig

HTTP configuration specific to requests library.

classsrc.snowflake.connector.sf_dirs.SFPlatformDirs

Single folder platformdirs.

methodsrc.snowflake.connector.sf_dirs.SFPlatformDirs.user_config_path() -> str

data directory tied to to the user

classsrc.snowflake.connector.sfdatetime.SnowflakeDateTimeFormat

Snowflake DateTime Formatter.

funcsrc.snowflake.connector.time_util.get_time_millis() -> int

Returns the current time in milliseconds.

funcsrc.snowflake.connector.tool.dump_certs.main() -> None

Internal Tool: Extract certificate files in PEM.

funcsrc.snowflake.connector.tool.dump_ocsp_response.main() -> None

Internal Tool: OCSP response dumper.

funcsrc.snowflake.connector.url_util.is_valid_url(url:str) -> bool

Confirms if the provided URL is a valid HTTP/HTTPS URL.

classsrc.snowflake.connector.util_text.SQLDelimiter

Class that wraps a SQL delimiter string.

funcsrc.snowflake.connector.util_text.construct_hostname(region:str | None, account:str) -> str

Constructs hostname from region and account.

funcsrc.snowflake.connector.util_text.is_valid_account_identifier(account:str) -> bool

Validate the Snowflake account identifier format.

funcsrc.snowflake.connector.wif_util.get_gcp_access_token(session_manager:SessionManager) -> str

Gets a GCP access token from the metadata server.

funcsrc.snowflake.connector.wif_util.get_gcp_identity_token(session_manager:SessionManager) -> str

Gets a GCP identity token from the metadata server.

About this data

These signatures were extracted from the public source of snowflakedb/snowflake-connector-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