Ayende @ Rahien

Hi!
My name is Oren Eini
Founder of Hibernating Rhinos LTD and RavenDB.
You can reach me by phone or email:

ayende@ayende.com

+972 52-548-6969

, @ Q c

Posts: 5,953 | Comments: 44,399

filter by tags archive

NHibernate Filters


One of the more interesting ability of NHibernate is to selectively filter records based on some global filters. This allow us to very easily create global where clauses that we can flip on and off at the touch of a switch.

Let us take a look at see what I mean.

We define the filter effectiveDate:

<filter-def name="effectiveDate">
	<filter-param name="asOfDate" type="System.DateTime"/>
</filter-def>

A filter definition is most commonly just a set of parameters that we can define, which will later be applied to in the appropriate places. An example of an appropriate place would be Post.PostedAt, we don’t want to show any post that was posted at a later time than the effective date. We can define this decision in the mapping, like this:

<class name="Post"
		   table="Posts">
		<id name="Id">
			<generator class="identity"/>
		</id>
		
		<property name="Title"/>
		<property name="Text"/>
		<property name="PostedAt"/>
		
		
		<filter name="effectiveDate"
						condition=":asOfDate >= PostedAt"/>
	</class>

And now we can start play:

s.CreateCriteria<Post>()
	.SetMaxResults(5)
	.List();

s.EnableFilter("effectiveDate")
	.SetParameter("asOfDate", DateTime.Now);

s.CreateCriteria<Post>()
	.SetMaxResults(5)
	.List();

Who do you think this will generate?

Well, the first query is pretty easy to understand:

image

But the second one is much more interesting:

image

We have selectively applied the filter so only posted posted after the 16th can be seen.

This is a very powerful capability to have, since we can use this globally, to define additional condition. For that matter, we can apply it in multiple places, so comments would also be so limited, etc.

For that matter, we can also put filters on associations as well:

<set name="Comments"
	 table="Comments">
	<key column="PostId"/>
	<one-to-many class="Comment"/>
	<filter name="effectiveDate"
					condition=":asOfDate >= PostedAt"/>
</set>

And trying to access the Comments collection on a Post would generate the following SQL when the filter is active:

image

Nice, isn’t it?


Comments

Frank Quednau

Hi Ayende,

would this be the right feature to leverage when implementing data restrictions based on user privileges?

Erik van Brakel

Wow, this is one feature I didn't know of. Thanks!

Ayende Rahien

Frank,

Depending on what you are doing.

I would tend to use Rhino Security for such tasks

Dmitry

Filters are certainly very useful especially when dealing with records that expire or can have a temporary invalid/restricted state.

What I really don't like is that Session.Get and Session.Load commands ignore filters. Session.Load is not much of a problem because it is only being used when it is known that the record exists. But I always end up reimplementing the Get() method in the repository using a query to make sure developers do not accidentally load an invalid record and probably ending up losing some optimization benefits.

zoidbeck

Hi Ayende,

is it possible to use this filter with properties residing deeper in the objectgraph, for example on a
<many association within the filtered bag?

something like this, where Edits would be a mapped <many-to-one holding the timestamp:

<filter= Edits.EditTS"/>

zoidbeck

Sorry, that did not work. should have masked the xml.

Here is the example in pure text:

class blog

has a list of comments

class comment

has a list of edits

class edit

has a edit-timestamp property

filter:

name="effectiveDate"

condition=":asOfDate >= Edits.EditTS"

would this be possible using filters?

Comment preview

Comments have been closed on this topic.

FUTURE POSTS

  1. Comparing developers - 4 hours from now

There are posts all the way to Jun 30, 2015

RECENT SERIES

  1. The RavenDB Comic Strip (3):
    28 May 2015 - Part III – High availability & sleeping soundly
  2. Special Offer (2):
    27 May 2015 - 29% discount for all our products
  3. RavenDB Sharding (3):
    22 May 2015 - Adding a new shard to an existing cluster, splitting the shard
  4. Challenge (45):
    28 Apr 2015 - What is the meaning of this change?
  5. Interview question (2):
    30 Mar 2015 - fix the index
View all series

Syndication

Main feed Feed Stats
Comments feed   Comments Feed Stats