Getting started

To start to use SolrExpress, just follow follow steps:

  1. Create a class to represent your collection, extend Document class and use attributes to indicate Solr fields.

    public class TechProductDocument : Document
        public string Manufacturer { get; set; }

        public GeoCoordinate StoredAt { get; set; }
  1. Choose your favorite Dependency Injection provider (SolrExpress.DI.Autofac, SolrExpress.DI.CoreClr, SolrExpress.DI.Ninject or SolrExpress.DI.SimpleInject) and add reference to package

  2. Add reference to correct Solr provider (SolrExpress.Solr4 or SolrExpress.Solr5)

  3. Configure SolrExpress setting Solr host address for each collection

    public void ConfigureServices(SomeDIContainer services)
            // This extension is from SolrExpress.DI.<Your favorite DI provider>
            .AddSolrExpress<TechProduct>(builder => builder
                // This extension is from SolrExpress.Solr5
                .UseSolr5()); // Or UseSolr4 from SolrExpress.Solr4
  1. Configue search parameters, execute, read results and enjoy :)

    using SolrExpress.Search.Parameter.Extension;

    public void MyAmazingSearch(DocumentCollection<TechProduct> techProducts)
        // Initial search settings (configure to result facet field Categories and filter by field id using value "205325092")
        var searchResult = techProducts
            .Fields(d => d.Id, d => d.Manufacturer)
            .FacetField(d => d.Categories)
            .Filter(d => d.Id, "205325092")

        // Get general information about search, documents and facets from search result
            .Information(out var information)
            .Document(out var documents)
            .Facets(out var facets);


  1. Class TechProductDocument represents a document in Solr collection and to be easy to identitify this, I call this class with the same name of the Solr collection (techproducts) but you can choose any name what you want, just remember, extends Document class;

  2. To example purposes, I set collection address in hard code.

Last updated