Technical Documentation

This page contains the internal technical documentation of the snowconvert-helpers project, generated automatically by pydoc

Functions

All the functions defined in the project.

access

access(path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)

Description:

Use the real uid/gid to test for access to a path.

dir_fd, effective_ids, and follow_symlinks may not be implemented on your platform. If they are unavailable, using them will raise a NotImplementedError.

Note that most operations will use the effective uid/gid, therefore this routine can be used in a suid/sgid environment to test if the invoking user has the specified access to the path.

Parameters:

• path, Path to be tested; can be string, bytes, or a path-like object

• mode, Operating-system mode bitfield. Can be F_OK to test existence, or the inclusive-OR of R_OK, W_OK, and X_OK

• dir_fd, If not None, it should be a file descriptor open to a directory, and path should be relative; path will then be relative to that directory

• effective_ids, If True, access will use the effective uid/gid instead of the real uid/gid

• follow_symlinks, If False, and the last element of the path is a symbolic link, access will examine the symbolic link itself instead of the file the link points to

at_exit_helpers

at_exit_helpers()

Description:

Executes at the exit of the execution of the script.

colored

colored(text, color='blue')

Description:

Prints colored text from the specified color.

Parameters:

• text, The text to be printed

• color="blue", The color to print

configure_log

configure_log(configuration_path)

Description:

Configures the logging that will be performed for any data-related execution on the snowflake connection. The log file is named 'snowflake_python_connector.log' by default.

Parameters:

• configuration_path, The configuration path of the file that contains all the settings desired for the logging

drop_transient_table

drop_transient_table(tempTableName, con=None)

Description:

Drops the transient table with the specified name.

Parameters:

• tempTableName, The name of the temporary table

• con=None, The connection to be used, if None is passed it will use the last connection performed

exception_hook

exception_hook(exctype, value, tback)

Description:

Parameters:

• exctype

• value

• tback

exec

exec(sql_string, using=None, con=None)

Description:

Executes a sql string using the last connection, optionally it uses arguments or an specific connection. Examples:

• exec("SELECT * FROM USER")

• exec("SELECT * FROM USER", con)

• exec("SELECT * FROM CUSTOMER WHERE CUSTOMERID= %S", customer)

Parameters:

• sql_string, The definition of the sql

• using=None, The optional parameter that can be used in the sql passed

• con=None, The connection to be used, if None is passed it will use the last connection performed

exec_file

exec_file(filename, con=None)

Description:

Reads the content of a file and executes the sql statements contained with the specified connection.

Parameters:

• filename, The filename to be read and executed

• con=None, The connection to be used, if None is passed it will use the last connection performed

exec_os

exec_os(command)

Description:

Executes a command in the operative system.

exec_sql_statement

exec_sql_statement(sql_string, con, using=None)

Description:

Executes a sql statement in the connection passed, with the optional arguments.

Parameters:

• sql_string, The sql containing the string to be executed

• con, The connection to be used

• using, The optional parameters to be used in the sql execution

expands_using_params

expands_using_params(statement, params)

Description:

Expands the statement passed with the parameters.

Parameters:

• statement, The sql containing the string to be executed

• params, The parameters of the sql statement

expandvar

expandvar(str)

Description:

Expands the variable from the string passed.

Parameters:

• str, The string to be expanded with the variables

expandvars

expandvars(path, params, skip_escaped=False)

Description:

Expand environment variables of form $var and ${var}. If parameter 'skip_escaped' is True, all escaped variable references (i.e. preceded by backslashes) are skipped. Unknown variables are set to 'default'. If 'default' is None, they are left unchanged.

Parameters:

• path,

• params,

• skip_escaped=False,

fast_load

fast_load(target_schema, filepath, stagename, target_table_name, con=None)

Description:

Executes the fast load with the passed parameters target_schema, filepath, stagename and target_table_name.

Parameters:

• target_schema, The name of the schema to be used in the fast load

• filepath, The filename path to be loaded in the table

• target_table_name, The name of the table that will have the data loaded

• con=None, The connection to be used, if None is passed it will use the last connection performed

file_exists_and_readable

file_exists_and_readable(filename)

Description:

Parameters:

• filename,

get_argkey

get_argkey(astr)

Description:

Gets the argument key value from the passed string. It must start with the string '--param-'

Parameters:

• astr, The argument string to be used. The string should have a value similar to --param-column=32 and the returned string will be '32

get_error_position

get_error_position()

Description:

Gets the error position from the file using the information of the stack of the produced error.

get_from_vars_or_args_or_environment

get_from_vars_or_args_or_environment(arg_pos, variable_name, vars, args)

Description:

Gets the argument from the position specified or gets the value from the table vars or gets the environment variable name passed.

Parameters:

• arg_pos, The argument position to be used from the arguments parameter

• variable_name, The name of the variable to be obtained

• vars, The hash with the variables names and values

• args, The arguments array parameter

import_data_to_temptable

import_data_to_temptable(tempTableName, inputDataPlaceholder, con)

Description:

Imports data to a temporary table using an input data place holder.

Parameters:

• tempTableName, The temporary table name.

• inputDataPlaceholder, The input place holder used that is a stage in the snowflake database

• con, The connection to be used

import_file

import_file(filename, separator=' ')

Description:

Imports the passed filename with the optional separator.

Parameters:

