Summary
-------
Simple ElasticSearch indexing integration for CubicWeb
Parameters
~~~~~~~~~~
* elasticsearch-locations (CW_ELASTICSEARCH_LOCATIONS)
* index-name (CW_INDEX_NAME)
* elasticsearch-verify-certs (CW_ELASTICSEARCH_VERIFY_CERTS)
* elasticsearch-ssl-show-warn (CW_ELASTICSEARCH_SSL_SHOW_WARN)
Pyramid debug panel
~~~~~~~~~~~~~~~~~~~
To activate the debug panel, you'll need to install ``pyramid_debugtoolbar``,
typically with::
pip install pyramid_debugtoolbar
Then, you'll have activate the debug toolbar and include the ElasticSearch
panel in your ``pyramid.ini``:
pyramid.includes =
pyramid_debugtoolbar
debugtoolbar.includes =
cubicweb_elasticsearch.pviews.espanel
**Alltext** field
~~~~~~~~~~~~~~~~~~
The `cubicweb_elasticsearch.search_helpers.compose_search` referencies
a custom `alltext` field which contains all indexed text. This field must be
defined in the custom Indexer mapping.
HTTPS and SSL certificates in communication with server
-------------------------------------------------------
In some cases (ElasticSearch Kubernetes deployment for example), self signed
certificates are used and can be ignored using elasticsearc-verify-certs, in
this case, the python binding will issue warnings for each request, which is
cumbersome when running requests in a `ccplugin` command. You can use
`elasticsearch-ssl-show-warn (CW_ELASTICSEARCH_SSL_SHOW_WARN)` to remove
those warnings (default is to show them). Most of the time, a better solution
is to have proper certificates to authenticate the servers you are talking to.
Raw data
{
"_id": null,
"home_page": "https://forge.extranet.logilab.fr/cubicweb/cubes/cubicweb-elasticsearch",
"name": "cubicweb-elasticsearch",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "LOGILAB S.A. (Paris, FRANCE)",
"author_email": "contact@logilab.fr",
"download_url": "https://files.pythonhosted.org/packages/62/4e/86eeb20097feb229e95519e7185458fece49610288b3b9f00a83bee53852/cubicweb-elasticsearch-2.0.0.tar.gz",
"platform": null,
"description": "Summary\n-------\nSimple ElasticSearch indexing integration for CubicWeb\n\n\nParameters\n~~~~~~~~~~\n\n* elasticsearch-locations (CW_ELASTICSEARCH_LOCATIONS)\n* index-name (CW_INDEX_NAME)\n* elasticsearch-verify-certs (CW_ELASTICSEARCH_VERIFY_CERTS)\n* elasticsearch-ssl-show-warn (CW_ELASTICSEARCH_SSL_SHOW_WARN)\n\nPyramid debug panel\n~~~~~~~~~~~~~~~~~~~\n\nTo activate the debug panel, you'll need to install ``pyramid_debugtoolbar``,\ntypically with::\n\n pip install pyramid_debugtoolbar\n\nThen, you'll have activate the debug toolbar and include the ElasticSearch\npanel in your ``pyramid.ini``:\n\n pyramid.includes =\n pyramid_debugtoolbar\n debugtoolbar.includes =\n cubicweb_elasticsearch.pviews.espanel\n\n\n**Alltext** field\n~~~~~~~~~~~~~~~~~~\n\nThe `cubicweb_elasticsearch.search_helpers.compose_search` referencies\na custom `alltext` field which contains all indexed text. This field must be\ndefined in the custom Indexer mapping.\n\nHTTPS and SSL certificates in communication with server\n-------------------------------------------------------\n\nIn some cases (ElasticSearch Kubernetes deployment for example), self signed\ncertificates are used and can be ignored using elasticsearc-verify-certs, in\nthis case, the python binding will issue warnings for each request, which is\ncumbersome when running requests in a `ccplugin` command. You can use\n`elasticsearch-ssl-show-warn (CW_ELASTICSEARCH_SSL_SHOW_WARN)` to remove\nthose warnings (default is to show them). Most of the time, a better solution\nis to have proper certificates to authenticate the servers you are talking to.\n",
"bugtrack_url": null,
"license": "LGPL",
"summary": "Simple ElasticSearch indexing integration for CubicWeb",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://forge.extranet.logilab.fr/cubicweb/cubes/cubicweb-elasticsearch"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f140b80ca630c4c0565c509cf8395764419676a24eab5fb36c17b6f69a8312e9",
"md5": "fc1451c424cc7cc89b3255155eed6779",
"sha256": "04870b1e5805986034fdb6000ebfe04fc1d089e30e3ec2cecc76358cfd0ca8ac"
},
"downloads": -1,
"filename": "cubicweb_elasticsearch-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc1451c424cc7cc89b3255155eed6779",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 24203,
"upload_time": "2024-03-21T13:18:34",
"upload_time_iso_8601": "2024-03-21T13:18:34.559385Z",
"url": "https://files.pythonhosted.org/packages/f1/40/b80ca630c4c0565c509cf8395764419676a24eab5fb36c17b6f69a8312e9/cubicweb_elasticsearch-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "624e86eeb20097feb229e95519e7185458fece49610288b3b9f00a83bee53852",
"md5": "43d02c9c3c6746237db40e4841f3b949",
"sha256": "befd002c5bfd3bf8843320232c19e63cc461405a667a844e536469ac5fa87f78"
},
"downloads": -1,
"filename": "cubicweb-elasticsearch-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "43d02c9c3c6746237db40e4841f3b949",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24791,
"upload_time": "2024-03-21T13:18:36",
"upload_time_iso_8601": "2024-03-21T13:18:36.522137Z",
"url": "https://files.pythonhosted.org/packages/62/4e/86eeb20097feb229e95519e7185458fece49610288b3b9f00a83bee53852/cubicweb-elasticsearch-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 13:18:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cubicweb-elasticsearch"
}
JSON