\n \n \n ecm:* \n dc:* \n ecm:binaryFulltext \n \n \n\n\n\n @Since 5.9.3\n name is the Elasticsearch index name.\n\n type is the Elasticsearch type that hold a mapping, \"doc\" is the mapping\n for Nuxeo documents\n\n create can be set to false if you don't want Nuxeo to initialize the index\n and mapping.\n\n settings the Elasticsearch settings\n @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/index-modules.html\n\n mapping the Elasticsearch mapping for the type\n @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping.html\n\n @Since 5.9.5\n fetchFromSources, include a list of field name pattern that will be included\n when fetching document from Elasticsearch (@see NxQueryBuilder.fetchFromElasticsearch)\n use the exclude list to prevent returning fulltext or long fields.\n\n \n",
"documentationHtml": "\nExtension point used to setup an Elasticsearch index.\n
\nThe one used to index Nuxeo documents must be of type "doc".\n
\n
<elasticSearchIndex create="true" name="nuxeo" type="doc">\n <settings/>\n <mapping/>\n <fetchFromSources>\n <include>ecm:*</include>\n <include>dc:*</include>\n <exclude>ecm:binaryFulltext</exclude>\n </fetchFromSources>\n </elasticSearchIndex>\n\n@Since 5.9.3\nname is the Elasticsearch index name.\n
\ntype is the Elasticsearch type that hold a mapping, "doc" is the mapping\nfor Nuxeo documents\n
\ncreate can be set to false if you don't want Nuxeo to initialize the index\nand mapping.\n
\nsettings the Elasticsearch settings\n@see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/index-modules.html\n
\nmapping the Elasticsearch mapping for the type\n@see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping.html\n
\n@Since 5.9.5\nfetchFromSources, include a list of field name pattern that will be included\nwhen fetching document from Elasticsearch (@see NxQueryBuilder.fetchFromElasticsearch)\nuse the exclude list to prevent returning fulltext or long fields.\n
", "hierarchyPath": "/grp:org.nuxeo.elasticsearch/org.nuxeo.elasticsearch.core/org.nuxeo.elasticsearch.ElasticSearchComponent/ExtensionPoints/org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchIndex", "id": "org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchIndex", "label": "elasticSearchIndex (org.nuxeo.elasticsearch.ElasticSearchComponent)", "name": "elasticSearchIndex", "version": "9.10" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.elasticsearch.ElasticSearchComponent", "descriptors": [ "org.nuxeo.elasticsearch.config.ElasticSearchDocWriterDescriptor" ], "documentation": "\n Extension point used to setup the writer used when a document is indexed.\n Must extend the JsonESDocumentWriter class.\n\n\n \n \n",
"documentationHtml": "\nExtension point used to setup the writer used when a document is indexed.\nMust extend the JsonESDocumentWriter class.\n
\n
<writer class="org.nuxeo.ecm.automation.jaxrs.io.documents.JsonESDocumentWriter"/>\n\n \n \n \n \n \n \n \n \n\n\n\n For a Rest client:\n \n \n \n \n\n",
"documentationHtml": "\nExtension point to define how to access the Elasticsearch cluster.\n
\nFor the TransportClient protocol:\n
<elasticSeachClient class="org.nuxeo.elasticsearch.client.ESTransportClientFactory">\n <option name="addressList">localhost:9300</option>\n <option name="clusterName">elasticsearch</option>\n <option name="clientTransportSniff">false</option>\n <option name="clientTransportIgnoreClusterName">false</option>\n <option name="clientTransportPingTimeout">5s</option>\n <option name="clientTransportNodesSamplerInterval">5s</option>\n </elasticSeachClient>\n\nFor a Rest client:\n
<elasticSeachClient class="org.nuxeo.elasticsearch.client.ESRestClientFactory">\n <option name="addressList">localhost:9200</option>\n </elasticSeachClient>\n\n \n \n\n\n Please refer to the Elasticsearch node configuration\n\n clusterName is the cluster.name\n\n nodeName is the node.name, default to nuxeoNode\n\n pathData is the path.data\n\n indexStoreType is the index.store_type\n\n httpEnabled is the node.enable_http\n\n \n",
"documentationHtml": "\nExtension point to setup an embedded Elasticsearch instance.\n
\nIt creates a local node using the same JVM as Nuxeo.\n
\nThis is a test configuration and must NOT be used in production,\nit is limited to one shard and no replica.\n
\n
<elasticSearchLocal clusterName="MyCluster" httpEnabled="true"\n indexStoreType="mmapfs" nodeName="MyNuxeo" pathData="/var/lib/nuxeo/elasticsearch/"/>\n\nPlease refer to the Elasticsearch node configuration\n
\nclusterName is the cluster.name\n
\nnodeName is the node.name, default to nuxeoNode\n
\npathData is the path.data\n
\nindexStoreType is the index.store_type\n
\nhttpEnabled is the node.enable_http\n
", "hierarchyPath": "/grp:org.nuxeo.elasticsearch/org.nuxeo.elasticsearch.core/org.nuxeo.elasticsearch.ElasticSearchComponent/ExtensionPoints/org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchEmbeddedServer", "id": "org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchEmbeddedServer", "label": "elasticSearchEmbeddedServer (org.nuxeo.elasticsearch.ElasticSearchComponent)", "name": "elasticSearchEmbeddedServer", "version": "9.10" } ], "extensions": [], "hierarchyPath": "/grp:org.nuxeo.elasticsearch/org.nuxeo.elasticsearch.core/org.nuxeo.elasticsearch.ElasticSearchComponent", "name": "org.nuxeo.elasticsearch.ElasticSearchComponent", "requirements": [], "services": [ { "@type": "NXService", "componentId": "org.nuxeo.elasticsearch.ElasticSearchComponent", "hierarchyPath": "/grp:org.nuxeo.elasticsearch/org.nuxeo.elasticsearch.core/org.nuxeo.elasticsearch.ElasticSearchComponent/Services/org.nuxeo.elasticsearch.api.ElasticSearchService", "id": "org.nuxeo.elasticsearch.api.ElasticSearchService", "overriden": false, "version": "9.10" }, { "@type": "NXService", "componentId": "org.nuxeo.elasticsearch.ElasticSearchComponent", "hierarchyPath": "/grp:org.nuxeo.elasticsearch/org.nuxeo.elasticsearch.core/org.nuxeo.elasticsearch.ElasticSearchComponent/Services/org.nuxeo.elasticsearch.api.ElasticSearchAdmin", "id": "org.nuxeo.elasticsearch.api.ElasticSearchAdmin", "overriden": false, "version": "9.10" }, { "@type": "NXService", "componentId": "org.nuxeo.elasticsearch.ElasticSearchComponent", "hierarchyPath": "/grp:org.nuxeo.elasticsearch/org.nuxeo.elasticsearch.core/org.nuxeo.elasticsearch.ElasticSearchComponent/Services/org.nuxeo.elasticsearch.api.ElasticSearchIndexing", "id": "org.nuxeo.elasticsearch.api.ElasticSearchIndexing", "overriden": false, "version": "9.10" } ], "version": "9.10", "xmlFileContent": "\n\n \n\n Please refer to the Elasticsearch node configuration\n\n clusterName is the cluster.name\n\n nodeName is the node.name, default to nuxeoNode\n\n pathData is the path.data\n\n indexStoreType is the index.store_type\n\n httpEnabled is the node.enable_http\n\n \n \n \n \n \n \n \n \n \n \n\n For a Rest client:\n \n \n \n \n \n\n \n \n \n ecm:* \n dc:* \n ecm:binaryFulltext \n \n \n \n\n @Since 5.9.3\n name is the Elasticsearch index name.\n\n type is the Elasticsearch type that hold a mapping, \"doc\" is the mapping\n for Nuxeo documents\n\n create can be set to false if you don't want Nuxeo to initialize the index\n and mapping.\n\n settings the Elasticsearch settings\n @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/index-modules.html\n\n mapping the Elasticsearch mapping for the type\n @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping.html\n\n @Since 5.9.5\n fetchFromSources, include a list of field name pattern that will be included\n when fetching document from Elasticsearch (@see NxQueryBuilder.fetchFromElasticsearch)\n use the exclude list to prevent returning fulltext or long fields.\n\n \n \n\n