• filename, The filename path to be imported

• separator=' ', The optional separator

import_file_to_temptable

import_file_to_temptable(filename, tempTableName, columnDefinition)

Description:

Imports the file passed to a temporary table. It will use a public stage named as the temporary table with the prefix Stage_. At the end of the loading to the temporary table, it will delete the stage that was used in the process.

Parameters:

• filename, The name of the file to be read

• tempTableName, The name of the temporary table

• columnDefinition, The definition of all the fields that will have the temporary table

import_reset

import_reset()

Description:

log

log(*msg, level=20, writter=None)

Description:

Prints a message to the console (standard output) or to the log file, depending on if logging is enabled

Parameters:

• *msg, The message to print or log

• level=20,

• writter=None,

log_on

log_on(user=None, password=None, account=None, database=None, warehouse=None, role=None, login_timeout=10, authenticator=None)

Description:

Logs on the snowflake database with the credentials, database, warehouse, role, login_timeout and authenticator passed parameters.

Parameters:

• user, The user of the database

• password The password of the user of the database

• database, The database to be connected

• warehouse, The warehouse of the database to be connected

• role, The role to be connected

• login_timeout, The maximum timeout before giving error if the connection is taking too long to connect

• authenticator, The authenticator supported value to use like SNOWFLAKE, EXTERNALBROWSER, SNOWFLAKE_JWT or OAUTH

• token, The OAUTH or JWT token

os

os(args)

Description:

Parameters:

• args,

print_table

print_table(dictionary)

Description:

Prints the dictionary without exposing user and password values.

Parameters:

• dictionary,

quit_application

quit_application(code=None)

Description:

Quits the application and optionally returns the passed code.

Parameters:

• code=None, The code to be returned after it quits

read_params_args

read_param_args(args)

Description:

Reads the parameter arguments from the passed array.

Parameters:

• args, The arguments to be used

readrun

readrun(line, skip=0)

Description:

Reads the given filename lines and optionally skips some lines at the beginning of the file.

Parameters:

• line, The filename to be read

• skip=0, The lines to be skipped

remark

remark(arg)

Description:

Prints the argument.

Parameters:

• arg, The argument to be printed

repeat_previous_sql_statement

repeat_previous_sql_statement(con=None, n=1)

Description:

Repeats the previous executed sql statement(s).

Parameters:

• con=None, Connection if specified. If it is not passed it will use the last connection performed

• n=1, The number of previous statements to be executed again

set_default_error_level

set_default_error_level(severity_value)

Description:

Parameters:

• severity_value,

set_error_level

set_error_level(arg, severity_value)

Description:

Parameters:

• arg,

• severity_value,

simple_fast_load

simple_fast_load(con, target_schema, filepath, stagename, target_table_name)

Description:

Executes a simple fast load in the connection and the passed parameter target_schema, filepath, stagename and target table name.

Parameters:

• arg, The connection to be used

• target_schema, The name of the schema to be used in the fast load

• filepath, The filename path to be loaded in the table

• target_table_name, The name of the table that will have the data loaded

stat

stat(path, *, dir_fd=None, follow_symlinks=True)

Description:

Perform a stat system call on the given path. dir_fd and follow_symlinks may not be implemented on your platform. If they are unavailable, using them will raise a NotImplementedError. It's an error to use dir_fd or follow_symlinks when specifying path as an open file descriptor

Parameters:

• path, Path to be examined; can be string, bytes, a path-like object or open-file-descriptor int
• dir_fd, If not None, it should be a file descriptor open to a directory, and path should be a relative string; path will then be relative to that directory

• follow_symlinks, If False, and the last element of the path is a symbolic link, stat will examine the symbolic link itself instead of the file the link points to

system

system(command)

Description:

Execute the command in a subshell.

Parameters:

• command,

using

using(*argv)

Description:

Parameters:

• *argv,

Classes

All the classes defined in the project

BeginLoading Class

This class contains the import_file_to_tab static function which provides support for the BEGIN LOADING and associated commands in FastLoad.

import_file_to_tab()

Parameters:

1. target_schema_table

   • the target schema (optional) and table name

2. define_file

   • The name of the file to be read

3. define_columns

   • The definition of all the columns for the temporary table

4. begin_loading_columns

   • The column names to insert. Dictates the order in which values are inserted

5. begin_loading_values

   • The list of raw insert values to convert

6. field_delimiter

   • The field delimiter

7. (optional) skip_header

   • The number of rows to skip

8. (optional) input_data_place_holder

   • The location of the file in a supported cloud provider. Set parameter when the file is not stored locally

9. (optional) con

   • The connection to be used

Export Class

Static methods in the class

• defaults()

• null(value=None)

• record_mode(value=None)

• report(file, separator=' ')

• reset()

• separator_string(value=None)

• separator_width(value=None)

• side_titles(value=None)

• title_dashes(value=None, withValue=None)

• title_dashes_with(value=None)

• width(value=None)

Data and other attributes defined here

• expandedfilename = None

• separator = ''

Import Class

Methods in the class

• reset()

Static methods in the class

• file(file, separator=' ')

• using(globals, *argv)

Data and other attributes defined in the class

• expandedfilename = None

• no_more_rows = False

• read_obj = None

• reader = None

• separator = ' '

Parameters Class

Data and other attributes defined in the class

• passed_variables = {}