SearchIndex
org.sagebionetworks.repo.model.search.table.SearchIndex
A search index entity. Its content is defined by a Synapse SQL query (definingSQL) that references a single table-like entity. An OpenSearch index is built from the query results, supporting full-text search, faceted search, and autocomplete. Optionally references a SearchConfiguration for analyzer and synonym settings.
| Field | Type | Description |
|---|---|---|
| name | STRING | The name of this entity. Must be 256 characters or less. Names may only contain: letters, numbers, spaces, underscores, hyphens, periods, plus signs, apostrophes, and parentheses |
| description | STRING | The description of this entity. Must be 1000 characters or less. |
| id | STRING | The unique immutable ID for this entity. A new ID will be generated for new Entities. Once issued, this ID is guaranteed to never change or be re-issued |
| etag | STRING | Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time an entity is updated it is used to detect when a client's current representation of an entity is out-of-date. |
| createdOn | STRING | The date this entity was created. |
| modifiedOn | STRING | The date this entity was last modified. |
| createdBy | STRING | The ID of the user that created this entity. |
| modifiedBy | STRING | The ID of the user that last modified this entity. |
| parentId | STRING | The ID of the Entity that is the parent of this Entity. |
| concreteType | STRING | Indicates which implementation of Entity this object represents. The value is the fully qualified class name, e.g. org.sagebionetworks.repo.model.FileEntity. |
| definingSQL | STRING | The Synapse SQL statement that defines which columns and rows are indexed. Must reference exactly one entity. Multi-entity JOINs are not supported. |
| searchConfigurationId | STRING | The ID of the SearchConfiguration to apply when building this search index. If not provided, the system will check for a search configuration binding on the parent project/folder hierarchy, or use platform defaults. |