termvector -> termvectors rename + bw compatibility alias

This commit is contained in:
Honza Král
2014-11-25 13:48:23 +01:00
parent 8ebbf3375f
commit ee4a37658f
+10 -3
View File
@@ -921,10 +921,14 @@ class Elasticsearch(object):
@query_params('field_statistics', 'fields', 'offsets', 'parent', 'payloads', @query_params('field_statistics', 'fields', 'offsets', 'parent', 'payloads',
'positions', 'preference', 'realtime', 'routing', 'term_statistics') 'positions', 'preference', 'realtime', 'routing', 'term_statistics')
def termvector(self, index, doc_type, id, body=None, params=None): def termvectors(self, index, doc_type, id, body=None, params=None):
""" """
Added in 1. Returns information and statistics on terms in the fields of a
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-termvectors.html>`_ particular document. The document could be stored in the index or
artificially provided by the user (Added in 1.4). Note that for
documents stored in the index, this is a near realtime API as the term
vectors are not available until the next refresh.
`<http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-termvectors.html>`
:arg index: The index in which the document resides. :arg index: The index in which the document resides.
:arg doc_type: The type of the document. :arg doc_type: The type of the document.
@@ -953,6 +957,9 @@ class Elasticsearch(object):
doc_type, id, '_termvector'), params=params, body=body) doc_type, id, '_termvector'), params=params, body=body)
return data return data
# backwards compatibility
termvector = termvectors
@query_params('field_statistics', 'fields', 'ids', 'offsets', 'parent', @query_params('field_statistics', 'fields', 'ids', 'offsets', 'parent',
'payloads', 'positions', 'preference', 'routing', 'term_statistics') 'payloads', 'positions', 'preference', 'routing', 'term_statistics')
def mtermvectors(self, index=None, doc_type=None, body=None, params=None): def mtermvectors(self, index=None, doc_type=None, body=None, params=None):