in

Dot Net Mafia

Group site for developer blogs dealing with (usually) .NET, SharePoint 2013, SharePoint 2010, Office 365, SharePoint Online, and other Microsoft products, as well as some discussion of general programming related concepts.

This Blog

Syndication

Archives

Corey Roth [MVP]

A SharePoint MVP bringing you the latest time saving tips for SharePoint 2013, Office 365 / SharePoint Online and Visual Studio 2013.

How to: Use the SharePoint 2013 Search KeywordQuery Class

Over the past few versions of SharePoint, I have provided a number of blog posts on how to query search.  Of those, my posts on how to use the KeywordQuery class using KQL are some of the most popular (2010 and 2007).  In continuing that tradition, I am proud to present the “How to” post on using the KeywordQuery class in SharePoint 2013.  The good news: your old KeywordQuery code should still work.  The bad news: the way you did it is marked completely obsolete.  I actually had to dig through quite a bit of documentation to find the right API that wasn’t obsolete.  One thing that always provided confusion was that there were similar classes named KeywordQuery in both Microsoft.Search.Query and Microsoft.Office.Server.Search.Query.  To reduce some of that confusion, the KeywordQuery class in Microsoft.Search.Query is now marked as obsolete.  The new updated class is in Microsoft.Office.Search.Query.  Microsoft may have killed the word Office from the name of the product in 2010, but it’s alive and well in the API.

Now let’s talk about what we need to execute some queries with our code.  The code here today will work well from farm solutions in SharePoint as well as other .NET applications hosted on the same SharePoint server.  We’ll be building a console application today.  If you want to query remotely using the object model, then you will need to use the Search Client Object Model which I covered previously.  Create a new console application, and then you will need to add a few references.  These can be found in the 15 hive in the ISAPI folder.  Add the following:

  • Microsoft.Office.Server
  • Microsoft.Office.Server.Search
  • Microsoft.SharePoint
  • Microsoft.SharePoint.Security

The classes we need are in the search assembly but you’ll get lots of errors about dependencies missing if you don’t include the others.  We then need the following references.  This gives us what we need for search, SharePoint, and for the underlying datatable object that is available after we query.

using System.Data;

using Microsoft.SharePoint;

using Microsoft.Office.Server.Search.Query;

Once we have this, we’re ready to get started.  There are many ways to instantiate a KeywordQuery object.  For simplicity, I am just going to pass a SPSite object for one of my site collections.  You can also pass a SPWeb or you can use the proxy technique like I used in my SharePoint 2010 post.  We’ll first, get our SPSite object.

using (SPSite siteCollection = new SPSite("http://server/sitecollection"))

We then create a KeywordQuery object using that site collection.

KeywordQuery keywordQuery = new KeywordQuery(siteCollection);

Now, we specify our query using the QueryText field.  This is where you can use your custom KQL queries.  The documentation team updated the post on this so there are a lot of good tips here.  I am just going to search for the word SharePoint.

keywordQuery.QueryText = "SharePoint";

In the past, we would then set the ResultsProvider and ResultTypes that we want, but now we don’t have to.  In fact, this whole process takes considerably less code.  Instead we use the new SearchExecutor class that I first mentioned in my Client OM post.

SearchExecutor searchExecutor = new SearchExecutor();

We then use it’s ExecuteQuery method passing it our KeywordQuery class.

ResultTableCollection resultTableCollection = searchExecutor.ExecuteQuery(keywordQuery);

Assuming it executes correctly, we can then get our search results.  Before, we used to use an indexer using ResultTypes.ReleventResults to get the table of results we need.  The indexer has been made obsolete, so now we must use the new Filter method.  I figured out what it required from the obsolete descriptor of the indexer.  For the first value, it needs a string with a value of TableType and since the previous enum is also obsolete, we now use KnownTableTypes.RelevantResults.

var resultTables = resultTableCollection.Filter("TableType", KnownTableTypes.RelevantResults);

It returns an IEnumerable<ResultType>, so we need to filter it.  I just FirstOrDefault() to get the table we need.

var resultTable = resultTables.FirstOrDefault();

Previously, we then had to load the data into a DataTable which took a few more lines of code.  However, now that is not required due to the new Table property.

DataTable dataTable = resultTable.Table;

Now that you have a DataTable, you can bind it or query it as you see.  You can also look at the results using the visualizer in Visual Studio.

KeywordQueryDataSetVisualizer

Here is the entire code snippet.

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

 

using System.Data;

using Microsoft.SharePoint;

using Microsoft.Office.Server.Search.Query;

 

namespace SearchConsoleApplication1

{

    class Program

    {

        static void Main(string[] args)

