Save a federated table

Updated at:
Copy as MD

This topic describes the function to save a federated table and provides an example.

Function path

fascia.biz.api.dataframe.save_fed_dataframe

Function definition

def save_fed_dataframe(fed_df: HDataFrame, 
                       uid: str = None, 
                       file_uri: Union[str, Dict] = None)

Request parameters

Name and Description

Type

Required

Description

fed_df

HDataFrame

Required

The federated table to save.

uid

String

Optional

The UID used to save the federated table. This parameter is typically used with the federated table name in the output configuration. The default value is None.

file_uri

String/Dict

Optional

Specifies the path to save the file. The format is <ID: PATH>, where ID is the participant ID and Path is the file path. The file path must be an absolute path. If this parameter is set to None, /home/admin/agent/data/dataset/feddataframe/<UID>.csv is used as the default path. Default value: None.

Request example

from fascia.biz.api.dataframe import save_fed_dataframe
# Assume that fed_df is an existing federated dataset.
save_fed_dataframe(fed_df, '$output0')