namespace MongoDbGenericRepository.Models
{
    /// <summary>
    /// This class represents a document that can be inserted in a collection that can be partitioned.
    /// The partition key allows for the creation of different collections having the same document schema.
    /// This can be useful if you are planning to build a Software as a Service (SaaS) Platform, or if you want to reduce indexing.
    /// You could for example insert Logs in different collections based on the week and year they where created, or their Log category/source.
    /// </summary>
    public interface IPartitionedDocument
    {
        /// <summary>
        /// The partition key used to partition your collection.
        /// </summary>
        string PartitionKey { get; set; }
    }
}