IDocumentWebService.SynchronizeDataSourcePathSegmentTree Method

IDocumentWebService SynchronizeDataSourcePathSegmentTree Method

Ankiro Enterprise Suite Reference Documentation

Completely replaces the data source path tree for a specified data source with the tree information passed to the method. Existing path segments that are not included in the updated path tree are removed, including any path segment rules that were associated with them. The method does not update rules that are passed to the method. However, rules that exists on path segments that are not removed, are not affected by the operation. It is legal to call the method with a null parameter. Calling the method with an empty (null) tree removes all path segments from the data source.

Namespace: Ankiro.SearchServer.Web.Services
Assembly: Ankiro.SearchServer.Web (in Ankiro.SearchServer.Web.dll) Version: 1.13.770.19253 (1.13.770.19253)

Syntax

C++

Copy to Clipboard Print

DataSourcePathSegmentData SynchronizeDataSourcePathSegmentTree(
	int dataSourceId,
	DataSourcePathSegmentData tree,
	bool deleteOrphanedDocuments,
	bool updateIncludeState
)

DataSourcePathSegmentData SynchronizeDataSourcePathSegmentTree(
	int dataSourceId,
	DataSourcePathSegmentData tree,
	bool deleteOrphanedDocuments,
	bool updateIncludeState
)

Parameters

dataSourceId: Type: System Int32
The id of the data source.

tree: Type: Ankiro.SearchServer.Data DataSourcePathSegmentData
The new data source tree for the data source.

deleteOrphanedDocuments: Type: System Boolean
If true, any documents in the data source that belongs to a deleted path segment is also deleted from the data source and from any index containing documents from the data source. The method does not commit this change. Rather, Commit() or CommitFullUpdate() should be invoked subsequently to complete the document deletion.

updateIncludeState: Type: System Boolean

Return Value

Type: DataSourcePathSegmentData
The updated data source tree.