Generic Way to Check If Entity Exists In Entity Framework?

C#GenericsEntity Framework-4.1

C# Problem Overview


Similar to https://stackoverflow.com/questions/1802286/best-way-to-check-if-object-exists-in-entity-framework

I'm looking for a generic way to check for an entity in a DbSet. Something like this, which doesn't work:

private DbContext DbContext { get; set; }

private DbSet<T> DbSet { get; set; }

public Boolean Exists(T entity) {
    return ((from item in this.DbSet
             where item == entity
             select item).Count() > 0);
}

The line where item == entity works in LINQ to SQL, but apparently not with LINQ to Entities. Since the entities may have different keys I can't have them all inherit from a common abstract with a known key for comparison.

I could do this, but I'm worried about the performance of catching exceptions as a verification process This doesn't work either since as long as the entity is detached the OriginalValues property can't be obtained:

public Boolean Exists(T entity) {
    try {
        var current = this.DbContext.Entry(entity).OriginalValues;
        // Won't reach this line if the entity isn't in the database yet
        return true;
    }
    catch (Exception ex) {
        return false;
    }
}

C# Solutions


Solution 1 - C#

Do you want generic way to check if entity was loaded by context or generic way to query database if entity exists?

For the former case use:

public bool Exists<T>(T entity) where T: class
{
    return this.Set<T>().Local.Any(e => e == entity);
}

For the latter case use (it will check loaded entities as well):

public bool Exists<T>(params object[] keys)
{
    return this.Set<T>().Find(keys) != null;
}

Edit:

EF code first is not supposed to access this kind of information but it is possible to get name of entity keys. I think something like that should work:

var objContext = ((IObjectContextAdapter)dbContext).ObjectContext;
var objSet = objContext.CreateObjectSet<T>();
var keyNames = objSet.EntitySet.ElementType.KeyMembers.Select(m => m.Name);

But this all doesn't make sense. You want generic approach but your entities doesn't share necessary information to allow generic approach. Now you say that you even don't know key values. Using this "generic" approach will require reflection and manual building of expression tree.

Solution 2 - C#

Thanks to @Ladislav for getting me in the right direction. Here's the code for a generic Exists() method.

I'd like to note that this doesn't require reflection and seems to perform quite well. The only thing I'm not thrilled about is that TryGetObjectByKey() has the side-effect of attaching the found entity. Since I don't want Exists() to have that unintentional result I have to detach the entity if it was found.

public Boolean Exists(T entity) {
    var objContext = ((IObjectContextAdapter)this.DbContext).ObjectContext;
    var objSet = objContext.CreateObjectSet<T>();
    var entityKey = objContext.CreateEntityKey(objSet.EntitySet.Name, entity);

    Object foundEntity;
    var exists = objContext.TryGetObjectByKey(entityKey, out foundEntity);
    // TryGetObjectByKey attaches a found entity
    // Detach it here to prevent side-effects
    if (exists) {
        objContext.Detach(foundEntity);
    }

    return (exists);
}

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionYuckView Question on Stackoverflow
Solution 1 - C#Ladislav MrnkaView Answer on Stackoverflow
Solution 2 - C#YuckView Answer on Stackoverflow