The IndexDocumentData class contains the additional information associated with a
document that has already been persisted in the Ankiro Suite database.
Inheritance Hierarchy
Ankiro.SearchServer.Data DocumentData
Ankiro.SearchServer.Data IndexDocumentData
Namespace: Ankiro.SearchServer.Data
Assembly: Ankiro.SearchServer.Data (in Ankiro.SearchServer.Data.dll) Version: 1.13.770.19207 (1.13.770.19207)
Syntax
The IndexDocumentData type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | IndexDocumentData | Initializes a new instance of the IndexDocumentData class |
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ReplaceProperty | (Inherited from DocumentData.) |
![]() | ToString | (Inherited from DocumentData.) |
Properties
Name | Description | |
---|---|---|
![]() | AccessRules |
The optional collection of generalized access rules for the document. Please refer to the developer documentation for more details about how security checking is handled in Ankiro Suite.
(Inherited from DocumentData.) |
![]() | Action |
Specifies whether a document processed through the document service should be created, updated or removed.
Currently, Create and Update are handled in the same way, whereas Action=Remove will permanently remove the document from the database.
If not specified, the default value is Create.
(Inherited from DocumentData.) |
![]() | Created |
Creation timestamp of the document instance in the Ankiro Suite installation, e.g. the time at which the document was first added.
|
![]() | DataSourceId |
The id of the data source to which the document belongs.
(Inherited from DocumentData.) |
![]() | ExtensionData | (Inherited from DocumentData.) |
![]() | FileData |
The optional file data of the document to be parsed by Ankiro Suite. Using file data assumes that one or more data source properties are mapped to binary field content.
Please refer to the developer documentation for more details about how file content is processed. (Inherited from DocumentData.) |
![]() | FriendlyUri |
The optional friendly uri for the data source document. Friendly uri's are not processed or handled specifically by Ankiro Suite,
rather the friendly uri is returned in search results for presentation purposes.
(Inherited from DocumentData.) |
![]() | Id |
Internal database id of the document. This property should never be modified manually.
|
![]() | Items |
The optional collection of items for the document, in case one or more properties of the data source are marked as item list properties. (Inherited from DocumentData.) |
![]() | Language |
The optional two-letter iso code of the language in which the document is authored.
(Inherited from DocumentData.) |
![]() | LastUpdated |
Timestamp of the last time the document was updated in the Ankiro Suite database.
|
![]() | PathSegment |
The location of the document in the data source path segment hierarchy.
(Inherited from DocumentData.) |
![]() | Position |
The optional geographical location of the document, if meaningful in the context of the data source. This property is used to facilitate geospatial queries on document
data. Position must be specified as a point using the global SRID (spatial reference id) of 4326, which is in the WGS84 format. When searching, use the
SearchParameters.PositionLimiter member to narrow searches to documents matching the geospatial limiter/filter.
(Inherited from DocumentData.) |
![]() | Properties |
The collection of properties of the document. Document property values must conform to the schema specified by the data source. (Inherited from DocumentData.) |
![]() | ServerIndexId |
Id of the server index in which the document is indexed, or 0 (zero) if the document is not indexed in any server index.
|
![]() | ServerNodeId |
Id of the search server node on which the persisted document is currently located.
|
![]() | StaticWeight |
NOTE: This property is not yet fully supported. For now data source properties with the type "weight" should be used in conjunction with a specially crafted search profile.
Optionally controls the static weight of the document within the interval [0.0-1.0]. The static document weight measure is factored into search result ranking
regardless of the search words that are used. This means that a statically higher-weighted document that is matched to some extent
by a search query will (all else being equal) gain precedence in the ranking, compared to other equally matched documents that
have a lower static weight.
The static weight of documents can be controlled either on a document-by-document basis, using the StaticWeight field, or on a data source
tree level, using the Weight field of an associated path segment tree.
A static weight measure of 0.0 on the document or on an ancestor path segment is equivalent to excluding the document from being indexed.
(Inherited from DocumentData.) |
![]() | Uri |
The Uri uniquely identifying the document in relation to the external data source.
This could be a string version of an external database id, a unique web url or other suitable value controlled by the data source connector.
(Inherited from DocumentData.) |
![]() | Version |
Internal database version of the document. This property should never be modified manually.
|
See Also