SearchIndex¶

{
  "$id": "https://open-metadata.org/schema/entity/data/SearchIndex.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SearchIndex",
  "description": "A `SearchIndex` is a index mapping definition in ElasticSearch or OpenSearch",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.data.SearchIndex",

  "definitions": {
    "searchIndexField": {
      "type": "object",
      "javaType": "org.openmetadata.schema.type.SearchIndexField",
      "description": "This schema defines the type for a field in a searchIndex.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Local name (not fully qualified name) of the field.",
          "minLength": 1,
          "maxLength": 256,
          "pattern": "^((?!::).)*$"
        },
        "displayName": {
          "type": "string",
          "description": "Display Name that identifies this searchIndexField name."
        },
        "dataType": {
          "type": "string",
          "description": "Data type of the searchIndex (int, date etc.).",
          "enum": [
            "NUMBER", "TEXT", "BINARY", "TIMESTAMP", "TIMESTAMPZ",
            "TIME", "DATE", "DATETIME", "KEYWORD", "ARRAY", "OBJECT",
            "FLATTENED", "NESTED", "JOIN", "RANGE", "IP", "VERSION",
            "MURMUR3", "AGGREGATE_METRIC_DOUBLE", "HISTOGRAM",
            "ANNOTATED-TEXT", "COMPLETION", "SEARCH_AS_YOU_TYPE",
            "DENSE_VECTOR", "RANK_FEATURE", "RANK_FEATURES",
            "GEO_POINT", "GEO_SHAPE", "POINT", "SHAPE", "PERCOLATOR",
            "BOOLEAN", "CONSTANT_KEYWORD", "WILDCARD", "LONG",
            "INTEGER", "SHORT", "BYTE", "DOUBLE", "FLOAT",
            "HALF_FLOAT", "SCALED_FLOAT", "UNSIGNED_LONG", "UNKNOWN"
          ]
        },
        "dataTypeDisplay": {
          "type": "string",
          "description": "Display name used for dataType."
        },
        "description": {
          "type": "string",
          "description": "Description of the field.",
          "$ref": "../../type/basic.json#/definitions/markdown"
        },
        "fullyQualifiedName": {
          "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
        },
        "tags": {
          "description": "Tags associated with the column.",
          "type": "array",
          "items": {
            "$ref": "../../type/tagLabel.json"
          }
        },
        "children": {
          "description": "Child columns if dataType has properties.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/searchIndexField"
          }
        }
      },
      "required": ["name", "dataType"]
    },
    "searchIndexSettings": {
      "javaType": "org.openmetadata.schema.type.searchindex.SearchIndexSettings",
      "description": "Contains key/value pair of SearchIndex Settings.",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "searchIndexSampleData": {
      "type": "object",
      "javaType": "org.openmetadata.schema.type.searchindex.SearchIndexSampleData",
      "description": "This schema defines the type to capture sample data for a SearchIndex.",
      "properties": {
        "messages": {
          "description": "List of local sample messages for a SearchIndex.",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "indexType": {
      "description": "Whether the entity is index or index template.",
      "type": "string",
      "enum": ["Index", "IndexTemplate"],
      "default": "Index"
    }
  },

  "properties": {
    "id": {
      "description": "Unique identifier that identifies this SearchIndex instance.",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Name that identifies the SearchIndex.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "Name that uniquely identifies a SearchIndex in the format 'searchServiceName.searchIndexName'.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "displayName": {
      "description": "Display Name that identifies this SearchIndex. It could be title or label from the source services.",
      "type": "string"
    },
    "description": {
      "description": "Description of the SearchIndex instance.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "version": {
      "description": "Metadata version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/entityVersion"
    },
    "updatedAt": {
      "description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
      "$ref": "../../type/basic.json#/definitions/timestamp"
    },
    "updatedBy": {
      "description": "User who made the update.",
      "type": "string"
    },
    "impersonatedBy": {
      "description": "Bot user that performed the action on behalf of the actual user.",
      "$ref": "../../type/basic.json#/definitions/impersonatedBy"
    },
    "service": {
      "description": "Link to the search cluster/service where this SearchIndex is hosted in.",
      "$ref": "../../type/entityReference.json"
    },
    "serviceType": {
      "description": "Service type where this SearchIndex is hosted in.",
      "$ref": "../services/searchService.json#/definitions/searchServiceType"
    },
    "fields": {
      "description": "Fields in this SearchIndex.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/searchIndexField"
      }
    },
    "searchIndexSettings": {
      "description": "Contains key/value pair of searchIndex settings.",
      "$ref": "#/definitions/searchIndexSettings"
    },
    "indexType": {
      "description": "Whether the entity is index or index template.",
      "$ref": "#/definitions/indexType",
      "default": "Index"
    },
    "sampleData": {
      "description": "Sample data for a searchIndex.",
      "$ref": "#/definitions/searchIndexSampleData"
    },
    "owners": {
      "description": "Owners of this searchIndex.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "followers": {
      "description": "Followers of this searchIndex.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this searchIndex.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      }
    },
    "href": {
      "description": "Link to the resource corresponding to this entity.",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "changeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "incrementalChangeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "deleted": {
      "description": "When `true` indicates the entity has been soft deleted.",
      "type": "boolean",
      "default": false
    },
    "extension": {
      "description": "Entity extension data with custom attributes added to the entity.",
      "$ref": "../../type/basic.json#/definitions/entityExtension"
    },
    "domains": {
      "description": "Domains the SearchIndex belongs to. When not set, the SearchIndex inherits the domain from the messaging service it belongs to.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "dataProducts": {
      "description": "List of data products this entity is part of.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "votes": {
      "description": "Votes on the entity.",
      "$ref": "../../type/votes.json"
    },
    "lifeCycle": {
      "description": "Life Cycle of the entity",
      "$ref": "../../type/lifeCycle.json"
    },
    "certification": {
      "$ref": "../../type/assetCertification.json"
    },
    "sourceHash": {
      "description": "Source hash of the entity",
      "type": "string",
      "minLength": 1,
      "maxLength": 32
    },
    "entityStatus": {
      "description": "Status of the SearchIndex.",
      "$ref": "../../type/status.json"
    }
  },

  "required": ["id", "name", "service", "fields"]
}

{
  "@context": {
    "@vocab": "https://open-metadata.org/schema/",
    "om": "https://open-metadata.org/schema/",
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "xsd": "http://www.w3.org/2001/XMLSchema#",

    "SearchIndex": "om:SearchIndex",
    "name": {
      "@id": "om:indexName",
      "@type": "xsd:string"
    },
    "fullyQualifiedName": {
      "@id": "om:fullyQualifiedName",
      "@type": "xsd:string"
    },
    "displayName": {
      "@id": "om:displayName",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "om:description",
      "@type": "xsd:string"
    },
    "fields": {
      "@id": "om:hasField",
      "@type": "@id",
      "@container": "@list"
    },
    "settings": {
      "@id": "om:hasSettings",
      "@type": "@id"
    },
    "service": {
      "@id": "om:belongsToService",
      "@type": "@id"
    },
    "owners": {
      "@id": "om:ownedBy",
      "@type": "@id",
      "@container": "@set"
    },
    "followers": {
      "@id": "om:followedBy",
      "@type": "@id",
      "@container": "@set"
    },
    "domains": {
      "@id": "om:inDomain",
      "@type": "@id",
      "@container": "@set"
    },
    "dataProducts": {
      "@id": "om:partOfDataProduct",
      "@type": "@id",
      "@container": "@set"
    },
    "tags": {
      "@id": "om:hasTag",
      "@type": "@id",
      "@container": "@set"
    }
  }
}

{
  "@context": "https://open-metadata.org/context/searchIndex.jsonld",
  "@type": "SearchIndex",
  "@id": "https://example.com/search/elasticsearch_prod/products",

  "name": "products",
  "fullyQualifiedName": "elasticsearch_prod.products",
  "displayName": "Product Catalog Index",
  "description": "Full-text search index for the product catalog with advanced filtering",

  "service": {
    "@id": "https://example.com/services/elasticsearch_prod",
    "@type": "SearchService",
    "name": "elasticsearch_prod"
  },

  "searchIndexSettings": {
    "@type": "SearchIndexSettings",
    "numberOfShards": "5",
    "numberOfReplicas": "2",
    "refreshInterval": "1s"
  },

  "owners": [
    {
      "@id": "https://example.com/teams/search-team",
      "@type": "Team",
      "name": "search-team",
      "displayName": "Search Team"
    }
  ],

  "tags": [
    {
      "@id": "https://open-metadata.org/tags/Tier/Gold",
      "tagFQN": "Tier.Gold"
    }
  ],

  "fields": [
    {
      "@type": "SearchIndexField",
      "name": "product_id",
      "dataType": "KEYWORD",
      "description": "Unique product identifier"
    },
    {
      "@type": "SearchIndexField",
      "name": "product_name",
      "dataType": "TEXT",
      "dataTypeDisplay": "text",
      "children": [
        {
          "name": "keyword",
          "dataType": "KEYWORD"
        }
      ]
    }
  ]
}