CDF Project Archiver

class cognite.utils.infrastructure.ProjectArchiver(client: CogniteClient)

A set of functionalities for archiving data from a CDF project.

Parameters

client (CogniteClient) – A client object connecting to CDF project of concern.

archive_assets(dirpath: str = '.', compress: bool = True) → None

Archive Asset resources from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.

archive_timeseries(dirpath: str = '.', compress: bool = True) → None

Archive TimeSeries resources from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.

archive_sequences(dirpath: str = '.', compress: bool = True) → None

Archive Sequence resources from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.

archive_events(dirpath: str = '.', compress: bool = True) → None

Archive Event resources from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.

archive_file_metadata(dirpath: str = '.', compress: bool = True) → None

Archive FileMetadata resources from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.

archive_files(dirpath: str = '.', compress: bool = True) → None

Archive file data from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.

archive_relationships(dirpath: str = '.', compress: bool = True) → None

Archive Relationship resources from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.

archive_labels(dirpath: str = '.', compress: bool = True) → None

Archive Label resources from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.

archive_datasets(dirpath: str = '.', compress: bool = True) → None

Archive DataSet resources from CDF.

Parameters

• dirpath (str) – Directory path to save the data. Defaults to “.” (i.e. current directory).

• compress (bool) – Whether to compress the saved data. Defaults to True.