Get in touch
Get in touch

Export entity data from the project to JSON files on disk

dump_data(to_dir_path, class_name, excluded_class_names, include_date_fields) {dict}

Export entity data from the project to JSON files on disk. Each class is written to a separate ``<ClassName>.json`` file. Base classes are automatically skipped.
Properties
NameTypeAttributesDefaultDescription
to_dir_pathUnion[str, Path]Target directory. Created automatically if it does not exist.
class_namestr<optional>Schema.ALL_CLASSESThe class name to dump, or Schema.ALL_CLASSES for all.
excluded_class_namesstr<optional>''Comma-separated list of classes to exclude from the export if class_name is Schema.ALL_CLASSES.
include_date_fieldsbool<optional>FalseWhether to include system date metadata.
Returns:
A dict with an exported count.
Type
dict