SqlFilter SqlFilter Class

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

Syntax

Declaration

[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 Hierarchy

Inherited Members

Microsoft.ServiceBus.Messaging.Filter.System.Runtime.Serialization.IExtensibleDataObject.ExtensionData
Microsoft.ServiceBus.Messaging.Filter.System.Runtime.Serialization.IExtensibleDataObject.ExtensionData
,
Microsoft.ServiceBus.Messaging.Filter.System.Runtime.Serialization.IExtensibleDataObject.ExtensionData
Microsoft.ServiceBus.Messaging.Filter.System.Runtime.Serialization.IExtensibleDataObject.ExtensionData
, , , , , , , , , , ,

Constructors summary

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

Properties summary

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

Sets the value of a filter expression.

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

Gets the SQL expression.

Methods summary

Specifies whether a message matches against the current SQL expression.

Gets the preprocessed filter expression.

Returns a string representation of SqlFilter.

Validates the SQL expression.

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

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

    Property Value

  • Parameters
    Parameters

    Sets the value of a filter expression.

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

    Property Value

  • 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

    Property Value

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

  • 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

    Property Value

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

    Returns

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

  • Preprocess()
    Preprocess()

    Gets the preprocessed filter expression.

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

    Returns

  • ToString()
    ToString()

    Returns a string representation of SqlFilter.

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

    Returns

  • Validate()
    Validate()

    Validates the SQL expression.

    public override void Validate()Public Overrides Sub Validate

Details

Assembly

Microsoft.ServiceBus.dll