Table of Contents

• dbhelper
• csv
  • to_csv
  • read_csv
  • head_csv
  • batch_csv

csv

to_csv

def to_csv(engine,
           sql_query: str,
           file_name: os.PathLike,
           compression=CSV_COMPRESSION_GZIP,
           func_print: Callable = print) -> int

SQL Query Statemet to CSV format file and compression data.

Arguments:

• engine Connection - Connection Database And SQLAlchemy.Engine
• sql_query str - SQL Query Statement (SELECT Only)
• file_name os.PathLike - save with filename and extention file (Example: ./mycsv.csv.gz)
• compression str, optional - Compression file type (plain|gzip|zip). Defaults to CSV_COMPRESSION_GZIP.
• func_print Callable, optional - Callback Print Massage function . Defaults to print.

Raises:

• ex - Errror Handler

Returns:

• int - Total count record data.

read_csv

def read_csv(filename: os.PathLike, **pandas_option) -> pd.DataFrame

Read Csv file

pandas option: https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html

Arguments:

• filename os.PathLike - file name os.PathLike

Returns:

• pd.DataFrame - pandas DataFrame

head_csv

def head_csv(filename: os.PathLike,
             nrows: int = 10,
             **pandas_option) -> pd.DataFrame

Read Head record in csv file

Arguments:

• filename os.PathLike - filename
• nrows int, optional - number rows. Defaults to 10.

Returns:

• pd.DataFrame - pandas DataFrame

batch_csv

def batch_csv(filename: os.PathLike,
              batch_size: int = 10000,
              **pandas_option) -> Iterator[pd.DataFrame]

Read CSV file for iteration object

Arguments:

• filename os.PathLike - filename
• batch_size int, optional - batch_size or chunksize row number. Defaults to 10000.

Yields:

• Iterator[pd.DataFrame] - Return Iterator[pd.DataFrame]