Try our conversational search powered by Generative AI!

AI OnAI Off

Class SearchParameters

Search parameters that can be specified to control what SQL Command is executed on the server.

Inheritance
System.Object
SearchParameters
CatalogSearchParameters
ApplicationLogParameters
OrderSearchParameters
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.Commerce.Shared
Assembly: Mediachase.Commerce.dll
Version: 10.8.0
Syntax
public abstract class SearchParameters

Constructors

SearchParameters()

Initializes a new instance of the SearchParameters class.

Declaration
public SearchParameters()

Properties

CacheKey

Gets the cache key. Used to generate hash that will be used to store data in memory if needed.

Declaration
public virtual string CacheKey { get; }
Property Value
Type Description
System.String

The cache key.

JoinSourceTable

Gets or sets the join source table. This value has to be a table name that exists in original query. For example it will be CatalogEntry for the Catalog Entry Search or CatalogNode for the Catalog Node Search.

Declaration
public string JoinSourceTable { get; set; }
Property Value
Type Description
System.String

The join source table.

JoinSourceTableKey

Gets or sets the join source table key.

Declaration
public string JoinSourceTableKey { get; set; }
Property Value
Type Description
System.String

The join source table key.

JoinTargetQuery

Gets or sets the join target query. This can either be a table name or a complete query. For exammple the table name can be something like CatalogEntryEx for the Catalog Entry search. This particular join will allow sorting by meta fields. This is not possible without a join. In some cases the target table can contain multiple records for the same record in source table. That will cause problems with constraints that are inforces by the search DTOs. In order to overcome this, you can specify the query, so if our CatalogEntryEx table had multiple records for one CatalogEntry, we would join it using the follow query: (select distinct ObjectId, DisplayName from CatalogEntryEx) CatalogEntryEx

Declaration
public string JoinTargetQuery { get; set; }
Property Value
Type Description
System.String

The join target table.

JoinTargetTableKey

Gets or sets the join target table key.

Declaration
public string JoinTargetTableKey { get; set; }
Property Value
Type Description
System.String

The join target table key.

JoinType

Gets or sets the type of the join used in the query. The example types are: inner join, outer join, left join and right join.

Declaration
public string JoinType { get; set; }
Property Value
Type Description
System.String

The type of the join.

KeywordSearchPhrase

Gets or sets the keyword text search phrase.

Declaration
public string KeywordSearchPhrase { get; set; }
Property Value
Type Description
System.String

The keyword text search phrase.

OrderByClause

Gets or sets the order by clause.

Declaration
public string OrderByClause { get; set; }
Property Value
Type Description
System.String

The order by clause.

SqlMetaWhereClause

Gets or sets the SQL meta where clause. You can specify filters for meta tables. Make sure to specifiy columns that exist for items searched.

Declaration
public string SqlMetaWhereClause { get; set; }
Property Value
Type Description
System.String

The SQL meta where clause.

SqlWhereClause

Gets or sets the SQL where clause. You can specify filter conditions against the tables returned by the query.

Declaration
public string SqlWhereClause { get; set; }
Property Value
Type Description
System.String

The SQL where clause.