        {

            using (SPSite siteCollection = new SPSite("http://server/sitecollection"))

            {

                KeywordQuery keywordQuery = new KeywordQuery(siteCollection);

                keywordQuery.QueryText = "SharePoint";

 

                SearchExecutor searchExecutor = new SearchExecutor();

                ResultTableCollection resultTableCollection = searchExecutor.ExecuteQuery(keywordQuery);

                var resultTables = resultTableCollection.Filter("TableType", KnownTableTypes.RelevantResults);

 

                var resultTable = resultTables.FirstOrDefault();

 

                DataTable dataTable = resultTable.Table;

            }

        }

    }

}

So if you have a lot of search based code, you may need to do some updates at some point.  However, I think these are good changes and simplify the process a little bit.  In an upcoming post, I’ll cover some of the new things you can do with the KeywordQuery class.

Comments

 

How to: Use the SharePoint 2013 Search KeywordQuery Class … | Mastering Sharepoint said:

Pingback from  How to: Use the SharePoint 2013 Search KeywordQuery Class &#8230; | Mastering Sharepoint

January 3, 2013 5:42 PM
 

SharePoint 2013 Search with Keyword Query Compatibility « Sladescross's Blog said:

Pingback from  SharePoint 2013 Search with Keyword Query Compatibility &laquo; Sladescross&#039;s Blog

January 4, 2013 9:23 AM
 

My SharePoint links January 5, 2013 | Jeremy Thake's musingsJeremy Thake's musings said:

Pingback from  My SharePoint links January 5, 2013 | Jeremy Thake&#039;s musingsJeremy Thake&#039;s musings

January 5, 2013 1:17 PM
 

roelBSS said:

Hi Corey,

Thanks yet again for a great write-up on SharePoint 2013. I am a bit confused however, about the proper class to use in this case. You state two different namespaces in the text, but in the code, you use Microsoft.Office.Server.Search.Query, which is probably the correct one, right?

I have implemented your example, and have a question  about the "QueryInfo" object that is filled after you issue a query: The TotalResults property stays 0, even though you have lots of results in the results table. Have you notices this before? Do you know of a workaround or solution to the problem? All other properties of the QueryInfo are being updated after querying, just not TotalResults.... And this is a property you'd really like to know in a search based application ;)

Thanks in advance,

Regards,

RoelBSS

January 15, 2013 4:52 AM
 

CoreyRoth said:

@RoelBSS thanks for point out the issue with the namespace.  I have corrected it.

As for the QueryInfo object, I haven't noticed that.  I'll try and take a look when I have a chance.

February 6, 2013 9:31 AM
 

SharePoint Daily » Blog Archive » SharePoint 2013 Crystal Ball; Ways to Have Conversations in SharePoint 2013; Windows Phone 8 is a Good Choice said:

Pingback from  SharePoint Daily  &raquo; Blog Archive   &raquo; SharePoint 2013 Crystal Ball; Ways to Have Conversations in SharePoint 2013; Windows Phone 8 is a Good Choice

February 12, 2013 7:42 AM
 

SharePoint Daily said:

Happy Mardi Gras. The first round of Hurricanes is on me. - Dooley Top News Stories 2013 Crystal Ball

February 12, 2013 7:51 AM
 

Satya said:

Hi,

Nice post.. I want to use keyword query class to search in People index, how can i achieve that.

February 27, 2013 1:28 AM
 

CoreyRoth said:

@Satya Use the Result Source for Local People Results.  www.dotnetmafia.com/.../list-of-common-sharepoint-2013-result-source-ids.aspx

April 11, 2013 10:19 PM
 

Mark said:

Hi, have you tried to use special scope in KeywordQuery?  In sp2013 we have result sources, I want to define search scope.

April 26, 2013 1:50 AM
 

MB said:

This example throws a missible Microsoft.SharePoint.Client.ServerRuntime error.  Am I missing an unmentioned DLL or install?

November 12, 2013 10:03 AM
 

Consultas con el modelo de objetos de servidor de SharePoint 2013 | materiagris.net said:

Pingback from  Consultas con el modelo de objetos de servidor de SharePoint 2013 | materiagris.net

April 25, 2014 5:59 AM
 

marcos said:

Hi Corey,

Thanks for the very helpful write up.

I was wondering if it is possible to search without a keyword.Eg.: Is it possible to simply list out all MS word documents using this keywordquery class?

May 22, 2014 7:03 AM
 

CoreyRoth said:

@Marcos sure you can do that with the FileExtension keyword.  Just enter a query such as FileExtension:docx and it will return all Word documents.

May 27, 2014 9:56 AM
 

Mostafa said:

This code doesn't return any results even though i have used SP2013 Query tool to test out my query which has one keyword and it returns 1 result while using code doesn't return results. any idea why would this happen ?

June 30, 2014 12:35 PM

Leave a Comment

(required)  
(optional)
(required)  
Add

About CoreyRoth

Corey Roth is an independent SharePoint consultant specializing in ECM, Apps, and Search.
2012 dotnetmafia.
Powered by Community Server (Non-Commercial Edition), by Telligent Systems