AddDocument
Adds a new document to be indexed.
Read time 2 minutesLast updated 12 days ago
Definition
- Type: Method
- Namespace: UnityEditor.Search
- Assembly: UnityEditor
AddDocument(string, bool)
Adds a new document to be indexed.
public int AddDocument(string document, bool checkIfExists = true)
Parameters
Returns
Type | Description |
|---|---|
| int | The document index/handle used to add new index entries. |
Examples
using System.Linq;using UnityEditor;using UnityEditor.Search;using UnityEngine;static class Example_SearchIndexer_AddDocument{ [MenuItem("Examples/SearchIndexer/AddDocument")] public static void Run() { var si = new SearchIndexer("SearchIndexerExample", FileUtil.GetUniqueTempPathInProject()); si.Start(); // The most efficient way of adding a document is by not checking if the // document ID was already added if you are sure that all your document IDs are unique. var di = si.AddDocument("document1", checkIfExists: false); // You can set `checkIfExists=true` to check for existing document IDs, and the system // will return an index of any existing document IDs. Debug.Assert(di == si.AddDocument("document1", checkIfExists: true)); // Once you have added a new document, you need to use the returned handle to index words, numbers and properties. si.AddWord("unity", 0, di); si.AddProperty("is", "awesome", di); si.AddNumber("version", 3.0, score: 0, di); si.Finish(() => { Debug.Assert(si.Search("unity version>=3").Count() == 1, "No result were found"); // Dispose of the SearchIndexer when you are done with it. si.Dispose(); }); }}
AddDocument(string, string, string, bool, SearchDocumentFlags)
Adds a new document to be indexed.
public int AddDocument(string document, string name, string source, bool checkIfExists, SearchDocumentFlags flags)
Parameters
Unique document ID.
Name of path of the document.
Source of the document. In example, if the document is a nested object, the source should be the container asset path.
Pass true if this document has some chance of existing already.
Flags describing the nature of the document.
Returns
Type | Description |
|---|---|
| int | The document index/handle used to add new index entries. |
Examples
using System.Linq;using UnityEditor;using UnityEditor.Search;using UnityEngine;static class Example_SearchIndexer_AddDocument{ [MenuItem("Examples/SearchIndexer/AddDocument")] public static void Run() { var si = new SearchIndexer("SearchIndexerExample", FileUtil.GetUniqueTempPathInProject()); si.Start(); // The most efficient way of adding a document is by not checking if the // document ID was already added if you are sure that all your document IDs are unique. var di = si.AddDocument("document1", checkIfExists: false); // You can set `checkIfExists=true` to check for existing document IDs, and the system // will return an index of any existing document IDs. Debug.Assert(di == si.AddDocument("document1", checkIfExists: true)); // Once you have added a new document, you need to use the returned handle to index words, numbers and properties. si.AddWord("unity", 0, di); si.AddProperty("is", "awesome", di); si.AddNumber("version", 3.0, score: 0, di); si.Finish(() => { Debug.Assert(si.Search("unity version>=3").Count() == 1, "No result were found"); // Dispose of the SearchIndexer when you are done with it. si.Dispose(); }); }}