Class SqlIndexBuilder

Namespace

Dynamicweb.Indexing.Builders

Assembly

Dynamicweb.Core.dll

Represents Sql Index Builder

[AddInName("Sql Index Builder")]
public class SqlIndexBuilder : IndexBuilderBase, IIndexBuilder

Inheritance

object

ConfigurableAddIn

IndexBuilderBase

SqlIndexBuilder

Implements

IIndexBuilder

Inherited Members

IndexBuilderBase.Name

IndexBuilderBase.Type

IndexBuilderBase.Action

IndexBuilderBase.Settings

IndexBuilderBase.Meta

IndexBuilderBase.Extenders

IndexBuilderBase.Schema

IndexBuilderBase.Notification

IndexBuilderBase.SetValue<T>(string, T)

IndexBuilderBase.GetBoolean(string)

IndexBuilderBase.GetInt32(string)

IndexBuilderBase.GetString(string)

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SqlIndexBuilder()

Initializes a new instance of the SqlIndexBuilder class.

public SqlIndexBuilder()

SqlIndexBuilder(IDictionary<string, string>)

Initializes a new instance of the SqlIndexBuilder class using the specified settings.

public SqlIndexBuilder(IDictionary<string, string> settings)

Parameters

settings IDictionary<string, string>

The settings data.

Properties

AutoUpdateID

Gets or sets a value indicating what is the AutoUpdateID field to use when Action is ExecuteWithAutoUpdateID.

[AddInParameterGroup("SQL Index Builder Settings")]
[AddInParameter("AutoUpdateID")]
[AddInLabel("Id Field for partial updates")]
[AddInParameterEditor(typeof(TextParameterEditor), "Explanation=Specifies the column that Lucene would use as a property to know which document to update")]
public string AutoUpdateID { get; set; }

Property Value

string

Connection

Gets or sets the connection string to use if another database than Dynamicweb database is needed.

[AddInParameterGroup("SQL Index Builder Settings")]
[AddInParameter("Connection")]
[AddInLabel("Connection string")]
[AddInParameterEditor(typeof(TextParameterEditor), "Explanation=Specifies a connection string to use if another database than Dynamicweb database is needed")]
public string Connection { get; set; }

Property Value

string

CountQuery

Gets or sets the SQL count statement to execute to return the number of rows expected from the query of records to index.

[AddInParameterGroup("SQL Index Builder Settings")]
[AddInParameter("CountQuery")]
[AddInLabel("SQL count statement")]
[AddInParameterEditor(typeof(TextParameterEditor), "TextArea=true;Explanation=Specifies the SQL to execute to return the number of rows expected from the query of records to index")]
public string CountQuery { get; set; }

Property Value

string

DefaultSettings

Gets the default settings collection.

public override IDictionary<string, object> DefaultSettings { get; }

Property Value

IDictionary<string, object>

Query

Gets or sets the SQL statement to execute and index the fields and rows returned from the query.

[AddInParameterGroup("SQL Index Builder Settings")]
[AddInParameter("Query")]
[AddInLabel("SQL statement")]
[AddInParameterEditor(typeof(TextParameterEditor), "TextArea=true;Explanation=Specifies the SQL to execute and index the fields and rows returned from the query")]
public string Query { get; set; }

Property Value

string

SupportedActions

List of supported actions

public override IEnumerable<string> SupportedActions { get; }

Property Value

IEnumerable<string>

UseStoredProcedure

Gets or sets a value indicating whether to use a stored procedure.

[AddInParameterGroup("SQL Index Builder Settings")]
[AddInParameter("UseStoredProcedure")]
[AddInLabel("Use stored procedure")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "Explanation=Determines if the query is a Stored Procedure")]
public bool UseStoredProcedure { get; set; }

Property Value

bool

Methods

Build(IIndexWriter, Tracker)

Builds the current SQL index.

public override void Build(IIndexWriter writer, Tracker tracker)

Parameters

writer IIndexWriter

The index writer.

tracker Tracker

The tracker.

GetFields()

Gets the index builder fields.

public override IEnumerable<FieldDefinitionBase> GetFields()

Returns

IEnumerable<FieldDefinitionBase>

The set of key-value pairs.