具有代码优先模型的“可组合”全文搜索

时间:2013-09-11 16:06:22

标签: c# .net entity-framework full-text-search

更新 2013年9月18日

看起来没有一种简单的方法可以做到这一点。我正在坚持一个涉及对Entity Framework进行一些扩展的解决方案。

如果您想在实体框架中看到这些功能,请在user voice site上投票,或许herehere


关于SO有几个类似的问题,但我找不到一个新问题和类似的问题,足以得到我正在寻找的答案。

如果这看起来像信息过载,请跳至摘要

背景

我正在编写WebApi REST服务,以通过OData端点公开一些预先存在的数据。我正在使用EntitySetContoller<TEntity, TKey>为我做所有琐碎的工作。除了由基类路由和翻译的standard OData parameters之外,我还添加了一些自定义参数,以便为我的控制器提供特定的功能。

我的数据库服务器是MS SQL Server,在[BigText] NVarChar[4000]表的[SomeEntity]列上有一个全文索引。

我有一个限制,我必须使用Code First模型。

// Model POCO
public class SomeEntity
{
    public int Id { get; set; }
    public string BigText { get; set; }
}

// Simple Controller
public class SomeEntityController : EntitySetController<SomeEntity, int>
{
    private readonly SomeDbContext context = new SomeDbContext();

    public override IQueryable<SomeEntity> Get()
    {
        var parameters = Request.GetQueryNameValuePairs()
            .ToDictionary(p => p.Key, p => p.Value);

        if (parameters.ContainsKey("BigTextContains")
        (
            var searchTerms = parameters["BigTextContains"];
            // return something special ... 
        )

        return this.context.SomeEntities;
    }

    // ... The rest is omitted for brevity.
}

问题

如何实现我的示例的// return something special ...部分?

显然,niave

return this.context.SomeEntities.Where(e =>
    e.BigText.Contains(searchTerm));

完全错误,它组成了一个WHERE子句,如

[BigText] LIKE '%' + @searchTerm + '%'

这不使用全文搜索,因此不支持复杂的搜索术语,否则执行可怕。

这种方法,

return this.context.SomeEntities.SqlQuery(
    "SELECT E.* FROM [dbo].[SomeEntity] E " +
        "JOIN CONTAINSTABLE([SomeEntity], [BigText], @searchTerm) FTS " +
            " ON FTS.[Key] = E.[Id]",
    new object[] { new SqlParameter("@searchTerm", searchTerm) })
    .AsQueryable();

看起来很有前途,它实际上使用全文搜索,并且非常实用。但是,您会注意到DbSqlQuerySqlQuery函数返回的类型未实现IQueryable。在这里,它被强制转换为具有AsQueryable()扩展名的正确返回类型,但这打破了“组合链”。将在服务器上执行的唯一语句是上面代码中指定的语句。在OData URL上指定的任何其他子句将在API托管Web服务器上提供服务,而不会受益于数据库引擎的索引和基于专用集的功能。

摘要

使用Entity Framework 5 Code First模型访问MS SQL Server的全文搜索CONTAINSTABLE函数并获取“可组合”结果的最便捷方法是什么?

我是否需要自己撰写IQueryProvider?我能以某种方式扩展EF吗?

我不想使用Lucene.Net,我不想使用数据库生成模型。也许我可以添加额外的包或等待EF6,这会有帮助吗?

2 个答案:

答案 0 :(得分:7)

这并不完美,但你可以通过2次调用数据库来完成你的目标。 第一个调用将从CONTAINSTABLE中检索匹配键的列表,然后第二个调用将是您使用从第一个调用返回的ID的可组合查询。

//Get the Keys from the FTS
var ids = context.Database.SqlQuery<int>( 
          "Select [KEY] from CONTAINSTABLE([SomeEntity], [BigText], @searchTerm)", 
          new object[] { new SqlParameter("@searchTerm", searchTerm) });

//Use the IDs as an initial filter on the query
var composablequery = context.SomeEntities.Where(d => ids.Contains(d.Id));

//add on whatever other parameters were captured to the 'composablequery' variable
composablequery = composablequery.Where(.....)

答案 1 :(得分:2)

我最近遇到了同样的问题: EF 5 Code First FTS Queriable

让我延长这个职位。

  • 你的第一个选择也是我的第一个 - 使用SqlQuery 我还需要做更多的过滤,所以不是总是编写完整的sql我使用了QueryBuilder,我做了一些更改并添加了更多功能以满足我的需求(如果需要我可以上传到某处): QueryBuilder

  • 在找到我实施的另一个想法之后。 有人已经在这里提到过,那就是使用将返回Ids的HashSet的SqlQuery,并且可以在包含EF的EF查询中使用它。 这是更好但不是最优的,因为你在内存中需要2个查询和Id列表。 例如:

        public IQueryable<Company> FullTextSearchCompaniesByName(int limit, int offset, string input, Guid accountingBureauId, string orderByColumn)
    {
        FtsQueryBuilder ftsQueryBuilder = new FtsQueryBuilder();
    
        ftsQueryBuilder.Input = FtsQueryBuilder.FormatQuery(input);
        ftsQueryBuilder.TableName = FtsQueryBuilder.GetTableName<Company>();
        ftsQueryBuilder.OrderByTable = ftsQueryBuilder.TableName;
        ftsQueryBuilder.OrderByColumn = orderByColumn;
        ftsQueryBuilder.Columns.Add("CompanyId");
    
        if (accountingBureauId != null && accountingBureauId != Guid.Empty)
            ftsQueryBuilder.AddConditionQuery<Guid>(Condition.And, "" , @"dbo.""Company"".""AccountingBureauId""", Operator.Equals, accountingBureauId, "AccountingBureauId", "");
    
        ftsQueryBuilder.AddConditionQuery<bool>(Condition.And, "", @"dbo.""Company"".""Deleted""", Operator.Equals, false, "Deleted", "");
    
        var companiesQuery = ftsQueryBuilder.BuildAndExecuteFtsQuery<Guid>(Context, limit, offset, "Name");
        TotalCountQuery = ftsQueryBuilder.Total;
        HashSet<Guid> companiesIdSet = new HashSet<Guid>(companiesQuery);
        var q = Query().Where(a => companiesIdSet.Contains(a.CompanyId));
        return q;
    }
    
  • 然而,EF 6现在有一些叫做Interceptor的东西,可以用来实现可查询的FTS,它非常简单和通用(最后的帖子): EF 6 Interceptors for FTS。 我测试过这个并且工作正常。

!!备注:即使使用版本6,EF Code First也不支持自定义存储过程。 如果我理解的话,只有一些用于预定义的CUD操作: Code First Insert/Update/Delete Stored Procedure Mapping,因此无法完成。

结论:如果你可以使用EF 6去第三个选项,那就给你所需要的一切。 如果您使用EF 5或更低版本,则第二个选项优先于第一个但不是最佳选择。