Keyoti SearchUnit API Docs
DataSetBasedSource Class
API DocumentationKeyoti.SearchEngine.Index.IndexableSourcesDataSetBasedSource
Keyoti SearchUnit v6
A dataset based source
Declaration Syntax
C#Visual Basic
public class DataSetBasedSource : IndexableSource
Public Class DataSetBasedSource
	Inherits IndexableSource
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
DataSetBasedSource(Configuration, IndexableSourceRecord, IDataSetAdapter)
Instantiates a dataSet based indexable source

AddedDocument
Fired when a document has been added to the index.
(Inherited from IndexableSource.)
AddingDocument
Fired when a document is about to be added
(Inherited from IndexableSource.)
Cancel()()()()
Cancel the import
(Inherited from IndexableSource.)
Cancelled
Whether the import was cancelled.
(Inherited from IndexableSource.)
Close()()()()
Closes the data access
(Inherited from IndexableSource.)
Configuration
The configuration.
(Inherited from IndexableSource.)
DataAccess
The data-access layer.
(Inherited from IndexableSource.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
FindDataRow(String, String)
Looks through the current and subsequent pages of DataSets for a DataRow whose primary key value is primaryKeyValue

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetImportSample(DataSet, Int32, LinkBasedImportSampler..::..InvokeMethod)
Gets a sample of the import data that Import will retrieve.
(Overrides IndexableSource.GetImportSample(DataSet, Int32, LinkBasedImportSampler..::..InvokeMethod).)
GetNextDataSet()()()()
Gets the next DataSet chunk from the data source.

GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Import()()()()
Imports the records for an indexable source
(Overrides IndexableSource.Import()()()().)
ImportSampleDataTableColumnsFinalized
Fired when the DataTable used for the import sample has it's columns finalized.
(Inherited from IndexableSource.)
IndexableSourceRecord
The record representing this source, in the data-access
(Inherited from IndexableSource.)
ItemsImported
The number of rows that have been imported since the last call to Import.
(Overrides IndexableSource.ItemsImported.)
ItemsToImportTotal
If available. The total number of items (documents, records, files, etc) that will be imported.
(Inherited from IndexableSource.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnAddedDocument(AddDocumentEventArgs)
Fires the AddedDocument event.
(Inherited from IndexableSource.)
OnAddingDocument(AddDocumentEventArgs)
Fires the AddingDocument event.
(Inherited from IndexableSource.)
OnImportSampleDataTableColumnsFinalized(EventArgs)
Raises ImportSampleDataTableColumnsFinalized
(Inherited from IndexableSource.)
OnReaderExceptionOccurred(ReaderExceptionOccurredEventArgs)
Called whenever a readerException is caught
(Inherited from IndexableSource.)
Open()()()()
Opens the data access
(Inherited from IndexableSource.)
PageSize
The number of records to read in each paging operation.

ReaderExceptionOccurred
Fired whenever the (web) reader encounters a network exception, eg. 404 (this can be useful for identifying dead links)
(Inherited from IndexableSource.)
Reset()()()()
Resets the iterator to the start of the DataSet

SetIndexableSourceRecord(IndexableSourceRecord)
Sets record representing this source, in the data-access
(Inherited from IndexableSource.)
ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Inheritance Hierarchy
Object
IndexableSource
 DataSetBasedSource

Assembly: Keyoti4.SearchEngine.Core (Module: Keyoti4.SearchEngine.Core.dll) Version: 2022.8.22.610