在elasticsearch中转义特殊字符

hjzp0vay  于 2023-05-16  发布在  ElasticSearch
关注(0)|答案(4)|浏览(408)

我正在使用elasticsearch python client对我们托管的elasticsearch示例进行一些查询。
我注意到有些字符需要转义。具体来说,这些…

+ - && || ! ( ) { } [ ] ^ " ~ * ? : \

除了我已经想到的方法之外,还有什么干净的方法吗?当然有比做更干净的方法

term
    .replace("+", "\+")
    .replace("-", "\-")

    # ....etc

我希望有一个API调用,我可以使用,但我找不到一个在文档中。这似乎是一个很常见的问题,应该有人解决。
有人知道“正确”的方法吗?
编辑:我仍然不确定是否有一个API调用,但我得到了足够简洁的东西,我很高兴。

def needs_escaping(character):                                                                                                                                                                                        

    escape_chars = {                                                                                                                                                                                               
        '\\' : True, '+' : True, '-' : True, '!' : True,                                                                                                                                                           
        '(' : True, ')' : True, ':' : True, '^' : True,                                                                                                                                                            
        '[' : True, ']': True, '\"' : True, '{' : True,                                                                                                                                                            
        '}' : True, '~' : True, '*' : True, '?' : True,                                                                                                                                                            
        '|' : True, '&' : True, '/' : True                                                                                                                                                                         
    }                                                                                                                                                                                                              
    return escape_chars.get(character, False)   

sanitized = ''
for character in query:                                                                                                                                                                                            

    if needs_escaping(character):                                                                                                                                                                                 
        sanitized += '\\%s' % character                                                                                                                                                                           
    else:                                                                                                                                                                                                      
        sanitized += character
2eafrhcq

2eafrhcq1#

是的,这些字符需要在您要在query_string query中搜索的内容中替换。要做到这一点(假设您使用的是PyLucene),您应该能够使用QueryParserBase.escape(String)
除此之外,您可以随时调整QueryParserBase.escape源代码以满足您的需求:

public static String escape(String s) {
  StringBuilder sb = new StringBuilder();
  for (int i = 0; i < s.length(); i++) {
    char c = s.charAt(i);
    // These characters are part of the query syntax and must be escaped
    if (c == '\\' || c == '+' || c == '-' || c == '!' || c == '(' || c == ')' || c == ':'
      || c == '^' || c == '[' || c == ']' || c == '\"' || c == '{' || c == '}' || c == '~'
      || c == '*' || c == '?' || c == '|' || c == '&' || c == '/') {
      sb.append('\\');
    }
    sb.append(c);
  }
  return sb.toString();
}
zd287kbt

zd287kbt2#

我修改了这段代码,找到了there

escapeRules = {'+': r'\+',
               '-': r'\-',
               '&': r'\&',
               '|': r'\|',
               '!': r'\!',
               '(': r'\(',
               ')': r'\)',
               '{': r'\{',
               '}': r'\}',
               '[': r'\[',
               ']': r'\]',
               '^': r'\^',
               '~': r'\~',
               '*': r'\*',
               '?': r'\?',
               ':': r'\:',
               '"': r'\"',
               '\\': r'\\;',
               '/': r'\/',
               '>': r' ',
               '<': r' '}

def escapedSeq(term):
    """ Yield the next string based on the
        next character (either this char
        or escaped version """
    for char in term:
        if char in escapeRules.keys():
            yield escapeRules[char]
        else:
            yield char

def escapeESArg(term):
    """ Apply escaping to the passed in query terms
        escaping special characters like : , etc"""
    term = term.replace('\\', r'\\')   # escape \ first
    return "".join([nextStr for nextStr in escapedSeq(term)])
ev7lccsx

ev7lccsx3#

为了直接回答这个问题,下面是一个使用re.sub的更干净的python解决方案

import re
KIBANA_SPECIAL = '+ - & | ! ( ) { } [ ] ^ " ~ * ? : \\'.split(' ')
re.sub('([{}])'.format('\\'.join(KIBANA_SPECIAL)), r'\\\1', val)

然而,一个更好的解决方案是正确地解析出发送给elasticsearch的错误字符:

import six.moves.urllib as urllib
urllib.parse.quote_plus(val)
tjjdgumg

tjjdgumg4#

是的,这些字符将需要在您要在query_string查询中搜索的内容中替换。

import re

def escape_elasticsearch_query(query):
    return re.sub(
        '(\+|\-|\=|&&|\|\||\>|\<|\!|\(|\)|\{|\}|\[|\]|\^|"|~|\*|\?|\:|\\\|\/)',
        "\\\\\\1",
        query,
    )

相关问题