Storage

Overview

The Storage classes provide a way to interact with Common Data Model files. The role of a storage adapter is to provide an abstraction of the underlying file system where Common Data Model files are stored. Whether data is stored locally or remotely, such as on Azure Data Lake Storage Gen 2, storage adapters can be used to simplify the reading and writing of documents without the object model having to understand the underlying mechanism of interacting with different file systems. There are various existing storage adapter implementation classes to help interact with different types of file systems. Users can also implement their own adapters by extending the storage adapter interface. The storage manager's role is to be the "storage" for the corpus, by allowing and managing interactions with the storage adapters.

The C# code can be found here.

Note

While storage adapters accept all paths, including paths that contain colons, the underlying file systems that back them may not. Keep this in mind if you need cross-platform support.

Classes

Name	Description
ADLS Adapter	Used to interact with data on Azure Data Lake Storage Gen2.
Common Data Model Standards Adapter	Points to the Common Data Model public standards schema documents.
Github Adapter	Points to the Common Data Model public standards schema documents on Github.
Local Adapter	Used to interact with data on the local file system.
Network Adapter	Contains logic for adapters that deal with data across a network.
Remote Adapter	Used to interact with data on a remote file system.
Storage Adapter Base	The base class for an adapter object that can read and write documents to and from a data source. It allows a user to interact with data from multiple data sources without having to manually copy data to the location where the object model is running. By deriving from this class, users are able to create their own adapter if needed.
Storage Adapter	The base interface for an adapter object that can read and write documents to and from a data source. It allows a user to interact with data from multiple data sources without having to manually copy data to the location where the object model is running. This interface also allows users to create their own adapter, if needed.
Note: This class is on the deprecation path. Use [StorageAdapterBase] instead
Storage Manager	Acts like a storage for the corpus and is used to interact with storage adapters.