SqlFilter SqlFilter Class

Definition

Represents a filter, which is a combination of an expression and an action that is executed in the publish/subscribe pipeline. For information about the SQLFilter syntax, see SQLFilter syntax.

[DataContract(Name = "SqlFilter", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
[KnownType(typeof (TrueFilter))]
[KnownType(typeof (FalseFilter))]
[KnownType(typeof (DateTimeOffset))]
public class SqlFilter : Filter, IExtensibleDataObject<DataContract(Name:="SqlFilter", Namespace:="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>
<KnownType(GetType(TrueFilter))>
<KnownType(GetType(FalseFilter))>
<KnownType(GetType(DateTimeOffset))>
Public Class SqlFilter
    Inherits Filter
    Implements IExtensibleDataObject
Inheritance
SqlFilterSqlFilter
Derived
Attributes

Inherited Members

Microsoft.ServiceBus.Messaging.Filter

System.Object

Constructors

SqlFilter(String) SqlFilter(String)

Initializes a new instance of the SqlFilter class using the specified SQL expression.

public SqlFilter(string sqlExpression)Public Sub New(sqlExpression As String)
Parameters
sqlExpression
String String

The SQL expression.

Attributes

Properties

CompatibilityLevel CompatibilityLevel

This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.

[DataMember(Name = "CompatibilityLevel", Order = 65538, EmitDefaultValue = false, IsRequired = false)]
public int CompatibilityLevel { get; }<DataMember(Name:="CompatibilityLevel", Order:=65538, EmitDefaultValue:=False, IsRequired:=False)>
Public ReadOnly Property CompatibilityLevel As Integer
Value
Int32 Int32

The compatibility level.

Attributes

Remarks

This property is reserved for future use.

Parameters Parameters

Sets the value of a filter expression.

public IDictionary<string, object> Parameters { get; }Public ReadOnly Property Parameters As IDictionary(Of String, Object)
Value
IDictionary<String, Object> IDictionary(Of String, Object)

The value of a filter expression.

Attributes

RequiresPreprocessing RequiresPreprocessing

Gets a value indicating whether the SQL filter expression requires preprocessing.

public override bool RequiresPreprocessing { get; }Public Overrides ReadOnly Property RequiresPreprocessing As Boolean
Value
Boolean Boolean

true if the SQL filter expression requires preprocessing; otherwise, false. Currently always returns true.

Attributes
Overrides

SqlExpression SqlExpression

Gets the SQL expression.

[DataMember(Name = "SqlExpression", Order = 65537, EmitDefaultValue = false, IsRequired = false)]
public string SqlExpression { get; }<DataMember(Name:="SqlExpression", Order:=65537, EmitDefaultValue:=False, IsRequired:=False)>
Public ReadOnly Property SqlExpression As String
Value
String String

The SQL expression.

Attributes

Methods

Match(BrokeredMessage) Match(BrokeredMessage)

Specifies whether a message matches against the current SQL expression.

public override bool Match(BrokeredMessage message)Public Overrides Function Match(message As BrokeredMessage) As Boolean
Parameters
message
BrokeredMessage BrokeredMessage

The BrokeredMessage.

Returns

truea message matches against the current SQL expression; otherwise, false.

Attributes
Overrides

Preprocess() Preprocess()

Gets the preprocessed filter expression.

public override Filter Preprocess()Public Overrides Function Preprocess As Filter
Returns

The preprocessed filter expression.

Attributes
Overrides

ToString() ToString()

Returns a string representation of SqlFilter.

public override string ToString()Public Overrides Function ToString As String
Returns

The string representation of SqlFilter.

Attributes
Overrides

Validate() Validate()

Validates the SQL expression.

public override void Validate()Public Overrides Sub Validate
Attributes
Overrides