Deletes records from tables in the databases connected via built-in PostgreSQL or an SQL Connection.

from morph_lib.database import delete_records

delete_records(
	data: pd.DataFrame,
	primary_keys: List[str],
	table_name: str,
	connection: Optional[str]
) -> None

Supported Databases

  • PostgreSQL

​
Parameters

​
data
pd.DataFrame
required

The actual data to pass to the function. The columns specified in primary_keys must exist.

​
primary_keys
List[str]
required

Specify the column names that will serve as the table’s Primary Key.

​
table_name
str
required

Specify the table name.

​
connection
str

Destination of the connection other than the registered builtin connection (optional)

*If not specified, it will be set to the built-in PostgreSQL.

​
Example

from morph_lib.database import delete_records

@morph.func
@morph.load_data("user_data")
def func_name(context):
	user_data: pd.DataFrame = context.data["user_data"]
	delete_records(
		user_data,
		["user_id"]
		"user",
	)