MySQLPandas package¶
Submodules¶
MySQLPandas.core module¶
- class MySQLPandas.core.MySQLPandas(user: str, db_name: str, host: str = 'localhost', port: str = '3306', initfile_path: str = '')¶
Bases:
MySQLConnection
- addPrimaryKey(table_name: str, primary_key: str) None ¶
Add PrimaryKey in table. You can know the advantage of specifying primarykey from here. https://dev.mysql.com/doc/refman/8.0/ja/partitioning-limitations-partitioning-keys-unique-keys.html
- Parameters:
table_name (str) –
primary_key (str) – Enter column name you want to add primarykey.
- Return type:
None
- deletePrimaryKey(table_name: str) None ¶
Delete PrimaryKey.
- Parameters:
table_name (str) –
- Return type:
None
- deleteTable(table_name: str) None ¶
Delete Table.
- Parameters:
table_name (str) –
- Return type:
None
- Raises:
PandasMySQLError – Input not existing table name.
- executeSQLcommand(command: str) DataFrame ¶
Execute SQL command and return DataFrame object
- Parameters:
command (str) –
- Return type:
DataFrame
- insertRecord(table_name: str, df_path: str | None = None, df: DataFrame | None = None, converters: dict | None = None, sep: str = ',', Strict_Mode: bool = True) None ¶
Insert Record into Table
- Parameters:
table_name (str) –
df_path (Optional[str]) – Please select either df_path or df option.
df (Optional[pd.Dataframe]) – Please select either df_path or df option.
converters (Optional[dict]) – Pass into pandas.read_csv() option. Please see https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html
sep (str) – Pass into pandas.read_csv() option. Please see https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html
Strict_Mode (bool (default:True)) – In default parameter, you can’t insert string data over that length definition. However,if you select Strict_mode = False, you can insert insert string data over that length definition automatically.
- Return type:
None
- Raises:
PandasMySQLError – Input not exist table name or quite differnt DataFrame.
Notes
numeric data definition can’t change! (Cannot change int type column into float one)
- isConnectDB() None ¶
Return whether object is connecting DB or Not
- Parameters:
None –
- Return type:
If it connects, it outputs “Connected to the database”
- Raises:
PandasMySQLError – When it disconnects DB.
- isNullTableNameinTableList(table_name: str) bool ¶
For debug. If self.DBList is None, it return True.
- makeTable(table_name: str, df_path: str | None = None, df: DataFrame | None = None, converters: dict | None = None, sep: str = ',') None ¶
Make table frame from DataFrame object or csv,tsv file. If a same table name exists, it raises Error.
- Parameters:
table_name (str) –
df_path (Optional[str]) – Please select either df_path or df option.
df (Optional[pd.Dataframe]) – Please select either df_path or df option.
converters (Optional[dict]) – Pass into pandas.read_csv() option. Please see https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html
sep (str) – Pass into pandas.read_csv() option. Please see https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html
- Return type:
None
- Raises:
PandasMySQLError – Input already existing table name.
- showTableList() None ¶
Display exist table name list.
- Parameters:
None –
- Return type:
None
- showTableinfo(table_name: str) None ¶
Display table column definition.
- Parameters:
table_name (str) –
- Return type:
None
- Raises:
PandasMySQLError – Input not existing table name.