save: Save a table into a file.

Code author: Ueli Sauter, Peter Kraus

The function dgpost.utils.save.save() processes the below specification in order to save the given DataFrame:

pydantic model dgbowl_schemas.dgpost.recipe_1_1.save.Save

Show JSON schema

{
   "title": "Save",
   "type": "object",
   "properties": {
      "table": {
         "title": "Table",
         "type": "string"
      },
      "as": {
         "title": "As",
         "type": "string"
      },
      "type": {
         "title": "Type",
         "enum": [
            "pkl",
            "json",
            "xlsx",
            "csv"
         ],
         "type": "string"
      },
      "sigma": {
         "title": "Sigma",
         "default": true,
         "type": "boolean"
      }
   },
   "required": [
      "table",
      "as"
   ],
   "additionalProperties": false
}

field table: str [Required]

field as_: str [Required] (alias 'as')

field type: Literal['pkl', 'json', 'xlsx', 'csv'] = None

field sigma: bool = True

Note

Metadata, including the recipe used to create the saved file, as well as provenance information about the version of dgpost used to process the recipe are saved into the df.attrs["meta"] entry and therefore only available in pkl or json exports.

dgpost.utils.save.save(table, path, type=None, sigma=True, meta=None)

Return type

None